@microsoft/teams-js 2.0.0-beta.6 → 2.0.0-beta.7-dev.1

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;
         /**
@@ -2906,7 +2992,7 @@ export namespace dialog {
 }
 
 /**
-    * Navigation specific part of the SDK.
+    * Navigation-specific part of the SDK.
     *
     * @beta
     */
@@ -2919,6 +3005,7 @@ export namespace pages {
         function returnFocus(navigateForward?: boolean): void;
         /**
             * @hidden
+            *
             * Registers a handler when focus needs to be passed from teams to the place of choice on app.
             *
             * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
@@ -2926,8 +3013,26 @@ export namespace pages {
             * @internal
             */
         function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
+        /**
+            * Sets/Updates the current frame with new information
+            *
+            * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
+            * user clicks 'Go To Website'
+            */
         function setCurrentFrame(frameInfo: FrameInfo): void;
+        /**
+            * Initializes the library with context information for the frame
+            *
+            * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
+            *  user clicks 'Go To Website'
+            * @param callback - An optional user-set callback that is executed once the app has finished initialization.
+            * @param validMessageOrigins - An optional list of cross-frame message origins. They must have
+            * https: protocol otherwise they will be ignored. Example: https:www.example.com
+            */
         function initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[]): void;
+        /**
+            * Defines the configuration of the current or desired instance
+            */
         interface InstanceConfig {
                 /**
                     * A suggested display name for the new content.
@@ -2989,7 +3094,9 @@ export namespace pages {
             */
         function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
         /**
-            * Checks if page capability is supported currently
+            * Checks if the current application host supports the pages capability
+            * @returns true if the pages capability is enabled in runtime.supports.pages and
+            * false if it is disabled
             */
         function isSupported(): boolean;
         /**
@@ -3032,17 +3139,19 @@ export namespace pages {
                     * Allows an app to retrieve for this user tabs that are owned by this app.
                     * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
                     * @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
-                    * @returns Promise that resolves with the {@link TabInformation}.
+                    * @returns Promise that resolves with the {@link TabInformation}. Contains information for the user's tabs that are owned by this application {@link TabInstance}.
                     */
                 function getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
                 /**
                     * Allows an app to retrieve the most recently used tabs for this user.
-                    * @param tabInstanceParameters OPTIONAL Ignored, kept for future use
-                    * @returns Promise that resolves with the {@link TabInformation}.
+                    * @param tabInstanceParameters OPTIONAL Ignored, kept for future use.
+                    * @returns Promise that resolves with the {@link TabInformation}. Contains information for the users' most recently used tabs {@link TabInstance}.
                     */
                 function getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
                 /**
-                    * Checks if pages.tabs capability is supported currently
+                    * Checks if the current application host supports the pages.tab capability
+                    * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
+                    * false if it is disabled
                     */
                 function isSupported(): boolean;
         }
@@ -3051,6 +3160,13 @@ export namespace pages {
             * This object is usable only on the config frame.
             */
         namespace config {
+                /**
+                    * @hidden
+                    * Hide from docs because this function is only used during initialization
+                    * ------------------
+                    * Adds register handlers for settings.save and settings.remove upon initialization. Function is called in {@link app.initializeHelper}
+                    * @internal
+                    */
                 function initialize(): void;
                 /**
                     * Sets the validity state for the config.
@@ -3082,10 +3198,14 @@ export namespace pages {
                     */
                 function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
                 /**
-                    * Registers a handler for when the user reconfigurated tab
+                    * Registers a handler for when the tab configuration is changed by the user
                     * @param handler The handler to invoke when the user click on Settings.
                     */
                 function registerChangeConfigHandler(handler: () => void): void;
+                /**
+                    * Describes the results of the settings.save event. Includes result, notifySuccess, and notifyFailure
+                    * to indicate the return object (result) and the status of whether the settings.save call succeeded or not and why.
+                    */
                 interface SaveEvent {
                         /**
                             * Object containing properties passed as arguments to the settings.save event.
@@ -3101,6 +3221,10 @@ export namespace pages {
                             */
                         notifyFailure(reason?: string): void;
                 }
+                /**
+                    * Describes the results of the settings.remove event. Includes notifySuccess, and notifyFailure
+                    * to indicate the status of whether the settings.save call succeeded or not and why.
+                    */
                 interface RemoveEvent {
                         /**
                             * Indicates that the underlying resource has been removed and the content can be removed.
@@ -3112,6 +3236,9 @@ export namespace pages {
                             */
                         notifyFailure(reason?: string): void;
                 }
+                /**
+                    * Parameters used in the settings.save event
+                    */
                 interface SaveParameters {
                         /**
                             * Connector's webhook Url returned as arguments to settings.save event as part of user clicking on Save
@@ -3119,7 +3246,9 @@ export namespace pages {
                         webhookUrl?: string;
                 }
                 /**
-                    * Checks if pages.config capability is supported currently
+                    * Checks if the current application host supports the pages.config capability
+                    * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
+                    * false if it is disabled
                     */
                 function isSupported(): boolean;
         }
@@ -3143,10 +3272,18 @@ export namespace pages {
                     */
                 function registerBackButtonHandler(handler: () => boolean): void;
                 /**
-                    * Checks if pages.backStack capability is supported currently
+                    * Checks if the current application host supports the pages.backStack capability
+                    * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
+                    * false if it is disabled
                     */
                 function isSupported(): boolean;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            * ------
+            * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
+            */
         namespace fullTrust {
                 /**
                     * @hidden
@@ -3163,7 +3300,12 @@ export namespace pages {
                     */
                 function exitFullscreen(): void;
                 /**
-                    * Checks if pages.fullTrust capability is supported currently
+                    * @hidden
+                    * Hide from docs
+                    * ------
+                    * Checks if the current application host supports the pages.fullTrust capability
+                    * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
+                    * false if it is disabled
                     */
                 function isSupported(): boolean;
         }
@@ -3191,6 +3333,8 @@ export namespace pages {
                 function onHoverLeave(handler: () => void): void;
                 /**
                     * Checks if pages.appButton capability is supported currently
+                    * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
+                    * false if it is disabled
                     */
                 function isSupported(): boolean;
         }
@@ -4566,25 +4710,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;
 }