@microsoft/teams-js 2.1.0-beta.1 → 2.1.0-beta.4

package/dist/MicrosoftTeams.js

@@ -1118,11 +1118,12 @@ __webpack_require__.d(__webpack_exports__, {
   "teams": () => (/* reexport */ teams),
   "teamsCore": () => (/* reexport */ teamsCore),
   "uploadCustomApp": () => (/* reexport */ uploadCustomApp),
-  "video": () => (/* reexport */ video)
+  "video": () => (/* reexport */ video),
+  "webStorage": () => (/* reexport */ webStorage)
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.1.0-beta.1";
+var version = "2.1.0-beta.4";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2358,6 +2359,7 @@ var runtime = {
         calendar: undefined,
         call: undefined,
         chat: undefined,
+        webStorage: undefined,
         conversations: undefined,
         dialog: {
             bot: undefined,
@@ -2460,6 +2462,12 @@ var versionConstants = {
             ],
         },
     ],
+    '2.0.5': [
+        {
+            capability: { webStorage: {} },
+            hostClientTypes: [HostClientType.android, HostClientType.ios],
+        },
+    ],
 };
 /**
  * @internal
@@ -2581,7 +2589,7 @@ var dialog;
         }
         var dialogInfo = getDialogInfoFromUrlDialogInfo(urlDialogInfo);
         sendMessageToParent('tasks.startTask', [dialogInfo], function (err, result) {
-            submitHandler({ err: err, result: result });
+            submitHandler === null || submitHandler === void 0 ? void 0 : submitHandler({ err: err, result: result });
             removeHandler('messageForParent');
         });
     }
@@ -2720,7 +2728,7 @@ var dialog;
             }
             var dialogInfo = getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo);
             sendMessageToParent('tasks.startTask', [dialogInfo], function (err, result) {
-                submitHandler({ err: err, result: result });
+                submitHandler === null || submitHandler === void 0 ? void 0 : submitHandler({ err: err, result: result });
                 removeHandler('messageForParent');
             });
         }
@@ -4052,6 +4060,10 @@ function removeHandler(name) {
     delete HandlersPrivate.handlers[name];
 }
 /** @internal */
+function doesHandlerExist(name) {
+    return HandlersPrivate.handlers[name] != null;
+}
+/** @internal */
 function handlers_registerOnThemeChangeHandler(handler) {
     HandlersPrivate.themeChangeHandler = handler;
     handler && sendMessageToParent('registerHandler', ['themeChange']);
@@ -5934,7 +5946,7 @@ var meeting;
     meeting.registerSpeakingStateChangeHandler = registerSpeakingStateChangeHandler;
     /**
      * Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
-     * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEvent}
+     * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
      * that will have the raiseHandState or an error object. Only one handler can be registered at a time. A subsequent registration
      * replaces an existing registration.
      *
@@ -6269,18 +6281,21 @@ var profile;
 
 /**
  * Namespace to video extensibility of the SDK
+ * @beta
  */
 var video;
 (function (video) {
     /**
      * Video frame format enum, currently only support NV12
+     * @beta
      */
     var VideoFrameFormat;
     (function (VideoFrameFormat) {
         VideoFrameFormat[VideoFrameFormat["NV12"] = 0] = "NV12";
     })(VideoFrameFormat = video.VideoFrameFormat || (video.VideoFrameFormat = {}));
     /**
-     *  Video effect change type enum
+     * Video effect change type enum
+     * @beta
      */
     var EffectChangeType;
     (function (EffectChangeType) {
@@ -6295,6 +6310,7 @@ var video;
     })(EffectChangeType = video.EffectChangeType || (video.EffectChangeType = {}));
     /**
      * Register to read the video frames in Permissions section
+     * @beta
      * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
      * @param config - VideoFrameConfig to customize generated video frame parameters
      */
@@ -6312,10 +6328,10 @@ var video;
     }
     video.registerForVideoFrame = registerForVideoFrame;
     /**
-     * video extension should call this to notify host client that the current selected effect parameter changed.
+     * Video extension should call this to notify host client that the current selected effect parameter changed.
      * If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
      * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
-     *
+     * @beta
      * @param effectChangeType - the effect change type.
      * @param effectId - Newly selected effect id.
      */
@@ -6329,6 +6345,7 @@ var video;
     video.notifySelectedVideoEffectChanged = notifySelectedVideoEffectChanged;
     /**
      * Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
+     * @beta
      * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
      */
     function registerForVideoEffect(callback) {
@@ -6342,12 +6359,14 @@ var video;
     /**
      * Sending notification to host client finished the video frame processing, now host client can render this video frame
      * or pass the video frame to next one in video pipeline
+     * @beta
      */
     function notifyVideoFrameProcessed() {
         sendMessageToParent('video.videoFrameProcessed');
     }
     /**
      * Sending error notification to host client
+     * @beta
      * @param errorMessage - The error message that will be sent to the host
      */
     function notifyError(errorMessage) {
@@ -6355,6 +6374,7 @@ var video;
     }
     /**
      * Checks if video capability is supported by the host
+     * @beta
      * @returns true if the video capability is enabled in runtime.supports.video and
      * false if it is disabled
      */
@@ -6483,6 +6503,47 @@ var stageView;
     stageView.open = open;
 })(stageView || (stageView = {}));
 
+;// CONCATENATED MODULE: ./src/public/webStorage.ts
+
+
+
+
+/**
+ * Contains functionality to allow web apps to store data in webview cache
+ *
+ * @beta
+ */
+var webStorage;
+(function (webStorage) {
+    /**
+     * Checks if web storage gets cleared when a user logs out from host client
+     *
+     * @returns true is web storage gets cleared on logout and false if it does not
+     *
+     * @beta
+     */
+    function isWebStorageClearedOnUserLogOut() {
+        ensureInitialized();
+        // return true as web storage is always cleared on desktop.
+        if (GlobalVars.hostClientType === HostClientType.desktop) {
+            return true;
+        }
+        return isSupported();
+    }
+    webStorage.isWebStorageClearedOnUserLogOut = isWebStorageClearedOnUserLogOut;
+    /**
+     * Checks if webStorage capability is supported by the host
+     * @returns true if the webStorage capability is enabled in runtime.supports.webStorage and
+     * false if it is disabled
+     *
+     * @beta
+     */
+    function isSupported() {
+        return runtime.supports.webStorage ? true : false;
+    }
+    webStorage.isSupported = isSupported;
+})(webStorage || (webStorage = {}));
+
 ;// CONCATENATED MODULE: ./src/public/call.ts
 
 
@@ -7090,7 +7151,7 @@ var settings;
     settings.setValidityState = setValidityState;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
+     * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
      *
      * Gets the settings for the current instance.
      *
@@ -7186,8 +7247,9 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
-     * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
+     * As of 2.0.0, please use {@link dialog.open dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
+     * and {@link dialog.bot.open dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot based dialogs. In Teams,
+     * this function can be used for adaptive card based dialogs. Support for adaptive card based dialogs is coming to other hosts in the future.
      *
      * Allows an app to open the task module.
      *
@@ -7195,19 +7257,18 @@ var tasks;
      * @param submitHandler - Handler to call when the task module is completed
      */
     function startTask(taskInfo, submitHandler) {
+        var dialogSubmitHandler = submitHandler
+            ? function (sdkResponse) { return submitHandler(sdkResponse.err, sdkResponse.result); }
+            : undefined;
         if (taskInfo.card !== undefined || taskInfo.url === undefined) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
             sendMessageToParent('tasks.startTask', [taskInfo], submitHandler);
         }
         else if (taskInfo.completionBotId !== undefined) {
-            dialog.bot.open(getBotUrlDialogInfoFromTaskInfo(taskInfo), function (sdkResponse) {
-                return submitHandler(sdkResponse.err, sdkResponse.result);
-            });
+            dialog.bot.open(getBotUrlDialogInfoFromTaskInfo(taskInfo), dialogSubmitHandler);
         }
         else {
-            dialog.open(getUrlDialogInfoFromTaskInfo(taskInfo), function (sdkResponse) {
-                return submitHandler(sdkResponse.err, sdkResponse.result);
-            });
+            dialog.open(getUrlDialogInfoFromTaskInfo(taskInfo), dialogSubmitHandler);
         }
         return new ChildAppWindow();
     }
@@ -7232,7 +7293,7 @@ var tasks;
     tasks.updateTask = updateTask;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
+     * As of 2.0.0, please use {@link dialog.submit} instead.
      *
      * Submit the task module.
      *
@@ -7243,6 +7304,11 @@ var tasks;
         dialog.submit(result, appIds);
     }
     tasks.submitTask = submitTask;
+    /**
+     * Converts {@link TaskInfo} to {@link UrlDialogInfo}
+     * @param taskInfo - TaskInfo object to convert
+     * @returns - Converted UrlDialogInfo object
+     */
     function getUrlDialogInfoFromTaskInfo(taskInfo) {
         var urldialogInfo = {
             url: taskInfo.url,
@@ -7256,6 +7322,11 @@ var tasks;
         return urldialogInfo;
     }
     tasks.getUrlDialogInfoFromTaskInfo = getUrlDialogInfoFromTaskInfo;
+    /**
+     * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
+     * @param taskInfo - TaskInfo object to convert
+     * @returns - converted BotUrlDialogInfo object
+     */
     function getBotUrlDialogInfoFromTaskInfo(taskInfo) {
         var botUrldialogInfo = {
             url: taskInfo.url,
@@ -7270,6 +7341,12 @@ var tasks;
         return botUrldialogInfo;
     }
     tasks.getBotUrlDialogInfoFromTaskInfo = getBotUrlDialogInfoFromTaskInfo;
+    /**
+     * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
+     * otherwise uses the height and width values corresponding to {@link TaskModuleDimension.Small}
+     * @param taskInfo TaskInfo object from which to extract size info, if specified
+     * @returns TaskInfo with height and width specified
+     */
     function getDefaultSizeIfNotProvided(taskInfo) {
         taskInfo.height = taskInfo.height ? taskInfo.height : TaskModuleDimension.Small;
         taskInfo.width = taskInfo.width ? taskInfo.width : TaskModuleDimension.Small;
@@ -7305,6 +7382,7 @@ var tasks;
 
 
 
+