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

package/dist/MicrosoftTeams.d.ts

@@ -2313,6 +2313,9 @@ export interface BotUrlDialogInfo extends UrlDialogInfo {
             */
         completionBotId: string;
 }
+/**
+    * Data structure to describe dialog information
+    */
 export interface DialogInfo {
         /**
             * The url to be rendered in the webview/iframe.
@@ -4481,7 +4484,7 @@ export namespace meeting {
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
         /**
             * 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.
             *
@@ -5401,7 +5404,7 @@ export namespace settings {
         function setValidityState(validityState: boolean): void;
         /**
             * @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.
             *
@@ -5455,9 +5458,8 @@ export namespace settings {
 export namespace 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.
             * Allows an app to open the task module.
             *
             * @param taskInfo - An object containing the parameters of the task module
@@ -5475,7 +5477,7 @@ export namespace tasks {
         function updateTask(taskInfo: TaskInfo): void;
         /**
             * @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.
             *
@@ -5483,8 +5485,24 @@ export namespace tasks {
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
+        /**
+            * Converts {@link TaskInfo} to {@link UrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - Converted UrlDialogInfo object
+            */
         function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
+        /**
+            * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - converted BotUrlDialogInfo object
+            */
         function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
+        /**
+            * 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): TaskInfo;
 }
 

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.1.0-beta.1";
+var version = "2.1.0-beta.2";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -5934,7 +5934,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.
      *
@@ -7090,7 +7090,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,9 +7186,8 @@ 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.
      * Allows an app to open the task module.
      *
      * @param taskInfo - An object containing the parameters of the task module
@@ -7232,7 +7231,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 +7242,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 +7260,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 +7279,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;