@microsoft/teams-js 2.0.0-beta.6-dev.20 → 2.0.0-beta.6-dev.21

package/dist/MicrosoftTeams.d.ts

@@ -1760,6 +1760,11 @@ export enum FileOpenPreference {
         Desktop = "desktop",
         Web = "web"
 }
+/**
+    * @deprecated
+    * As of 2.0.0-beta.1, please use {@link app.Context} instead.
+    * Represents structure of the received context message.
+    */
 export interface Context {
         /**
             * @hidden
@@ -2297,26 +2302,78 @@ export namespace app {
                 Failure: string;
                 ExpectedFailure: string;
         };
+        /**
+            * Describes errors that caused app initialization to fail
+            */
         enum FailedReason {
+                /**
+                    * Authentication failed
+                    */
                 AuthFailed = "AuthFailed",
+                /**
+                    * The application timed out
+                    */
                 Timeout = "Timeout",
+                /**
+                    * The app failed for a different reason
+                    */
                 Other = "Other"
         }
+        /**
+            * Describes expected errors that occurred during an otherwise successful
+            * app initialization
+            */
         enum ExpectedFailureReason {
+                /**
+                    * There was a permission error
+                    */
                 PermissionError = "PermissionError",
+                /**
+                    * The item was not found
+                    */
                 NotFound = "NotFound",
+                /**
+                    * The network is currently throttled
+                    */
                 Throttling = "Throttling",
+                /**
+                    * The application is currently offline
+                    */
                 Offline = "Offline",
+                /**
+                    * The app failed for a different reason
+                    */
                 Other = "Other"
         }
+        /**
+            * Represents the failed request sent during a failed app initialization.
+            */
         interface IFailedRequest {
+                /**
+                    * The reason for the failure
+                    */
                 reason: FailedReason;
+                /**
+                    * A message that describes the failure
+                    */
                 message?: string;
         }
+        /**
+            * Represents the failure request sent during an erroneous app initialization.
+            */
         interface IExpectedFailureRequest {
+                /**
+                    * The reason for the failure
+                    */
                 reason: ExpectedFailureReason;
+                /**
+                    * A message that describes the failure
+                    */
                 message?: string;
         }
+        /**
+            * Represents application information.
+            */
         interface AppInfo {
                 /**
                     * The current locale that the user has configured for the app formatted as
@@ -2363,6 +2420,9 @@ export namespace app {
                     */
                 appLaunchId?: string;
         }
+        /**
+            * Represents information about the application's host.
+            */
         interface AppHostInfo {
                 /**
                     * The name of the host client. Possible values are: Office, Orange, Outlook, Teams
@@ -2381,6 +2441,9 @@ export namespace app {
                     */
                 ringId?: string;
         }
+        /**
+            * Represents Channel information.
+            */
         interface ChannelInfo {
                 /**
                     * The Microsoft Teams ID for the channel with which the content is associated.
@@ -2411,18 +2474,27 @@ export namespace app {
                     */
                 ownerGroupId?: string;
         }
+        /**
+            * Represents Chat information.
+            */
         interface ChatInfo {
                 /**
                     * The Microsoft Teams ID for the chat with which the content is associated.
                     */
                 id: string;
         }
+        /**
+            * Represents Meeting information.
+            */
         interface MeetingInfo {
                 /**
                     * Meeting Id used by tab when running in meeting context
                     */
                 id: string;
         }
+        /**
+            * Represents Page information.
+            */
         interface PageInfo {
                 /**
                     * The developer-defined unique ID for the page this content points to.
@@ -2451,6 +2523,9 @@ export namespace app {
                     */
                 sourceOrigin?: string;
         }
+        /**
+            * Represents Team information.
+            */
         interface TeamInfo {
                 /**
                     * The Microsoft Teams ID for the team with which the content is associated.
@@ -2485,6 +2560,9 @@ export namespace app {
                     */
                 userRole?: UserTeamRole;
         }
+        /**
+            * Represents User information.
+            */
         interface UserInfo {
                 /**
                     * The Azure AD object id of the current user.
@@ -2528,6 +2606,9 @@ export namespace app {
                     */
                 tenant?: TenantInfo;
         }
+        /**
+            * Represents Tenant information.
+            */
         interface TenantInfo {
                 /**
                     * The Azure AD tenant ID of the current user.
@@ -2568,7 +2649,7 @@ export namespace app {
                 mySitePath?: string;
         }
         /**
-            * Represents structure of the context message received
+            * Represents structure of the received context message.
             */
         interface Context {
                 /**
@@ -2614,7 +2695,7 @@ export namespace app {
             */
         function isInitialized(): boolean;
         /**
-            * Gets the Frame Context that the App is running in. {@see FrameContexts} for the list of possible values.
+            * Gets the Frame Context that the App is running in. See {@link FrameContexts} for the list of possible values.
             * @returns the Frame Context.
             */
         function getFrameContext(): FrameContexts;
@@ -2651,7 +2732,7 @@ export namespace app {
         /**
             * Retrieves the current context the frame is running in.
             *
-            * @returns Promise that will resolve with the {@link Context} object.
+            * @returns Promise that will resolve with the {@link app.Context} object.
             */
         function getContext(): Promise<app.Context>;
         /**
@@ -2664,10 +2745,15 @@ export namespace app {
         function notifySuccess(): void;
         /**
             * Notifies the frame that app initialization has failed and to show an error page in its place.
+            *
+            * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
+            * during initialization as well as an optional message.
             */
         function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
         /**
             * Notifies the frame that app initialized with some expected errors.
+            *
+            * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
             */
         function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
         /**
@@ -4566,25 +4652,32 @@ export namespace appInitialization {
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
+            *
             * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
             */
         function notifyAppLoaded(): void;
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
+            *
             * Notifies the frame that app initialization is successful and is ready for user interaction.
             */
         function notifySuccess(): void;
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
+            *
             * Notifies the frame that app initialization has failed and to show an error page in its place.
+            * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
+            * during initialization as well as an optional message.
             */
         function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
+            *
             * Notifies the frame that app initialized with some expected errors.
+            * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
             */
         function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
 }

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.20";
+var version = "2.0.0-beta.6-dev.21";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -3027,18 +3027,49 @@ var app_app;
         Failure: 'appInitialization.failure',
         ExpectedFailure: 'appInitialization.expectedFailure',
     };
+    /**
+     * Describes errors that caused app initialization to fail
+     */
     var FailedReason;
     (function (FailedReason) {
+        /**
+         * Authentication failed
+         */
         FailedReason["AuthFailed"] = "AuthFailed";
+        /**
+         * The application timed out
+         */
         FailedReason["Timeout"] = "Timeout";
+        /**
+         * The app failed for a different reason
+         */
         FailedReason["Other"] = "Other";
     })(FailedReason = app.FailedReason || (app.FailedReason = {}));
+    /**
+     * Describes expected errors that occurred during an otherwise successful
+     * app initialization
+     */
     var ExpectedFailureReason;
     (function (ExpectedFailureReason) {
+        /**
+         * There was a permission error
+         */
         ExpectedFailureReason["PermissionError"] = "PermissionError";
+        /**
+         * The item was not found
+         */
         ExpectedFailureReason["NotFound"] = "NotFound";
+        /**
+         * The network is currently throttled
+         */
         ExpectedFailureReason["Throttling"] = "Throttling";
+        /**
+         * The application is currently offline
+         */
         ExpectedFailureReason["Offline"] = "Offline";
+        /**
+         * The app failed for a different reason
+         */
         ExpectedFailureReason["Other"] = "Other";
     })(ExpectedFailureReason = app.ExpectedFailureReason || (app.ExpectedFailureReason = {}));
     /**
@@ -3050,7 +3081,7 @@ var app_app;
     }
     app.isInitialized = isInitialized;
     /**
-     * Gets the Frame Context that the App is running in. {@see FrameContexts} for the list of possible values.
+     * Gets the Frame Context that the App is running in. See {@link FrameContexts} for the list of possible values.
      * @returns the Frame Context.
      */
     function getFrameContext() {
@@ -3198,7 +3229,7 @@ var app_app;
     /**
      * Retrieves the current context the frame is running in.
      *
-     * @returns Promise that will resolve with the {@link Context} object.
+     * @returns Promise that will resolve with the {@link app.Context} object.
      */
     function getContext() {
         return new Promise(function (resolve) {
@@ -3225,6 +3256,9 @@ var app_app;
     app.notifySuccess = notifySuccess;
     /**
      * Notifies the frame that app initialization has failed and to show an error page in its place.
+     *
+     * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
+     * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
         ensureInitialized();
@@ -3236,6 +3270,8 @@ var app_app;
     app.notifyFailure = notifyFailure;
     /**
      * Notifies the frame that app initialized with some expected errors.
+     *
+     * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
         ensureInitialized();
@@ -6301,6 +6337,7 @@ var appInitialization;
     /**
      * @deprecated
      * As of 2.0.0-beta.1, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
+     *
      * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
      */
     function notifyAppLoaded() {
@@ -6310,6 +6347,7 @@ var appInitialization;
     /**
      * @deprecated
      * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
+     *
      * Notifies the frame that app initialization is successful and is ready for user interaction.
      */
     function notifySuccess() {
@@ -6319,7 +6357,10 @@ var appInitialization;
     /**
      * @deprecated
      * As of 2.0.0-beta.1, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
+     *
      * Notifies the frame that app initialization has failed and to show an error page in its place.
+     * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
+     * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
         app_app.notifyFailure(appInitializationFailedRequest);
@@ -6328,7 +6369,9 @@ var appInitialization;
     /**
      * @deprecated
      * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
+     *
      * Notifies the frame that app initialized with some expected errors.
+     * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
         app_app.notifyExpectedFailure(expectedFailureRequest);