@microsoft/teams-js 2.0.0-beta.6-dev.11 → 2.0.0-beta.6-dev.14

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;
@@ -1582,6 +1551,7 @@ export enum HostClientType {
         web = "web",
         android = "android",
         ios = "ios",
+        ipados = "ipados",
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
@@ -1653,8 +1623,6 @@ export const errorNotSupportedOnPlatform: SdkError;
 
 /**
     * Represents information about tabs for an app
-    *
-    * @alpha
     */
 export interface TabInformation {
         teamTabs: TabInstance[];
@@ -2720,9 +2688,6 @@ export namespace app {
         function openLink(deepLink: string): Promise<void>;
 }
 
-/**
-  * @alpha
-  */
 export namespace appInstallDialog {
     interface OpenAppInstallDialogParams {
         appId: string;
@@ -3231,9 +3196,6 @@ export namespace pages {
         }
 }
 
-/**
-    * @alpha
-    */
 export interface IAppWindow {
         /**
             * Send a message to the AppWindow.
@@ -3819,9 +3781,6 @@ export namespace media {
         export {};
 }
 
-/**
-    * @alpha
-    */
 export namespace location {
         interface LocationProps {
                 /**
@@ -3897,7 +3856,7 @@ export namespace meeting {
         /**
             * @hidden
             * Hide from docs
-            * Data structure to represent a meeting details.
+            * Data structure to represent a meeting details
             *
             * @internal
             */
@@ -4078,7 +4037,7 @@ export namespace meeting {
             *
             * @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
             * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-            * result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
+            * result can either contain a IMeetingDetailsResponse value, in case of a successful get or null when the get fails
             *
             * @internal
             */
@@ -4208,9 +4167,6 @@ export namespace meeting {
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
 }
 
-/**
-    * @alpha
-    */
 export namespace monetization {
         /**
             * @hidden
@@ -4261,9 +4217,6 @@ export namespace monetization {
         function isSupported(): boolean;
 }
 
-/**
-  * @alpha
-  */
 export namespace calendar {
     function openCalendarItem(openCalendarItemParams: OpenCalendarItemParams): Promise<void>;
     function composeMeeting(composeMeetingParams: ComposeMeetingParams): Promise<void>;
@@ -4280,9 +4233,6 @@ export namespace calendar {
     }
 }
 
-/**
-    * @alpha
-    */
 export namespace mail {
         export function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
         export function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
@@ -4321,8 +4271,6 @@ export namespace mail {
 
 /**
     * Namespace containing the set of APIs that support Teams-specific functionalities.
-    *
-    * @alpha
     */
 export namespace teamsCore {
         /**
@@ -4355,9 +4303,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
@@ -4426,22 +4371,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;
                 /**
@@ -4468,7 +4410,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 {
                 /**
@@ -4481,7 +4423,7 @@ export namespace video {
             */
         enum EffectChangeType {
                 /**
-                    * current video effect changed.
+                    * current video effect changed
                     */
                 EffectChanged = 0,
                 /**
@@ -4498,7 +4440,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;
         /**
@@ -4511,15 +4453,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;
@@ -4628,30 +4567,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;
 }
 
 /**