@microsoft/teams-js 2.0.0-beta.6-dev.13 → 2.0.0-beta.6-dev.16

package/dist/MicrosoftTeams.d.ts

@@ -27,8 +27,6 @@ export namespace logs {
     * Hide from docs
     * --------
     * Information about all members in a chat
-    *
-    * @alpha
     */
 export interface ChatMembersInformation {
         members: ThreadMember[];
@@ -38,8 +36,6 @@ export interface ChatMembersInformation {
     * Hide from docs
     * --------
     * Information about a chat member
-    *
-    * @alpha
     */
 export interface ThreadMember {
         /**
@@ -48,16 +44,10 @@ export interface ThreadMember {
             */
         upn: string;
 }
-/**
-    * @alpha
-    */
 export enum NotificationTypes {
         fileDownloadStart = "fileDownloadStart",
         fileDownloadComplete = "fileDownloadComplete"
 }
-/**
-    * @alpha
-    */
 export interface ShowNotificationParameters {
         message: string;
         notificationType: NotificationTypes;
@@ -65,8 +55,6 @@ export interface ShowNotificationParameters {
 /**
     * @hidden
     * Hide from docs.
-    * ------
-    * @alpha
     */
 export enum ViewerActionTypes {
         view = "view",
@@ -77,8 +65,7 @@ export enum ViewerActionTypes {
     * @hidden
     * Hide from docs.
     * ------
-    * User setting changes that can be subscribed to,
-    * @alpha
+    * User setting changes that can be subscribed to
     */
 export enum UserSettingTypes {
         /**
@@ -95,8 +82,6 @@ export enum UserSettingTypes {
 /**
     * @hidden
     * Hide from docs.
-    * ------
-    * @alpha
     */
 export interface FilePreviewParameters {
         /**
@@ -176,7 +161,6 @@ export interface FilePreviewParameters {
     * Hide from docs
     * --------
     * Query parameters used when fetching team information
-    * @alpha
     */
 export interface TeamInstanceParameters {
         /**
@@ -190,7 +174,6 @@ export interface TeamInstanceParameters {
     * Hide from docs
     * --------
     * Information on userJoined Teams
-    * @alpha
     */
 export interface UserJoinedTeamsInformation {
         /**
@@ -347,8 +330,6 @@ export interface ConversationResponse {
 /**
     * @hidden
     * Namespace to interact with the conversational subEntities inside the tab
-    *
-    * @alpha
     */
 export namespace conversations {
         /**
@@ -793,9 +774,6 @@ export namespace legacy {
         function isSupported(): boolean;
 }
 
-/**
-    * @alpha
-    */
 export namespace meetingRoom {
         /**
             * @hidden
@@ -967,9 +945,6 @@ export namespace notifications {
     function isSupported(): boolean;
 }
 
-/**
-    * @alpha
-    */
 export namespace remoteCamera {
         /**
             * @hidden
@@ -1197,8 +1172,6 @@ export namespace remoteCamera {
 /**
     * @hidden
     * Namespace to interact with the application entities specific part of the SDK.
-    *
-    * @alpha
     */
 export namespace appEntity {
         /**
@@ -1206,8 +1179,6 @@ export namespace appEntity {
             * Hide from docs
             * --------
             * Information on an app entity
-            *
-            * @alpha
             */
         interface AppEntity {
                 /**
@@ -1248,8 +1219,6 @@ export namespace appEntity {
             * @param callback Callback that will be triggered once the app entity information is available.
             *                 The callback takes two arguments: an SdkError in case something happened (i.e.
             *                 no permissions to execute the API) and the app entity configuration, if available
-            *
-            * @alpha
             */
         function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
         function isSupported(): boolean;
@@ -1654,8 +1623,6 @@ export const errorNotSupportedOnPlatform: SdkError;
 
 /**
     * Represents information about tabs for an app
-    *
-    * @alpha
     */
 export interface TabInformation {
         teamTabs: TabInstance[];
@@ -2721,9 +2688,6 @@ export namespace app {
         function openLink(deepLink: string): Promise<void>;
 }
 
-/**
-  * @alpha
-  */
 export namespace appInstallDialog {
     interface OpenAppInstallDialogParams {
         appId: string;
@@ -3232,9 +3196,6 @@ export namespace pages {
         }
 }
 
-/**
-    * @alpha
-    */
 export interface IAppWindow {
         /**
             * Send a message to the AppWindow.
@@ -3448,10 +3409,6 @@ export namespace menus {
         function isSupported(): boolean;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
-    */
 export namespace media {
         /**
             * Enum for file formats supported
@@ -3488,9 +3445,6 @@ export namespace media {
                 name?: string;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
             *
             * @params callback - Callback will be called with an @see SdkError if there are any.
@@ -3776,9 +3730,6 @@ export namespace media {
                 file: Blob;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Select an attachment using camera/gallery
             *
             * @param mediaInputs - The input params to customize the media to be selected
@@ -3786,10 +3737,8 @@ export namespace media {
             */
         export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * View images using native image viewer
+            *
             * @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
             * @param callback - returns back error if encountered, returns null in case of success
             */
@@ -3806,10 +3755,8 @@ export namespace media {
                 timeOutIntervalInSec?: number;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Scan Barcode/QRcode using camera
+            *
             * @remarks
             * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
             *
@@ -3820,9 +3767,6 @@ export namespace media {
         export {};
 }
 
-/**
-    * @alpha
-    */
 export namespace location {
         interface LocationProps {
                 /**
@@ -3890,10 +3834,6 @@ export namespace location {
         function isSupported(): boolean;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
-    */
 export namespace meeting {
         /**
             * @hidden
@@ -4044,9 +3984,6 @@ export namespace meeting {
                 GroupCall = "groupCall"
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to get the incoming audio speaker setting for the meeting user
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4057,9 +3994,6 @@ export namespace meeting {
             */
         function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4069,9 +4003,6 @@ export namespace meeting {
             */
         function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Hide from docs
             *
@@ -4085,9 +4016,6 @@ export namespace meeting {
             */
         function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Allows an app to get the authentication token for the anonymous or guest user in the meeting
             *
@@ -4099,9 +4027,6 @@ export namespace meeting {
             */
         function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to get the state of the live stream in the current meeting
             *
             * @param callback - Callback contains 2 parameters: error and liveStreamState.
@@ -4110,9 +4035,6 @@ export namespace meeting {
             */
         function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to request the live streaming be started at the given streaming url
             *
             * @remarks
@@ -4124,9 +4046,6 @@ export namespace meeting {
             */
         function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to request the live streaming be stopped at the given streaming url
             *
             * @remarks
@@ -4136,9 +4055,6 @@ export namespace meeting {
             */
         function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Registers a handler for changes to the live stream.
             *
             * @remarks
@@ -4148,9 +4064,6 @@ export namespace meeting {
             */
         function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to share contents in the meeting
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4160,9 +4073,6 @@ export namespace meeting {
             */
         function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Provides information related app's in-meeting sharing capabilities
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4172,9 +4082,6 @@ export namespace meeting {
             */
         function getAppContentStageSharingCapabilities(callback: (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Hide from docs.
             * Terminates current stage sharing session in meeting
@@ -4185,9 +4092,6 @@ export namespace meeting {
             */
         function stopSharingAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Provides information related to current stage sharing state for app
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4197,9 +4101,6 @@ export namespace meeting {
             */
         function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
             * will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
             * at a time. A subsequent registration replaces an existing registration.
@@ -4209,9 +4110,6 @@ export namespace meeting {
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
 }
 
-/**
-    * @alpha
-    */
 export namespace monetization {
         /**
             * @hidden
@@ -4262,9 +4160,6 @@ export namespace monetization {
         function isSupported(): boolean;
 }
 
-/**
-  * @alpha
-  */
 export namespace calendar {
     function openCalendarItem(openCalendarItemParams: OpenCalendarItemParams): Promise<void>;
     function composeMeeting(composeMeetingParams: ComposeMeetingParams): Promise<void>;
@@ -4281,9 +4176,6 @@ export namespace calendar {
     }
 }
 
-/**
-    * @alpha
-    */
 export namespace mail {
         export function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
         export function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
@@ -4322,8 +4214,6 @@ export namespace mail {
 
 /**
     * Namespace containing the set of APIs that support Teams-specific functionalities.
-    *
-    * @alpha
     */
 export namespace teamsCore {
         /**
@@ -4356,9 +4246,6 @@ export namespace teamsCore {
         function isSupported(): boolean;
 }
 
-/**
-    * @alpha
-    */
 export namespace people {
         /**
             * Launches a people picker and allows the user to select one or more people from the list
@@ -4427,22 +4314,19 @@ export namespace people {
 }
 
 /**
-    * Namespace to video extensibility of the SDK.
-    *
-    * @alpha
-    *
+    * Namespace to video extensibility of the SDK
     */
 export namespace video {
         /**
-            * Represents a video frame.
+            * Represents a video frame
             */
         interface VideoFrame {
                 /**
-                    * Video frame width.
+                    * Video frame width
                     */
                 width: number;
                 /**
-                    * Video frame height.
+                    * Video frame height
                     */
                 height: number;
                 /**
@@ -4469,7 +4353,7 @@ export namespace video {
                 NV12 = 0
         }
         /**
-            * Video frame configuration supplied to Teams to customize the generated video frame parameters, like format.
+            * Video frame configuration supplied to Teams to customize the generated video frame parameters, like format
             */
         interface VideoFrameConfig {
                 /**
@@ -4482,7 +4366,7 @@ export namespace video {
             */
         enum EffectChangeType {
                 /**
-                    * current video effect changed.
+                    * current video effect changed
                     */
                 EffectChanged = 0,
                 /**
@@ -4499,7 +4383,7 @@ export namespace video {
             */
         type VideoEffectCallBack = (effectId: string | undefined) => void;
         /**
-            * register to read the video frames in Permissions section.
+            * Register to read the video frames in Permissions section
             */
         function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
@@ -4512,15 +4396,12 @@ export namespace video {
             */
         function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
         /**
-            * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied.
+            * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied
             */
         function registerForVideoEffect(callback: VideoEffectCallBack): void;
         function isSupported(): boolean;
 }
 
-/**
-    * @alpha
-    */
 export namespace sharing {
         export const SharingAPIMessages: {
                 shareWebContent: string;
@@ -4629,30 +4510,27 @@ export namespace stageView {
         function open(stageViewParams: StageViewParams, callback?: (sdkError?: SdkError) => void): void;
 }
 
-/**
-    * @alpha
-    */
 export namespace call {
-        enum CallModalities {
-                Unknown = "unknown",
-                Audio = "audio",
-                Video = "video",
-                VideoBasedScreenSharing = "videoBasedScreenSharing",
-                Data = "data"
-        }
-        interface StartCallParams {
-                targets: string[];
-                requestedModalities?: CallModalities[];
-                source?: string;
-        }
-        /**
-            * Starts a call with other users
-            *
-            * @param startCallParams - Parameters for the call
-            * @returns If the call is accepted
-            */
-        function startCall(startCallParams: StartCallParams): Promise<boolean>;
-        function isSupported(): boolean;
+    enum CallModalities {
+        Unknown = "unknown",
+        Audio = "audio",
+        Video = "video",
+        VideoBasedScreenSharing = "videoBasedScreenSharing",
+        Data = "data"
+    }
+    interface StartCallParams {
+        targets: string[];
+        requestedModalities?: CallModalities[];
+        source?: string;
+    }
+    /**
+      * Starts a call with other users
+      *
+      * @param startCallParams - Parameters for the call
+      * @returns If the call is accepted
+      */
+    function startCall(startCallParams: StartCallParams): Promise<boolean>;
+    function isSupported(): boolean;
 }
 
 /**