@microsoft/teams-js 2.29.0-beta.1 → 2.29.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +4 -4
- package/dist/esm/packages/teams-js/src/index.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/emailAddressValidation.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/interfaces.js +1 -1
- package/dist/esm/packages/teams-js/src/public/emailAddress.js +1 -0
- package/dist/esm/packages/teams-js/src/public/meeting.js +1 -1
- package/dist/esm/packages/teams-js/src/public/version.js +1 -1
- package/dist/umd/MicrosoftTeams.d.ts +260 -120
- package/dist/umd/MicrosoftTeams.js +270 -37
- package/dist/umd/MicrosoftTeams.js.map +1 -1
- package/dist/umd/MicrosoftTeams.min.js +1 -1
- package/dist/umd/MicrosoftTeams.min.js.map +1 -1
- package/package.json +51 -1
@@ -275,72 +275,6 @@ export interface UserJoinedTeamsInformation {
|
|
275
275
|
*/
|
276
276
|
userJoinedTeams: TeamInformation[];
|
277
277
|
}
|
278
|
-
/**
|
279
|
-
* @beta
|
280
|
-
* @hidden
|
281
|
-
* The types for ActionOpenUrl
|
282
|
-
*
|
283
|
-
* @internal
|
284
|
-
* Limited to Microsoft-internal use
|
285
|
-
*/
|
286
|
-
export enum ActionOpenUrlType {
|
287
|
-
DeepLinkDialog = "DeepLinkDialog",
|
288
|
-
DeepLinkOther = "DeepLinkOther",
|
289
|
-
DeepLinkStageView = "DeepLinkStageView",
|
290
|
-
GenericUrl = "GenericUrl"
|
291
|
-
}
|
292
|
-
/**
|
293
|
-
* @beta
|
294
|
-
* @hidden
|
295
|
-
* Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
296
|
-
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
297
|
-
*
|
298
|
-
* @internal
|
299
|
-
* Limited to Microsoft-internal use
|
300
|
-
*/
|
301
|
-
export interface ActionOpenUrlError {
|
302
|
-
errorCode: ActionOpenUrlErrorCode;
|
303
|
-
message?: string;
|
304
|
-
}
|
305
|
-
/**
|
306
|
-
* @beta
|
307
|
-
* @hidden
|
308
|
-
* Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
309
|
-
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
310
|
-
*
|
311
|
-
* @internal
|
312
|
-
* Limited to Microsoft-internal use
|
313
|
-
*/
|
314
|
-
export enum ActionOpenUrlErrorCode {
|
315
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
316
|
-
INVALID_LINK = "INVALID_LINK",
|
317
|
-
NOT_SUPPORTED = "NOT_SUPPORTED"
|
318
|
-
}
|
319
|
-
/**
|
320
|
-
* @beta
|
321
|
-
* @hidden
|
322
|
-
* The payload that is used when executing an Adaptive Card Action.Submit
|
323
|
-
*
|
324
|
-
* @internal
|
325
|
-
* Limited to Microsoft-internal use
|
326
|
-
*/
|
327
|
-
export interface IAdaptiveCardActionSubmit {
|
328
|
-
id: string;
|
329
|
-
data: string | Record<string, unknown>;
|
330
|
-
}
|
331
|
-
/**
|
332
|
-
* @beta
|
333
|
-
* @hidden
|
334
|
-
* Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
|
335
|
-
* and IExternalAppCardActionForCEAService.handleActionSubmit
|
336
|
-
*
|
337
|
-
* @internal
|
338
|
-
* Limited to Microsoft-internal use
|
339
|
-
*/
|
340
|
-
export interface ActionSubmitError {
|
341
|
-
errorCode: ExternalAppErrorCode;
|
342
|
-
message?: string;
|
343
|
-
}
|
344
278
|
|
345
279
|
export function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
|
346
280
|
/**
|
@@ -709,6 +643,22 @@ export namespace externalAppAuthentication {
|
|
709
643
|
verb: string;
|
710
644
|
data: string | Record<string, unknown>;
|
711
645
|
}
|
646
|
+
/**
|
647
|
+
* @beta
|
648
|
+
* @hidden
|
649
|
+
* Determines if the provided response object is an instance of IActionExecuteResponse
|
650
|
+
* @internal
|
651
|
+
* Limited to Microsoft-internal use
|
652
|
+
* @param response The object to check whether it is of IActionExecuteResponse type
|
653
|
+
*/
|
654
|
+
function isActionExecuteResponse(response: unknown): response is externalAppAuthentication.IActionExecuteResponse;
|
655
|
+
/**
|
656
|
+
* @hidden
|
657
|
+
* This is the only allowed value for IActionExecuteInvokeRequest.type. Used for validation
|
658
|
+
* @internal
|
659
|
+
* Limited to Microsoft-internal use
|
660
|
+
*/
|
661
|
+
const ActionExecuteInvokeRequestType = "Action.Execute";
|
712
662
|
/**
|
713
663
|
* @hidden
|
714
664
|
* Used to differentiate between IOriginalRequestInfo types
|
@@ -832,6 +782,15 @@ export namespace externalAppAuthentication {
|
|
832
782
|
errorCode: InvokeErrorCode;
|
833
783
|
message?: string;
|
834
784
|
}
|
785
|
+
/**
|
786
|
+
* @beta
|
787
|
+
* @hidden
|
788
|
+
* Determines if the provided error object is an instance of InvokeError
|
789
|
+
* @internal
|
790
|
+
* Limited to Microsoft-internal use
|
791
|
+
* @param err The error object to check whether it is of InvokeError type
|
792
|
+
*/
|
793
|
+
function isInvokeError(err: unknown): err is externalAppAuthentication.InvokeError;
|
835
794
|
/**
|
836
795
|
* @hidden
|
837
796
|
*
|
@@ -841,6 +800,15 @@ export namespace externalAppAuthentication {
|
|
841
800
|
enum InvokeErrorCode {
|
842
801
|
INTERNAL_ERROR = "INTERNAL_ERROR"
|
843
802
|
}
|
803
|
+
/**
|
804
|
+
* @hidden
|
805
|
+
* Wrapper to differentiate between InvokeError and IInvokeResponse response from host
|
806
|
+
* @internal
|
807
|
+
* Limited to Microsoft-internal use
|
808
|
+
*/
|
809
|
+
type InvokeErrorWrapper = InvokeError & {
|
810
|
+
responseType: undefined;
|
811
|
+
};
|
844
812
|
/**
|
845
813
|
* @beta
|
846
814
|
* @hidden
|
@@ -913,6 +881,80 @@ export namespace externalAppAuthentication {
|
|
913
881
|
function isSupported(): boolean;
|
914
882
|
}
|
915
883
|
|
884
|
+
/**
|
885
|
+
* @hidden
|
886
|
+
* Namespace to delegate authentication requests to the host for custom engine agents
|
887
|
+
* @internal
|
888
|
+
* Limited to Microsoft-internal use
|
889
|
+
* @beta
|
890
|
+
*/
|
891
|
+
export namespace externalAppAuthenticationForCEA {
|
892
|
+
/**
|
893
|
+
* @beta
|
894
|
+
* @hidden
|
895
|
+
* Signals to the host to perform SSO authentication for the application specified by the app ID, and then send the authResult to the application backend.
|
896
|
+
* @internal
|
897
|
+
* Limited to Microsoft-internal use
|
898
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
899
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
900
|
+
* @param authTokenRequest Parameters for SSO authentication
|
901
|
+
* @throws InvokeError if the host encounters an error while authenticating
|
902
|
+
* @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
|
903
|
+
*/
|
904
|
+
function authenticateWithSSO(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters): Promise<void>;
|
905
|
+
/**
|
906
|
+
* @beta
|
907
|
+
* @hidden
|
908
|
+
* Signals to the host to perform authentication using the given authentication parameters and then send the auth result to the application backend.
|
909
|
+
* @internal
|
910
|
+
* Limited to Microsoft-internal use
|
911
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
912
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
913
|
+
* @param authenticateParameters Parameters for the authentication pop-up
|
914
|
+
* @throws InvokeError if the host encounters an error while authenticating
|
915
|
+
* @returns A promise that resolves from the application backend and rejects with InvokeError if the host encounters an error while authenticating
|
916
|
+
*/
|
917
|
+
function authenticateWithOauth(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters): Promise<void>;
|
918
|
+
/**
|
919
|
+
* @beta
|
920
|
+
* @hidden
|
921
|
+
* Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application backend with the authentication result.
|
922
|
+
* @internal
|
923
|
+
* Limited to Microsoft-internal use
|
924
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
925
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
926
|
+
* @param authenticateParameters Parameters for the authentication pop-up
|
927
|
+
* @param originalRequestInfo Information about the original request that should be resent
|
928
|
+
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
929
|
+
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
930
|
+
*/
|
931
|
+
function authenticateAndResendRequest(appId: AppId, conversationId: string, authenticateParameters: externalAppAuthentication.AuthenticatePopUpParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
932
|
+
/**
|
933
|
+
* @beta
|
934
|
+
* @hidden
|
935
|
+
* Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result and originalRequestInfo
|
936
|
+
* @internal
|
937
|
+
* Limited to Microsoft-internal use
|
938
|
+
* @param appId App ID of the app upon whose behalf Copilot is requesting authentication. This must be a UUID.
|
939
|
+
* @param conversationId ConversationId To tell the bot what conversation the calls are coming from
|
940
|
+
* @param authTokenRequest Parameters for SSO authentication
|
941
|
+
* @param originalRequestInfo Information about the original request that should be resent
|
942
|
+
* @throws InvokeError if the host encounters an error while authenticating or resending the request
|
943
|
+
* @returns A promise that resolves to the IActionExecuteResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
|
944
|
+
*/
|
945
|
+
function authenticateWithSSOAndResendRequest(appId: AppId, conversationId: string, authTokenRequest: externalAppAuthentication.AuthTokenRequestParameters, originalRequestInfo: externalAppAuthentication.IActionExecuteInvokeRequest): Promise<externalAppAuthentication.IActionExecuteResponse>;
|
946
|
+
/**
|
947
|
+
* @beta
|
948
|
+
* @hidden
|
949
|
+
* Checks if the externalAppAuthenticationForCEA capability is supported by the host
|
950
|
+
* @returns boolean to represent whether externalAppAuthenticationForCEA capability is supported
|
951
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
952
|
+
* @internal
|
953
|
+
* Limited to Microsoft-internal use
|
954
|
+
*/
|
955
|
+
function isSupported(): boolean;
|
956
|
+
}
|
957
|
+
|
916
958
|
/**
|
917
959
|
* @hidden
|
918
960
|
* Namespace to delegate adaptive card action execution to the host
|
@@ -932,6 +974,58 @@ export namespace externalAppCardActions {
|
|
932
974
|
DeepLinkStageView = "DeepLinkStageView",
|
933
975
|
GenericUrl = "GenericUrl"
|
934
976
|
}
|
977
|
+
/**
|
978
|
+
* @beta
|
979
|
+
* @hidden
|
980
|
+
* Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
981
|
+
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
982
|
+
*
|
983
|
+
* @internal
|
984
|
+
* Limited to Microsoft-internal use
|
985
|
+
*/
|
986
|
+
interface ActionOpenUrlError {
|
987
|
+
errorCode: ActionOpenUrlErrorCode;
|
988
|
+
message?: string;
|
989
|
+
}
|
990
|
+
/**
|
991
|
+
* @beta
|
992
|
+
* @hidden
|
993
|
+
* Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
|
994
|
+
* and IExternalAppCardActionForCEAService.handleActionOpenUrl
|
995
|
+
*
|
996
|
+
* @internal
|
997
|
+
* Limited to Microsoft-internal use
|
998
|
+
*/
|
999
|
+
enum ActionOpenUrlErrorCode {
|
1000
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
1001
|
+
INVALID_LINK = "INVALID_LINK",
|
1002
|
+
NOT_SUPPORTED = "NOT_SUPPORTED"
|
1003
|
+
}
|
1004
|
+
/**
|
1005
|
+
* @beta
|
1006
|
+
* @hidden
|
1007
|
+
* The payload that is used when executing an Adaptive Card Action.Submit
|
1008
|
+
*
|
1009
|
+
* @internal
|
1010
|
+
* Limited to Microsoft-internal use
|
1011
|
+
*/
|
1012
|
+
interface IAdaptiveCardActionSubmit {
|
1013
|
+
id: string;
|
1014
|
+
data: string | Record<string, unknown>;
|
1015
|
+
}
|
1016
|
+
/**
|
1017
|
+
* @beta
|
1018
|
+
* @hidden
|
1019
|
+
* Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
|
1020
|
+
* and IExternalAppCardActionForCEAService.handleActionSubmit
|
1021
|
+
*
|
1022
|
+
* @internal
|
1023
|
+
* Limited to Microsoft-internal use
|
1024
|
+
*/
|
1025
|
+
interface ActionSubmitError {
|
1026
|
+
errorCode: ExternalAppErrorCode;
|
1027
|
+
message?: string;
|
1028
|
+
}
|
935
1029
|
/**
|
936
1030
|
* @beta
|
937
1031
|
* @hidden
|
@@ -993,7 +1087,7 @@ export namespace externalAppCardActionsForCEA {
|
|
993
1087
|
* @throws Error if the response has not successfully completed
|
994
1088
|
* @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
|
995
1089
|
*/
|
996
|
-
function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<ActionOpenUrlType>;
|
1090
|
+
function processActionOpenUrl(appId: AppId, conversationId: string, url: URL): Promise<externalAppCardActions.ActionOpenUrlType>;
|
997
1091
|
/**
|
998
1092
|
* @beta
|
999
1093
|
* @hidden
|
@@ -1006,7 +1100,7 @@ export namespace externalAppCardActionsForCEA {
|
|
1006
1100
|
* @throws Error if host notifies of an error
|
1007
1101
|
* @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
|
1008
1102
|
*/
|
1009
|
-
function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: IAdaptiveCardActionSubmit): Promise<void>;
|
1103
|
+
function processActionSubmit(appId: AppId, conversationId: string, actionSubmitPayload: externalAppCardActions.IAdaptiveCardActionSubmit): Promise<void>;
|
1010
1104
|
/**
|
1011
1105
|
* @beta
|
1012
1106
|
* @hidden
|
@@ -5590,6 +5684,17 @@ export class AppId {
|
|
5590
5684
|
toString(): string;
|
5591
5685
|
}
|
5592
5686
|
|
5687
|
+
/**
|
5688
|
+
* Represents a validated email.
|
5689
|
+
*/
|
5690
|
+
export class EmailAddress {
|
5691
|
+
constructor(val: string);
|
5692
|
+
/**
|
5693
|
+
* Retrieve the validated email address as a string.
|
5694
|
+
*/
|
5695
|
+
toString(): string;
|
5696
|
+
}
|
5697
|
+
|
5593
5698
|
export namespace appInstallDialog {
|
5594
5699
|
/** Represents set of parameters needed to open the appInstallDialog. */
|
5595
5700
|
interface OpenAppInstallDialogParams {
|
@@ -7571,19 +7676,19 @@ export namespace location {
|
|
7571
7676
|
*/
|
7572
7677
|
export namespace meeting {
|
7573
7678
|
/** Error callback function type */
|
7574
|
-
type errorCallbackFunctionType = (error: SdkError | null, result: boolean | null) => void;
|
7679
|
+
export type errorCallbackFunctionType = (error: SdkError | null, result: boolean | null) => void;
|
7575
7680
|
/** Get live stream state callback function type */
|
7576
|
-
type getLiveStreamStateCallbackFunctionType = (error: SdkError | null, liveStreamState: LiveStreamState | null) => void;
|
7681
|
+
export type getLiveStreamStateCallbackFunctionType = (error: SdkError | null, liveStreamState: LiveStreamState | null) => void;
|
7577
7682
|
/** Live stream error callback function type */
|
7578
|
-
type liveStreamErrorCallbackFunctionType = (error: SdkError | null) => void;
|
7683
|
+
export type liveStreamErrorCallbackFunctionType = (error: SdkError | null) => void;
|
7579
7684
|
/** Register live stream changed handler function type */
|
7580
|
-
type registerLiveStreamChangedHandlerFunctionType = (liveStreamState: LiveStreamState) => void;
|
7685
|
+
export type registerLiveStreamChangedHandlerFunctionType = (liveStreamState: LiveStreamState) => void;
|
7581
7686
|
/** Get app content stage sharing capabilities callback function type */
|
7582
|
-
type getAppContentCallbackFunctionType = (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void;
|
7687
|
+
export type getAppContentCallbackFunctionType = (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void;
|
7583
7688
|
/** Get app content stage sharing state callback function type */
|
7584
|
-
type getAppContentStageCallbackFunctionType = (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void;
|
7689
|
+
export type getAppContentStageCallbackFunctionType = (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void;
|
7585
7690
|
/** Register speaking state change handler function type */
|
7586
|
-
type registerSpeakingStateChangeHandlerFunctionType = (speakingState: ISpeakingState) => void;
|
7691
|
+
export type registerSpeakingStateChangeHandlerFunctionType = (speakingState: ISpeakingState) => void;
|
7587
7692
|
/**
|
7588
7693
|
* @hidden
|
7589
7694
|
* Data structure to represent meeting details
|
@@ -7591,7 +7696,7 @@ export namespace meeting {
|
|
7591
7696
|
* @internal
|
7592
7697
|
* Limited to Microsoft-internal use
|
7593
7698
|
*/
|
7594
|
-
interface IMeetingDetailsResponse {
|
7699
|
+
export interface IMeetingDetailsResponse {
|
7595
7700
|
/**
|
7596
7701
|
* @hidden
|
7597
7702
|
* details object
|
@@ -7613,7 +7718,7 @@ export namespace meeting {
|
|
7613
7718
|
* Hide from docs
|
7614
7719
|
* Base data structure to represent a meeting or call detail
|
7615
7720
|
*/
|
7616
|
-
interface IMeetingOrCallDetailsBase<T> {
|
7721
|
+
export interface IMeetingOrCallDetailsBase<T> {
|
7617
7722
|
/**
|
7618
7723
|
* @hidden
|
7619
7724
|
* Scheduled start time of the meeting or start time of the call
|
@@ -7630,22 +7735,56 @@ export namespace meeting {
|
|
7630
7735
|
*/
|
7631
7736
|
type?: T;
|
7632
7737
|
}
|
7738
|
+
/**
|
7739
|
+
* @hidden
|
7740
|
+
* Hide from docs
|
7741
|
+
* Data structure to represent call participant identifiers
|
7742
|
+
*/
|
7743
|
+
interface ICallParticipantIdentifiers {
|
7744
|
+
/**
|
7745
|
+
* Phone number of a caller
|
7746
|
+
*/
|
7747
|
+
phoneNumber?: string;
|
7748
|
+
/**
|
7749
|
+
* Email of a caller
|
7750
|
+
*/
|
7751
|
+
email?: EmailAddress;
|
7752
|
+
}
|
7633
7753
|
/**
|
7634
7754
|
* @hidden
|
7635
7755
|
* Hide from docs
|
7636
7756
|
* Data structure to represent call details
|
7637
7757
|
*/
|
7638
|
-
interface ICallDetails extends IMeetingOrCallDetailsBase<CallType> {
|
7758
|
+
export interface ICallDetails extends IMeetingOrCallDetailsBase<CallType> {
|
7639
7759
|
/**
|
7760
|
+
* @deprecated please use {@link ICallDetails.originalCallerInfo} instead
|
7761
|
+
*
|
7640
7762
|
* @hidden
|
7641
7763
|
* Phone number of a PSTN caller or email of a VoIP caller
|
7642
7764
|
*/
|
7643
7765
|
originalCaller?: string;
|
7644
7766
|
/**
|
7767
|
+
* @hidden
|
7768
|
+
* Object representing the original caller
|
7769
|
+
*/
|
7770
|
+
originalCallerInfo?: ICallParticipantIdentifiers;
|
7771
|
+
/**
|
7772
|
+
* @hidden
|
7773
|
+
* Identifier for the current call
|
7774
|
+
*/
|
7775
|
+
callId?: string;
|
7776
|
+
/**
|
7777
|
+
* @deprecated please use {@link ICallDetails.dialedEntityInfo} instead
|
7778
|
+
*
|
7645
7779
|
* @hidden
|
7646
7780
|
* Phone number of a PSTN callee or email of a VoIP callee
|
7647
7781
|
*/
|
7648
7782
|
dialedEntity?: never;
|
7783
|
+
/**
|
7784
|
+
* @hidden
|
7785
|
+
* Object representing the entity the caller dialed
|
7786
|
+
*/
|
7787
|
+
dialedEntityInfo?: never;
|
7649
7788
|
/**
|
7650
7789
|
* @hidden
|
7651
7790
|
* Tracking identifier for grouping related calls
|
@@ -7657,7 +7796,7 @@ export namespace meeting {
|
|
7657
7796
|
* Hide from docs
|
7658
7797
|
* Data structure to represent meeting details.
|
7659
7798
|
*/
|
7660
|
-
interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
7799
|
+
export interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
7661
7800
|
/**
|
7662
7801
|
* @hidden
|
7663
7802
|
* Scheduled end time of the meeting
|
@@ -7681,7 +7820,7 @@ export namespace meeting {
|
|
7681
7820
|
* @internal
|
7682
7821
|
* Limited to Microsoft-internal use
|
7683
7822
|
*/
|
7684
|
-
interface IConversation {
|
7823
|
+
export interface IConversation {
|
7685
7824
|
/**
|
7686
7825
|
* @hidden
|
7687
7826
|
* conversation id of the meeting
|
@@ -7695,7 +7834,7 @@ export namespace meeting {
|
|
7695
7834
|
* @internal
|
7696
7835
|
* Limited to Microsoft-internal use
|
7697
7836
|
*/
|
7698
|
-
interface IOrganizer {
|
7837
|
+
export interface IOrganizer {
|
7699
7838
|
/**
|
7700
7839
|
* @hidden
|
7701
7840
|
* organizer id of the meeting
|
@@ -7713,7 +7852,7 @@ export namespace meeting {
|
|
7713
7852
|
* @remarks
|
7714
7853
|
* RTMP is a popular communication protocol for streaming audio, video, and data over the Internet.
|
7715
7854
|
*/
|
7716
|
-
interface LiveStreamState {
|
7855
|
+
export interface LiveStreamState {
|
7717
7856
|
/**
|
7718
7857
|
* true when the current meeting is being streamed through RTMP, or false if it is not.
|
7719
7858
|
*/
|
@@ -7729,7 +7868,7 @@ export namespace meeting {
|
|
7729
7868
|
};
|
7730
7869
|
}
|
7731
7870
|
/** Defines additional sharing options which can be provided to the {@link shareAppContentToStage} API. */
|
7732
|
-
interface IShareAppContentToStageOptions {
|
7871
|
+
export interface IShareAppContentToStageOptions {
|
7733
7872
|
/**
|
7734
7873
|
* The protocol option for sharing app content to the meeting stage. Defaults to `Collaborative`.
|
7735
7874
|
* See {@link SharingProtocol} for more information.
|
@@ -7737,7 +7876,7 @@ export namespace meeting {
|
|
7737
7876
|
sharingProtocol?: SharingProtocol;
|
7738
7877
|
}
|
7739
7878
|
/** Represents app permission to share contents to meeting. */
|
7740
|
-
interface IAppContentStageSharingCapabilities {
|
7879
|
+
export interface IAppContentStageSharingCapabilities {
|
7741
7880
|
/**
|
7742
7881
|
* indicates whether app has permission to share contents to meeting stage.
|
7743
7882
|
* true when your `configurableTabs` or `staticTabs` entry's `context` array includes `meetingStage`.
|
@@ -7745,7 +7884,7 @@ export namespace meeting {
|
|
7745
7884
|
doesAppHaveSharePermission: boolean;
|
7746
7885
|
}
|
7747
7886
|
/** Represents app being shared to stage. */
|
7748
|
-
interface IAppContentStageSharingState {
|
7887
|
+
export interface IAppContentStageSharingState {
|
7749
7888
|
/**
|
7750
7889
|
* indicates whether app is currently being shared to stage
|
7751
7890
|
*/
|
@@ -7755,7 +7894,7 @@ export namespace meeting {
|
|
7755
7894
|
* Property bag for the speakingState changed event
|
7756
7895
|
*
|
7757
7896
|
*/
|
7758
|
-
interface ISpeakingState {
|
7897
|
+
export interface ISpeakingState {
|
7759
7898
|
/**
|
7760
7899
|
* true when one or more participants in a meeting are speaking, or false if no participants are speaking
|
7761
7900
|
*/
|
@@ -7776,7 +7915,7 @@ export namespace meeting {
|
|
7776
7915
|
*
|
7777
7916
|
* @beta
|
7778
7917
|
*/
|
7779
|
-
interface MeetingReactionReceivedEventData {
|
7918
|
+
export interface MeetingReactionReceivedEventData {
|
7780
7919
|
/**
|
7781
7920
|
* Indicates the type of meeting reaction received
|
7782
7921
|
*
|
@@ -7803,7 +7942,7 @@ export namespace meeting {
|
|
7803
7942
|
*
|
7804
7943
|
* @beta
|
7805
7944
|
*/
|
7806
|
-
interface IRaiseHandState {
|
7945
|
+
export interface IRaiseHandState {
|
7807
7946
|
/** Indicates whether the selfParticipant's hand is raised or not
|
7808
7947
|
*
|
7809
7948
|
* @hidden
|
@@ -7822,7 +7961,7 @@ export namespace meeting {
|
|
7822
7961
|
*
|
7823
7962
|
* @beta
|
7824
7963
|
*/
|
7825
|
-
interface RaiseHandStateChangedEventData {
|
7964
|
+
export interface RaiseHandStateChangedEventData {
|
7826
7965
|
/**
|
7827
7966
|
* entire raiseHandState object for the selfParticipant
|
7828
7967
|
*
|
@@ -7849,7 +7988,7 @@ export namespace meeting {
|
|
7849
7988
|
*
|
7850
7989
|
* @beta
|
7851
7990
|
*/
|
7852
|
-
interface MicState {
|
7991
|
+
export interface MicState {
|
7853
7992
|
/**
|
7854
7993
|
* Indicates the mute status of the mic
|
7855
7994
|
*/
|
@@ -7866,7 +8005,7 @@ export namespace meeting {
|
|
7866
8005
|
*
|
7867
8006
|
* @beta
|
7868
8007
|
*/
|
7869
|
-
interface RequestAppAudioHandlingParams {
|
8008
|
+
export interface RequestAppAudioHandlingParams {
|
7870
8009
|
/**
|
7871
8010
|
* Indicates whether the app is requesting to start handling audio, or if
|
7872
8011
|
* it's giving audio back to the host
|
@@ -7901,7 +8040,7 @@ export namespace meeting {
|
|
7901
8040
|
*
|
7902
8041
|
* @beta
|
7903
8042
|
*/
|
7904
|
-
interface AudioDeviceSelection {
|
8043
|
+
export interface AudioDeviceSelection {
|
7905
8044
|
speaker?: AudioDeviceInfo;
|
7906
8045
|
microphone?: AudioDeviceInfo;
|
7907
8046
|
}
|
@@ -7921,7 +8060,7 @@ export namespace meeting {
|
|
7921
8060
|
*
|
7922
8061
|
* @beta
|
7923
8062
|
*/
|
7924
|
-
interface AudioDeviceInfo {
|
8063
|
+
export interface AudioDeviceInfo {
|
7925
8064
|
deviceLabel: string;
|
7926
8065
|
}
|
7927
8066
|
/**
|
@@ -7935,7 +8074,7 @@ export namespace meeting {
|
|
7935
8074
|
*
|
7936
8075
|
* @beta
|
7937
8076
|
*/
|
7938
|
-
enum MeetingReactionType {
|
8077
|
+
export enum MeetingReactionType {
|
7939
8078
|
like = "like",
|
7940
8079
|
heart = "heart",
|
7941
8080
|
laugh = "laugh",
|
@@ -7951,7 +8090,7 @@ export namespace meeting {
|
|
7951
8090
|
* @remarks
|
7952
8091
|
* Teams has several types of meetings to account for different user scenarios and requirements.
|
7953
8092
|
*/
|
7954
|
-
enum MeetingType {
|
8093
|
+
export enum MeetingType {
|
7955
8094
|
/**
|
7956
8095
|
* Used when the meeting type is not known.
|
7957
8096
|
*
|
@@ -8005,7 +8144,7 @@ export namespace meeting {
|
|
8005
8144
|
* @hidden
|
8006
8145
|
* Hide from docs.
|
8007
8146
|
*/
|
8008
|
-
enum CallType {
|
8147
|
+
export enum CallType {
|
8009
8148
|
/**
|
8010
8149
|
* Represents a call between two people.
|
8011
8150
|
*
|
@@ -8025,7 +8164,7 @@ export namespace meeting {
|
|
8025
8164
|
/**
|
8026
8165
|
* Represents the protocol option for sharing app content to the meeting stage.
|
8027
8166
|
*/
|
8028
|
-
enum SharingProtocol {
|
8167
|
+
export enum SharingProtocol {
|
8029
8168
|
/**
|
8030
8169
|
* The default protocol for sharing app content to stage. To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
|
8031
8170
|
*/
|
@@ -8050,7 +8189,7 @@ export namespace meeting {
|
|
8050
8189
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when fetch is successful.
|
8051
8190
|
* `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the request fails.
|
8052
8191
|
*/
|
8053
|
-
function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
|
8192
|
+
export function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
|
8054
8193
|
/**
|
8055
8194
|
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa.
|
8056
8195
|
* To learn more, visit https://aka.ms/teamsjs/toggleIncomingClientAudio
|
@@ -8065,7 +8204,7 @@ export namespace meeting {
|
|
8065
8204
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when toggle is successful.
|
8066
8205
|
* `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the toggling fails.
|
8067
8206
|
*/
|
8068
|
-
function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
|
8207
|
+
export function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
|
8069
8208
|
/**
|
8070
8209
|
* @throws error if your app manifest does not include the `OnlineMeeting.ReadBasic.Chat` RSC permission.
|
8071
8210
|
* Find the app manifest reference at https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema.
|
@@ -8081,7 +8220,7 @@ export namespace meeting {
|
|
8081
8220
|
* @internal
|
8082
8221
|
* Limited to Microsoft-internal use
|
8083
8222
|
*/
|
8084
|
-
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
8223
|
+
export function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
8085
8224
|
/**
|
8086
8225
|
* @throws error if your app manifest does not include both the `OnlineMeeting.ReadBasic.Chat` RSC permission
|
8087
8226
|
* and the `OnlineMeetingParticipant.Read.Chat` RSC permission.
|
@@ -8099,7 +8238,7 @@ export namespace meeting {
|
|
8099
8238
|
*
|
8100
8239
|
* @beta
|
8101
8240
|
*/
|
8102
|
-
function getMeetingDetailsVerbose(): Promise<IMeetingDetailsResponse>;
|
8241
|
+
export function getMeetingDetailsVerbose(): Promise<IMeetingDetailsResponse>;
|
8103
8242
|
/**
|
8104
8243
|
* @hidden
|
8105
8244
|
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
@@ -8111,7 +8250,7 @@ export namespace meeting {
|
|
8111
8250
|
* @internal
|
8112
8251
|
* Limited to Microsoft-internal use
|
8113
8252
|
*/
|
8114
|
-
function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
8253
|
+
export function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
8115
8254
|
/**
|
8116
8255
|
* Allows an app to get the state of the outgoing live stream in the current meeting.
|
8117
8256
|
*
|
@@ -8125,7 +8264,7 @@ export namespace meeting {
|
|
8125
8264
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when the request is successful
|
8126
8265
|
* `liveStreamState` can either contain a `LiveStreamState` value, or null when operation fails
|
8127
8266
|
*/
|
8128
|
-
function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
|
8267
|
+
export function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
|
8129
8268
|
/**
|
8130
8269
|
* Allows an app to ask the local user to begin live streaming the current meeting to the given Real-Time Messaging Protocol (RTMP) stream url.
|
8131
8270
|
* A confirmation dialog will be shown to the local user with options to "Allow" or "Cancel" this request.
|
@@ -8142,7 +8281,7 @@ export namespace meeting {
|
|
8142
8281
|
* @param streamUrl - the url to the RTMP stream resource
|
8143
8282
|
* @param streamKey - the key to the RTMP stream resource
|
8144
8283
|
*/
|
8145
|
-
function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
|
8284
|
+
export function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
|
8146
8285
|
/**
|
8147
8286
|
* Allows an app to request that live streaming be stopped.
|
8148
8287
|
*
|
@@ -8154,7 +8293,7 @@ export namespace meeting {
|
|
8154
8293
|
*
|
8155
8294
|
* @param callback - completion callback that contains an error parameter, which can be of type `SdkError` in case of an error, or null when operation is successful
|
8156
8295
|
*/
|
8157
|
-
function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
|
8296
|
+
export function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
|
8158
8297
|
/**
|
8159
8298
|
* Registers an event handler for state changes to the live stream.
|
8160
8299
|
*
|
@@ -8167,7 +8306,7 @@ export namespace meeting {
|
|
8167
8306
|
*
|
8168
8307
|
* @param handler - The handler to invoke when the live stream state changes
|
8169
8308
|
*/
|
8170
|
-
function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
|
8309
|
+
export function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
|
8171
8310
|
/**
|
8172
8311
|
* Allows an app to share a given URL to the meeting stage for all users in the meeting.
|
8173
8312
|
* To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
|
@@ -8188,7 +8327,7 @@ export namespace meeting {
|
|
8188
8327
|
* @param shareOptions - is an object that contains additional sharing options. If omitted, the default
|
8189
8328
|
* sharing protocol will be `Collaborative`. See {@link IShareAppContentToStageOptions} for more information.
|
8190
8329
|
*/
|
8191
|
-
function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string, shareOptions?: IShareAppContentToStageOptions): void;
|
8330
|
+
export function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string, shareOptions?: IShareAppContentToStageOptions): void;
|
8192
8331
|
/**
|
8193
8332
|
* Allows an app to request whether the local user's app version has the required app manifest permissions to share content to meeting stage.
|
8194
8333
|
* To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingCapabilities
|
@@ -8206,7 +8345,7 @@ export namespace meeting {
|
|
8206
8345
|
* `error` can either contain an error of type `SdkError` (error indication), or null (non-error indication).
|
8207
8346
|
* `appContentStageSharingCapabilities` will contain an {@link IAppContentStageSharingCapabilities} object if the request succeeds, or null if it failed.
|
8208
8347
|
*/
|
8209
|
-
function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
|
8348
|
+
export function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
|
8210
8349
|
/**
|
8211
8350
|
* @hidden
|
8212
8351
|
* Hide from docs.
|
@@ -8216,7 +8355,7 @@ export namespace meeting {
|
|
8216
8355
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
8217
8356
|
* result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
|
8218
8357
|
*/
|
8219
|
-
function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
|
8358
|
+
export function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
|
8220
8359
|
/**
|
8221
8360
|
* Provides information related to current stage sharing state for your app.
|
8222
8361
|
* To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingState
|
@@ -8231,7 +8370,7 @@ export namespace meeting {
|
|
8231
8370
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
8232
8371
|
* `appContentStageSharingState` can either contain an `IAppContentStageSharingState` object if the request succeeds, or null if it failed
|
8233
8372
|
*/
|
8234
|
-
function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
|
8373
|
+
export function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
|
8235
8374
|
/**
|
8236
8375
|
* Registers a handler for changes to participant speaking states.
|
8237
8376
|
* To learn more, visit https://aka.ms/teamsjs/registerSpeakingStateChangeHandler
|
@@ -8247,7 +8386,7 @@ export namespace meeting {
|
|
8247
8386
|
*
|
8248
8387
|
* @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
|
8249
8388
|
*/
|
8250
|
-
function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
|
8389
|
+
export function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
|
8251
8390
|
/**
|
8252
8391
|
* Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
|
8253
8392
|
* will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
|
@@ -8264,7 +8403,7 @@ export namespace meeting {
|
|
8264
8403
|
*
|
8265
8404
|
* @beta
|
8266
8405
|
*/
|
8267
|
-
function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
|
8406
|
+
export function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
|
8268
8407
|
/**
|
8269
8408
|
* Registers a handler for receiving meeting reactions. When the selfParticipant (current user) successfully sends a meeting reaction and it is being rendered on the UI, the meetingReactionType will be populated. Only one handler can be registered
|
8270
8409
|
* at a time. A subsequent registration replaces an existing registration.
|
@@ -8279,7 +8418,7 @@ export namespace meeting {
|
|
8279
8418
|
*
|
8280
8419
|
* @beta
|
8281
8420
|
*/
|
8282
|
-
function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
|
8421
|
+
export function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
|
8283
8422
|
/**
|
8284
8423
|
* @hidden
|
8285
8424
|
* Hide from docs beacuse it's only used internally as a serialization/deserialization type
|
@@ -8287,7 +8426,7 @@ export namespace meeting {
|
|
8287
8426
|
* @internal
|
8288
8427
|
* Limited to Microsoft-internal use
|
8289
8428
|
*/
|
8290
|
-
interface ISerializedJoinMeetingParams {
|
8429
|
+
export interface ISerializedJoinMeetingParams {
|
8291
8430
|
joinWebUrl: string;
|
8292
8431
|
source: EventActionSource;
|
8293
8432
|
}
|
@@ -8299,20 +8438,20 @@ export namespace meeting {
|
|
8299
8438
|
* @param joinMeetingParams This takes {@link JoinMeetingParams} for joining the meeting. If source isn't passed then it is marked as 'Other' by default.
|
8300
8439
|
* @throws error if the meeting join fails, the promise will reject to an object with the error message.
|
8301
8440
|
*/
|
8302
|
-
function joinMeeting(joinMeetingParams: JoinMeetingParams): Promise<void>;
|
8441
|
+
export function joinMeeting(joinMeetingParams: JoinMeetingParams): Promise<void>;
|
8303
8442
|
/**
|
8304
8443
|
* Contains information associated with parameters required for joining the Microsoft Teams meetings.
|
8305
8444
|
* More details regarding parameters can be found at:
|
8306
8445
|
* [Online Meeting Base - Microsoft Graph v1.0](https://learn.microsoft.com/en-us/graph/api/resources/onlinemeetingbase?view=graph-rest-1.0)
|
8307
8446
|
*/
|
8308
|
-
interface JoinMeetingParams {
|
8447
|
+
export interface JoinMeetingParams {
|
8309
8448
|
/** The join URL of the online meeting. */
|
8310
8449
|
joinWebUrl: URL;
|
8311
8450
|
/** The source of the join button click. If not passed, 'Other' is the default value of source. {@link EventActionSource} */
|
8312
8451
|
source?: EventActionSource;
|
8313
8452
|
}
|
8314
8453
|
/** The source of the join button click. */
|
8315
|
-
enum EventActionSource {
|
8454
|
+
export enum EventActionSource {
|
8316
8455
|
/**
|
8317
8456
|
* Source is calendar grid context menu.
|
8318
8457
|
*/
|
@@ -8349,7 +8488,7 @@ export namespace meeting {
|
|
8349
8488
|
*
|
8350
8489
|
* @beta
|
8351
8490
|
*/
|
8352
|
-
namespace appShareButton {
|
8491
|
+
export namespace appShareButton {
|
8353
8492
|
/**
|
8354
8493
|
* Property bag for the setVisibilityInfo
|
8355
8494
|
*
|
@@ -8415,7 +8554,7 @@ export namespace meeting {
|
|
8415
8554
|
*
|
8416
8555
|
* @beta
|
8417
8556
|
*/
|
8418
|
-
function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
|
8557
|
+
export function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
|
8419
8558
|
/**
|
8420
8559
|
* Notifies the host that the microphone state has changed in the app.
|
8421
8560
|
* @param micState - The new state that the microphone is in
|
@@ -8429,7 +8568,8 @@ export namespace meeting {
|
|
8429
8568
|
*
|
8430
8569
|
* @beta
|
8431
8570
|
*/
|
8432
|
-
function updateMicState(micState: MicState): void;
|
8571
|
+
export function updateMicState(micState: MicState): void;
|
8572
|
+
export {};
|
8433
8573
|
}
|
8434
8574
|
|
8435
8575
|
export namespace monetization {
|