@microsoft/teams-js 2.29.0-beta.2 → 2.29.0-beta.3
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/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 +206 -52
- package/dist/umd/MicrosoftTeams.js +253 -5
- 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 +1 -1
@@ -643,6 +643,22 @@ export namespace externalAppAuthentication {
|
|
643
643
|
verb: string;
|
644
644
|
data: string | Record<string, unknown>;
|
645
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";
|
646
662
|
/**
|
647
663
|
* @hidden
|
648
664
|
* Used to differentiate between IOriginalRequestInfo types
|
@@ -766,6 +782,15 @@ export namespace externalAppAuthentication {
|
|
766
782
|
errorCode: InvokeErrorCode;
|
767
783
|
message?: string;
|
768
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;
|
769
794
|
/**
|
770
795
|
* @hidden
|
771
796
|
*
|
@@ -775,6 +800,15 @@ export namespace externalAppAuthentication {
|
|
775
800
|
enum InvokeErrorCode {
|
776
801
|
INTERNAL_ERROR = "INTERNAL_ERROR"
|
777
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
|
+
};
|
778
812
|
/**
|
779
813
|
* @beta
|
780
814
|
* @hidden
|
@@ -847,6 +881,80 @@ export namespace externalAppAuthentication {
|
|
847
881
|
function isSupported(): boolean;
|
848
882
|
}
|
849
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
|
+
|
850
958
|
/**
|
851
959
|
* @hidden
|
852
960
|
* Namespace to delegate adaptive card action execution to the host
|
@@ -5576,6 +5684,17 @@ export class AppId {
|
|
5576
5684
|
toString(): string;
|
5577
5685
|
}
|
5578
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
|
+
|
5579
5698
|
export namespace appInstallDialog {
|
5580
5699
|
/** Represents set of parameters needed to open the appInstallDialog. */
|
5581
5700
|
interface OpenAppInstallDialogParams {
|
@@ -7557,19 +7676,19 @@ export namespace location {
|
|
7557
7676
|
*/
|
7558
7677
|
export namespace meeting {
|
7559
7678
|
/** Error callback function type */
|
7560
|
-
type errorCallbackFunctionType = (error: SdkError | null, result: boolean | null) => void;
|
7679
|
+
export type errorCallbackFunctionType = (error: SdkError | null, result: boolean | null) => void;
|
7561
7680
|
/** Get live stream state callback function type */
|
7562
|
-
type getLiveStreamStateCallbackFunctionType = (error: SdkError | null, liveStreamState: LiveStreamState | null) => void;
|
7681
|
+
export type getLiveStreamStateCallbackFunctionType = (error: SdkError | null, liveStreamState: LiveStreamState | null) => void;
|
7563
7682
|
/** Live stream error callback function type */
|
7564
|
-
type liveStreamErrorCallbackFunctionType = (error: SdkError | null) => void;
|
7683
|
+
export type liveStreamErrorCallbackFunctionType = (error: SdkError | null) => void;
|
7565
7684
|
/** Register live stream changed handler function type */
|
7566
|
-
type registerLiveStreamChangedHandlerFunctionType = (liveStreamState: LiveStreamState) => void;
|
7685
|
+
export type registerLiveStreamChangedHandlerFunctionType = (liveStreamState: LiveStreamState) => void;
|
7567
7686
|
/** Get app content stage sharing capabilities callback function type */
|
7568
|
-
type getAppContentCallbackFunctionType = (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void;
|
7687
|
+
export type getAppContentCallbackFunctionType = (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void;
|
7569
7688
|
/** Get app content stage sharing state callback function type */
|
7570
|
-
type getAppContentStageCallbackFunctionType = (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void;
|
7689
|
+
export type getAppContentStageCallbackFunctionType = (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void;
|
7571
7690
|
/** Register speaking state change handler function type */
|
7572
|
-
type registerSpeakingStateChangeHandlerFunctionType = (speakingState: ISpeakingState) => void;
|
7691
|
+
export type registerSpeakingStateChangeHandlerFunctionType = (speakingState: ISpeakingState) => void;
|
7573
7692
|
/**
|
7574
7693
|
* @hidden
|
7575
7694
|
* Data structure to represent meeting details
|
@@ -7577,7 +7696,7 @@ export namespace meeting {
|
|
7577
7696
|
* @internal
|
7578
7697
|
* Limited to Microsoft-internal use
|
7579
7698
|
*/
|
7580
|
-
interface IMeetingDetailsResponse {
|
7699
|
+
export interface IMeetingDetailsResponse {
|
7581
7700
|
/**
|
7582
7701
|
* @hidden
|
7583
7702
|
* details object
|
@@ -7599,7 +7718,7 @@ export namespace meeting {
|
|
7599
7718
|
* Hide from docs
|
7600
7719
|
* Base data structure to represent a meeting or call detail
|
7601
7720
|
*/
|
7602
|
-
interface IMeetingOrCallDetailsBase<T> {
|
7721
|
+
export interface IMeetingOrCallDetailsBase<T> {
|
7603
7722
|
/**
|
7604
7723
|
* @hidden
|
7605
7724
|
* Scheduled start time of the meeting or start time of the call
|
@@ -7616,22 +7735,56 @@ export namespace meeting {
|
|
7616
7735
|
*/
|
7617
7736
|
type?: T;
|
7618
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
|
+
}
|
7619
7753
|
/**
|
7620
7754
|
* @hidden
|
7621
7755
|
* Hide from docs
|
7622
7756
|
* Data structure to represent call details
|
7623
7757
|
*/
|
7624
|
-
interface ICallDetails extends IMeetingOrCallDetailsBase<CallType> {
|
7758
|
+
export interface ICallDetails extends IMeetingOrCallDetailsBase<CallType> {
|
7625
7759
|
/**
|
7760
|
+
* @deprecated please use {@link ICallDetails.originalCallerInfo} instead
|
7761
|
+
*
|
7626
7762
|
* @hidden
|
7627
7763
|
* Phone number of a PSTN caller or email of a VoIP caller
|
7628
7764
|
*/
|
7629
7765
|
originalCaller?: string;
|
7630
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
|
+
*
|
7631
7779
|
* @hidden
|
7632
7780
|
* Phone number of a PSTN callee or email of a VoIP callee
|
7633
7781
|
*/
|
7634
7782
|
dialedEntity?: never;
|
7783
|
+
/**
|
7784
|
+
* @hidden
|
7785
|
+
* Object representing the entity the caller dialed
|
7786
|
+
*/
|
7787
|
+
dialedEntityInfo?: never;
|
7635
7788
|
/**
|
7636
7789
|
* @hidden
|
7637
7790
|
* Tracking identifier for grouping related calls
|
@@ -7643,7 +7796,7 @@ export namespace meeting {
|
|
7643
7796
|
* Hide from docs
|
7644
7797
|
* Data structure to represent meeting details.
|
7645
7798
|
*/
|
7646
|
-
interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
7799
|
+
export interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
7647
7800
|
/**
|
7648
7801
|
* @hidden
|
7649
7802
|
* Scheduled end time of the meeting
|
@@ -7667,7 +7820,7 @@ export namespace meeting {
|
|
7667
7820
|
* @internal
|
7668
7821
|
* Limited to Microsoft-internal use
|
7669
7822
|
*/
|
7670
|
-
interface IConversation {
|
7823
|
+
export interface IConversation {
|
7671
7824
|
/**
|
7672
7825
|
* @hidden
|
7673
7826
|
* conversation id of the meeting
|
@@ -7681,7 +7834,7 @@ export namespace meeting {
|
|
7681
7834
|
* @internal
|
7682
7835
|
* Limited to Microsoft-internal use
|
7683
7836
|
*/
|
7684
|
-
interface IOrganizer {
|
7837
|
+
export interface IOrganizer {
|
7685
7838
|
/**
|
7686
7839
|
* @hidden
|
7687
7840
|
* organizer id of the meeting
|
@@ -7699,7 +7852,7 @@ export namespace meeting {
|
|
7699
7852
|
* @remarks
|
7700
7853
|
* RTMP is a popular communication protocol for streaming audio, video, and data over the Internet.
|
7701
7854
|
*/
|
7702
|
-
interface LiveStreamState {
|
7855
|
+
export interface LiveStreamState {
|
7703
7856
|
/**
|
7704
7857
|
* true when the current meeting is being streamed through RTMP, or false if it is not.
|
7705
7858
|
*/
|
@@ -7715,7 +7868,7 @@ export namespace meeting {
|
|
7715
7868
|
};
|
7716
7869
|
}
|
7717
7870
|
/** Defines additional sharing options which can be provided to the {@link shareAppContentToStage} API. */
|
7718
|
-
interface IShareAppContentToStageOptions {
|
7871
|
+
export interface IShareAppContentToStageOptions {
|
7719
7872
|
/**
|
7720
7873
|
* The protocol option for sharing app content to the meeting stage. Defaults to `Collaborative`.
|
7721
7874
|
* See {@link SharingProtocol} for more information.
|
@@ -7723,7 +7876,7 @@ export namespace meeting {
|
|
7723
7876
|
sharingProtocol?: SharingProtocol;
|
7724
7877
|
}
|
7725
7878
|
/** Represents app permission to share contents to meeting. */
|
7726
|
-
interface IAppContentStageSharingCapabilities {
|
7879
|
+
export interface IAppContentStageSharingCapabilities {
|
7727
7880
|
/**
|
7728
7881
|
* indicates whether app has permission to share contents to meeting stage.
|
7729
7882
|
* true when your `configurableTabs` or `staticTabs` entry's `context` array includes `meetingStage`.
|
@@ -7731,7 +7884,7 @@ export namespace meeting {
|
|
7731
7884
|
doesAppHaveSharePermission: boolean;
|
7732
7885
|
}
|
7733
7886
|
/** Represents app being shared to stage. */
|
7734
|
-
interface IAppContentStageSharingState {
|
7887
|
+
export interface IAppContentStageSharingState {
|
7735
7888
|
/**
|
7736
7889
|
* indicates whether app is currently being shared to stage
|
7737
7890
|
*/
|
@@ -7741,7 +7894,7 @@ export namespace meeting {
|
|
7741
7894
|
* Property bag for the speakingState changed event
|
7742
7895
|
*
|
7743
7896
|
*/
|
7744
|
-
interface ISpeakingState {
|
7897
|
+
export interface ISpeakingState {
|
7745
7898
|
/**
|
7746
7899
|
* true when one or more participants in a meeting are speaking, or false if no participants are speaking
|
7747
7900
|
*/
|
@@ -7762,7 +7915,7 @@ export namespace meeting {
|
|
7762
7915
|
*
|
7763
7916
|
* @beta
|
7764
7917
|
*/
|
7765
|
-
interface MeetingReactionReceivedEventData {
|
7918
|
+
export interface MeetingReactionReceivedEventData {
|
7766
7919
|
/**
|
7767
7920
|
* Indicates the type of meeting reaction received
|
7768
7921
|
*
|
@@ -7789,7 +7942,7 @@ export namespace meeting {
|
|
7789
7942
|
*
|
7790
7943
|
* @beta
|
7791
7944
|
*/
|
7792
|
-
interface IRaiseHandState {
|
7945
|
+
export interface IRaiseHandState {
|
7793
7946
|
/** Indicates whether the selfParticipant's hand is raised or not
|
7794
7947
|
*
|
7795
7948
|
* @hidden
|
@@ -7808,7 +7961,7 @@ export namespace meeting {
|
|
7808
7961
|
*
|
7809
7962
|
* @beta
|
7810
7963
|
*/
|
7811
|
-
interface RaiseHandStateChangedEventData {
|
7964
|
+
export interface RaiseHandStateChangedEventData {
|
7812
7965
|
/**
|
7813
7966
|
* entire raiseHandState object for the selfParticipant
|
7814
7967
|
*
|
@@ -7835,7 +7988,7 @@ export namespace meeting {
|
|
7835
7988
|
*
|
7836
7989
|
* @beta
|
7837
7990
|
*/
|
7838
|
-
interface MicState {
|
7991
|
+
export interface MicState {
|
7839
7992
|
/**
|
7840
7993
|
* Indicates the mute status of the mic
|
7841
7994
|
*/
|
@@ -7852,7 +8005,7 @@ export namespace meeting {
|
|
7852
8005
|
*
|
7853
8006
|
* @beta
|
7854
8007
|
*/
|
7855
|
-
interface RequestAppAudioHandlingParams {
|
8008
|
+
export interface RequestAppAudioHandlingParams {
|
7856
8009
|
/**
|
7857
8010
|
* Indicates whether the app is requesting to start handling audio, or if
|
7858
8011
|
* it's giving audio back to the host
|
@@ -7887,7 +8040,7 @@ export namespace meeting {
|
|
7887
8040
|
*
|
7888
8041
|
* @beta
|
7889
8042
|
*/
|
7890
|
-
interface AudioDeviceSelection {
|
8043
|
+
export interface AudioDeviceSelection {
|
7891
8044
|
speaker?: AudioDeviceInfo;
|
7892
8045
|
microphone?: AudioDeviceInfo;
|
7893
8046
|
}
|
@@ -7907,7 +8060,7 @@ export namespace meeting {
|
|
7907
8060
|
*
|
7908
8061
|
* @beta
|
7909
8062
|
*/
|
7910
|
-
interface AudioDeviceInfo {
|
8063
|
+
export interface AudioDeviceInfo {
|
7911
8064
|
deviceLabel: string;
|
7912
8065
|
}
|
7913
8066
|
/**
|
@@ -7921,7 +8074,7 @@ export namespace meeting {
|
|
7921
8074
|
*
|
7922
8075
|
* @beta
|
7923
8076
|
*/
|
7924
|
-
enum MeetingReactionType {
|
8077
|
+
export enum MeetingReactionType {
|
7925
8078
|
like = "like",
|
7926
8079
|
heart = "heart",
|
7927
8080
|
laugh = "laugh",
|
@@ -7937,7 +8090,7 @@ export namespace meeting {
|
|
7937
8090
|
* @remarks
|
7938
8091
|
* Teams has several types of meetings to account for different user scenarios and requirements.
|
7939
8092
|
*/
|
7940
|
-
enum MeetingType {
|
8093
|
+
export enum MeetingType {
|
7941
8094
|
/**
|
7942
8095
|
* Used when the meeting type is not known.
|
7943
8096
|
*
|
@@ -7991,7 +8144,7 @@ export namespace meeting {
|
|
7991
8144
|
* @hidden
|
7992
8145
|
* Hide from docs.
|
7993
8146
|
*/
|
7994
|
-
enum CallType {
|
8147
|
+
export enum CallType {
|
7995
8148
|
/**
|
7996
8149
|
* Represents a call between two people.
|
7997
8150
|
*
|
@@ -8011,7 +8164,7 @@ export namespace meeting {
|
|
8011
8164
|
/**
|
8012
8165
|
* Represents the protocol option for sharing app content to the meeting stage.
|
8013
8166
|
*/
|
8014
|
-
enum SharingProtocol {
|
8167
|
+
export enum SharingProtocol {
|
8015
8168
|
/**
|
8016
8169
|
* The default protocol for sharing app content to stage. To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
|
8017
8170
|
*/
|
@@ -8036,7 +8189,7 @@ export namespace meeting {
|
|
8036
8189
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when fetch is successful.
|
8037
8190
|
* `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the request fails.
|
8038
8191
|
*/
|
8039
|
-
function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
|
8192
|
+
export function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
|
8040
8193
|
/**
|
8041
8194
|
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa.
|
8042
8195
|
* To learn more, visit https://aka.ms/teamsjs/toggleIncomingClientAudio
|
@@ -8051,7 +8204,7 @@ export namespace meeting {
|
|
8051
8204
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when toggle is successful.
|
8052
8205
|
* `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the toggling fails.
|
8053
8206
|
*/
|
8054
|
-
function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
|
8207
|
+
export function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
|
8055
8208
|
/**
|
8056
8209
|
* @throws error if your app manifest does not include the `OnlineMeeting.ReadBasic.Chat` RSC permission.
|
8057
8210
|
* Find the app manifest reference at https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema.
|
@@ -8067,7 +8220,7 @@ export namespace meeting {
|
|
8067
8220
|
* @internal
|
8068
8221
|
* Limited to Microsoft-internal use
|
8069
8222
|
*/
|
8070
|
-
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
8223
|
+
export function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
8071
8224
|
/**
|
8072
8225
|
* @throws error if your app manifest does not include both the `OnlineMeeting.ReadBasic.Chat` RSC permission
|
8073
8226
|
* and the `OnlineMeetingParticipant.Read.Chat` RSC permission.
|
@@ -8085,7 +8238,7 @@ export namespace meeting {
|
|
8085
8238
|
*
|
8086
8239
|
* @beta
|
8087
8240
|
*/
|
8088
|
-
function getMeetingDetailsVerbose(): Promise<IMeetingDetailsResponse>;
|
8241
|
+
export function getMeetingDetailsVerbose(): Promise<IMeetingDetailsResponse>;
|
8089
8242
|
/**
|
8090
8243
|
* @hidden
|
8091
8244
|
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
@@ -8097,7 +8250,7 @@ export namespace meeting {
|
|
8097
8250
|
* @internal
|
8098
8251
|
* Limited to Microsoft-internal use
|
8099
8252
|
*/
|
8100
|
-
function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
8253
|
+
export function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
8101
8254
|
/**
|
8102
8255
|
* Allows an app to get the state of the outgoing live stream in the current meeting.
|
8103
8256
|
*
|
@@ -8111,7 +8264,7 @@ export namespace meeting {
|
|
8111
8264
|
* `error` can either contain an error of type `SdkError`, in case of an error, or null when the request is successful
|
8112
8265
|
* `liveStreamState` can either contain a `LiveStreamState` value, or null when operation fails
|
8113
8266
|
*/
|
8114
|
-
function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
|
8267
|
+
export function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
|
8115
8268
|
/**
|
8116
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.
|
8117
8270
|
* A confirmation dialog will be shown to the local user with options to "Allow" or "Cancel" this request.
|
@@ -8128,7 +8281,7 @@ export namespace meeting {
|
|
8128
8281
|
* @param streamUrl - the url to the RTMP stream resource
|
8129
8282
|
* @param streamKey - the key to the RTMP stream resource
|
8130
8283
|
*/
|
8131
|
-
function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
|
8284
|
+
export function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
|
8132
8285
|
/**
|
8133
8286
|
* Allows an app to request that live streaming be stopped.
|
8134
8287
|
*
|
@@ -8140,7 +8293,7 @@ export namespace meeting {
|
|
8140
8293
|
*
|
8141
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
|
8142
8295
|
*/
|
8143
|
-
function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
|
8296
|
+
export function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
|
8144
8297
|
/**
|
8145
8298
|
* Registers an event handler for state changes to the live stream.
|
8146
8299
|
*
|
@@ -8153,7 +8306,7 @@ export namespace meeting {
|
|
8153
8306
|
*
|
8154
8307
|
* @param handler - The handler to invoke when the live stream state changes
|
8155
8308
|
*/
|
8156
|
-
function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
|
8309
|
+
export function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
|
8157
8310
|
/**
|
8158
8311
|
* Allows an app to share a given URL to the meeting stage for all users in the meeting.
|
8159
8312
|
* To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
|
@@ -8174,7 +8327,7 @@ export namespace meeting {
|
|
8174
8327
|
* @param shareOptions - is an object that contains additional sharing options. If omitted, the default
|
8175
8328
|
* sharing protocol will be `Collaborative`. See {@link IShareAppContentToStageOptions} for more information.
|
8176
8329
|
*/
|
8177
|
-
function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string, shareOptions?: IShareAppContentToStageOptions): void;
|
8330
|
+
export function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string, shareOptions?: IShareAppContentToStageOptions): void;
|
8178
8331
|
/**
|
8179
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.
|
8180
8333
|
* To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingCapabilities
|
@@ -8192,7 +8345,7 @@ export namespace meeting {
|
|
8192
8345
|
* `error` can either contain an error of type `SdkError` (error indication), or null (non-error indication).
|
8193
8346
|
* `appContentStageSharingCapabilities` will contain an {@link IAppContentStageSharingCapabilities} object if the request succeeds, or null if it failed.
|
8194
8347
|
*/
|
8195
|
-
function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
|
8348
|
+
export function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
|
8196
8349
|
/**
|
8197
8350
|
* @hidden
|
8198
8351
|
* Hide from docs.
|
@@ -8202,7 +8355,7 @@ export namespace meeting {
|
|
8202
8355
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
8203
8356
|
* result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
|
8204
8357
|
*/
|
8205
|
-
function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
|
8358
|
+
export function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
|
8206
8359
|
/**
|
8207
8360
|
* Provides information related to current stage sharing state for your app.
|
8208
8361
|
* To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingState
|
@@ -8217,7 +8370,7 @@ export namespace meeting {
|
|
8217
8370
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
8218
8371
|
* `appContentStageSharingState` can either contain an `IAppContentStageSharingState` object if the request succeeds, or null if it failed
|
8219
8372
|
*/
|
8220
|
-
function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
|
8373
|
+
export function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
|
8221
8374
|
/**
|
8222
8375
|
* Registers a handler for changes to participant speaking states.
|
8223
8376
|
* To learn more, visit https://aka.ms/teamsjs/registerSpeakingStateChangeHandler
|
@@ -8233,7 +8386,7 @@ export namespace meeting {
|
|
8233
8386
|
*
|
8234
8387
|
* @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
|
8235
8388
|
*/
|
8236
|
-
function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
|
8389
|
+
export function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
|
8237
8390
|
/**
|
8238
8391
|
* Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
|
8239
8392
|
* will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
|
@@ -8250,7 +8403,7 @@ export namespace meeting {
|
|
8250
8403
|
*
|
8251
8404
|
* @beta
|
8252
8405
|
*/
|
8253
|
-
function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
|
8406
|
+
export function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
|
8254
8407
|
/**
|
8255
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
|
8256
8409
|
* at a time. A subsequent registration replaces an existing registration.
|
@@ -8265,7 +8418,7 @@ export namespace meeting {
|
|
8265
8418
|
*
|
8266
8419
|
* @beta
|
8267
8420
|
*/
|
8268
|
-
function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
|
8421
|
+
export function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
|
8269
8422
|
/**
|
8270
8423
|
* @hidden
|
8271
8424
|
* Hide from docs beacuse it's only used internally as a serialization/deserialization type
|
@@ -8273,7 +8426,7 @@ export namespace meeting {
|
|
8273
8426
|
* @internal
|
8274
8427
|
* Limited to Microsoft-internal use
|
8275
8428
|
*/
|
8276
|
-
interface ISerializedJoinMeetingParams {
|
8429
|
+
export interface ISerializedJoinMeetingParams {
|
8277
8430
|
joinWebUrl: string;
|
8278
8431
|
source: EventActionSource;
|
8279
8432
|
}
|
@@ -8285,20 +8438,20 @@ export namespace meeting {
|
|
8285
8438
|
* @param joinMeetingParams This takes {@link JoinMeetingParams} for joining the meeting. If source isn't passed then it is marked as 'Other' by default.
|
8286
8439
|
* @throws error if the meeting join fails, the promise will reject to an object with the error message.
|
8287
8440
|
*/
|
8288
|
-
function joinMeeting(joinMeetingParams: JoinMeetingParams): Promise<void>;
|
8441
|
+
export function joinMeeting(joinMeetingParams: JoinMeetingParams): Promise<void>;
|
8289
8442
|
/**
|
8290
8443
|
* Contains information associated with parameters required for joining the Microsoft Teams meetings.
|
8291
8444
|
* More details regarding parameters can be found at:
|
8292
8445
|
* [Online Meeting Base - Microsoft Graph v1.0](https://learn.microsoft.com/en-us/graph/api/resources/onlinemeetingbase?view=graph-rest-1.0)
|
8293
8446
|
*/
|
8294
|
-
interface JoinMeetingParams {
|
8447
|
+
export interface JoinMeetingParams {
|
8295
8448
|
/** The join URL of the online meeting. */
|
8296
8449
|
joinWebUrl: URL;
|
8297
8450
|
/** The source of the join button click. If not passed, 'Other' is the default value of source. {@link EventActionSource} */
|
8298
8451
|
source?: EventActionSource;
|
8299
8452
|
}
|
8300
8453
|
/** The source of the join button click. */
|
8301
|
-
enum EventActionSource {
|
8454
|
+
export enum EventActionSource {
|
8302
8455
|
/**
|
8303
8456
|
* Source is calendar grid context menu.
|
8304
8457
|
*/
|
@@ -8335,7 +8488,7 @@ export namespace meeting {
|
|
8335
8488
|
*
|
8336
8489
|
* @beta
|
8337
8490
|
*/
|
8338
|
-
namespace appShareButton {
|
8491
|
+
export namespace appShareButton {
|
8339
8492
|
/**
|
8340
8493
|
* Property bag for the setVisibilityInfo
|
8341
8494
|
*
|
@@ -8401,7 +8554,7 @@ export namespace meeting {
|
|
8401
8554
|
*
|
8402
8555
|
* @beta
|
8403
8556
|
*/
|
8404
|
-
function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
|
8557
|
+
export function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
|
8405
8558
|
/**
|
8406
8559
|
* Notifies the host that the microphone state has changed in the app.
|
8407
8560
|
* @param micState - The new state that the microphone is in
|
@@ -8415,7 +8568,8 @@ export namespace meeting {
|
|
8415
8568
|
*
|
8416
8569
|
* @beta
|
8417
8570
|
*/
|
8418
|
-
function updateMicState(micState: MicState): void;
|
8571
|
+
export function updateMicState(micState: MicState): void;
|
8572
|
+
export {};
|
8419
8573
|
}
|
8420
8574
|
|
8421
8575
|
export namespace monetization {
|