@microsoft/teams-js 2.24.0-beta.0 → 2.24.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/MicrosoftTeams.d.ts +194 -145
- package/dist/MicrosoftTeams.js +279 -241
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +1 -1
- package/dist/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
package/dist/MicrosoftTeams.d.ts
CHANGED
@@ -2948,7 +2948,7 @@ export namespace authentication {
|
|
2948
2948
|
function initialize(): void;
|
2949
2949
|
/**
|
2950
2950
|
* @deprecated
|
2951
|
-
* As of
|
2951
|
+
* As of TeamsJS v2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
|
2952
2952
|
*
|
2953
2953
|
* Registers handlers to be called with the result of an authentication flow triggered using {@link authentication.authenticate authentication.authenticate(authenticateParameters?: AuthenticateParameters): void}
|
2954
2954
|
*
|
@@ -2984,7 +2984,7 @@ export namespace authentication {
|
|
2984
2984
|
function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
|
2985
2985
|
/**
|
2986
2986
|
* @deprecated
|
2987
|
-
* As of
|
2987
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
|
2988
2988
|
*
|
2989
2989
|
* The documentation for {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} applies
|
2990
2990
|
* to this function.
|
@@ -3011,7 +3011,7 @@ export namespace authentication {
|
|
3011
3011
|
function getAuthToken(authTokenRequest?: AuthTokenRequestParameters): Promise<string>;
|
3012
3012
|
/**
|
3013
3013
|
* @deprecated
|
3014
|
-
* As of
|
3014
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
|
3015
3015
|
*
|
3016
3016
|
* The documentation {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} applies to this
|
3017
3017
|
* function as well. The one difference when using this function is that the result is provided in the callbacks in the `authTokenRequest` parameter
|
@@ -3033,7 +3033,7 @@ export namespace authentication {
|
|
3033
3033
|
function getUser(): Promise<UserProfile>;
|
3034
3034
|
/**
|
3035
3035
|
* @deprecated
|
3036
|
-
* As of
|
3036
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
|
3037
3037
|
*
|
3038
3038
|
* @hidden
|
3039
3039
|
* Requests the decoded Microsoft Entra user identity on behalf of the app.
|
@@ -3075,21 +3075,21 @@ export namespace authentication {
|
|
3075
3075
|
function notifyFailure(result?: string): void;
|
3076
3076
|
/**
|
3077
3077
|
* @deprecated
|
3078
|
-
* As of
|
3078
|
+
* As of TeamsJS v2.0.0, this interface has been deprecated in favor of leveraging the `Promise` returned from {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
|
3079
3079
|
*-------------------------
|
3080
3080
|
* Used in {@link AuthenticateParameters} and {@link AuthTokenRequest}
|
3081
3081
|
*/
|
3082
3082
|
interface LegacyCallBacks {
|
3083
3083
|
/**
|
3084
3084
|
* @deprecated
|
3085
|
-
* As of
|
3085
|
+
* As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
|
3086
3086
|
*
|
3087
3087
|
* A function that is called if the request succeeds.
|
3088
3088
|
*/
|
3089
3089
|
successCallback?: (result: string) => void;
|
3090
3090
|
/**
|
3091
3091
|
* @deprecated
|
3092
|
-
* As of
|
3092
|
+
* As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
|
3093
3093
|
*
|
3094
3094
|
* A function that is called if the request fails, with the reason for the failure.
|
3095
3095
|
*/
|
@@ -3124,7 +3124,7 @@ export namespace authentication {
|
|
3124
3124
|
}
|
3125
3125
|
/**
|
3126
3126
|
* @deprecated
|
3127
|
-
* As of
|
3127
|
+
* As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} and
|
3128
3128
|
* the associated {@link AuthenticatePopUpParameters} instead.
|
3129
3129
|
*
|
3130
3130
|
* @see {@link LegacyCallBacks}
|
@@ -3155,7 +3155,7 @@ export namespace authentication {
|
|
3155
3155
|
}
|
3156
3156
|
/**
|
3157
3157
|
* @deprecated
|
3158
|
-
* As of
|
3158
|
+
* As of TeamsJS v2.0.0, please use {@link AuthTokenRequestParameters} instead.
|
3159
3159
|
*/
|
3160
3160
|
type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
|
3161
3161
|
/**
|
@@ -3325,7 +3325,7 @@ export namespace authentication {
|
|
3325
3325
|
}
|
3326
3326
|
/**
|
3327
3327
|
* @deprecated
|
3328
|
-
* As of
|
3328
|
+
* As of TeamsJS v2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
|
3329
3329
|
* @hidden
|
3330
3330
|
* Describes the UserRequest. Success callback describes how a successful request is handled.
|
3331
3331
|
* Failure callback describes how a failed request is handled.
|
@@ -3360,7 +3360,7 @@ export enum HostClientType {
|
|
3360
3360
|
macos = "macos",
|
3361
3361
|
/**
|
3362
3362
|
* @deprecated
|
3363
|
-
* As of
|
3363
|
+
* As of TeamsJS v2.0.0, please use {@link teamsRoomsWindows} instead.
|
3364
3364
|
*/
|
3365
3365
|
rigel = "rigel",
|
3366
3366
|
/** Represents the client of host, which runs on surface hub devices. */
|
@@ -3477,7 +3477,7 @@ export enum DialogDimension {
|
|
3477
3477
|
}
|
3478
3478
|
/**
|
3479
3479
|
* @deprecated
|
3480
|
-
* As of
|
3480
|
+
* As of TeamsJS v2.0.0, please use {@link DialogDimension} instead.
|
3481
3481
|
*/
|
3482
3482
|
export import TaskModuleDimension = DialogDimension;
|
3483
3483
|
/**
|
@@ -3765,7 +3765,7 @@ export interface ActionInfo {
|
|
3765
3765
|
}
|
3766
3766
|
/**
|
3767
3767
|
* @deprecated
|
3768
|
-
* As of
|
3768
|
+
* As of TeamsJS v2.0.0, please use the {@link app.Context} interface and its updated properties instead.
|
3769
3769
|
*
|
3770
3770
|
* @remarks
|
3771
3771
|
* For more details about the updated {@link app.Context} interface, visit the
|
@@ -3777,14 +3777,14 @@ export interface ActionInfo {
|
|
3777
3777
|
export interface Context {
|
3778
3778
|
/**
|
3779
3779
|
* @deprecated
|
3780
|
-
* As of
|
3780
|
+
* As of TeamsJS v2.0.0, please use {@link ActionInfo | app.Context.actionInfo} instead
|
3781
3781
|
*
|
3782
3782
|
* Common information applicable to all content actions
|
3783
3783
|
*/
|
3784
3784
|
actionInfo?: ActionInfo;
|
3785
3785
|
/**
|
3786
3786
|
* @deprecated
|
3787
|
-
* As of
|
3787
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.groupId | app.Context.team.groupId} instead
|
3788
3788
|
*
|
3789
3789
|
* The Office 365 group ID for the team with which the content is associated.
|
3790
3790
|
* This field is available only when the identity permission is requested in the manifest.
|
@@ -3792,49 +3792,49 @@ export interface Context {
|
|
3792
3792
|
groupId?: string;
|
3793
3793
|
/**
|
3794
3794
|
* @deprecated
|
3795
|
-
* As of
|
3795
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.internalId | app.Context.team.internalId} instead
|
3796
3796
|
*
|
3797
3797
|
* The Microsoft Teams ID for the team with which the content is associated.
|
3798
3798
|
*/
|
3799
3799
|
teamId?: string;
|
3800
3800
|
/**
|
3801
3801
|
* @deprecated
|
3802
|
-
* As of
|
3802
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.displayName | app.Context.team.displayName} instead
|
3803
3803
|
*
|
3804
3804
|
* The name for the team with which the content is associated.
|
3805
3805
|
*/
|
3806
3806
|
teamName?: string;
|
3807
3807
|
/**
|
3808
3808
|
* @deprecated
|
3809
|
-
* As of
|
3809
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.id | app.Context.channel.id} instead
|
3810
3810
|
*
|
3811
3811
|
* The Microsoft Teams ID for the channel with which the content is associated.
|
3812
3812
|
*/
|
3813
3813
|
channelId?: string;
|
3814
3814
|
/**
|
3815
3815
|
* @deprecated
|
3816
|
-
* As of
|
3816
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.displayName | app.Context.channel.displayName} instead
|
3817
3817
|
*
|
3818
3818
|
* The name for the channel with which the content is associated.
|
3819
3819
|
*/
|
3820
3820
|
channelName?: string;
|
3821
3821
|
/**
|
3822
3822
|
* @deprecated
|
3823
|
-
* As of
|
3823
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.membershipType | app.Context.channel.membershipType} instead
|
3824
3824
|
*
|
3825
3825
|
* The type of the channel with which the content is associated.
|
3826
3826
|
*/
|
3827
3827
|
channelType?: ChannelType;
|
3828
3828
|
/**
|
3829
3829
|
* @deprecated
|
3830
|
-
* As of
|
3830
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.id | app.Context.page.id} instead
|
3831
3831
|
*
|
3832
3832
|
* The developer-defined unique ID for the entity this content points to.
|
3833
3833
|
*/
|
3834
3834
|
entityId: string;
|
3835
3835
|
/**
|
3836
3836
|
* @deprecated
|
3837
|
-
* As of
|
3837
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.subPageId | app.Context.page.subPageId} instead
|
3838
3838
|
*
|
3839
3839
|
* The developer-defined unique ID for the sub-entity this content points to.
|
3840
3840
|
* This field should be used to restore to a specific state within an entity,
|
@@ -3843,7 +3843,7 @@ export interface Context {
|
|
3843
3843
|
subEntityId?: string;
|
3844
3844
|
/**
|
3845
3845
|
* @deprecated
|
3846
|
-
* As of
|
3846
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.locale | app.Context.app.locale} instead
|
3847
3847
|
*
|
3848
3848
|
* The current locale that the user has configured for the app formatted as
|
3849
3849
|
* languageId-countryId (for example, en-us).
|
@@ -3851,7 +3851,7 @@ export interface Context {
|
|
3851
3851
|
locale: string;
|
3852
3852
|
/**
|
3853
3853
|
* @deprecated
|
3854
|
-
* As of
|
3854
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.osLocaleInfo | app.Context.app.osLocaleInfo} instead
|
3855
3855
|
*
|
3856
3856
|
* More detailed locale info from the user's OS if available. Can be used together with
|
3857
3857
|
* the @microsoft/globe NPM package to ensure your app respects the user's OS date and
|
@@ -3861,7 +3861,7 @@ export interface Context {
|
|
3861
3861
|
/**
|
3862
3862
|
* @deprecated
|
3863
3863
|
*
|
3864
|
-
* As of
|
3864
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} or
|
3865
3865
|
* {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead.
|
3866
3866
|
* The UPN of the current user.
|
3867
3867
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -3871,7 +3871,7 @@ export interface Context {
|
|
3871
3871
|
upn?: string;
|
3872
3872
|
/**
|
3873
3873
|
* @deprecated
|
3874
|
-
* As of
|
3874
|
+
* As of TeamsJS v2.0.0, please use {@link app.TenantInfo.id | app.Context.user.tenant.id} instead
|
3875
3875
|
*
|
3876
3876
|
* The Microsoft Entra tenant ID of the current user.
|
3877
3877
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -3881,77 +3881,77 @@ export interface Context {
|
|
3881
3881
|
tid?: string;
|
3882
3882
|
/**
|
3883
3883
|
* @deprecated
|
3884
|
-
* As of
|
3884
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.theme | app.Context.app.theme} instead
|
3885
3885
|
*
|
3886
3886
|
* The current UI theme.
|
3887
3887
|
*/
|
3888
3888
|
theme?: string;
|
3889
3889
|
/**
|
3890
3890
|
* @deprecated
|
3891
|
-
* As of
|
3891
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.isFullScreen | app.Context.page.isFullScreen} instead
|
3892
3892
|
*
|
3893
3893
|
* Indication whether the tab is in full-screen mode.
|
3894
3894
|
*/
|
3895
3895
|
isFullScreen?: boolean;
|
3896
3896
|
/**
|
3897
3897
|
* @deprecated
|
3898
|
-
* As of
|
3898
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.type | app.Context.team.type} instead
|
3899
3899
|
*
|
3900
3900
|
* The type of the team.
|
3901
3901
|
*/
|
3902
3902
|
teamType?: TeamType;
|
3903
3903
|
/**
|
3904
3904
|
* @deprecated
|
3905
|
-
* As of
|
3905
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteUrl | app.Context.sharePointSite.teamSiteUrl} instead
|
3906
3906
|
*
|
3907
3907
|
* The root SharePoint site associated with the team.
|
3908
3908
|
*/
|
3909
3909
|
teamSiteUrl?: string;
|
3910
3910
|
/**
|
3911
3911
|
* @deprecated
|
3912
|
-
* As of
|
3912
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteDomain | app.Context.sharePointSite.teamSiteDomain} instead
|
3913
3913
|
*
|
3914
3914
|
* The domain of the root SharePoint site associated with the team.
|
3915
3915
|
*/
|
3916
3916
|
teamSiteDomain?: string;
|
3917
3917
|
/**
|
3918
3918
|
* @deprecated
|
3919
|
-
* As of
|
3919
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSitePath | app.Context.sharePointSite.teamSitePath} instead
|
3920
3920
|
*
|
3921
3921
|
* The relative path to the SharePoint site associated with the team.
|
3922
3922
|
*/
|
3923
3923
|
teamSitePath?: string;
|
3924
3924
|
/**
|
3925
3925
|
* @deprecated
|
3926
|
-
* As of
|
3926
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.ownerTenantId | app.Context.channel.ownerTenantId} instead
|
3927
3927
|
*
|
3928
3928
|
* The tenant ID of the host team.
|
3929
3929
|
*/
|
3930
3930
|
hostTeamTenantId?: string;
|
3931
3931
|
/**
|
3932
3932
|
* @deprecated
|
3933
|
-
* As of
|
3933
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.ownerGroupId | app.Context.channel.ownerGroupId} instead
|
3934
3934
|
*
|
3935
3935
|
* The Microsoft Entra group ID of the host team.
|
3936
3936
|
*/
|
3937
3937
|
hostTeamGroupId?: string;
|
3938
3938
|
/**
|
3939
3939
|
* @deprecated
|
3940
|
-
* As of
|
3940
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.relativeUrl | app.Context.channel.relativeUrl} instead
|
3941
3941
|
*
|
3942
3942
|
* The relative path to the SharePoint folder associated with the channel.
|
3943
3943
|
*/
|
3944
3944
|
channelRelativeUrl?: string;
|
3945
3945
|
/**
|
3946
3946
|
* @deprecated
|
3947
|
-
* As of
|
3947
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.sessionId | app.Context.app.host.sessionId} instead
|
3948
3948
|
*
|
3949
3949
|
* Unique ID for the current Teams session for use in correlating telemetry data.
|
3950
3950
|
*/
|
3951
3951
|
sessionId?: string;
|
3952
3952
|
/**
|
3953
3953
|
* @deprecated
|
3954
|
-
* As of
|
3954
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.userRole | app.Context.team.userRole} instead
|
3955
3955
|
*
|
3956
3956
|
* The user's role in the team.
|
3957
3957
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -3960,14 +3960,14 @@ export interface Context {
|
|
3960
3960
|
userTeamRole?: UserTeamRole;
|
3961
3961
|
/**
|
3962
3962
|
* @deprecated
|
3963
|
-
* As of
|
3963
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChatInfo.id | app.Context.chat.id} instead
|
3964
3964
|
*
|
3965
3965
|
* The Microsoft Teams ID for the chat with which the content is associated.
|
3966
3966
|
*/
|
3967
3967
|
chatId?: string;
|
3968
3968
|
/**
|
3969
3969
|
* @deprecated
|
3970
|
-
* As of
|
3970
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} instead
|
3971
3971
|
*
|
3972
3972
|
* A value suitable for use as a login_hint when authenticating with Microsoft Entra ID.
|
3973
3973
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -3977,7 +3977,7 @@ export interface Context {
|
|
3977
3977
|
loginHint?: string;
|
3978
3978
|
/**
|
3979
3979
|
* @deprecated
|
3980
|
-
* As of
|
3980
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead
|
3981
3981
|
*
|
3982
3982
|
* The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
|
3983
3983
|
* Because a malicious party run your content in a browser, this value should
|
@@ -3987,7 +3987,7 @@ export interface Context {
|
|
3987
3987
|
userPrincipalName?: string;
|
3988
3988
|
/**
|
3989
3989
|
* @deprecated
|
3990
|
-
* As of
|
3990
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.id | app.Context.user.id} instead
|
3991
3991
|
*
|
3992
3992
|
* The Microsoft Entra object ID of the current user.
|
3993
3993
|
* Because a malicious party run your content in a browser, this value should
|
@@ -3997,7 +3997,7 @@ export interface Context {
|
|
3997
3997
|
userObjectId?: string;
|
3998
3998
|
/**
|
3999
3999
|
* @deprecated
|
4000
|
-
* As of
|
4000
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.isArchived | app.Context.team.isArchived} instead
|
4001
4001
|
*
|
4002
4002
|
* Indicates whether team is archived.
|
4003
4003
|
* Apps should use this as a signal to prevent any changes to content associated with archived teams.
|
@@ -4005,14 +4005,14 @@ export interface Context {
|
|
4005
4005
|
isTeamArchived?: boolean;
|
4006
4006
|
/**
|
4007
4007
|
* @deprecated
|
4008
|
-
* As of
|
4008
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.name | app.Context.app.host.name} instead
|
4009
4009
|
*
|
4010
4010
|
* The name of the host client. Possible values are: Office, Orange, Outlook, Teams
|
4011
4011
|
*/
|
4012
4012
|
hostName?: HostName;
|
4013
4013
|
/**
|
4014
4014
|
* @deprecated
|
4015
|
-
* As of
|
4015
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.clientType | app.Context.app.host.clientType} instead
|
4016
4016
|
*
|
4017
4017
|
* The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead),
|
4018
4018
|
* surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
|
@@ -4020,35 +4020,35 @@ export interface Context {
|
|
4020
4020
|
hostClientType?: HostClientType;
|
4021
4021
|
/**
|
4022
4022
|
* @deprecated
|
4023
|
-
* As of
|
4023
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.frameContext | app.Context.page.frameContext} instead
|
4024
4024
|
*
|
4025
4025
|
* The context where tab url is loaded (content, task, setting, remove, sidePanel)
|
4026
4026
|
*/
|
4027
4027
|
frameContext?: FrameContexts;
|
4028
4028
|
/**
|
4029
4029
|
* @deprecated
|
4030
|
-
* As of
|
4030
|
+
* As of TeamsJS v2.0.0, please use {@link app.Context | app.Context.sharepoint} instead
|
4031
4031
|
*
|
4032
4032
|
* SharePoint context. This is only available when hosted in SharePoint.
|
4033
4033
|
*/
|
4034
4034
|
sharepoint?: any;
|
4035
4035
|
/**
|
4036
4036
|
* @deprecated
|
4037
|
-
* As of
|
4037
|
+
* As of TeamsJS v2.0.0, please use {@link app.TenantInfo.teamsSku | app.Context.tenant.teamsSku} instead
|
4038
4038
|
*
|
4039
4039
|
* The type of license for the current users tenant.
|
4040
4040
|
*/
|
4041
4041
|
tenantSKU?: string;
|
4042
4042
|
/**
|
4043
4043
|
* @deprecated
|
4044
|
-
* As of
|
4044
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.licenseType | app.Context.user.licenseType} instead
|
4045
4045
|
*
|
4046
4046
|
* The license type for the current user.
|
4047
4047
|
*/
|
4048
4048
|
userLicenseType?: string;
|
4049
4049
|
/**
|
4050
4050
|
* @deprecated
|
4051
|
-
* As of
|
4051
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.parentMessageId | app.Context.app.parentMessageId} instead
|
4052
4052
|
*
|
4053
4053
|
* The ID of the parent message from which this task module was launched.
|
4054
4054
|
* This is only available in task modules launched from bot cards.
|
@@ -4056,126 +4056,133 @@ export interface Context {
|
|
4056
4056
|
parentMessageId?: string;
|
4057
4057
|
/**
|
4058
4058
|
* @deprecated
|
4059
|
-
* As of
|
4059
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.ringId | app.Context.app.host.ringId} instead
|
4060
4060
|
*
|
4061
4061
|
* Current ring ID
|
4062
4062
|
*/
|
4063
4063
|
ringId?: string;
|
4064
4064
|
/**
|
4065
4065
|
* @deprecated
|
4066
|
-
* As of
|
4066
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.sessionId | app.Context.app.sessionId} instead
|
4067
4067
|
*
|
4068
4068
|
* Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.
|
4069
4069
|
*/
|
4070
4070
|
appSessionId?: string;
|
4071
4071
|
/**
|
4072
4072
|
* @deprecated
|
4073
|
-
* As of
|
4073
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.appLaunchId | app.Context.app.appLaunchId} instead
|
4074
4074
|
*
|
4075
4075
|
* ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data``
|
4076
4076
|
*/
|
4077
4077
|
appLaunchId?: string;
|
4078
4078
|
/**
|
4079
4079
|
* @deprecated
|
4080
|
-
* As of
|
4080
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.isCallingAllowed | app.Context.user.isCallingAllowed} instead
|
4081
4081
|
*
|
4082
4082
|
* Represents whether calling is allowed for the current logged in User
|
4083
4083
|
*/
|
4084
4084
|
isCallingAllowed?: boolean;
|
4085
4085
|
/**
|
4086
4086
|
* @deprecated
|
4087
|
-
* As of
|
4087
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.isPSTNCallingAllowed | app.Context.user.isPSTNCallingAllowed} instead
|
4088
4088
|
*
|
4089
4089
|
* Represents whether PSTN calling is allowed for the current logged in User
|
4090
4090
|
*/
|
4091
4091
|
isPSTNCallingAllowed?: boolean;
|
4092
4092
|
/**
|
4093
4093
|
* @deprecated
|
4094
|
-
* As of
|
4094
|
+
* As of TeamsJS v2.0.0, please use {@link app.MeetingInfo.id | app.Context.meeting.id} instead
|
4095
4095
|
*
|
4096
4096
|
* Meeting Id used by tab when running in meeting context
|
4097
4097
|
*/
|
4098
4098
|
meetingId?: string;
|
4099
4099
|
/**
|
4100
4100
|
* @deprecated
|
4101
|
-
* As of
|
4101
|
+
* As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.defaultOneNoteSectionId | app.Context.channel.defaultOneNoteSectionId} instead
|
4102
4102
|
*
|
4103
4103
|
* The OneNote section ID that is linked to the channel.
|
4104
4104
|
*/
|
4105
4105
|
defaultOneNoteSectionId?: string;
|
4106
4106
|
/**
|
4107
4107
|
* @deprecated
|
4108
|
-
* As of
|
4108
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.isMultiWindow | app.Context.page.isMultiWindow} instead
|
4109
4109
|
*
|
4110
4110
|
* Indication whether the tab is in a pop out window
|
4111
4111
|
*/
|
4112
4112
|
isMultiWindow?: boolean;
|
4113
4113
|
/**
|
4114
4114
|
* @deprecated
|
4115
|
-
* As of
|
4115
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.isBackgroundLoad | app.Context.page.isBackgroundLoad} instead
|
4116
|
+
*
|
4117
|
+
* Indication whether the tab is being loaded in the background
|
4118
|
+
*/
|
4119
|
+
isBackgroundLoad?: boolean;
|
4120
|
+
/**
|
4121
|
+
* @deprecated
|
4122
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.iconPositionVertical | app.Context.app.iconPositionVertical} instead
|
4116
4123
|
*
|
4117
4124
|
* Personal app icon y coordinate position
|
4118
4125
|
*/
|
4119
4126
|
appIconPosition?: number;
|
4120
4127
|
/**
|
4121
4128
|
* @deprecated
|
4122
|
-
* As of
|
4129
|
+
* As of TeamsJS v2.0.0, please use {@link app.PageInfo.sourceOrigin | app.Context.page.sourceOrigin} instead
|
4123
4130
|
*
|
4124
4131
|
* Source origin from where the tab is opened
|
4125
4132
|
*/
|
4126
4133
|
sourceOrigin?: string;
|
4127
4134
|
/**
|
4128
4135
|
* @deprecated
|
4129
|
-
* As of
|
4136
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} instead
|
4130
4137
|
*
|
4131
4138
|
* Time when the user clicked on the tab
|
4132
4139
|
*/
|
4133
4140
|
userClickTime?: number;
|
4134
4141
|
/**
|
4135
4142
|
* @deprecated
|
4136
|
-
* As of
|
4143
|
+
* As of TeamsJS v2.0.0, please use {@link app.TeamInfo.templateId | app.Context.team.templateId} instead
|
4137
4144
|
*
|
4138
4145
|
* Team Template ID if there was a Team Template associated with the creation of the team.
|
4139
4146
|
*/
|
4140
4147
|
teamTemplateId?: string;
|
4141
4148
|
/**
|
4142
4149
|
* @deprecated
|
4143
|
-
* As of
|
4150
|
+
* As of TeamsJS v2.0.0, please use {@link app.AppInfo.userFileOpenPreference | app.Context.app.userFileOpenPreference} instead
|
4144
4151
|
*
|
4145
4152
|
* Where the user prefers the file to be opened from by default during file open
|
4146
4153
|
*/
|
4147
4154
|
userFileOpenPreference?: FileOpenPreference;
|
4148
4155
|
/**
|
4149
4156
|
* @deprecated
|
4150
|
-
* As of
|
4157
|
+
* As of TeamsJS v2.0.0, please use {@link app.UserInfo.displayName | app.Context.user.displayName} instead
|
4151
4158
|
*
|
4152
4159
|
* The address book name of the current user.
|
4153
4160
|
*/
|
4154
4161
|
userDisplayName?: string;
|
4155
4162
|
/**
|
4156
4163
|
* @deprecated
|
4157
|
-
* As of
|
4164
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteId | app.Context.sharePointSite.teamSiteId} instead
|
4158
4165
|
*
|
4159
4166
|
* Teamsite ID, aka sharepoint site id.
|
4160
4167
|
*/
|
4161
4168
|
teamSiteId?: string;
|
4162
4169
|
/**
|
4163
4170
|
* @deprecated
|
4164
|
-
* As of
|
4171
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.mySiteDomain | app.Context.sharePointSite.mySiteDomain} instead
|
4165
4172
|
*
|
4166
4173
|
* The SharePoint my site domain associated with the user.
|
4167
4174
|
*/
|
4168
4175
|
mySiteDomain?: string;
|
4169
4176
|
/**
|
4170
4177
|
* @deprecated
|
4171
|
-
* As of
|
4178
|
+
* As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.mySitePath | app.Context.sharePointSite.mySitePath} instead
|
4172
4179
|
*
|
4173
4180
|
* The SharePoint relative path to the current users mysite
|
4174
4181
|
*/
|
4175
4182
|
mySitePath?: string;
|
4176
4183
|
/**
|
4177
4184
|
* @deprecated
|
4178
|
-
* As of
|
4185
|
+
* As of TeamsJS v2.0.0, please use {@link app.Context.dialogParameters} instead
|
4179
4186
|
*
|
4180
4187
|
* When `processActionCommand` activates a dialog, this dialog should automatically fill in some fields with information. This information comes from M365 and is given to `processActionCommand` as `extractedParameters`.
|
4181
4188
|
* App developers need to use these `extractedParameters` in their dialog.
|
@@ -4202,7 +4209,7 @@ export interface ShareDeepLinkParameters {
|
|
4202
4209
|
}
|
4203
4210
|
/**
|
4204
4211
|
* @deprecated
|
4205
|
-
* As of
|
4212
|
+
* As of TeamsJS v2.0.0, please use {@link ShareDeepLinkParameters} instead.
|
4206
4213
|
*/
|
4207
4214
|
export interface DeepLinkParameters {
|
4208
4215
|
/**
|
@@ -4336,7 +4343,7 @@ export interface DialogInfo {
|
|
4336
4343
|
}
|
4337
4344
|
/**
|
4338
4345
|
* @deprecated
|
4339
|
-
* As of
|
4346
|
+
* As of TeamsJS v2.0.0, please use {@link DialogInfo} instead.
|
4340
4347
|
*/
|
4341
4348
|
export type TaskInfo = DialogInfo;
|
4342
4349
|
/**
|
@@ -4371,7 +4378,7 @@ export interface FrameInfo {
|
|
4371
4378
|
}
|
4372
4379
|
/**
|
4373
4380
|
* @deprecated
|
4374
|
-
* As of
|
4381
|
+
* As of TeamsJS v2.0.0, please use {@link FrameInfo} instead.
|
4375
4382
|
*/
|
4376
4383
|
export type FrameContext = FrameInfo;
|
4377
4384
|
/** Represents an error that occurs during the execution of an app or integration. */
|
@@ -4726,6 +4733,11 @@ export namespace app {
|
|
4726
4733
|
* Indication whether the page is in a pop out window
|
4727
4734
|
*/
|
4728
4735
|
isMultiWindow?: boolean;
|
4736
|
+
/**
|
4737
|
+
* Indicates whether the page is being loaded in the background as
|
4738
|
+
* part of an opt-in performance enhancement.
|
4739
|
+
*/
|
4740
|
+
isBackgroundLoad?: boolean;
|
4729
4741
|
/**
|
4730
4742
|
* Source origin from where the page is opened
|
4731
4743
|
*/
|
@@ -5010,10 +5022,35 @@ export namespace app {
|
|
5010
5022
|
*/
|
5011
5023
|
function registerOnThemeChangeHandler(handler: themeHandler): void;
|
5012
5024
|
/**
|
5013
|
-
*
|
5025
|
+
* This function opens deep links to other modules in the host such as chats or channels or
|
5026
|
+
* general-purpose links (to external websites). It should not be used for navigating to your
|
5027
|
+
* own or other apps.
|
5014
5028
|
*
|
5015
|
-
* @
|
5016
|
-
*
|
5029
|
+
* @remarks
|
5030
|
+
* If you need to navigate to your own or other apps, use:
|
5031
|
+
*
|
5032
|
+
* - {@link pages.currentApp.navigateToDefaultPage} for navigating to the default page of your own app
|
5033
|
+
* - {@link pages.currentApp.navigateTo} for navigating to a section of your own app
|
5034
|
+
* - {@link pages.navigateToApp} for navigating to other apps besides your own
|
5035
|
+
*
|
5036
|
+
* Many areas of functionality previously provided by deep links are now handled by strongly-typed functions in capabilities.
|
5037
|
+
* If your app is using a deep link to trigger these specific components, use the strongly-typed alternatives.
|
5038
|
+
* For example (this list is not exhaustive):
|
5039
|
+
* - To open an app installation dialog, use the {@link appInstallDialog} capability
|
5040
|
+
* - To start a call, use the {@link call} capability
|
5041
|
+
* - To open a chat, use the {@link chat} capability
|
5042
|
+
* - To open a dialog, use the {@link dialog} capability
|
5043
|
+
* - To create a new meeting, use the {@link calendar.composeMeeting} function
|
5044
|
+
* - To open a Stage View, use the {@link stageView} capability
|
5045
|
+
*
|
5046
|
+
* In each of these capabilities, you can use the `isSupported()` function to determine if the host supports that capability.
|
5047
|
+
* When using a deep link to trigger these components, there's no way to determine whether the host supports it.
|
5048
|
+
*
|
5049
|
+
* For more information on crafting deep links to the host, see [Configure deep links](https://learn.microsoft.com/microsoftteams/platform/concepts/build-and-test/deep-links)
|
5050
|
+
*
|
5051
|
+
* @param deepLink The host deep link or external web URL to which to navigate
|
5052
|
+
* @returns `Promise` that will be fulfilled when the navigation has initiated. A successful `Promise` resolution
|
5053
|
+
* does not necessarily indicate whether the target loaded successfully.
|
5017
5054
|
*/
|
5018
5055
|
function openLink(deepLink: string): Promise<void>;
|
5019
5056
|
/**
|
@@ -5754,13 +5791,12 @@ export namespace pages {
|
|
5754
5791
|
*/
|
5755
5792
|
function navigateCrossDomain(url: string): Promise<void>;
|
5756
5793
|
/**
|
5757
|
-
*
|
5758
|
-
*
|
5759
|
-
*
|
5760
|
-
*
|
5761
|
-
*
|
5762
|
-
* @
|
5763
|
-
* @returns a promise that will resolve if the navigation was successful
|
5794
|
+
* Used to navigate to apps other than your own.
|
5795
|
+
*
|
5796
|
+
* If you are looking to navigate within your own app, use {@link pages.currentApp.navigateToDefaultPage} or {@link pages.currentApp.navigateTo}
|
5797
|
+
*
|
5798
|
+
* @param params Parameters for the navigation
|
5799
|
+
* @returns a `Promise` that will resolve if the navigation was successful or reject if it was not
|
5764
5800
|
*/
|
5765
5801
|
function navigateToApp(params: NavigateToAppParams): Promise<void>;
|
5766
5802
|
/**
|
@@ -5790,24 +5826,24 @@ export namespace pages {
|
|
5790
5826
|
*/
|
5791
5827
|
interface NavigateToAppParams {
|
5792
5828
|
/**
|
5793
|
-
* ID of the
|
5829
|
+
* ID of the app to navigate to
|
5794
5830
|
*/
|
5795
5831
|
appId: string;
|
5796
5832
|
/**
|
5797
|
-
* Developer-defined ID of the
|
5833
|
+
* Developer-defined ID of the page to navigate to within the app (formerly called `entityId`)
|
5798
5834
|
*/
|
5799
5835
|
pageId: string;
|
5800
5836
|
/**
|
5801
|
-
*
|
5837
|
+
* Fallback URL to open if the navigation cannot be completed within the host (e.g. if the target app is not installed)
|
5802
5838
|
*/
|
5803
5839
|
webUrl?: string;
|
5804
5840
|
/**
|
5805
|
-
*
|
5806
|
-
*
|
5841
|
+
* Developer-defined ID describing the content to navigate to within the page. This ID is passed to the application
|
5842
|
+
* via the {@link app.PageInfo.subPageId} property on the {@link app.Context} object (retrieved by calling {@link app.getContext})
|
5807
5843
|
*/
|
5808
5844
|
subPageId?: string;
|
5809
5845
|
/**
|
5810
|
-
*
|
5846
|
+
* For apps installed as a channel tab, this ID can be supplied to indicate in which Teams channel the app should be opened
|
5811
5847
|
*/
|
5812
5848
|
channelId?: string;
|
5813
5849
|
}
|
@@ -6075,16 +6111,19 @@ export namespace pages {
|
|
6075
6111
|
function isSupported(): boolean;
|
6076
6112
|
}
|
6077
6113
|
/**
|
6078
|
-
* Provides functions for navigating
|
6114
|
+
* Provides functions for navigating within your own app
|
6115
|
+
*
|
6116
|
+
* @remarks
|
6117
|
+
* If you are looking to navigate to a different app, use {@link pages.navigateToApp}.
|
6079
6118
|
*/
|
6080
6119
|
namespace currentApp {
|
6081
6120
|
/**
|
6082
|
-
* Parameters
|
6121
|
+
* Parameters provided to the {@link pages.currentApp.navigateTo} function
|
6083
6122
|
*/
|
6084
6123
|
interface NavigateWithinAppParams {
|
6085
6124
|
/**
|
6086
6125
|
* The developer-defined unique ID for the page defined in the manifest or when first configuring
|
6087
|
-
* the page. (Known as {@linkcode Context.entityId} prior to TeamsJS
|
6126
|
+
* the page. (Known as {@linkcode Context.entityId} prior to TeamsJS v2.0.0)
|
6088
6127
|
*/
|
6089
6128
|
pageId: string;
|
6090
6129
|
/**
|
@@ -6094,15 +6133,20 @@ export namespace pages {
|
|
6094
6133
|
subPageId?: string;
|
6095
6134
|
}
|
6096
6135
|
/**
|
6097
|
-
* Navigate within the currently running
|
6098
|
-
*
|
6099
|
-
* @
|
6100
|
-
*
|
6136
|
+
* Navigate within the currently running app
|
6137
|
+
*
|
6138
|
+
* @remarks
|
6139
|
+
* If you are looking to navigate to a different app, use {@link pages.navigateToApp}.
|
6140
|
+
*
|
6141
|
+
* @param params Parameters for the navigation
|
6142
|
+
* @returns `Promise` that will resolve if the navigation was successful and reject if not
|
6101
6143
|
*/
|
6102
6144
|
function navigateTo(params: NavigateWithinAppParams): Promise<void>;
|
6103
6145
|
/**
|
6104
|
-
* Navigate to the currently running
|
6146
|
+
* Navigate to the currently running app's first static page defined in the application
|
6105
6147
|
* manifest.
|
6148
|
+
*
|
6149
|
+
* @returns `Promise` that will resolve if the navigation was successful and reject if not
|
6106
6150
|
*/
|
6107
6151
|
function navigateToDefaultPage(): Promise<void>;
|
6108
6152
|
/**
|
@@ -7828,7 +7872,7 @@ export namespace monetization {
|
|
7828
7872
|
function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
|
7829
7873
|
/**
|
7830
7874
|
* @deprecated
|
7831
|
-
* As of
|
7875
|
+
* As of TeamsJS v2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
|
7832
7876
|
*
|
7833
7877
|
* @hidden
|
7834
7878
|
* Open dialog to start user's purchase experience
|
@@ -8082,7 +8126,7 @@ export namespace people {
|
|
8082
8126
|
function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
|
8083
8127
|
/**
|
8084
8128
|
* @deprecated
|
8085
|
-
* As of
|
8129
|
+
* As of TeamsJS v2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
|
8086
8130
|
*
|
8087
8131
|
* Launches a people picker and allows the user to select one or more people from the list
|
8088
8132
|
* If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
|
@@ -8634,7 +8678,7 @@ export namespace sharing {
|
|
8634
8678
|
export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
|
8635
8679
|
/**
|
8636
8680
|
* @deprecated
|
8637
|
-
* As of
|
8681
|
+
* As of TeamsJS v2.0.0, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
|
8638
8682
|
*
|
8639
8683
|
* Feature is under development
|
8640
8684
|
* Opens a share dialog for web content
|
@@ -9063,46 +9107,46 @@ export namespace call {
|
|
9063
9107
|
export namespace appInitialization {
|
9064
9108
|
/**
|
9065
9109
|
* @deprecated
|
9066
|
-
* As of
|
9110
|
+
* As of TeamsJS v2.0.0, please use {@link app.Messages} instead.
|
9067
9111
|
*/
|
9068
9112
|
export import Messages = app.Messages;
|
9069
9113
|
/**
|
9070
9114
|
* @deprecated
|
9071
|
-
* As of
|
9115
|
+
* As of TeamsJS v2.0.0, please use {@link app.FailedReason} instead.
|
9072
9116
|
*/
|
9073
9117
|
export import FailedReason = app.FailedReason;
|
9074
9118
|
/**
|
9075
9119
|
* @deprecated
|
9076
|
-
* As of
|
9120
|
+
* As of TeamsJS v2.0.0, please use {@link app.ExpectedFailureReason} instead.
|
9077
9121
|
*/
|
9078
9122
|
export import ExpectedFailureReason = app.ExpectedFailureReason;
|
9079
9123
|
/**
|
9080
9124
|
* @deprecated
|
9081
|
-
* As of
|
9125
|
+
* As of TeamsJS v2.0.0, please use {@link app.IFailedRequest} instead.
|
9082
9126
|
*/
|
9083
9127
|
export import IFailedRequest = app.IFailedRequest;
|
9084
9128
|
/**
|
9085
9129
|
* @deprecated
|
9086
|
-
* As of
|
9130
|
+
* As of TeamsJS v2.0.0, please use {@link app.IExpectedFailureRequest} instead.
|
9087
9131
|
*/
|
9088
9132
|
export import IExpectedFailureRequest = app.IExpectedFailureRequest;
|
9089
9133
|
/**
|
9090
9134
|
* @deprecated
|
9091
|
-
* As of
|
9135
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
|
9092
9136
|
*
|
9093
9137
|
* Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
|
9094
9138
|
*/
|
9095
9139
|
function notifyAppLoaded(): void;
|
9096
9140
|
/**
|
9097
9141
|
* @deprecated
|
9098
|
-
* As of
|
9142
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
|
9099
9143
|
*
|
9100
9144
|
* Notifies the frame that app initialization is successful and is ready for user interaction.
|
9101
9145
|
*/
|
9102
9146
|
function notifySuccess(): void;
|
9103
9147
|
/**
|
9104
9148
|
* @deprecated
|
9105
|
-
* As of
|
9149
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
|
9106
9150
|
*
|
9107
9151
|
* Notifies the frame that app initialization has failed and to show an error page in its place.
|
9108
9152
|
* @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
|
@@ -9111,7 +9155,7 @@ export namespace appInitialization {
|
|
9111
9155
|
function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
|
9112
9156
|
/**
|
9113
9157
|
* @deprecated
|
9114
|
-
* As of
|
9158
|
+
* As of TeamsJS v2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
|
9115
9159
|
*
|
9116
9160
|
* Notifies the frame that app initialized with some expected errors.
|
9117
9161
|
* @param expectedFailureRequest - The expected failure request containing the reason and an optional message
|
@@ -9233,7 +9277,7 @@ export namespace thirdPartyCloudStorage {
|
|
9233
9277
|
function isSupported(): boolean;
|
9234
9278
|
}
|
9235
9279
|
|
9236
|
-
/**
|
9280
|
+
/** Type of callback used to indicate when {@link executeDeepLink} completes */
|
9237
9281
|
export type executeDeepLinkOnCompleteFunctionType = (status: boolean, reason?: string) => void;
|
9238
9282
|
/** Callback function type */
|
9239
9283
|
export type callbackFunctionType = () => void;
|
@@ -9249,7 +9293,7 @@ export type registerFullScreenHandlerFunctionType = (isFullScreen: boolean) => v
|
|
9249
9293
|
export type registerOnThemeChangeHandlerFunctionType = (theme: string) => void;
|
9250
9294
|
/**
|
9251
9295
|
* @deprecated
|
9252
|
-
* As of
|
9296
|
+
* As of TeamsJS v2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
|
9253
9297
|
*
|
9254
9298
|
* Initializes the library. This must be called before any other SDK calls
|
9255
9299
|
* but after the frame is loaded successfully.
|
@@ -9260,21 +9304,21 @@ export type registerOnThemeChangeHandlerFunctionType = (theme: string) => void;
|
|
9260
9304
|
export function initialize(callback?: callbackFunctionType, validMessageOrigins?: string[]): void;
|
9261
9305
|
/**
|
9262
9306
|
* @deprecated
|
9263
|
-
* As of
|
9307
|
+
* As of TeamsJS v2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
|
9264
9308
|
*
|
9265
9309
|
* Enable print capability to support printing page using Ctrl+P and cmd+P
|
9266
9310
|
*/
|
9267
9311
|
export function enablePrintCapability(): void;
|
9268
9312
|
/**
|
9269
9313
|
* @deprecated
|
9270
|
-
* As of
|
9314
|
+
* As of TeamsJS v2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
|
9271
9315
|
*
|
9272
9316
|
* Default print handler
|
9273
9317
|
*/
|
9274
9318
|
export function print(): void;
|
9275
9319
|
/**
|
9276
9320
|
* @deprecated
|
9277
|
-
* As of
|
9321
|
+
* As of TeamsJS v2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
|
9278
9322
|
*
|
9279
9323
|
* Retrieves the current context the frame is running in.
|
9280
9324
|
*
|
@@ -9283,7 +9327,7 @@ export function print(): void;
|
|
9283
9327
|
export function getContext(callback: getContextCallbackFunctionType): void;
|
9284
9328
|
/**
|
9285
9329
|
* @deprecated
|
9286
|
-
* As of
|
9330
|
+
* As of TeamsJS v2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void} instead.
|
9287
9331
|
*
|
9288
9332
|
* Registers a handler for theme changes.
|
9289
9333
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
@@ -9293,7 +9337,7 @@ export function getContext(callback: getContextCallbackFunctionType): void;
|
|
9293
9337
|
export function registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void;
|
9294
9338
|
/**
|
9295
9339
|
* @deprecated
|
9296
|
-
* As of
|
9340
|
+
* As of TeamsJS v2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void} instead.
|
9297
9341
|
*
|
9298
9342
|
* Registers a handler for changes from or to full-screen view for a tab.
|
9299
9343
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
@@ -9303,7 +9347,7 @@ export function registerOnThemeChangeHandler(handler: registerOnThemeChangeHandl
|
|
9303
9347
|
export function registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void;
|
9304
9348
|
/**
|
9305
9349
|
* @deprecated
|
9306
|
-
* As of
|
9350
|
+
* As of TeamsJS v2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: callbackFunctionType): void} instead.
|
9307
9351
|
*
|
9308
9352
|
* Registers a handler for clicking the app button.
|
9309
9353
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
@@ -9313,7 +9357,7 @@ export function registerFullScreenHandler(handler: registerFullScreenHandlerFunc
|
|
9313
9357
|
export function registerAppButtonClickHandler(handler: callbackFunctionType): void;
|
9314
9358
|
/**
|
9315
9359
|
* @deprecated
|
9316
|
-
* As of
|
9360
|
+
* As of TeamsJS v2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: callbackFunctionType): void} instead.
|
9317
9361
|
*
|
9318
9362
|
* Registers a handler for entering hover of the app button.
|
9319
9363
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
@@ -9323,7 +9367,7 @@ export function registerAppButtonClickHandler(handler: callbackFunctionType): vo
|
|
9323
9367
|
export function registerAppButtonHoverEnterHandler(handler: callbackFunctionType): void;
|
9324
9368
|
/**
|
9325
9369
|
* @deprecated
|
9326
|
-
* As of
|
9370
|
+
* As of TeamsJS v2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: callbackFunctionType): void} instead.
|
9327
9371
|
*
|
9328
9372
|
* Registers a handler for exiting hover of the app button.
|
9329
9373
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
@@ -9333,7 +9377,7 @@ export function registerAppButtonHoverEnterHandler(handler: callbackFunctionType
|
|
9333
9377
|
export function registerAppButtonHoverLeaveHandler(handler: callbackFunctionType): void;
|
9334
9378
|
/**
|
9335
9379
|
* @deprecated
|
9336
|
-
* As of
|
9380
|
+
* As of TeamsJS v2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void} instead.
|
9337
9381
|
*
|
9338
9382
|
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
|
9339
9383
|
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
|
@@ -9345,7 +9389,7 @@ export function registerAppButtonHoverLeaveHandler(handler: callbackFunctionType
|
|
9345
9389
|
export function registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void;
|
9346
9390
|
/**
|
9347
9391
|
* @deprecated
|
9348
|
-
* As of
|
9392
|
+
* As of TeamsJS v2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
|
9349
9393
|
*
|
9350
9394
|
* @hidden
|
9351
9395
|
* Registers a handler to be called when the page has been requested to load.
|
@@ -9355,7 +9399,7 @@ export function registerBackButtonHandler(handler: registerBackButtonHandlerFunc
|
|
9355
9399
|
export function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
|
9356
9400
|
/**
|
9357
9401
|
* @deprecated
|
9358
|
-
* As of
|
9402
|
+
* As of TeamsJS v2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void} instead.
|
9359
9403
|
*
|
9360
9404
|
* @hidden
|
9361
9405
|
* Registers a handler to be called before the page is unloaded.
|
@@ -9366,7 +9410,7 @@ export function registerOnLoadHandler(handler: (context: LoadContext) => void):
|
|
9366
9410
|
export function registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void;
|
9367
9411
|
/**
|
9368
9412
|
* @deprecated
|
9369
|
-
* As of
|
9413
|
+
* As of TeamsJS v2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
|
9370
9414
|
*
|
9371
9415
|
* @hidden
|
9372
9416
|
* Registers a handler when focus needs to be passed from teams to the place of choice on app.
|
@@ -9376,7 +9420,7 @@ export function registerBeforeUnloadHandler(handler: (readyToUnload: callbackFun
|
|
9376
9420
|
export function registerFocusEnterHandler(handler: (navigateForward: boolean) => boolean): void;
|
9377
9421
|
/**
|
9378
9422
|
* @deprecated
|
9379
|
-
* As of
|
9423
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void} instead.
|
9380
9424
|
*
|
9381
9425
|
* Registers a handler for when the user reconfigurated tab.
|
9382
9426
|
*
|
@@ -9385,7 +9429,7 @@ export function registerFocusEnterHandler(handler: (navigateForward: boolean) =>
|
|
9385
9429
|
export function registerChangeSettingsHandler(handler: callbackFunctionType): void;
|
9386
9430
|
/**
|
9387
9431
|
* @deprecated
|
9388
|
-
* As of
|
9432
|
+
* As of TeamsJS v2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
|
9389
9433
|
*
|
9390
9434
|
* Allows an app to retrieve for this user tabs that are owned by this app.
|
9391
9435
|
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
|
@@ -9396,7 +9440,7 @@ export function registerChangeSettingsHandler(handler: callbackFunctionType): vo
|
|
9396
9440
|
export function getTabInstances(callback: getTabInstancesCallbackFunctionType, tabInstanceParameters?: TabInstanceParameters): void;
|
9397
9441
|
/**
|
9398
9442
|
* @deprecated
|
9399
|
-
* As of
|
9443
|
+
* As of TeamsJS v2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
|
9400
9444
|
*
|
9401
9445
|
* Allows an app to retrieve the most recently used tabs for this user.
|
9402
9446
|
*
|
@@ -9406,7 +9450,7 @@ export function getTabInstances(callback: getTabInstancesCallbackFunctionType, t
|
|
9406
9450
|
export function getMruTabInstances(callback: getTabInstancesCallbackFunctionType, tabInstanceParameters?: TabInstanceParameters): void;
|
9407
9451
|
/**
|
9408
9452
|
* @deprecated
|
9409
|
-
* As of
|
9453
|
+
* As of TeamsJS v2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
|
9410
9454
|
*
|
9411
9455
|
* Shares a deep link that a user can use to navigate back to a specific state in this page.
|
9412
9456
|
*
|
@@ -9415,16 +9459,21 @@ export function getMruTabInstances(callback: getTabInstancesCallbackFunctionType
|
|
9415
9459
|
export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
|
9416
9460
|
/**
|
9417
9461
|
* @deprecated
|
9418
|
-
* As of
|
9462
|
+
* This function was previously used for opening various types of links. As of TeamsJS v2.0.0, it has been replaced with multiple different
|
9463
|
+
* functions depending on the type of link:
|
9419
9464
|
*
|
9420
|
-
*
|
9465
|
+
* - Use {@link pages.currentApp.navigateToDefaultPage} to navigate to the default page of your own app
|
9466
|
+
* - Use {@link pages.currentApp.navigateTo} to navigate to a section of your own app
|
9467
|
+
* - Use {@link pages.navigateToApp} to navigate to other apps besides your own
|
9468
|
+
* - Use {@link app.openLink} for opening deep links to other parts of the host (e.g., to chats or channels) or
|
9469
|
+
* general-purpose links (e.g., to external websites).
|
9421
9470
|
*
|
9422
|
-
* @param deepLink
|
9471
|
+
* @param deepLink deep link.
|
9423
9472
|
*/
|
9424
9473
|
export function executeDeepLink(deepLink: string, onComplete?: executeDeepLinkOnCompleteFunctionType): void;
|
9425
9474
|
/**
|
9426
9475
|
* @deprecated
|
9427
|
-
* As of
|
9476
|
+
* As of TeamsJS v2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
|
9428
9477
|
*
|
9429
9478
|
* Set the current Frame Context
|
9430
9479
|
*
|
@@ -9433,7 +9482,7 @@ export function executeDeepLink(deepLink: string, onComplete?: executeDeepLinkOn
|
|
9433
9482
|
export function setFrameContext(frameContext: FrameContext): void;
|
9434
9483
|
/**
|
9435
9484
|
* @deprecated
|
9436
|
-
* As of
|
9485
|
+
* As of TeamsJS v2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void} instead.
|
9437
9486
|
*
|
9438
9487
|
* Initialize with FrameContext
|
9439
9488
|
*
|
@@ -9448,7 +9497,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
|
|
9448
9497
|
export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
|
9449
9498
|
/**
|
9450
9499
|
* @deprecated
|
9451
|
-
* As of
|
9500
|
+
* As of TeamsJS v2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
|
9452
9501
|
*
|
9453
9502
|
* Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
|
9454
9503
|
*
|
@@ -9457,7 +9506,7 @@ export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) =
|
|
9457
9506
|
export function returnFocus(navigateForward?: boolean): void;
|
9458
9507
|
/**
|
9459
9508
|
* @deprecated
|
9460
|
-
* As of
|
9509
|
+
* As of TeamsJS v2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
|
9461
9510
|
*
|
9462
9511
|
* Navigates the Microsoft Teams app to the specified tab instance.
|
9463
9512
|
*
|
@@ -9467,7 +9516,7 @@ export function returnFocus(navigateForward?: boolean): void;
|
|
9467
9516
|
export function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteHandlerFunctionType): void;
|
9468
9517
|
/**
|
9469
9518
|
* @deprecated
|
9470
|
-
* As of
|
9519
|
+
* As of TeamsJS v2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
|
9471
9520
|
*
|
9472
9521
|
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
|
9473
9522
|
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
|
@@ -9481,7 +9530,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteH
|
|
9481
9530
|
export function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerFunctionType): void;
|
9482
9531
|
/**
|
9483
9532
|
* @deprecated
|
9484
|
-
* As of
|
9533
|
+
* As of TeamsJS v2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
|
9485
9534
|
*
|
9486
9535
|
* Navigates back in the Teams client.
|
9487
9536
|
* See registerBackButtonHandler for more information on when it's appropriate to use this method.
|
@@ -9492,7 +9541,7 @@ export function navigateBack(onComplete?: onCompleteHandlerFunctionType): void;
|
|
9492
9541
|
|
9493
9542
|
/**
|
9494
9543
|
* @deprecated
|
9495
|
-
* As of
|
9544
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config} namespace instead.
|
9496
9545
|
*
|
9497
9546
|
* Namespace to interact with the settings-specific part of the SDK.
|
9498
9547
|
* This object is usable only on the settings frame.
|
@@ -9508,35 +9557,35 @@ export namespace settings {
|
|
9508
9557
|
type getSettingsCallbackFunctionType = (instanceSettings: Settings) => void;
|
9509
9558
|
/**
|
9510
9559
|
* @deprecated
|
9511
|
-
* As of
|
9560
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.Config} instead.
|
9512
9561
|
* @remarks
|
9513
9562
|
* Renamed to config in pages.Config
|
9514
9563
|
*/
|
9515
9564
|
export import Settings = pages.InstanceConfig;
|
9516
9565
|
/**
|
9517
9566
|
* @deprecated
|
9518
|
-
* As of
|
9567
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.SaveEvent} instead.
|
9519
9568
|
* @remarks
|
9520
9569
|
* See pages.SaveEvent
|
9521
9570
|
*/
|
9522
9571
|
export import SaveEvent = pages.config.SaveEvent;
|
9523
9572
|
/**
|
9524
9573
|
* @deprecated
|
9525
|
-
* As of
|
9574
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.RemoveEvent} instead.
|
9526
9575
|
* @remarks
|
9527
9576
|
* See pages.RemoveEvent
|
9528
9577
|
*/
|
9529
9578
|
export import RemoveEvent = pages.config.RemoveEvent;
|
9530
9579
|
/**
|
9531
9580
|
* @deprecated
|
9532
|
-
* As of
|
9581
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.SaveParameters} instead.
|
9533
9582
|
* @remarks
|
9534
9583
|
* See pages.SaveParameters
|
9535
9584
|
*/
|
9536
9585
|
export import SaveParameters = pages.config.SaveParameters;
|
9537
9586
|
/**
|
9538
9587
|
* @deprecated
|
9539
|
-
* As of
|
9588
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
|
9540
9589
|
*
|
9541
9590
|
* Sets the validity state for the settings.
|
9542
9591
|
* The initial value is false, so the user cannot save the settings until this is called with true.
|
@@ -9546,7 +9595,7 @@ export namespace settings {
|
|
9546
9595
|
function setValidityState(validityState: boolean): void;
|
9547
9596
|
/**
|
9548
9597
|
* @deprecated
|
9549
|
-
* As of
|
9598
|
+
* As of TeamsJS v2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
|
9550
9599
|
*
|
9551
9600
|
* Gets the settings for the current instance.
|
9552
9601
|
*
|
@@ -9555,7 +9604,7 @@ export namespace settings {
|
|
9555
9604
|
function getSettings(callback: getSettingsCallbackFunctionType): void;
|
9556
9605
|
/**
|
9557
9606
|
* @deprecated
|
9558
|
-
* As of
|
9607
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
|
9559
9608
|
*
|
9560
9609
|
* Sets the settings for the current instance.
|
9561
9610
|
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
|
@@ -9565,7 +9614,7 @@ export namespace settings {
|
|
9565
9614
|
function setSettings(instanceSettings: Settings, onComplete?: setSettingsOnCompleteFunctionType): void;
|
9566
9615
|
/**
|
9567
9616
|
* @deprecated
|
9568
|
-
* As of
|
9617
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead.
|
9569
9618
|
*
|
9570
9619
|
* Registers a handler for when the user attempts to save the settings. This handler should be used
|
9571
9620
|
* to create or update the underlying resource powering the content.
|
@@ -9577,7 +9626,7 @@ export namespace settings {
|
|
9577
9626
|
function registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void;
|
9578
9627
|
/**
|
9579
9628
|
* @deprecated
|
9580
|
-
* As of
|
9629
|
+
* As of TeamsJS v2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
|
9581
9630
|
*
|
9582
9631
|
* Registers a handler for user attempts to remove content. This handler should be used
|
9583
9632
|
* to remove the underlying resource powering the content.
|
@@ -9591,7 +9640,7 @@ export namespace settings {
|
|
9591
9640
|
|
9592
9641
|
/**
|
9593
9642
|
* @deprecated
|
9594
|
-
* As of
|
9643
|
+
* As of TeamsJS v2.0.0, please use {@link dialog} namespace instead.
|
9595
9644
|
*
|
9596
9645
|
* Namespace to interact with the task module-specific part of the SDK.
|
9597
9646
|
* This object is usable only on the content frame.
|
@@ -9624,7 +9673,7 @@ export namespace tasks {
|
|
9624
9673
|
function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
|
9625
9674
|
/**
|
9626
9675
|
* @deprecated
|
9627
|
-
* As of
|
9676
|
+
* As of TeamsJS v2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
|
9628
9677
|
*
|
9629
9678
|
* Update height/width task info properties.
|
9630
9679
|
*
|