@microsoft/teams-js 2.0.0-beta.7-dev.4 → 2.0.0-beta.7-dev.7
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 +186 -136
- package/dist/MicrosoftTeams.js +153 -105
- 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
|
@@ -200,7 +200,7 @@ export function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolea
|
|
|
200
200
|
/**
|
|
201
201
|
* @hidden
|
|
202
202
|
* Internal use only
|
|
203
|
-
* Sends a custom action MessageRequest to
|
|
203
|
+
* Sends a custom action MessageRequest to host or parent window
|
|
204
204
|
*
|
|
205
205
|
* @param actionName - Specifies name of the custom action to be sent
|
|
206
206
|
* @param args - Specifies additional arguments passed to the action
|
|
@@ -693,7 +693,7 @@ export namespace files {
|
|
|
693
693
|
* Hide from docs
|
|
694
694
|
* ------
|
|
695
695
|
*
|
|
696
|
-
* Open a cloud storage file in
|
|
696
|
+
* Open a cloud storage file in Teams
|
|
697
697
|
*
|
|
698
698
|
* @param file - cloud storage file that should be opened
|
|
699
699
|
* @param providerCode - Code of the cloud storage folder provider
|
|
@@ -736,6 +736,9 @@ export namespace files {
|
|
|
736
736
|
}
|
|
737
737
|
|
|
738
738
|
/**
|
|
739
|
+
* @hidden
|
|
740
|
+
* Hide from docs
|
|
741
|
+
* ------
|
|
739
742
|
* @internal
|
|
740
743
|
*/
|
|
741
744
|
export namespace legacy {
|
|
@@ -751,6 +754,14 @@ export namespace legacy {
|
|
|
751
754
|
* @returns Promise resolved containing information about the user joined teams or rejected with error
|
|
752
755
|
*/
|
|
753
756
|
function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
|
|
757
|
+
/**
|
|
758
|
+
* @hidden
|
|
759
|
+
* Hide from docs
|
|
760
|
+
* ------
|
|
761
|
+
* Checks if teams.fullTrust.joinedTeams capability is supported by the host
|
|
762
|
+
* @returns true if the teams.fullTrust.joinedTeams capability is enabled in
|
|
763
|
+
* runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
|
|
764
|
+
*/
|
|
754
765
|
function isSupported(): boolean;
|
|
755
766
|
}
|
|
756
767
|
/**
|
|
@@ -764,12 +775,22 @@ export namespace legacy {
|
|
|
764
775
|
*/
|
|
765
776
|
function getConfigSetting(key: string): Promise<string>;
|
|
766
777
|
/**
|
|
767
|
-
*
|
|
778
|
+
* @hidden
|
|
779
|
+
* Hide from docs
|
|
780
|
+
* ------
|
|
781
|
+
* Checks if teams.fullTrust capability is supported by the host
|
|
782
|
+
* @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
|
|
783
|
+
* false if it is disabled
|
|
768
784
|
*/
|
|
769
785
|
function isSupported(): boolean;
|
|
770
786
|
}
|
|
771
787
|
/**
|
|
772
|
-
*
|
|
788
|
+
* @hidden
|
|
789
|
+
* Hide from docs
|
|
790
|
+
* ------
|
|
791
|
+
* Checks if teams capability is supported by the host
|
|
792
|
+
* @returns true if the teams capability is enabled in runtime.supports.teams and
|
|
793
|
+
* false if it is disabled
|
|
773
794
|
*/
|
|
774
795
|
function isSupported(): boolean;
|
|
775
796
|
}
|
|
@@ -1183,7 +1204,7 @@ export namespace appEntity {
|
|
|
1183
1204
|
interface AppEntity {
|
|
1184
1205
|
/**
|
|
1185
1206
|
* @hidden
|
|
1186
|
-
*
|
|
1207
|
+
* ID of the application
|
|
1187
1208
|
*/
|
|
1188
1209
|
appId: string;
|
|
1189
1210
|
/**
|
|
@@ -1213,14 +1234,19 @@ export namespace appEntity {
|
|
|
1213
1234
|
* --------
|
|
1214
1235
|
* Open the Tab Gallery and retrieve the app entity
|
|
1215
1236
|
* @param threadId ID of the thread where the app entity will be created
|
|
1216
|
-
* @param categories A list of
|
|
1237
|
+
* @param categories A list of application categories that will be displayed in the opened tab gallery
|
|
1217
1238
|
* @param subEntityId An object that will be made available to the application being configured
|
|
1218
|
-
* through the
|
|
1239
|
+
* through the Context's subEntityId field.
|
|
1219
1240
|
* @param callback Callback that will be triggered once the app entity information is available.
|
|
1220
1241
|
* The callback takes two arguments: an SdkError in case something happened (i.e.
|
|
1221
1242
|
* no permissions to execute the API) and the app entity configuration, if available
|
|
1222
1243
|
*/
|
|
1223
1244
|
function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
|
|
1245
|
+
/**
|
|
1246
|
+
* Checks if appEntity capability is supported by the host
|
|
1247
|
+
* @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
|
|
1248
|
+
* false if it is disabled
|
|
1249
|
+
*/
|
|
1224
1250
|
function isSupported(): boolean;
|
|
1225
1251
|
}
|
|
1226
1252
|
|
|
@@ -1263,6 +1289,12 @@ export namespace teams {
|
|
|
1263
1289
|
* provided, the threadId from route params will be used.
|
|
1264
1290
|
*/
|
|
1265
1291
|
function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
|
|
1292
|
+
/**
|
|
1293
|
+
* @hidden
|
|
1294
|
+
* Checks if teams capability is supported by the host
|
|
1295
|
+
* @returns true if the teams capability is enabled in runtime.supports.teams and
|
|
1296
|
+
* false if it is disabled
|
|
1297
|
+
*/
|
|
1266
1298
|
function isSupported(): boolean;
|
|
1267
1299
|
}
|
|
1268
1300
|
|
|
@@ -1563,7 +1595,7 @@ export enum HostClientType {
|
|
|
1563
1595
|
ipados = "ipados",
|
|
1564
1596
|
/**
|
|
1565
1597
|
* @deprecated
|
|
1566
|
-
* As of 2.0.0
|
|
1598
|
+
* As of 2.0.0, please use {@link teamsRoomsWindows} instead.
|
|
1567
1599
|
*/
|
|
1568
1600
|
rigel = "rigel",
|
|
1569
1601
|
surfaceHub = "surfaceHub",
|
|
@@ -1617,7 +1649,7 @@ export enum DialogDimension {
|
|
|
1617
1649
|
}
|
|
1618
1650
|
/**
|
|
1619
1651
|
* @deprecated
|
|
1620
|
-
* As of 2.0.0
|
|
1652
|
+
* As of 2.0.0, please use {@link DialogDimension} instead.
|
|
1621
1653
|
*/
|
|
1622
1654
|
export import TaskModuleDimension = DialogDimension;
|
|
1623
1655
|
/**
|
|
@@ -1771,8 +1803,13 @@ export enum FileOpenPreference {
|
|
|
1771
1803
|
}
|
|
1772
1804
|
/**
|
|
1773
1805
|
* @deprecated
|
|
1774
|
-
* As of 2.0.0
|
|
1775
|
-
*
|
|
1806
|
+
* As of 2.0.0, please use {@link app.Context} instead.
|
|
1807
|
+
*
|
|
1808
|
+
* @remarks
|
|
1809
|
+
* For more details on the updated {@link app.Context} interface, visit
|
|
1810
|
+
* {@link https://docs.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface}.
|
|
1811
|
+
*
|
|
1812
|
+
* Represents the structure of the received context message.
|
|
1776
1813
|
*/
|
|
1777
1814
|
export interface Context {
|
|
1778
1815
|
/**
|
|
@@ -1834,7 +1871,7 @@ export interface Context {
|
|
|
1834
1871
|
/**
|
|
1835
1872
|
* @hidden
|
|
1836
1873
|
* @deprecated
|
|
1837
|
-
* As of 2.0.0
|
|
1874
|
+
* As of 2.0.0, please use {@link loginHint} or {@link userPrincipalName} instead.
|
|
1838
1875
|
* The UPN of the current user.
|
|
1839
1876
|
* Because a malicious party can run your content in a browser, this value should
|
|
1840
1877
|
* be used only as a hint as to who the user is and never as proof of identity.
|
|
@@ -2082,7 +2119,7 @@ export interface ShareDeepLinkParameters {
|
|
|
2082
2119
|
}
|
|
2083
2120
|
/**
|
|
2084
2121
|
* @deprecated
|
|
2085
|
-
* As of 2.0.0
|
|
2122
|
+
* As of 2.0.0, please use {@link ShareDeepLinkParameters} instead.
|
|
2086
2123
|
*/
|
|
2087
2124
|
export interface DeepLinkParameters {
|
|
2088
2125
|
/**
|
|
@@ -2184,7 +2221,7 @@ export interface DialogInfo {
|
|
|
2184
2221
|
}
|
|
2185
2222
|
/**
|
|
2186
2223
|
* @deprecated
|
|
2187
|
-
* As of 2.0.0
|
|
2224
|
+
* As of 2.0.0, please use {@link DialogInfo} instead.
|
|
2188
2225
|
*/
|
|
2189
2226
|
export type TaskInfo = DialogInfo;
|
|
2190
2227
|
export interface DialogSize {
|
|
@@ -2221,7 +2258,7 @@ export interface FrameInfo {
|
|
|
2221
2258
|
}
|
|
2222
2259
|
/**
|
|
2223
2260
|
* @deprecated
|
|
2224
|
-
* As of 2.0.0
|
|
2261
|
+
* As of 2.0.0, please use {@link FrameInfo} instead.
|
|
2225
2262
|
*/
|
|
2226
2263
|
export type FrameContext = FrameInfo;
|
|
2227
2264
|
export interface SdkError {
|
|
@@ -3007,17 +3044,17 @@ export namespace dialog {
|
|
|
3007
3044
|
*/
|
|
3008
3045
|
export namespace pages {
|
|
3009
3046
|
/**
|
|
3010
|
-
* Return focus to the host. Will move focus forward or backward based on where the
|
|
3011
|
-
* the F6/
|
|
3047
|
+
* Return focus to the host. Will move focus forward or backward based on where the application container falls in
|
|
3048
|
+
* the F6/tab order in the host.
|
|
3012
3049
|
* @param navigateForward - Determines the direction to focus in host.
|
|
3013
3050
|
*/
|
|
3014
3051
|
function returnFocus(navigateForward?: boolean): void;
|
|
3015
3052
|
/**
|
|
3016
3053
|
* @hidden
|
|
3017
3054
|
*
|
|
3018
|
-
* Registers a handler
|
|
3055
|
+
* Registers a handler for specifying focus when it passes from the host to the application.
|
|
3019
3056
|
*
|
|
3020
|
-
* @param handler - The handler
|
|
3057
|
+
* @param handler - The handler for placing focus within the application.
|
|
3021
3058
|
*
|
|
3022
3059
|
* @internal
|
|
3023
3060
|
*/
|
|
@@ -3034,7 +3071,7 @@ export namespace pages {
|
|
|
3034
3071
|
*
|
|
3035
3072
|
* @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
|
|
3036
3073
|
* user clicks 'Go To Website'
|
|
3037
|
-
* @param callback - An optional
|
|
3074
|
+
* @param callback - An optional callback that is executed once the application has finished initialization.
|
|
3038
3075
|
* @param validMessageOrigins - An optional list of cross-frame message origins. They must have
|
|
3039
3076
|
* https: protocol otherwise they will be ignored. Example: https:www.example.com
|
|
3040
3077
|
*/
|
|
@@ -3074,19 +3111,19 @@ export namespace pages {
|
|
|
3074
3111
|
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
|
|
3075
3112
|
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
|
|
3076
3113
|
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
|
|
3077
|
-
* than the current one in a way that keeps the
|
|
3114
|
+
* than the current one in a way that keeps the application informed of the change and allows the SDK to
|
|
3078
3115
|
* continue working.
|
|
3079
3116
|
* @param url - The URL to navigate the frame to.
|
|
3080
3117
|
* @returns Promise that resolves when the navigation has completed.
|
|
3081
3118
|
*/
|
|
3082
3119
|
function navigateCrossDomain(url: string): Promise<void>;
|
|
3083
3120
|
/**
|
|
3084
|
-
* Navigate to the given
|
|
3085
|
-
* be navigated to, such as if it is not installed), Channel ID (for
|
|
3086
|
-
*
|
|
3087
|
-
* a deep link with the above data, but does not require the
|
|
3121
|
+
* Navigate to the given application ID and page ID, with optional parameters for a WebURL (if the application
|
|
3122
|
+
* cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab),
|
|
3123
|
+
* and sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
|
|
3124
|
+
* a deep link with the above data, but does not require the application to build a URL or worry about different
|
|
3088
3125
|
* deep link formats for different hosts.
|
|
3089
|
-
* @param params Parameters for the navigation
|
|
3126
|
+
* @param params - Parameters for the navigation
|
|
3090
3127
|
* @returns a promise that will resolve if the navigation was successful
|
|
3091
3128
|
*/
|
|
3092
3129
|
function navigateToApp(params: NavigateToAppParams): Promise<void>;
|
|
@@ -3103,7 +3140,7 @@ export namespace pages {
|
|
|
3103
3140
|
*/
|
|
3104
3141
|
function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
|
|
3105
3142
|
/**
|
|
3106
|
-
* Checks if the
|
|
3143
|
+
* Checks if the pages capability is supported by the host
|
|
3107
3144
|
* @returns true if the pages capability is enabled in runtime.supports.pages and
|
|
3108
3145
|
* false if it is disabled
|
|
3109
3146
|
*/
|
|
@@ -3113,11 +3150,11 @@ export namespace pages {
|
|
|
3113
3150
|
*/
|
|
3114
3151
|
interface NavigateToAppParams {
|
|
3115
3152
|
/**
|
|
3116
|
-
* ID of the
|
|
3153
|
+
* ID of the application to navigate to
|
|
3117
3154
|
*/
|
|
3118
3155
|
appId: string;
|
|
3119
3156
|
/**
|
|
3120
|
-
* Developer-defined ID of the Page to navigate to within the
|
|
3157
|
+
* Developer-defined ID of the Page to navigate to within the application (Formerly EntityID)
|
|
3121
3158
|
*/
|
|
3122
3159
|
pageId: string;
|
|
3123
3160
|
/**
|
|
@@ -3126,47 +3163,48 @@ export namespace pages {
|
|
|
3126
3163
|
webUrl?: string;
|
|
3127
3164
|
/**
|
|
3128
3165
|
* Optional developer-defined ID describing the content to navigate to within the Page. This will be passed
|
|
3129
|
-
* back to the
|
|
3166
|
+
* back to the application via the Context object.
|
|
3130
3167
|
*/
|
|
3131
3168
|
subPageId?: string;
|
|
3132
3169
|
/**
|
|
3133
|
-
* Optional ID of the Teams Channel where the
|
|
3170
|
+
* Optional ID of the Teams Channel where the application should be opened
|
|
3134
3171
|
*/
|
|
3135
3172
|
channelId?: string;
|
|
3136
3173
|
}
|
|
3137
3174
|
/**
|
|
3138
|
-
*
|
|
3175
|
+
* Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
|
|
3176
|
+
* contextual tabs are pages associated with a specific context, such as channel or chat.
|
|
3139
3177
|
*/
|
|
3140
3178
|
namespace tabs {
|
|
3141
3179
|
/**
|
|
3142
|
-
* Navigates the hosted
|
|
3143
|
-
* @param tabInstance The tab instance
|
|
3180
|
+
* Navigates the hosted application to the specified tab instance.
|
|
3181
|
+
* @param tabInstance - The destination tab instance.
|
|
3144
3182
|
* @returns Promise that resolves when the navigation has completed.
|
|
3145
3183
|
*/
|
|
3146
3184
|
function navigateToTab(tabInstance: TabInstance): Promise<void>;
|
|
3147
3185
|
/**
|
|
3148
|
-
*
|
|
3149
|
-
* If no TabInstanceParameters are passed, the
|
|
3150
|
-
* @param tabInstanceParameters
|
|
3186
|
+
* Retrieves application tabs for the current user.
|
|
3187
|
+
* If no TabInstanceParameters are passed, the application defaults to favorite teams and favorite channels.
|
|
3188
|
+
* @param tabInstanceParameters - An optional set of flags that specify whether to scope call to favorite teams or channels.
|
|
3151
3189
|
* @returns Promise that resolves with the {@link TabInformation}. Contains information for the user's tabs that are owned by this application {@link TabInstance}.
|
|
3152
3190
|
*/
|
|
3153
3191
|
function getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
|
|
3154
3192
|
/**
|
|
3155
|
-
*
|
|
3156
|
-
* @param tabInstanceParameters
|
|
3193
|
+
* Retrieves the most recently used application tabs for the current user.
|
|
3194
|
+
* @param tabInstanceParameters - An optional set of flags. Note this is currently ignored and kept for future use.
|
|
3157
3195
|
* @returns Promise that resolves with the {@link TabInformation}. Contains information for the users' most recently used tabs {@link TabInstance}.
|
|
3158
3196
|
*/
|
|
3159
3197
|
function getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
|
|
3160
3198
|
/**
|
|
3161
|
-
* Checks if the
|
|
3199
|
+
* Checks if the pages.tab capability is supported by the host
|
|
3162
3200
|
* @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
|
|
3163
3201
|
* false if it is disabled
|
|
3164
3202
|
*/
|
|
3165
3203
|
function isSupported(): boolean;
|
|
3166
3204
|
}
|
|
3167
3205
|
/**
|
|
3168
|
-
*
|
|
3169
|
-
* This object is usable only on the
|
|
3206
|
+
* Provides APIs to interact with the configuration-specific part of the SDK.
|
|
3207
|
+
* This object is usable only on the configuration frame.
|
|
3170
3208
|
*/
|
|
3171
3209
|
namespace config {
|
|
3172
3210
|
/**
|
|
@@ -3178,24 +3216,24 @@ export namespace pages {
|
|
|
3178
3216
|
*/
|
|
3179
3217
|
function initialize(): void;
|
|
3180
3218
|
/**
|
|
3181
|
-
* Sets the validity state for the
|
|
3182
|
-
* The initial value is false, so the user cannot save the
|
|
3183
|
-
* @param validityState Indicates whether the save or remove button is enabled for the user.
|
|
3219
|
+
* Sets the validity state for the configuration.
|
|
3220
|
+
* The initial value is false, so the user cannot save the configuration until this is called with true.
|
|
3221
|
+
* @param validityState - Indicates whether the save or remove button is enabled for the user.
|
|
3184
3222
|
*/
|
|
3185
3223
|
function setValidityState(validityState: boolean): void;
|
|
3186
3224
|
/**
|
|
3187
|
-
* Sets the
|
|
3225
|
+
* Sets the configuration for the current instance.
|
|
3188
3226
|
* This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
|
|
3189
|
-
* @param instanceConfig The desired
|
|
3227
|
+
* @param instanceConfig - The desired configuration for this instance.
|
|
3190
3228
|
* @returns Promise that resolves when the operation has completed.
|
|
3191
3229
|
*/
|
|
3192
3230
|
function setConfig(instanceConfig: InstanceConfig): Promise<void>;
|
|
3193
3231
|
/**
|
|
3194
|
-
* Registers a handler for when the user attempts to save the
|
|
3232
|
+
* Registers a handler for when the user attempts to save the configuration. This handler should be used
|
|
3195
3233
|
* to create or update the underlying resource powering the content.
|
|
3196
3234
|
* The object passed to the handler must be used to notify whether to proceed with the save.
|
|
3197
3235
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
3198
|
-
* @param handler The handler to invoke when the user selects the
|
|
3236
|
+
* @param handler - The handler to invoke when the user selects the Save button.
|
|
3199
3237
|
*/
|
|
3200
3238
|
function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
|
|
3201
3239
|
/**
|
|
@@ -3203,12 +3241,12 @@ export namespace pages {
|
|
|
3203
3241
|
* to remove the underlying resource powering the content.
|
|
3204
3242
|
* The object passed to the handler must be used to indicate whether to proceed with the removal.
|
|
3205
3243
|
* Only one handler may be registered at a time. Subsequent registrations will override the first.
|
|
3206
|
-
* @param handler The handler to invoke when the user selects the
|
|
3244
|
+
* @param handler - The handler to invoke when the user selects the Remove button.
|
|
3207
3245
|
*/
|
|
3208
3246
|
function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
|
|
3209
3247
|
/**
|
|
3210
3248
|
* Registers a handler for when the tab configuration is changed by the user
|
|
3211
|
-
* @param handler The handler to invoke when the user
|
|
3249
|
+
* @param handler - The handler to invoke when the user clicks on Settings.
|
|
3212
3250
|
*/
|
|
3213
3251
|
function registerChangeConfigHandler(handler: () => void): void;
|
|
3214
3252
|
/**
|
|
@@ -3226,7 +3264,7 @@ export namespace pages {
|
|
|
3226
3264
|
notifySuccess(): void;
|
|
3227
3265
|
/**
|
|
3228
3266
|
* Indicates that creation of the underlying resource failed and that the config cannot be saved.
|
|
3229
|
-
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
|
|
3267
|
+
* @param reason - Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
|
|
3230
3268
|
*/
|
|
3231
3269
|
notifyFailure(reason?: string): void;
|
|
3232
3270
|
}
|
|
@@ -3241,7 +3279,7 @@ export namespace pages {
|
|
|
3241
3279
|
notifySuccess(): void;
|
|
3242
3280
|
/**
|
|
3243
3281
|
* Indicates that removal of the underlying resource failed and that the content cannot be removed.
|
|
3244
|
-
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
|
|
3282
|
+
* @param reason - Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
|
|
3245
3283
|
*/
|
|
3246
3284
|
notifyFailure(reason?: string): void;
|
|
3247
3285
|
}
|
|
@@ -3255,33 +3293,32 @@ export namespace pages {
|
|
|
3255
3293
|
webhookUrl?: string;
|
|
3256
3294
|
}
|
|
3257
3295
|
/**
|
|
3258
|
-
* Checks if the
|
|
3296
|
+
* Checks if the pages.config capability is supported by the host
|
|
3259
3297
|
* @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
|
|
3260
3298
|
* false if it is disabled
|
|
3261
3299
|
*/
|
|
3262
3300
|
function isSupported(): boolean;
|
|
3263
3301
|
}
|
|
3264
3302
|
/**
|
|
3265
|
-
*
|
|
3303
|
+
* Provides APIs for handling the user's navigational history.
|
|
3266
3304
|
*/
|
|
3267
3305
|
namespace backStack {
|
|
3268
3306
|
function _initialize(): void;
|
|
3269
3307
|
/**
|
|
3270
|
-
* Navigates back in the hosted
|
|
3271
|
-
* it's appropriate to use this method.
|
|
3308
|
+
* Navigates back in the hosted application. See {@link pages.backStack.registerBackButtonHandler} for notes on usage.
|
|
3272
3309
|
* @returns Promise that resolves when the navigation has completed.
|
|
3273
3310
|
*/
|
|
3274
3311
|
function navigateBack(): Promise<void>;
|
|
3275
3312
|
/**
|
|
3276
|
-
* Registers a handler for user presses of the
|
|
3277
|
-
* navigation stack should use this handler to navigate the user back within their frame. If an
|
|
3313
|
+
* Registers a handler for user presses of the host client's back button. Experiences that maintain an internal
|
|
3314
|
+
* navigation stack should use this handler to navigate the user back within their frame. If an application finds
|
|
3278
3315
|
* that after running its back button handler it cannot handle the event it should call the navigateBack
|
|
3279
|
-
* method to ask the
|
|
3280
|
-
* @param handler The handler to invoke when the user presses
|
|
3316
|
+
* method to ask the host client to handle it instead.
|
|
3317
|
+
* @param handler - The handler to invoke when the user presses the host client's back button.
|
|
3281
3318
|
*/
|
|
3282
3319
|
function registerBackButtonHandler(handler: () => boolean): void;
|
|
3283
3320
|
/**
|
|
3284
|
-
* Checks if the
|
|
3321
|
+
* Checks if the pages.backStack capability is supported by the host
|
|
3285
3322
|
* @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
|
|
3286
3323
|
* false if it is disabled
|
|
3287
3324
|
*/
|
|
@@ -3291,7 +3328,7 @@ export namespace pages {
|
|
|
3291
3328
|
* @hidden
|
|
3292
3329
|
* Hide from docs
|
|
3293
3330
|
* ------
|
|
3294
|
-
*
|
|
3331
|
+
* Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
|
|
3295
3332
|
*/
|
|
3296
3333
|
namespace fullTrust {
|
|
3297
3334
|
/**
|
|
@@ -3312,14 +3349,14 @@ export namespace pages {
|
|
|
3312
3349
|
* @hidden
|
|
3313
3350
|
* Hide from docs
|
|
3314
3351
|
* ------
|
|
3315
|
-
* Checks if the
|
|
3352
|
+
* Checks if the pages.fullTrust capability is supported by the host
|
|
3316
3353
|
* @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
|
|
3317
3354
|
* false if it is disabled
|
|
3318
3355
|
*/
|
|
3319
3356
|
function isSupported(): boolean;
|
|
3320
3357
|
}
|
|
3321
3358
|
/**
|
|
3322
|
-
*
|
|
3359
|
+
* Provides APIs to interact with the app button part of the SDK.
|
|
3323
3360
|
*/
|
|
3324
3361
|
namespace appButton {
|
|
3325
3362
|
/**
|
|
@@ -3341,7 +3378,7 @@ export namespace pages {
|
|
|
3341
3378
|
*/
|
|
3342
3379
|
function onHoverLeave(handler: () => void): void;
|
|
3343
3380
|
/**
|
|
3344
|
-
* Checks if pages.appButton capability is supported
|
|
3381
|
+
* Checks if pages.appButton capability is supported by the host
|
|
3345
3382
|
* @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
|
|
3346
3383
|
* false if it is disabled
|
|
3347
3384
|
*/
|
|
@@ -3963,7 +4000,7 @@ export namespace location {
|
|
|
3963
4000
|
function getLocation(props: LocationProps): Promise<Location>;
|
|
3964
4001
|
/**
|
|
3965
4002
|
* @deprecated
|
|
3966
|
-
* As of 2.0.0
|
|
4003
|
+
* As of 2.0.0, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
|
|
3967
4004
|
* @param props {@link LocationProps} - Specifying how the location request is handled
|
|
3968
4005
|
* @param callback - Callback to invoke when current user location is fetched
|
|
3969
4006
|
*/
|
|
@@ -3977,7 +4014,7 @@ export namespace location {
|
|
|
3977
4014
|
function showLocation(location: Location): Promise<void>;
|
|
3978
4015
|
/**
|
|
3979
4016
|
* @deprecated
|
|
3980
|
-
* As of 2.0.0
|
|
4017
|
+
* As of 2.0.0, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
|
|
3981
4018
|
* Shows the location on map corresponding to the given coordinates
|
|
3982
4019
|
* @param location {@link Location} - which needs to be shown on map
|
|
3983
4020
|
* @param callback - Callback to invoke when the location is opened on map
|
|
@@ -4297,7 +4334,7 @@ export namespace monetization {
|
|
|
4297
4334
|
function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
|
|
4298
4335
|
/**
|
|
4299
4336
|
* @deprecated
|
|
4300
|
-
* As of 2.0.0
|
|
4337
|
+
* As of 2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
|
|
4301
4338
|
*
|
|
4302
4339
|
* @hidden
|
|
4303
4340
|
* Hide from docs
|
|
@@ -4396,6 +4433,11 @@ export namespace teamsCore {
|
|
|
4396
4433
|
* @internal
|
|
4397
4434
|
*/
|
|
4398
4435
|
function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
|
|
4436
|
+
/**
|
|
4437
|
+
* Checks if teamsCore capability is supported by the host
|
|
4438
|
+
* @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
|
|
4439
|
+
* false if it is disabled
|
|
4440
|
+
*/
|
|
4399
4441
|
function isSupported(): boolean;
|
|
4400
4442
|
}
|
|
4401
4443
|
|
|
@@ -4411,7 +4453,7 @@ export namespace people {
|
|
|
4411
4453
|
function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
|
|
4412
4454
|
/**
|
|
4413
4455
|
* @deprecated
|
|
4414
|
-
* As of 2.0.0
|
|
4456
|
+
* As of 2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
|
|
4415
4457
|
*
|
|
4416
4458
|
* Launches a people picker and allows the user to select one or more people from the list
|
|
4417
4459
|
* 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
|
|
@@ -4506,7 +4548,7 @@ export namespace video {
|
|
|
4506
4548
|
NV12 = 0
|
|
4507
4549
|
}
|
|
4508
4550
|
/**
|
|
4509
|
-
* Video frame configuration supplied to
|
|
4551
|
+
* Video frame configuration supplied to the host to customize the generated video frame parameters, like format
|
|
4510
4552
|
*/
|
|
4511
4553
|
interface VideoFrameConfig {
|
|
4512
4554
|
/**
|
|
@@ -4537,21 +4579,29 @@ export namespace video {
|
|
|
4537
4579
|
type VideoEffectCallBack = (effectId: string | undefined) => void;
|
|
4538
4580
|
/**
|
|
4539
4581
|
* Register to read the video frames in Permissions section
|
|
4582
|
+
* @param frameCallback - The callback to invoke when registerForVideoFrame has completed
|
|
4583
|
+
* @param config - VideoFrameConfig to customize generated video frame parameters
|
|
4540
4584
|
*/
|
|
4541
4585
|
function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
|
|
4542
4586
|
/**
|
|
4543
|
-
* video extension should call this to notify
|
|
4544
|
-
* If it's pre-meeting,
|
|
4545
|
-
* in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
4587
|
+
* video extension should call this to notify host client that the current selected effect parameter changed.
|
|
4588
|
+
* If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
|
|
4589
|
+
* If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
4546
4590
|
*
|
|
4547
4591
|
* @param effectChangeType - the effect change type.
|
|
4548
4592
|
* @param effectId - Newly selected effect id.
|
|
4549
4593
|
*/
|
|
4550
4594
|
function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
|
|
4551
4595
|
/**
|
|
4552
|
-
* Register the video effect callback,
|
|
4596
|
+
* Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
|
|
4597
|
+
* @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
|
|
4553
4598
|
*/
|
|
4554
4599
|
function registerForVideoEffect(callback: VideoEffectCallBack): void;
|
|
4600
|
+
/**
|
|
4601
|
+
* Checks if video capability is supported by the host
|
|
4602
|
+
* @returns true if the video capability is enabled in runtime.supports.video and
|
|
4603
|
+
* false if it is disabled
|
|
4604
|
+
*/
|
|
4555
4605
|
function isSupported(): boolean;
|
|
4556
4606
|
}
|
|
4557
4607
|
|
|
@@ -4592,7 +4642,7 @@ export namespace sharing {
|
|
|
4592
4642
|
export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
|
|
4593
4643
|
/**
|
|
4594
4644
|
* @deprecated
|
|
4595
|
-
* As of 2.0.0
|
|
4645
|
+
* As of 2.0.0, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
|
|
4596
4646
|
*
|
|
4597
4647
|
* Feature is under development
|
|
4598
4648
|
* Opens a share dialog for web content
|
|
@@ -4614,7 +4664,7 @@ export namespace stageView {
|
|
|
4614
4664
|
*/
|
|
4615
4665
|
interface StageViewParams {
|
|
4616
4666
|
/**
|
|
4617
|
-
* The
|
|
4667
|
+
* The ID of the Teams application to be opened.
|
|
4618
4668
|
*/
|
|
4619
4669
|
appId: string;
|
|
4620
4670
|
/**
|
|
@@ -4630,11 +4680,11 @@ export namespace stageView {
|
|
|
4630
4680
|
*/
|
|
4631
4681
|
title: string;
|
|
4632
4682
|
/**
|
|
4633
|
-
* The Teams
|
|
4683
|
+
* The Teams application website URL.
|
|
4634
4684
|
*/
|
|
4635
4685
|
websiteUrl?: string;
|
|
4636
4686
|
/**
|
|
4637
|
-
* The entity ID of the Teams
|
|
4687
|
+
* The entity ID of the Teams application content being opened.
|
|
4638
4688
|
*/
|
|
4639
4689
|
entityId?: string;
|
|
4640
4690
|
}
|
|
@@ -4642,9 +4692,9 @@ export namespace stageView {
|
|
|
4642
4692
|
* @hidden
|
|
4643
4693
|
* Feature is under development
|
|
4644
4694
|
*
|
|
4645
|
-
* Opens a stage view to display a Teams
|
|
4646
|
-
* @param stageViewParams The parameters to pass into the stage view.
|
|
4647
|
-
*
|
|
4695
|
+
* Opens a stage view to display a Teams application
|
|
4696
|
+
* @param stageViewParams - The parameters to pass into the stage view.
|
|
4697
|
+
* @returns Promise that resolves once the stage view is closed.
|
|
4648
4698
|
*/
|
|
4649
4699
|
function open(stageViewParams: StageViewParams): Promise<void>;
|
|
4650
4700
|
/**
|
|
@@ -4652,11 +4702,11 @@ export namespace stageView {
|
|
|
4652
4702
|
* Feature is under development
|
|
4653
4703
|
*
|
|
4654
4704
|
* @deprecated
|
|
4655
|
-
* As of 2.0.0
|
|
4705
|
+
* As of 2.0.0, please use {@link stageView.open stageView.open(): Promise\<void\>} instead.
|
|
4656
4706
|
*
|
|
4657
|
-
* Opens a stage view to display a Teams
|
|
4658
|
-
* @param stageViewParams The parameters to pass into the stage view.
|
|
4659
|
-
*
|
|
4707
|
+
* Opens a stage view to display a Teams application
|
|
4708
|
+
* @param stageViewParams - The parameters to pass into the stage view.
|
|
4709
|
+
* @param callback - Optional callback that will be triggered once the stage view is closed.
|
|
4660
4710
|
* The callback takes as an argument an SdkError in case something happened (i.e.
|
|
4661
4711
|
* no permissions to execute the API)
|
|
4662
4712
|
*/
|
|
@@ -4688,51 +4738,51 @@ export namespace call {
|
|
|
4688
4738
|
|
|
4689
4739
|
/**
|
|
4690
4740
|
* @deprecated
|
|
4691
|
-
* As of 2.0.0
|
|
4741
|
+
* As of 2.0.0, please use {@link app} namespace instead.
|
|
4692
4742
|
*/
|
|
4693
4743
|
export namespace appInitialization {
|
|
4694
4744
|
/**
|
|
4695
4745
|
* @deprecated
|
|
4696
|
-
* As of 2.0.0
|
|
4746
|
+
* As of 2.0.0, please use {@link app.Messages} instead.
|
|
4697
4747
|
*/
|
|
4698
4748
|
export import Messages = app.Messages;
|
|
4699
4749
|
/**
|
|
4700
4750
|
* @deprecated
|
|
4701
|
-
* As of 2.0.0
|
|
4751
|
+
* As of 2.0.0, please use {@link app.FailedReason} instead.
|
|
4702
4752
|
*/
|
|
4703
4753
|
export import FailedReason = app.FailedReason;
|
|
4704
4754
|
/**
|
|
4705
4755
|
* @deprecated
|
|
4706
|
-
* As of 2.0.0
|
|
4756
|
+
* As of 2.0.0, please use {@link app.ExpectedFailureReason} instead.
|
|
4707
4757
|
*/
|
|
4708
4758
|
export import ExpectedFailureReason = app.ExpectedFailureReason;
|
|
4709
4759
|
/**
|
|
4710
4760
|
* @deprecated
|
|
4711
|
-
* As of 2.0.0
|
|
4761
|
+
* As of 2.0.0, please use {@link app.IFailedRequest} instead.
|
|
4712
4762
|
*/
|
|
4713
4763
|
export import IFailedRequest = app.IFailedRequest;
|
|
4714
4764
|
/**
|
|
4715
4765
|
* @deprecated
|
|
4716
|
-
* As of 2.0.0
|
|
4766
|
+
* As of 2.0.0, please use {@link app.IExpectedFailureRequest} instead.
|
|
4717
4767
|
*/
|
|
4718
4768
|
export import IExpectedFailureRequest = app.IExpectedFailureRequest;
|
|
4719
4769
|
/**
|
|
4720
4770
|
* @deprecated
|
|
4721
|
-
* As of 2.0.0
|
|
4771
|
+
* As of 2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
|
|
4722
4772
|
*
|
|
4723
4773
|
* Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
|
|
4724
4774
|
*/
|
|
4725
4775
|
function notifyAppLoaded(): void;
|
|
4726
4776
|
/**
|
|
4727
4777
|
* @deprecated
|
|
4728
|
-
* As of 2.0.0
|
|
4778
|
+
* As of 2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
|
|
4729
4779
|
*
|
|
4730
4780
|
* Notifies the frame that app initialization is successful and is ready for user interaction.
|
|
4731
4781
|
*/
|
|
4732
4782
|
function notifySuccess(): void;
|
|
4733
4783
|
/**
|
|
4734
4784
|
* @deprecated
|
|
4735
|
-
* As of 2.0.0
|
|
4785
|
+
* As of 2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
|
|
4736
4786
|
*
|
|
4737
4787
|
* Notifies the frame that app initialization has failed and to show an error page in its place.
|
|
4738
4788
|
* @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
|
|
@@ -4741,7 +4791,7 @@ export namespace appInitialization {
|
|
|
4741
4791
|
function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
|
|
4742
4792
|
/**
|
|
4743
4793
|
* @deprecated
|
|
4744
|
-
* As of 2.0.0
|
|
4794
|
+
* As of 2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
|
|
4745
4795
|
*
|
|
4746
4796
|
* Notifies the frame that app initialized with some expected errors.
|
|
4747
4797
|
* @param expectedFailureRequest - The expected failure request containing the reason and an optional message
|
|
@@ -4751,7 +4801,7 @@ export namespace appInitialization {
|
|
|
4751
4801
|
|
|
4752
4802
|
/**
|
|
4753
4803
|
* @deprecated
|
|
4754
|
-
* As of 2.0.0
|
|
4804
|
+
* As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
|
|
4755
4805
|
*
|
|
4756
4806
|
* Initializes the library. This must be called before any other SDK calls
|
|
4757
4807
|
* but after the frame is loaded successfully.
|
|
@@ -4762,7 +4812,7 @@ export namespace appInitialization {
|
|
|
4762
4812
|
export function initialize(callback?: () => void, validMessageOrigins?: string[]): void;
|
|
4763
4813
|
/**
|
|
4764
4814
|
* @deprecated
|
|
4765
|
-
* As of 2.0.0
|
|
4815
|
+
* As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
|
|
4766
4816
|
*
|
|
4767
4817
|
* @hidden
|
|
4768
4818
|
* Hide from docs.
|
|
@@ -4774,7 +4824,7 @@ export function initialize(callback?: () => void, validMessageOrigins?: string[]
|
|
|
4774
4824
|
export function _initialize(hostWindow: any): void;
|
|
4775
4825
|
/**
|
|
4776
4826
|
* @deprecated
|
|
4777
|
-
* As of 2.0.0
|
|
4827
|
+
* As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
|
|
4778
4828
|
*
|
|
4779
4829
|
* @hidden
|
|
4780
4830
|
* Hide from docs.
|
|
@@ -4786,21 +4836,21 @@ export function _initialize(hostWindow: any): void;
|
|
|
4786
4836
|
export function _uninitialize(): void;
|
|
4787
4837
|
/**
|
|
4788
4838
|
* @deprecated
|
|
4789
|
-
* As of 2.0.0
|
|
4839
|
+
* As of 2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
|
|
4790
4840
|
*
|
|
4791
4841
|
* Enable print capability to support printing page using Ctrl+P and cmd+P
|
|
4792
4842
|
*/
|
|
4793
4843
|
export function enablePrintCapability(): void;
|
|
4794
4844
|
/**
|
|
4795
4845
|
* @deprecated
|
|
4796
|
-
* As of 2.0.0
|
|
4846
|
+
* As of 2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
|
|
4797
4847
|
*
|
|
4798
4848
|
* Default print handler
|
|
4799
4849
|
*/
|
|
4800
4850
|
export function print(): void;
|
|
4801
4851
|
/**
|
|
4802
4852
|
* @deprecated
|
|
4803
|
-
* As of 2.0.0
|
|
4853
|
+
* As of 2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
|
|
4804
4854
|
*
|
|
4805
4855
|
* Retrieves the current context the frame is running in.
|
|
4806
4856
|
*
|
|
@@ -4809,7 +4859,7 @@ export function print(): void;
|
|
|
4809
4859
|
export function getContext(callback: (context: Context) => void): void;
|
|
4810
4860
|
/**
|
|
4811
4861
|
* @deprecated
|
|
4812
|
-
* As of 2.0.0
|
|
4862
|
+
* As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
|
|
4813
4863
|
*
|
|
4814
4864
|
* Registers a handler for theme changes.
|
|
4815
4865
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
@@ -4819,7 +4869,7 @@ export function getContext(callback: (context: Context) => void): void;
|
|
|
4819
4869
|
export function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
|
|
4820
4870
|
/**
|
|
4821
4871
|
* @deprecated
|
|
4822
|
-
* As of 2.0.0
|
|
4872
|
+
* As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
|
|
4823
4873
|
*
|
|
4824
4874
|
* Registers a handler for changes from or to full-screen view for a tab.
|
|
4825
4875
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
@@ -4829,7 +4879,7 @@ export function registerOnThemeChangeHandler(handler: (theme: string) => void):
|
|
|
4829
4879
|
export function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
|
|
4830
4880
|
/**
|
|
4831
4881
|
* @deprecated
|
|
4832
|
-
* As of 2.0.0
|
|
4882
|
+
* As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
|
|
4833
4883
|
*
|
|
4834
4884
|
* Registers a handler for clicking the app button.
|
|
4835
4885
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
@@ -4839,7 +4889,7 @@ export function registerFullScreenHandler(handler: (isFullScreen: boolean) => vo
|
|
|
4839
4889
|
export function registerAppButtonClickHandler(handler: () => void): void;
|
|
4840
4890
|
/**
|
|
4841
4891
|
* @deprecated
|
|
4842
|
-
* As of 2.0.0
|
|
4892
|
+
* As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
|
|
4843
4893
|
*
|
|
4844
4894
|
* Registers a handler for entering hover of the app button.
|
|
4845
4895
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
@@ -4849,7 +4899,7 @@ export function registerAppButtonClickHandler(handler: () => void): void;
|
|
|
4849
4899
|
export function registerAppButtonHoverEnterHandler(handler: () => void): void;
|
|
4850
4900
|
/**
|
|
4851
4901
|
* @deprecated
|
|
4852
|
-
* As of 2.0.0
|
|
4902
|
+
* As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
|
|
4853
4903
|
*
|
|
4854
4904
|
* Registers a handler for exiting hover of the app button.
|
|
4855
4905
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
|
@@ -4859,7 +4909,7 @@ export function registerAppButtonHoverEnterHandler(handler: () => void): void;
|
|
|
4859
4909
|
export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
|
|
4860
4910
|
/**
|
|
4861
4911
|
* @deprecated
|
|
4862
|
-
* As of 2.0.0
|
|
4912
|
+
* As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
|
|
4863
4913
|
*
|
|
4864
4914
|
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
|
|
4865
4915
|
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
|
|
@@ -4871,7 +4921,7 @@ export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
|
|
|
4871
4921
|
export function registerBackButtonHandler(handler: () => boolean): void;
|
|
4872
4922
|
/**
|
|
4873
4923
|
* @deprecated
|
|
4874
|
-
* As of 2.0.0
|
|
4924
|
+
* As of 2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
|
|
4875
4925
|
*
|
|
4876
4926
|
* @hidden
|
|
4877
4927
|
* Registers a handler to be called when the page has been requested to load.
|
|
@@ -4881,7 +4931,7 @@ export function registerBackButtonHandler(handler: () => boolean): void;
|
|
|
4881
4931
|
export function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
|
|
4882
4932
|
/**
|
|
4883
4933
|
* @deprecated
|
|
4884
|
-
* As of 2.0.0
|
|
4934
|
+
* As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
|
|
4885
4935
|
*
|
|
4886
4936
|
* @hidden
|
|
4887
4937
|
* Registers a handler to be called before the page is unloaded.
|
|
@@ -4892,7 +4942,7 @@ export function registerOnLoadHandler(handler: (context: LoadContext) => void):
|
|
|
4892
4942
|
export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
|
|
4893
4943
|
/**
|
|
4894
4944
|
* @deprecated
|
|
4895
|
-
* As of 2.0.0
|
|
4945
|
+
* As of 2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
|
|
4896
4946
|
*
|
|
4897
4947
|
* @hidden
|
|
4898
4948
|
* Registers a handler when focus needs to be passed from teams to the place of choice on app.
|
|
@@ -4902,7 +4952,7 @@ export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void)
|
|
|
4902
4952
|
export function registerFocusEnterHandler(handler: (navigateForward: boolean) => boolean): void;
|
|
4903
4953
|
/**
|
|
4904
4954
|
* @deprecated
|
|
4905
|
-
* As of 2.0.0
|
|
4955
|
+
* As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
|
|
4906
4956
|
*
|
|
4907
4957
|
* Registers a handler for when the user reconfigurated tab.
|
|
4908
4958
|
*
|
|
@@ -4911,7 +4961,7 @@ export function registerFocusEnterHandler(handler: (navigateForward: boolean) =>
|
|
|
4911
4961
|
export function registerEnterSettingsHandler(handler: () => void): void;
|
|
4912
4962
|
/**
|
|
4913
4963
|
* @deprecated
|
|
4914
|
-
* As of 2.0.0
|
|
4964
|
+
* As of 2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
|
|
4915
4965
|
*
|
|
4916
4966
|
* Allows an app to retrieve for this user tabs that are owned by this app.
|
|
4917
4967
|
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
|
|
@@ -4922,7 +4972,7 @@ export function registerEnterSettingsHandler(handler: () => void): void;
|
|
|
4922
4972
|
export function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
|
|
4923
4973
|
/**
|
|
4924
4974
|
* @deprecated
|
|
4925
|
-
* As of 2.0.0
|
|
4975
|
+
* As of 2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
|
|
4926
4976
|
*
|
|
4927
4977
|
* Allows an app to retrieve the most recently used tabs for this user.
|
|
4928
4978
|
*
|
|
@@ -4932,7 +4982,7 @@ export function getTabInstances(callback: (tabInfo: TabInformation) => void, tab
|
|
|
4932
4982
|
export function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
|
|
4933
4983
|
/**
|
|
4934
4984
|
* @deprecated
|
|
4935
|
-
* As of 2.0.0
|
|
4985
|
+
* As of 2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
|
|
4936
4986
|
*
|
|
4937
4987
|
* Shares a deep link that a user can use to navigate back to a specific state in this page.
|
|
4938
4988
|
*
|
|
@@ -4941,7 +4991,7 @@ export function getMruTabInstances(callback: (tabInfo: TabInformation) => void,
|
|
|
4941
4991
|
export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
|
|
4942
4992
|
/**
|
|
4943
4993
|
* @deprecated
|
|
4944
|
-
* As of 2.0.0
|
|
4994
|
+
* As of 2.0.0, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
|
|
4945
4995
|
*
|
|
4946
4996
|
* Execute deep link API.
|
|
4947
4997
|
*
|
|
@@ -4950,7 +5000,7 @@ export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
|
|
|
4950
5000
|
export function executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string) => void): void;
|
|
4951
5001
|
/**
|
|
4952
5002
|
* @deprecated
|
|
4953
|
-
* As of 2.0.0
|
|
5003
|
+
* As of 2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
|
|
4954
5004
|
*
|
|
4955
5005
|
* Set the current Frame Context
|
|
4956
5006
|
*
|
|
@@ -4959,7 +5009,7 @@ export function executeDeepLink(deepLink: string, onComplete?: (status: boolean,
|
|
|
4959
5009
|
export function setFrameContext(frameContext: FrameContext): void;
|
|
4960
5010
|
/**
|
|
4961
5011
|
* @deprecated
|
|
4962
|
-
* As of 2.0.0
|
|
5012
|
+
* As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
|
|
4963
5013
|
*
|
|
4964
5014
|
* Initilize with FrameContext
|
|
4965
5015
|
*
|
|
@@ -4972,7 +5022,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
|
|
|
4972
5022
|
|
|
4973
5023
|
/**
|
|
4974
5024
|
* @deprecated
|
|
4975
|
-
* As of 2.0.0
|
|
5025
|
+
* As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
|
|
4976
5026
|
*
|
|
4977
5027
|
* Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
|
|
4978
5028
|
*
|
|
@@ -4981,7 +5031,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
|
|
|
4981
5031
|
export function returnFocus(navigateForward?: boolean): void;
|
|
4982
5032
|
/**
|
|
4983
5033
|
* @deprecated
|
|
4984
|
-
* As of 2.0.0
|
|
5034
|
+
* As of 2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
|
|
4985
5035
|
*
|
|
4986
5036
|
* Navigates the Microsoft Teams app to the specified tab instance.
|
|
4987
5037
|
*
|
|
@@ -4991,7 +5041,7 @@ export function returnFocus(navigateForward?: boolean): void;
|
|
|
4991
5041
|
export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string) => void): void;
|
|
4992
5042
|
/**
|
|
4993
5043
|
* @deprecated
|
|
4994
|
-
* As of 2.0.0
|
|
5044
|
+
* As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
|
|
4995
5045
|
*
|
|
4996
5046
|
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
|
|
4997
5047
|
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
|
|
@@ -5005,7 +5055,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: bo
|
|
|
5005
5055
|
export function navigateCrossDomain(url: string, onComplete?: (status: boolean, reason?: string) => void): void;
|
|
5006
5056
|
/**
|
|
5007
5057
|
* @deprecated
|
|
5008
|
-
* As of 2.0.0
|
|
5058
|
+
* As of 2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
|
|
5009
5059
|
*
|
|
5010
5060
|
* Navigates back in the Teams client.
|
|
5011
5061
|
* See registerBackButtonHandler for more information on when it's appropriate to use this method.
|
|
@@ -5016,7 +5066,7 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
|
|
|
5016
5066
|
|
|
5017
5067
|
/**
|
|
5018
5068
|
* @deprecated
|
|
5019
|
-
* As of 2.0.0
|
|
5069
|
+
* As of 2.0.0, please use {@link pages.config} namespace instead.
|
|
5020
5070
|
*
|
|
5021
5071
|
* Namespace to interact with the settings-specific part of the SDK.
|
|
5022
5072
|
* This object is usable only on the settings frame.
|
|
@@ -5024,35 +5074,35 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
|
|
|
5024
5074
|
export namespace settings {
|
|
5025
5075
|
/**
|
|
5026
5076
|
* @deprecated
|
|
5027
|
-
* As of 2.0.0
|
|
5077
|
+
* As of 2.0.0, please use {@link pages.config.Config} instead.
|
|
5028
5078
|
* @remarks
|
|
5029
5079
|
* Renamed to config in pages.Config
|
|
5030
5080
|
*/
|
|
5031
5081
|
export import Settings = pages.InstanceConfig;
|
|
5032
5082
|
/**
|
|
5033
5083
|
* @deprecated
|
|
5034
|
-
* As of 2.0.0
|
|
5084
|
+
* As of 2.0.0, please use {@link pages.config.SaveEvent} instead.
|
|
5035
5085
|
* @remarks
|
|
5036
5086
|
* See pages.SaveEvent
|
|
5037
5087
|
*/
|
|
5038
5088
|
export import SaveEvent = pages.config.SaveEvent;
|
|
5039
5089
|
/**
|
|
5040
5090
|
* @deprecated
|
|
5041
|
-
* As of 2.0.0
|
|
5091
|
+
* As of 2.0.0, please use {@link pages.config.RemoveEvent} instead.
|
|
5042
5092
|
* @remarks
|
|
5043
5093
|
* See pages.RemoveEvent
|
|
5044
5094
|
*/
|
|
5045
5095
|
export import RemoveEvent = pages.config.RemoveEvent;
|
|
5046
5096
|
/**
|
|
5047
5097
|
* @deprecated
|
|
5048
|
-
* As of 2.0.0
|
|
5098
|
+
* As of 2.0.0, please use {@link pages.config.SaveParameters} instead.
|
|
5049
5099
|
* @remarks
|
|
5050
5100
|
* See pages.SaveParameters
|
|
5051
5101
|
*/
|
|
5052
5102
|
export import SaveParameters = pages.config.SaveParameters;
|
|
5053
5103
|
/**
|
|
5054
5104
|
* @deprecated
|
|
5055
|
-
* As of 2.0.0
|
|
5105
|
+
* As of 2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
|
|
5056
5106
|
*
|
|
5057
5107
|
* Sets the validity state for the settings.
|
|
5058
5108
|
* The initial value is false, so the user cannot save the settings until this is called with true.
|
|
@@ -5062,7 +5112,7 @@ export namespace settings {
|
|
|
5062
5112
|
function setValidityState(validityState: boolean): void;
|
|
5063
5113
|
/**
|
|
5064
5114
|
* @deprecated
|
|
5065
|
-
* As of 2.0.0
|
|
5115
|
+
* As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
|
|
5066
5116
|
*
|
|
5067
5117
|
* Gets the settings for the current instance.
|
|
5068
5118
|
*
|
|
@@ -5071,7 +5121,7 @@ export namespace settings {
|
|
|
5071
5121
|
function getSettings(callback: (instanceSettings: Settings) => void): void;
|
|
5072
5122
|
/**
|
|
5073
5123
|
* @deprecated
|
|
5074
|
-
* As of 2.0.0
|
|
5124
|
+
* As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
|
|
5075
5125
|
*
|
|
5076
5126
|
* Sets the settings for the current instance.
|
|
5077
5127
|
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
|
|
@@ -5081,7 +5131,7 @@ export namespace settings {
|
|
|
5081
5131
|
function setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) => void): void;
|
|
5082
5132
|
/**
|
|
5083
5133
|
* @deprecated
|
|
5084
|
-
* As of 2.0.0
|
|
5134
|
+
* As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
|
|
5085
5135
|
*
|
|
5086
5136
|
* Registers a handler for when the user attempts to save the settings. This handler should be used
|
|
5087
5137
|
* to create or update the underlying resource powering the content.
|
|
@@ -5093,7 +5143,7 @@ export namespace settings {
|
|
|
5093
5143
|
function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
|
|
5094
5144
|
/**
|
|
5095
5145
|
* @deprecated
|
|
5096
|
-
* As of 2.0.0
|
|
5146
|
+
* As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
|
|
5097
5147
|
*
|
|
5098
5148
|
* Registers a handler for user attempts to remove content. This handler should be used
|
|
5099
5149
|
* to remove the underlying resource powering the content.
|
|
@@ -5107,7 +5157,7 @@ export namespace settings {
|
|
|
5107
5157
|
|
|
5108
5158
|
/**
|
|
5109
5159
|
* @deprecated
|
|
5110
|
-
* As of 2.0.0
|
|
5160
|
+
* As of 2.0.0, please use {@link dialog} namespace instead.
|
|
5111
5161
|
*
|
|
5112
5162
|
* Namespace to interact with the task module-specific part of the SDK.
|
|
5113
5163
|
* This object is usable only on the content frame.
|
|
@@ -5116,7 +5166,7 @@ export namespace settings {
|
|
|
5116
5166
|
export namespace tasks {
|
|
5117
5167
|
/**
|
|
5118
5168
|
* @deprecated
|
|
5119
|
-
* As of 2.0.0
|
|
5169
|
+
* As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
|
|
5120
5170
|
* and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
|
|
5121
5171
|
*
|
|
5122
5172
|
* Allows an app to open the task module.
|
|
@@ -5127,7 +5177,7 @@ export namespace tasks {
|
|
|
5127
5177
|
function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
|
|
5128
5178
|
/**
|
|
5129
5179
|
* @deprecated
|
|
5130
|
-
* As of 2.0.0
|
|
5180
|
+
* As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
|
|
5131
5181
|
*
|
|
5132
5182
|
* Update height/width task info properties.
|
|
5133
5183
|
*
|
|
@@ -5136,7 +5186,7 @@ export namespace tasks {
|
|
|
5136
5186
|
function updateTask(taskInfo: TaskInfo): void;
|
|
5137
5187
|
/**
|
|
5138
5188
|
* @deprecated
|
|
5139
|
-
* As of 2.0.0
|
|
5189
|
+
* As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
|
|
5140
5190
|
*
|
|
5141
5191
|
* Submit the task module.
|
|
5142
5192
|
*
|