@microsoft/teams-js 2.5.0 → 2.6.0-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -23,8 +23,11 @@ export namespace logs {
         /**
             * @hidden
             *
+            * Checks if the logs capability is supported by the host
             * @returns boolean to represent whether the logs capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -488,8 +491,11 @@ export namespace conversations {
             */
         function getChatMembers(): Promise<ChatMembersInformation>;
         /**
+            * Checks if the conversations capability is supported by the host
             * @returns boolean to represent whether conversations capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -1458,8 +1464,11 @@ export namespace meetingRoom {
         /**
             * @hidden
             *
+            * Checks if the meetingRoom capability is supported by the host
             * @returns boolean to represent whether the meetingRoom capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -1481,8 +1490,12 @@ export namespace notifications {
         function showNotification(showNotificationParameters: ShowNotificationParameters): void;
         /**
             * @hidden
+            *
+            * Checks if the notifications capability is supported by the host
             * @returns boolean to represent whether the notifications capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -1781,8 +1794,12 @@ export namespace remoteCamera {
         function registerOnSessionStatusChangeHandler(handler: (sessionStatusChange: SessionStatus) => void): void;
         /**
             * @hidden
+            *
+            * Checks if the remoteCamera capability is supported by the host
             * @returns boolean to represent whether the remoteCamera capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @internal
             * Limited to Microsoft-internal use
             */
@@ -1867,9 +1884,10 @@ export namespace appEntity {
         /**
             * @hidden
             *
-            * Checks if appEntity capability is supported by the host
-            * @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
-            * false if it is disabled
+            * Checks if the appEntity capability is supported by the host
+            * @returns boolean to represent whether the appEntity capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             *
             * @internal
             * Limited to Microsoft-internal use
@@ -1927,10 +1945,11 @@ export namespace teams {
         function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
         /**
             * @hidden
+            *
             * Checks if teams capability is supported by the host
+            * @returns boolean to represent whether the teams capability is supported
             *
-            * @returns true if the teams capability is enabled in runtime.supports.teams and
-            * false if it is disabled
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             *
             * @internal
             * Limited to Microsoft-internal use
@@ -1961,10 +1980,11 @@ export namespace teams {
                         function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
                         /**
                             * @hidden
+                            *
                             * Checks if teams.fullTrust.joinedTeams capability is supported by the host
+                            * @returns boolean to represent whether the teams.fullTrust.joinedTeams capability is supported
                             *
-                            * @returns true if the teams.fullTrust.joinedTeams capability is enabled in
-                            * runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
+                            * @throws Error if {@linkcode app.initialize} has not successfully completed
                             *
                             * @internal
                             * Limited to Microsoft-internal use
@@ -1984,9 +2004,11 @@ export namespace teams {
                 function getConfigSetting(key: string): Promise<string>;
                 /**
                     * @hidden
+                    *
                     * Checks if teams.fullTrust capability is supported by the host
-                    * @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the teams.fullTrust capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     *
                     * @internal
                     * Limited to Microsoft-internal use
@@ -2143,11 +2165,13 @@ export namespace videoEx {
         function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
         /**
             * @hidden
+            *
             * 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
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @returns boolean to represent whether the video capability is supported
             *
             * @internal
             * Limited to Microsoft-internal use
@@ -2177,7 +2201,7 @@ export namespace authentication {
             *
             * @returns Promise that will be fulfilled with the result from the authentication pop-up if successful.
             *
-            * @throws if the authentication request fails or is canceled by the user.
+            * @throws Error if the authentication request fails or is canceled by the user.
             *
             */
         function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
@@ -3926,6 +3950,12 @@ export namespace appInstallDialog {
         appId: string;
     }
     function openAppInstallDialog(openAPPInstallDialogParams: OpenAppInstallDialogParams): Promise<void>;
+    /**
+      * Checks if the appInstallDialog capability is supported by the host
+      * @returns boolean to represent whether the appInstallDialog capability is supported
+      *
+      * @throws Error if {@linkcode app.initialize} has not successfully completed
+      */
     function isSupported(): boolean;
 }
 
@@ -3976,8 +4006,9 @@ export namespace barCode {
         function requestPermission(): Promise<boolean>;
         /**
             * Checks if barCode capability is supported by the host
+            * @returns boolean to represent whether the barCode capability is supported
             *
-            * @returns boolean to represent whether barCode is supported
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             *
             * @beta
             */
@@ -4055,10 +4086,11 @@ export namespace chat {
             */
         function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
         /**
-            * Checks if chat capability is supported by the host
-            *
+            * Checks if the chat capability is supported by the host
             * @returns boolean to represent whether the chat capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @beta
             */
         function isSupported(): boolean;
@@ -4169,9 +4201,10 @@ export namespace dialog {
             */
         function registerOnMessageFromParent(listener: PostMessageChannel): void;
         /**
-            * Checks if dialog module is supported by the host
+            * Checks if dialog capability is supported by the host
+            * @returns boolean to represent whether dialog capabilty is supported
             *
-            * @returns boolean to represent whether dialog module is supported
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             *
             * @beta
             */
@@ -4192,8 +4225,9 @@ export namespace dialog {
                 function resize(dimensions: DialogSize): void;
                 /**
                     * Checks if dialog.update capability is supported by the host
+                    * @returns boolean to represent whether dialog.update capabilty is supported
                     *
-                    * @returns boolean to represent whether dialog.update is supported
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     *
                     * @beta
                     */
@@ -4219,9 +4253,10 @@ export namespace dialog {
                 function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
                 /**
                     * Checks if dialog.bot capability is supported by the host
-                    *
                     * @returns boolean to represent whether dialog.bot is supported
                     *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
                     * @beta
                     */
                 function isSupported(): boolean;
@@ -4309,9 +4344,10 @@ export namespace geoLocation {
         function requestPermission(): Promise<boolean>;
         /**
             * Checks if geoLocation capability is supported by the host
-            *
             * @returns boolean to represent whether geoLocation is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @beta
             */
         function isSupported(): boolean;
@@ -4340,9 +4376,10 @@ export namespace geoLocation {
                 function showLocation(location: Location): Promise<void>;
                 /**
                     * Checks if geoLocation.map capability is supported by the host
-                    *
                     * @returns boolean to represent whether geoLocation.map is supported
                     *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
                     * @beta
                     */
                 function isSupported(): boolean;
@@ -4459,8 +4496,9 @@ export namespace pages {
         function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
         /**
             * Checks if the pages capability is supported by the host
-            * @returns true if the pages capability is enabled in runtime.supports.pages and
-            * false if it is disabled
+            * @returns boolean to represent whether the appEntity capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             */
         function isSupported(): boolean;
         /**
@@ -4515,8 +4553,9 @@ export namespace pages {
                 function getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
                 /**
                     * Checks if the pages.tab capability is supported by the host
-                    * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.tab capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     */
                 function isSupported(): boolean;
         }
@@ -4635,8 +4674,9 @@ export namespace pages {
                 }
                 /**
                     * Checks if the pages.config capability is supported by the host
-                    * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.config capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     */
                 function isSupported(): boolean;
         }
@@ -4671,8 +4711,9 @@ export namespace pages {
                 function registerBackButtonHandlerHelper(handler: () => boolean, versionSpecificHelper?: () => void): void;
                 /**
                     * Checks if the pages.backStack capability is supported by the host
-                    * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.backStack capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     */
                 function isSupported(): boolean;
         }
@@ -4699,11 +4740,11 @@ export namespace pages {
                 function exitFullscreen(): void;
                 /**
                     * @hidden
-                    * Hide from docs
-                    * ------
+                    *
                     * Checks if the pages.fullTrust capability is supported by the host
-                    * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.fullTrust capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     */
                 function isSupported(): boolean;
         }
@@ -4731,8 +4772,9 @@ export namespace pages {
                 function onHoverLeave(handler: () => void): void;
                 /**
                     * Checks if pages.appButton capability is supported by the host
-                    * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.appButton capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
                     */
                 function isSupported(): boolean;
         }
@@ -4776,8 +4818,9 @@ export namespace pages {
                 function navigateToDefaultPage(): Promise<void>;
                 /**
                     * Checks if pages.currentApp capability is supported by the host
-                    * @returns true if the pages.currentApp capability is enabled in runtime.supports.pages.currentApp and
-                    * false if it is disabled
+                    * @returns boolean to represent whether the pages.currentApp capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully complete
                     *
                     * @beta
                     */
@@ -5007,6 +5050,12 @@ export namespace menus {
             * @param handler - The handler to invoke when the user selects menu item.
             */
         function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+        /**
+            * Checks if the menus capability is supported by the host
+            * @returns boolean to represent whether the menus capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         function isSupported(): boolean;
 }
 
@@ -5444,6 +5493,8 @@ export namespace location {
             *
             * Checks if Location capability is supported by the host
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @returns boolean to represent whether Location is supported
             */
         function isSupported(): boolean;
@@ -5802,6 +5853,39 @@ export namespace meeting {
             * @beta
             */
         function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
+        /**
+            * Nested namespace for functions to control behavior of the app share button
+            *
+            * @beta
+            */
+        namespace appShareButton {
+                /**
+                    * Property bag for the setVisibilityInfo
+                    *
+                    * @beta
+                    */
+                interface ShareInformation {
+                        /**
+                            * boolean flag to set show or hide app share button
+                            */
+                        isVisible: boolean;
+                        /**
+                            * optional string contentUrl, which will override contentUrl coming from Manifest
+                            */
+                        contentUrl?: string;
+                }
+                /**
+                    * By default app share button will be hidden and this API will govern the visibility of it.
+                    *
+                    * This function can be used to hide/show app share button in meeting,
+                    * along with contentUrl (overrides contentUrl populated in app manifest)
+                    * @throws standard Invalid Url error
+                    * @param shareInformation has two elements, one isVisible boolean flag and another
+                    * optional string contentUrl, which will override contentUrl coming from Manifest
+                    * @beta
+                    */
+                function setOptions(shareInformation: ShareInformation): void;
+        }
 }
 
 export namespace monetization {
@@ -5851,12 +5935,26 @@ export namespace monetization {
             * Limited to Microsoft-internal use
             */
         function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
+        /**
+            * @hidden
+            *
+            * Checks if the monetization capability is supported by the host
+            * @returns boolean to represent whether the monetization capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         function isSupported(): boolean;
 }
 
 export namespace calendar {
     function openCalendarItem(openCalendarItemParams: OpenCalendarItemParams): Promise<void>;
     function composeMeeting(composeMeetingParams: ComposeMeetingParams): Promise<void>;
+    /**
+      * Checks if the calendar capability is supported by the host
+      * @returns boolean to represent whether the calendar capability is supported
+      *
+      * @throws Error if {@linkcode app.initialize} has not successfully completed
+      */
     function isSupported(): boolean;
     interface OpenCalendarItemParams {
         itemId: string;
@@ -5873,6 +5971,12 @@ export namespace calendar {
 export namespace mail {
         export function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
         export function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
+        /**
+            * Checks if the mail capability is supported by the host
+            * @returns boolean to represent whether the mail capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         export function isSupported(): boolean;
         export interface OpenMailItemParams {
                 itemId: string;
@@ -5962,8 +6066,11 @@ export namespace teamsCore {
         function registerBeforeUnloadHandlerHelper(handler: (readyToUnload: () => void) => boolean, versionSpecificHelper?: () => void): void;
         /**
             * Checks if teamsCore capability is supported by the host
-            * @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
-            * false if it is disabled
+            *
+            * @returns boolean to represent whether the teamsCore capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             */
         function isSupported(): boolean;
 }
@@ -6032,6 +6139,12 @@ export namespace people {
                     */
                 email?: string;
         }
+        /**
+            * Checks if the people capability is supported by the host
+            * @returns boolean to represent whether the people capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         function isSupported(): boolean;
 }
 
@@ -6133,9 +6246,10 @@ export namespace profile {
         }
         /**
             * Checks if the profile capability is supported by the host
-            *
             * @returns boolean to represent whether the profile capability is supported
             *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             * @beta
             */
         function isSupported(): boolean;
@@ -6149,6 +6263,12 @@ export type Rectangle = {
         width: number;
         height: number;
 };
+/**
+    * @beta
+    * @hidden
+    * An internal representation of the showProfile parameters suitable for sending via postMessage.
+    * The hub expects to receive an object of this type.
+    */
 export interface ShowProfileRequestInternal {
         modality?: profile.Modality;
         persona: profile.Persona;
@@ -6261,8 +6381,10 @@ export namespace 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
+            * @returns boolean to represent whether the video capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             */
         function isSupported(): boolean;
 }
@@ -6344,8 +6466,9 @@ export namespace search {
         function unregisterHandlers(): void;
         /**
             * Checks if search capability is supported by the host
-            * @returns true if the search capability is supported by the host and false otherwise
-            * false if it is disabled
+            * @returns boolean to represent whether the search capability is supported
+            *
+            * @throws Error if {@link app.initialize} has not successfully completed
             *
             * @beta
             */
@@ -6398,6 +6521,12 @@ export namespace sharing {
             * @param callback - optional callback
             */
         export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback: (err?: SdkError) => void): void;
+        /**
+            * Checks if the sharing capability is supported by the host
+            * @returns boolean to represent whether the sharing capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         export function isSupported(): boolean;
         export {};
 }
@@ -6450,8 +6579,10 @@ export namespace stageView {
         /**
             * Checks if stageView capability is supported by the host
             * @beta
-            * @returns true if the stageView capability is enabled in runtime.supports.stageView and
-            * false if it is disabled
+            * @returns boolean to represent whether the stageView capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
             */
         function isSupported(): boolean;
 }
@@ -6474,8 +6605,9 @@ export namespace webStorage {
         function isWebStorageClearedOnUserLogOut(): boolean;
         /**
             * 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
+            * @returns boolean to represent whether the webStorage capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
             *
             * @beta
             */
@@ -6516,6 +6648,12 @@ export namespace call {
             * @returns If the call is accepted
             */
         function startCall(startCallParams: StartCallParams): Promise<boolean>;
+        /**
+            * Checks if the call capability is supported by the host
+            * @returns boolean to represent whether the call capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            */
         function isSupported(): boolean;
 }