@microsoft/teams-js 2.16.0 → 2.17.0-beta.0

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.
@@ -3644,7 +3644,7 @@ export interface ResumeContext {
3644
3644
  }
3645
3645
  /**
3646
3646
  * @deprecated
3647
- * As of 2.14.1, please use ResumeContext instead.
3647
+ * As of 2.14.1, please use {@link ResumeContext} instead.
3648
3648
  */
3649
3649
  export type LoadContext = ResumeContext;
3650
3650
  /** Represents information about a frame within a tab or dialog module. */
@@ -3781,7 +3781,7 @@ export interface ClipboardParams {
3781
3781
  */
3782
3782
  export namespace app {
3783
3783
  /** App Initialization Messages */
3784
- export const Messages: {
3784
+ const Messages: {
3785
3785
  /** App loaded. */
3786
3786
  AppLoaded: string;
3787
3787
  /** App initialized successfully. */
@@ -3794,7 +3794,7 @@ export namespace app {
3794
3794
  /**
3795
3795
  * Describes errors that caused app initialization to fail
3796
3796
  */
3797
- export enum FailedReason {
3797
+ enum FailedReason {
3798
3798
  /**
3799
3799
  * Authentication failed
3800
3800
  */
@@ -3812,7 +3812,7 @@ export namespace app {
3812
3812
  * Describes expected errors that occurred during an otherwise successful
3813
3813
  * app initialization
3814
3814
  */
3815
- export enum ExpectedFailureReason {
3815
+ enum ExpectedFailureReason {
3816
3816
  /**
3817
3817
  * There was a permission error
3818
3818
  */
@@ -3837,7 +3837,7 @@ export namespace app {
3837
3837
  /**
3838
3838
  * Represents the failed request sent during a failed app initialization.
3839
3839
  */
3840
- export interface IFailedRequest {
3840
+ interface IFailedRequest {
3841
3841
  /**
3842
3842
  * The reason for the failure
3843
3843
  */
@@ -3850,7 +3850,7 @@ export namespace app {
3850
3850
  /**
3851
3851
  * Represents the failure request sent during an erroneous app initialization.
3852
3852
  */
3853
- export interface IExpectedFailureRequest {
3853
+ interface IExpectedFailureRequest {
3854
3854
  /**
3855
3855
  * The reason for the failure
3856
3856
  */
@@ -3863,7 +3863,7 @@ export namespace app {
3863
3863
  /**
3864
3864
  * Represents application information.
3865
3865
  */
3866
- export interface AppInfo {
3866
+ interface AppInfo {
3867
3867
  /**
3868
3868
  * The current locale that the user has configured for the app formatted as
3869
3869
  * languageId-countryId (for example, en-us).
@@ -3912,7 +3912,7 @@ export namespace app {
3912
3912
  /**
3913
3913
  * Represents information about the application's host.
3914
3914
  */
3915
- export interface AppHostInfo {
3915
+ interface AppHostInfo {
3916
3916
  /**
3917
3917
  * Identifies which host is running your app
3918
3918
  */
@@ -3933,7 +3933,7 @@ export namespace app {
3933
3933
  /**
3934
3934
  * Represents Channel information.
3935
3935
  */
3936
- export interface ChannelInfo {
3936
+ interface ChannelInfo {
3937
3937
  /**
3938
3938
  * The Microsoft Teams ID for the channel with which the content is associated.
3939
3939
  */
@@ -3966,7 +3966,7 @@ export namespace app {
3966
3966
  /**
3967
3967
  * Represents Chat information.
3968
3968
  */
3969
- export interface ChatInfo {
3969
+ interface ChatInfo {
3970
3970
  /**
3971
3971
  * The Microsoft Teams ID for the chat with which the content is associated.
3972
3972
  */
@@ -3975,7 +3975,7 @@ export namespace app {
3975
3975
  /**
3976
3976
  * Represents Meeting information.
3977
3977
  */
3978
- export interface MeetingInfo {
3978
+ interface MeetingInfo {
3979
3979
  /**
3980
3980
  * Meeting Id used by tab when running in meeting context
3981
3981
  */
@@ -3984,7 +3984,7 @@ export namespace app {
3984
3984
  /**
3985
3985
  * Represents Page information.
3986
3986
  */
3987
- export interface PageInfo {
3987
+ interface PageInfo {
3988
3988
  /**
3989
3989
  * The developer-defined unique ID for the page this content points to.
3990
3990
  */
@@ -4015,7 +4015,7 @@ export namespace app {
4015
4015
  /**
4016
4016
  * Represents Team information.
4017
4017
  */
4018
- export interface TeamInfo {
4018
+ interface TeamInfo {
4019
4019
  /**
4020
4020
  * The Microsoft Teams ID for the team with which the content is associated.
4021
4021
  */
@@ -4053,7 +4053,7 @@ export namespace app {
4053
4053
  /**
4054
4054
  * Represents User information.
4055
4055
  */
4056
- export interface UserInfo {
4056
+ interface UserInfo {
4057
4057
  /**
4058
4058
  * The Microsoft Entra object id of the current user.
4059
4059
  *
@@ -4113,7 +4113,7 @@ export namespace app {
4113
4113
  /**
4114
4114
  * Represents Tenant information.
4115
4115
  */
4116
- export interface TenantInfo {
4116
+ interface TenantInfo {
4117
4117
  /**
4118
4118
  * The Microsoft Entra tenant ID of the current user.
4119
4119
 
@@ -4125,12 +4125,12 @@ export namespace app {
4125
4125
  */
4126
4126
  id: string;
4127
4127
  /**
4128
- * The type of license for the current users tenant.
4128
+ * The type of license for the current user's tenant. Possible values are enterprise, free, edu, and unknown.
4129
4129
  */
4130
4130
  teamsSku?: string;
4131
4131
  }
4132
4132
  /** Represents information about a SharePoint site */
4133
- export interface SharePointSiteInfo {
4133
+ interface SharePointSiteInfo {
4134
4134
  /**
4135
4135
  * The root SharePoint site associated with the team.
4136
4136
  */
@@ -4159,7 +4159,7 @@ export namespace app {
4159
4159
  /**
4160
4160
  * Represents structure of the received context message.
4161
4161
  */
4162
- export interface Context {
4162
+ interface Context {
4163
4163
  /**
4164
4164
  * Content Action Info
4165
4165
  *
@@ -4214,12 +4214,12 @@ export namespace app {
4214
4214
  * Checks whether the Teams client SDK has been initialized.
4215
4215
  * @returns whether the Teams client SDK has been initialized.
4216
4216
  */
4217
- export function isInitialized(): boolean;
4217
+ function isInitialized(): boolean;
4218
4218
  /**
4219
4219
  * Gets the Frame Context that the App is running in. See {@link FrameContexts} for the list of possible values.
4220
4220
  * @returns the Frame Context.
4221
4221
  */
4222
- export function getFrameContext(): FrameContexts;
4222
+ function getFrameContext(): FrameContexts;
4223
4223
  /**
4224
4224
  * Initializes the library.
4225
4225
  *
@@ -4230,7 +4230,7 @@ export namespace app {
4230
4230
  * https: protocol otherwise they will be ignored. Example: https://www.example.com
4231
4231
  * @returns Promise that will be fulfilled when initialization has completed, or rejected if the initialization fails or times out
4232
4232
  */
4233
- export function initialize(validMessageOrigins?: string[]): Promise<void>;
4233
+ function initialize(validMessageOrigins?: string[]): Promise<void>;
4234
4234
  /**
4235
4235
  * @hidden
4236
4236
  * Undocumented function used to set a mock window for unit tests
@@ -4238,7 +4238,7 @@ export namespace app {
4238
4238
  * @internal
4239
4239
  * Limited to Microsoft-internal use
4240
4240
  */
4241
- export function _initialize(hostWindow: any): void;
4241
+ function _initialize(hostWindow: any): void;
4242
4242
  /**
4243
4243
  * @hidden
4244
4244
  * Undocumented function used to clear state between unit tests
@@ -4246,34 +4246,34 @@ export namespace app {
4246
4246
  * @internal
4247
4247
  * Limited to Microsoft-internal use
4248
4248
  */
4249
- export function _uninitialize(): void;
4249
+ function _uninitialize(): void;
4250
4250
  /**
4251
4251
  * Retrieves the current context the frame is running in.
4252
4252
  *
4253
4253
  * @returns Promise that will resolve with the {@link app.Context} object.
4254
4254
  */
4255
- export function getContext(): Promise<app.Context>;
4255
+ function getContext(): Promise<app.Context>;
4256
4256
  /**
4257
4257
  * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
4258
4258
  */
4259
- export function notifyAppLoaded(): void;
4259
+ function notifyAppLoaded(): void;
4260
4260
  /**
4261
4261
  * Notifies the frame that app initialization is successful and is ready for user interaction.
4262
4262
  */
4263
- export function notifySuccess(): void;
4263
+ function notifySuccess(): void;
4264
4264
  /**
4265
4265
  * Notifies the frame that app initialization has failed and to show an error page in its place.
4266
4266
  *
4267
4267
  * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
4268
4268
  * during initialization as well as an optional message.
4269
4269
  */
4270
- export function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
4270
+ function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
4271
4271
  /**
4272
4272
  * Notifies the frame that app initialized with some expected errors.
4273
4273
  *
4274
4274
  * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
4275
4275
  */
4276
- export function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
4276
+ function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
4277
4277
  /**
4278
4278
  * Registers a handler for theme changes.
4279
4279
  *
@@ -4282,14 +4282,14 @@ export namespace app {
4282
4282
  *
4283
4283
  * @param handler - The handler to invoke when the user changes their theme.
4284
4284
  */
4285
- export function registerOnThemeChangeHandler(handler: themeHandler): void;
4285
+ function registerOnThemeChangeHandler(handler: themeHandler): void;
4286
4286
  /**
4287
4287
  * open link API.
4288
4288
  *
4289
4289
  * @param deepLink - deep link.
4290
4290
  * @returns Promise that will be fulfilled when the operation has completed
4291
4291
  */
4292
- export function openLink(deepLink: string): Promise<void>;
4292
+ function openLink(deepLink: string): Promise<void>;
4293
4293
  /**
4294
4294
  * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
4295
4295
  * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
@@ -4299,7 +4299,7 @@ export namespace app {
4299
4299
  *
4300
4300
  * @beta
4301
4301
  */
4302
- export namespace lifecycle {
4302
+ namespace lifecycle {
4303
4303
  /**
4304
4304
  * Register on resume handler function type
4305
4305
  *
@@ -4320,7 +4320,7 @@ export namespace app {
4320
4320
  * Upon returning, the app will be suspended or terminated.
4321
4321
  *
4322
4322
  */
4323
- export function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
4323
+ function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
4324
4324
  /**
4325
4325
  * Registers a handler to be called when the page has been requested to resume from being suspended.
4326
4326
  *
@@ -4329,7 +4329,7 @@ export namespace app {
4329
4329
  *
4330
4330
  * @beta
4331
4331
  */
4332
- export function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
4332
+ function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
4333
4333
  /**
4334
4334
  * Checks if app.lifecycle is supported by the host.
4335
4335
  * @returns boolean to represent whether the lifecycle capability is supported
@@ -4337,10 +4337,8 @@ export namespace app {
4337
4337
  *
4338
4338
  * @beta
4339
4339
  */
4340
- export function isSupported(): boolean;
4341
- export {};
4340
+ function isSupported(): boolean;
4342
4341
  }
4343
- export {};
4344
4342
  }
4345
4343
 
4346
4344
  export namespace appInstallDialog {
@@ -4929,7 +4927,7 @@ export namespace pages {
4929
4927
  * effect and will be a no-op when called.
4930
4928
  * @param navigateForward - Determines the direction to focus in host.
4931
4929
  */
4932
- export function returnFocus(navigateForward?: boolean): void;
4930
+ function returnFocus(navigateForward?: boolean): void;
4933
4931
  /**
4934
4932
  * @hidden
4935
4933
  *
@@ -4942,14 +4940,14 @@ export namespace pages {
4942
4940
  * @internal
4943
4941
  * Limited to Microsoft-internal use
4944
4942
  */
4945
- export function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
4943
+ function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
4946
4944
  /**
4947
4945
  * Sets/Updates the current frame with new information
4948
4946
  *
4949
4947
  * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
4950
4948
  * user clicks 'Go To Website'
4951
4949
  */
4952
- export function setCurrentFrame(frameInfo: FrameInfo): void;
4950
+ function setCurrentFrame(frameInfo: FrameInfo): void;
4953
4951
  /**
4954
4952
  * Initializes the library with context information for the frame
4955
4953
  *
@@ -4959,11 +4957,11 @@ export namespace pages {
4959
4957
  * @param validMessageOrigins - An optional list of cross-frame message origins. They must have
4960
4958
  * https: protocol otherwise they will be ignored. Example: https:www.example.com
4961
4959
  */
4962
- export function initializeWithFrameContext(frameInfo: FrameInfo, callback?: handlerFunctionType, validMessageOrigins?: string[]): void;
4960
+ function initializeWithFrameContext(frameInfo: FrameInfo, callback?: handlerFunctionType, validMessageOrigins?: string[]): void;
4963
4961
  /**
4964
4962
  * Defines the configuration of the current or desired instance
4965
4963
  */
4966
- export interface InstanceConfig {
4964
+ interface InstanceConfig {
4967
4965
  /**
4968
4966
  * A suggested display name for the new content.
4969
4967
  * In the settings for an existing instance being updated, this call has no effect.
@@ -4990,7 +4988,7 @@ export namespace pages {
4990
4988
  * Gets the config for the current instance.
4991
4989
  * @returns Promise that resolves with the {@link InstanceConfig} object.
4992
4990
  */
4993
- export function getConfig(): Promise<InstanceConfig>;
4991
+ function getConfig(): Promise<InstanceConfig>;
4994
4992
  /**
4995
4993
  * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
4996
4994
  * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -5000,7 +4998,7 @@ export namespace pages {
5000
4998
  * @param url - The URL to navigate the frame to.
5001
4999
  * @returns Promise that resolves when the navigation has completed.
5002
5000
  */
5003
- export function navigateCrossDomain(url: string): Promise<void>;
5001
+ function navigateCrossDomain(url: string): Promise<void>;
5004
5002
  /**
5005
5003
  * Navigate to the given application ID and page ID, with optional parameters for a WebURL (if the application
5006
5004
  * cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab),
@@ -5010,14 +5008,14 @@ export namespace pages {
5010
5008
  * @param params - Parameters for the navigation
5011
5009
  * @returns a promise that will resolve if the navigation was successful
5012
5010
  */
5013
- export function navigateToApp(params: NavigateToAppParams): Promise<void>;
5011
+ function navigateToApp(params: NavigateToAppParams): Promise<void>;
5014
5012
  /**
5015
5013
  * Shares a deep link that a user can use to navigate back to a specific state in this page.
5016
5014
  * Please note that this method does not yet work on mobile hosts.
5017
5015
  *
5018
5016
  * @param deepLinkParameters - ID and label for the link and fallback URL.
5019
5017
  */
5020
- export function shareDeepLink(deepLinkParameters: ShareDeepLinkParameters): void;
5018
+ function shareDeepLink(deepLinkParameters: ShareDeepLinkParameters): void;
5021
5019
  /**
5022
5020
  * Registers a handler for changes from or to full-screen view for a tab.
5023
5021
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -5025,18 +5023,18 @@ export namespace pages {
5025
5023
  * with this function will never be called.
5026
5024
  * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
5027
5025
  */
5028
- export function registerFullScreenHandler(handler: fullScreenChangeFunctionType): void;
5026
+ function registerFullScreenHandler(handler: fullScreenChangeFunctionType): void;
5029
5027
  /**
5030
5028
  * Checks if the pages capability is supported by the host
5031
5029
  * @returns boolean to represent whether the appEntity capability is supported
5032
5030
  *
5033
5031
  * @throws Error if {@linkcode app.initialize} has not successfully completed
5034
5032
  */
5035
- export function isSupported(): boolean;
5033
+ function isSupported(): boolean;
5036
5034
  /**
5037
5035
  * Parameters for the NavigateToApp API
5038
5036
  */
5039
- export interface NavigateToAppParams {
5037
+ interface NavigateToAppParams {
5040
5038
  /**
5041
5039
  * ID of the application to navigate to
5042
5040
  */
@@ -5063,7 +5061,7 @@ export namespace pages {
5063
5061
  * Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
5064
5062
  * contextual tabs are pages associated with a specific context, such as channel or chat.
5065
5063
  */
5066
- export namespace tabs {
5064
+ namespace tabs {
5067
5065
  /**
5068
5066
  * Navigates the hosted application to the specified tab instance.
5069
5067
  * @param tabInstance - The destination tab instance.
@@ -5095,7 +5093,7 @@ export namespace pages {
5095
5093
  * Provides APIs to interact with the configuration-specific part of the SDK.
5096
5094
  * This object is usable only on the configuration frame.
5097
5095
  */
5098
- export namespace config {
5096
+ namespace config {
5099
5097
  /**
5100
5098
  * @hidden
5101
5099
  * Hide from docs because this function is only used during initialization
@@ -5215,7 +5213,7 @@ export namespace pages {
5215
5213
  /**
5216
5214
  * Provides APIs for handling the user's navigational history.
5217
5215
  */
5218
- export namespace backStack {
5216
+ namespace backStack {
5219
5217
  /**
5220
5218
  * @hidden
5221
5219
  * Register backButtonPress handler.
@@ -5262,7 +5260,7 @@ export namespace pages {
5262
5260
  * ------
5263
5261
  * Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
5264
5262
  */
5265
- export namespace fullTrust {
5263
+ namespace fullTrust {
5266
5264
  /**
5267
5265
  * @hidden
5268
5266
  * Hide from docs
@@ -5290,7 +5288,7 @@ export namespace pages {
5290
5288
  /**
5291
5289
  * Provides APIs to interact with the app button part of the SDK.
5292
5290
  */
5293
- export namespace appButton {
5291
+ namespace appButton {
5294
5292
  /**
5295
5293
  * Registers a handler for clicking the app button.
5296
5294
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -5322,7 +5320,7 @@ export namespace pages {
5322
5320
  *
5323
5321
  * @beta
5324
5322
  */
5325
- export namespace currentApp {
5323
+ namespace currentApp {
5326
5324
  /**
5327
5325
  * Parameters for the NavigateWithinApp
5328
5326
  *
@@ -5365,13 +5363,12 @@ export namespace pages {
5365
5363
  */
5366
5364
  function isSupported(): boolean;
5367
5365
  }
5368
- export {};
5369
5366
  }
5370
5367
 
5371
5368
  /** onComplete function type */
5372
- type onCompleteFunctionType = (status: boolean, reason?: string) => void;
5369
+ export type onCompleteFunctionType = (status: boolean, reason?: string) => void;
5373
5370
  /** addEventListner function type */
5374
- type addEventListnerFunctionType = (message: any) => void;
5371
+ export type addEventListnerFunctionType = (message: any) => void;
5375
5372
  /** Represents a window or frame within the host app. */
5376
5373
  export interface IAppWindow {
5377
5374
  /**
@@ -5432,7 +5429,6 @@ export class ParentAppWindow implements IAppWindow {
5432
5429
  */
5433
5430
  addEventListener(type: string, listener: addEventListnerFunctionType): void;
5434
5431
  }
5435
- export {};
5436
5432
 
5437
5433
  /**
5438
5434
  * Namespace to interact with the menu-specific part of the SDK.
@@ -5628,15 +5624,15 @@ export namespace menus {
5628
5624
  */
5629
5625
  export namespace media {
5630
5626
  /** Capture image callback function type. */
5631
- type captureImageCallbackFunctionType = (error: SdkError, files: File[]) => void;
5627
+ export type captureImageCallbackFunctionType = (error: SdkError, files: File[]) => void;
5632
5628
  /** Select media callback function type. */
5633
- type selectMediaCallbackFunctionType = (error: SdkError, attachments: Media[]) => void;
5629
+ export type selectMediaCallbackFunctionType = (error: SdkError, attachments: Media[]) => void;
5634
5630
  /** Error callback function type. */
5635
- type errorCallbackFunctionType = (error?: SdkError) => void;
5631
+ export type errorCallbackFunctionType = (error?: SdkError) => void;
5636
5632
  /** Scan BarCode callback function type. */
5637
- type scanBarCodeCallbackFunctionType = (error: SdkError, decodedText: string) => void;
5633
+ export type scanBarCodeCallbackFunctionType = (error: SdkError, decodedText: string) => void;
5638
5634
  /** Get media callback function type. */
5639
- type getMediaCallbackFunctionType = (error: SdkError, blob: Blob) => void;
5635
+ export type getMediaCallbackFunctionType = (error: SdkError, blob: Blob) => void;
5640
5636
  /**
5641
5637
  * Enum for file formats supported
5642
5638
  */
@@ -6083,7 +6079,7 @@ export namespace location {
6083
6079
  * @deprecated
6084
6080
  * Data Structure to set the location properties in getLocation call.
6085
6081
  */
6086
- export interface LocationProps {
6082
+ interface LocationProps {
6087
6083
  /**
6088
6084
  whether user can alter location or not
6089
6085
  if false, user will be shown current location
@@ -6102,7 +6098,7 @@ export namespace location {
6102
6098
  * @deprecated
6103
6099
  * Data struture to represent the location information
6104
6100
  */
6105
- export interface Location {
6101
+ interface Location {
6106
6102
  /**
6107
6103
  Latitude of the location
6108
6104
  */
@@ -6130,7 +6126,7 @@ export namespace location {
6130
6126
  * @param props {@link LocationProps} - Specifying how the location request is handled
6131
6127
  * @param callback - Callback to invoke when current user location is fetched
6132
6128
  */
6133
- export function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
6129
+ function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
6134
6130
  /**
6135
6131
  * @deprecated
6136
6132
  * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
@@ -6140,7 +6136,7 @@ export namespace location {
6140
6136
  * @param location - Location to be shown on the map
6141
6137
  * @param callback - Callback to invoke when the location is opened on map
6142
6138
  */
6143
- export function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
6139
+ function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
6144
6140
  /**
6145
6141
  * @deprecated
6146
6142
  * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
@@ -6151,8 +6147,7 @@ export namespace location {
6151
6147
  *
6152
6148
  * @returns boolean to represent whether Location is supported
6153
6149
  */
6154
- export function isSupported(): boolean;
6155
- export {};
6150
+ function isSupported(): boolean;
6156
6151
  }
6157
6152
 
6158
6153
  /**
@@ -6184,7 +6179,7 @@ export namespace meeting {
6184
6179
  * @internal
6185
6180
  * Limited to Microsoft-internal use
6186
6181
  */
6187
- export interface IMeetingDetailsResponse {
6182
+ interface IMeetingDetailsResponse {
6188
6183
  /**
6189
6184
  * @hidden
6190
6185
  * details object
@@ -6206,7 +6201,7 @@ export namespace meeting {
6206
6201
  * Hide from docs
6207
6202
  * Base data structure to represent a meeting or call detail
6208
6203
  */
6209
- export interface IMeetingOrCallDetailsBase<T> {
6204
+ interface IMeetingOrCallDetailsBase<T> {
6210
6205
  /**
6211
6206
  * @hidden
6212
6207
  * Scheduled start time of the meeting or start time of the call
@@ -6228,13 +6223,13 @@ export namespace meeting {
6228
6223
  * Hide from docs
6229
6224
  * Data structure to represent call details
6230
6225
  */
6231
- export type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
6226
+ type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
6232
6227
  /**
6233
6228
  * @hidden
6234
6229
  * Hide from docs
6235
6230
  * Data structure to represent meeting details.
6236
6231
  */
6237
- export interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
6232
+ interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
6238
6233
  /**
6239
6234
  * @hidden
6240
6235
  * Scheduled end time of the meeting
@@ -6253,7 +6248,7 @@ export namespace meeting {
6253
6248
  * @internal
6254
6249
  * Limited to Microsoft-internal use
6255
6250
  */
6256
- export interface IConversation {
6251
+ interface IConversation {
6257
6252
  /**
6258
6253
  * @hidden
6259
6254
  * conversation id of the meeting
@@ -6267,7 +6262,7 @@ export namespace meeting {
6267
6262
  * @internal
6268
6263
  * Limited to Microsoft-internal use
6269
6264
  */
6270
- export interface IOrganizer {
6265
+ interface IOrganizer {
6271
6266
  /**
6272
6267
  * @hidden
6273
6268
  * organizer id of the meeting
@@ -6285,7 +6280,7 @@ export namespace meeting {
6285
6280
  * @remarks
6286
6281
  * RTMP is a popular communication protocol for streaming audio, video, and data over the Internet.
6287
6282
  */
6288
- export interface LiveStreamState {
6283
+ interface LiveStreamState {
6289
6284
  /**
6290
6285
  * true when the current meeting is being streamed through RTMP, or false if it is not.
6291
6286
  */
@@ -6301,7 +6296,7 @@ export namespace meeting {
6301
6296
  };
6302
6297
  }
6303
6298
  /** Represents app permission to share contents to meeting. */
6304
- export interface IAppContentStageSharingCapabilities {
6299
+ interface IAppContentStageSharingCapabilities {
6305
6300
  /**
6306
6301
  * indicates whether app has permission to share contents to meeting stage.
6307
6302
  * true when your `configurableTabs` or `staticTabs` entry's `context` array includes `meetingStage`.
@@ -6309,7 +6304,7 @@ export namespace meeting {
6309
6304
  doesAppHaveSharePermission: boolean;
6310
6305
  }
6311
6306
  /** Represents app being shared to stage. */
6312
- export interface IAppContentStageSharingState {
6307
+ interface IAppContentStageSharingState {
6313
6308
  /**
6314
6309
  * indicates whether app is currently being shared to stage
6315
6310
  */
@@ -6319,7 +6314,7 @@ export namespace meeting {
6319
6314
  * Property bag for the speakingState changed event
6320
6315
  *
6321
6316
  */
6322
- export interface ISpeakingState {
6317
+ interface ISpeakingState {
6323
6318
  /**
6324
6319
  * true when one or more participants in a meeting are speaking, or false if no participants are speaking
6325
6320
  */
@@ -6340,7 +6335,7 @@ export namespace meeting {
6340
6335
  *
6341
6336
  * @beta
6342
6337
  */
6343
- export interface MeetingReactionReceivedEventData {
6338
+ interface MeetingReactionReceivedEventData {
6344
6339
  /**
6345
6340
  * Indicates the type of meeting reaction received
6346
6341
  *
@@ -6367,7 +6362,7 @@ export namespace meeting {
6367
6362
  *
6368
6363
  * @beta
6369
6364
  */
6370
- export interface IRaiseHandState {
6365
+ interface IRaiseHandState {
6371
6366
  /** Indicates whether the selfParticipant's hand is raised or not
6372
6367
  *
6373
6368
  * @hidden
@@ -6386,7 +6381,7 @@ export namespace meeting {
6386
6381
  *
6387
6382
  * @beta
6388
6383
  */
6389
- export interface RaiseHandStateChangedEventData {
6384
+ interface RaiseHandStateChangedEventData {
6390
6385
  /**
6391
6386
  * entire raiseHandState object for the selfParticipant
6392
6387
  *
@@ -6413,7 +6408,7 @@ export namespace meeting {
6413
6408
  *
6414
6409
  * @beta
6415
6410
  */
6416
- export interface MicState {
6411
+ interface MicState {
6417
6412
  /**
6418
6413
  * Indicates the mute status of the mic
6419
6414
  */
@@ -6430,7 +6425,7 @@ export namespace meeting {
6430
6425
  *
6431
6426
  * @beta
6432
6427
  */
6433
- export interface RequestAppAudioHandlingParams {
6428
+ interface RequestAppAudioHandlingParams {
6434
6429
  /**
6435
6430
  * Indicates whether the app is requesting to start handling audio, or if
6436
6431
  * it's giving audio back to the host
@@ -6454,7 +6449,7 @@ export namespace meeting {
6454
6449
  *
6455
6450
  * @beta
6456
6451
  */
6457
- export enum MeetingReactionType {
6452
+ enum MeetingReactionType {
6458
6453
  like = "like",
6459
6454
  heart = "heart",
6460
6455
  laugh = "laugh",
@@ -6470,7 +6465,7 @@ export namespace meeting {
6470
6465
  * @remarks
6471
6466
  * Teams has several types of meetings to account for different user scenarios and requirements.
6472
6467
  */
6473
- export enum MeetingType {
6468
+ enum MeetingType {
6474
6469
  /**
6475
6470
  * Used when the meeting type is not known.
6476
6471
  *
@@ -6524,7 +6519,7 @@ export namespace meeting {
6524
6519
  * @hidden
6525
6520
  * Hide from docs.
6526
6521
  */
6527
- export enum CallType {
6522
+ enum CallType {
6528
6523
  /**
6529
6524
  * Represents a call between two people.
6530
6525
  *
@@ -6555,7 +6550,7 @@ export namespace meeting {
6555
6550
  * `error` can either contain an error of type `SdkError`, in case of an error, or null when fetch is successful.
6556
6551
  * `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the request fails.
6557
6552
  */
6558
- export function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
6553
+ function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
6559
6554
  /**
6560
6555
  * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa.
6561
6556
  * To learn more, visit https://aka.ms/teamsjs/toggleIncomingClientAudio
@@ -6570,7 +6565,7 @@ export namespace meeting {
6570
6565
  * `error` can either contain an error of type `SdkError`, in case of an error, or null when toggle is successful.
6571
6566
  * `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the toggling fails.
6572
6567
  */
6573
- export function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
6568
+ function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
6574
6569
  /**
6575
6570
  * @hidden
6576
6571
  * Allows an app to get the meeting details for the meeting
@@ -6582,7 +6577,7 @@ export namespace meeting {
6582
6577
  * @internal
6583
6578
  * Limited to Microsoft-internal use
6584
6579
  */
6585
- export function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
6580
+ function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
6586
6581
  /**
6587
6582
  * @hidden
6588
6583
  * Allows an app to get the authentication token for the anonymous or guest user in the meeting
@@ -6594,7 +6589,7 @@ export namespace meeting {
6594
6589
  * @internal
6595
6590
  * Limited to Microsoft-internal use
6596
6591
  */
6597
- export function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
6592
+ function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
6598
6593
  /**
6599
6594
  * Allows an app to get the state of the outgoing live stream in the current meeting.
6600
6595
  *
@@ -6608,7 +6603,7 @@ export namespace meeting {
6608
6603
  * `error` can either contain an error of type `SdkError`, in case of an error, or null when the request is successful
6609
6604
  * `liveStreamState` can either contain a `LiveStreamState` value, or null when operation fails
6610
6605
  */
6611
- export function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
6606
+ function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
6612
6607
  /**
6613
6608
  * Allows an app to ask the local user to begin live streaming the current meeting to the given Real-Time Messaging Protocol (RTMP) stream url.
6614
6609
  * A confirmation dialog will be shown to the local user with options to "Allow" or "Cancel" this request.
@@ -6625,7 +6620,7 @@ export namespace meeting {
6625
6620
  * @param streamUrl - the url to the RTMP stream resource
6626
6621
  * @param streamKey - the key to the RTMP stream resource
6627
6622
  */
6628
- export function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
6623
+ function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
6629
6624
  /**
6630
6625
  * Allows an app to request that live streaming be stopped.
6631
6626
  *
@@ -6637,7 +6632,7 @@ export namespace meeting {
6637
6632
  *
6638
6633
  * @param callback - completion callback that contains an error parameter, which can be of type `SdkError` in case of an error, or null when operation is successful
6639
6634
  */
6640
- export function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
6635
+ function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
6641
6636
  /**
6642
6637
  * Registers an event handler for state changes to the live stream.
6643
6638
  *
@@ -6650,7 +6645,7 @@ export namespace meeting {
6650
6645
  *
6651
6646
  * @param handler - The handler to invoke when the live stream state changes
6652
6647
  */
6653
- export function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
6648
+ function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
6654
6649
  /**
6655
6650
  * Allows an app to share a given URL to the meeting stage for all users in the meeting.
6656
6651
  * To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
@@ -6669,7 +6664,7 @@ export namespace meeting {
6669
6664
  * @param appContentUrl - is the input URL to be shared to the meeting stage.
6670
6665
  * the URL origin must be included in your app manifest's `validDomains` field.
6671
6666
  */
6672
- export function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string): void;
6667
+ function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string): void;
6673
6668
  /**
6674
6669
  * Allows an app to request whether the local user's app version has the required app manifest permissions to share content to meeting stage.
6675
6670
  * To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingCapabilities
@@ -6687,7 +6682,7 @@ export namespace meeting {
6687
6682
  * `error` can either contain an error of type `SdkError` (error indication), or null (non-error indication).
6688
6683
  * `appContentStageSharingCapabilities` will contain an {@link IAppContentStageSharingCapabilities} object if the request succeeds, or null if it failed.
6689
6684
  */
6690
- export function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
6685
+ function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
6691
6686
  /**
6692
6687
  * @hidden
6693
6688
  * Hide from docs.
@@ -6697,7 +6692,7 @@ export namespace meeting {
6697
6692
  * error can either contain an error of type SdkError (error indication), or null (non-error indication)
6698
6693
  * result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
6699
6694
  */
6700
- export function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
6695
+ function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
6701
6696
  /**
6702
6697
  * Provides information related to current stage sharing state for your app.
6703
6698
  * To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingState
@@ -6712,7 +6707,7 @@ export namespace meeting {
6712
6707
  * error can either contain an error of type SdkError (error indication), or null (non-error indication)
6713
6708
  * `appContentStageSharingState` can either contain an `IAppContentStageSharingState` object if the request succeeds, or null if it failed
6714
6709
  */
6715
- export function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
6710
+ function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
6716
6711
  /**
6717
6712
  * Registers a handler for changes to participant speaking states.
6718
6713
  * To learn more, visit https://aka.ms/teamsjs/registerSpeakingStateChangeHandler
@@ -6728,7 +6723,7 @@ export namespace meeting {
6728
6723
  *
6729
6724
  * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
6730
6725
  */
6731
- export function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
6726
+ function registerSpeakingStateChangeHandler(handler: registerSpeakingStateChangeHandlerFunctionType): void;
6732
6727
  /**
6733
6728
  * Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
6734
6729
  * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
@@ -6745,7 +6740,7 @@ export namespace meeting {
6745
6740
  *
6746
6741
  * @beta
6747
6742
  */
6748
- export function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
6743
+ function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
6749
6744
  /**
6750
6745
  * Registers a handler for receiving meeting reactions. When the selfParticipant (current user) successfully sends a meeting reaction and it is being rendered on the UI, the meetingReactionType will be populated. Only one handler can be registered
6751
6746
  * at a time. A subsequent registration replaces an existing registration.
@@ -6760,7 +6755,7 @@ export namespace meeting {
6760
6755
  *
6761
6756
  * @beta
6762
6757
  */
6763
- export function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
6758
+ function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
6764
6759
  /**
6765
6760
  * Nested namespace for functions to control behavior of the app share button
6766
6761
  *
@@ -6772,7 +6767,7 @@ export namespace meeting {
6772
6767
  *
6773
6768
  * @beta
6774
6769
  */
6775
- export namespace appShareButton {
6770
+ namespace appShareButton {
6776
6771
  /**
6777
6772
  * Property bag for the setVisibilityInfo
6778
6773
  *
@@ -6838,7 +6833,7 @@ export namespace meeting {
6838
6833
  *
6839
6834
  * @beta
6840
6835
  */
6841
- export function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
6836
+ function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
6842
6837
  /**
6843
6838
  * Notifies the host that the microphone state has changed in the app.
6844
6839
  * @param micState - The new state that the microphone is in
@@ -6852,8 +6847,7 @@ export namespace meeting {
6852
6847
  *
6853
6848
  * @beta
6854
6849
  */
6855
- export function updateMicState(micState: MicState): void;
6856
- export {};
6850
+ function updateMicState(micState: MicState): void;
6857
6851
  }
6858
6852
 
6859
6853
  export namespace monetization {
@@ -7066,11 +7060,11 @@ export namespace teamsCore {
7066
7060
  /**
7067
7061
  * Enable print capability to support printing page using Ctrl+P and cmd+P
7068
7062
  */
7069
- export function enablePrintCapability(): void;
7063
+ function enablePrintCapability(): void;
7070
7064
  /**
7071
7065
  * default print handler
7072
7066
  */
7073
- export function print(): void;
7067
+ function print(): void;
7074
7068
  /**
7075
7069
  * Registers a handler to be called when the page has been requested to load.
7076
7070
  *
@@ -7079,12 +7073,9 @@ export namespace teamsCore {
7079
7073
  *
7080
7074
  * @param handler - The handler to invoke when the page is loaded.
7081
7075
  *
7082
- * @deprecated
7083
- * As of 2.14.1, please use {@link app.lifecycle.registerOnResumeHandler} instead.
7084
- *
7085
7076
  * @beta
7086
7077
  */
7087
- export function registerOnLoadHandler(handler: registerOnLoadHandlerFunctionType): void;
7078
+ function registerOnLoadHandler(handler: registerOnLoadHandlerFunctionType): void;
7088
7079
  /**
7089
7080
  * @hidden
7090
7081
  * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
@@ -7097,7 +7088,7 @@ export namespace teamsCore {
7097
7088
  *
7098
7089
  * @deprecated
7099
7090
  */
7100
- export function registerOnLoadHandlerHelper(handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
7091
+ function registerOnLoadHandlerHelper(handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
7101
7092
  /**
7102
7093
  * Registers a handler to be called before the page is unloaded.
7103
7094
  *
@@ -7107,10 +7098,9 @@ export namespace teamsCore {
7107
7098
  * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
7108
7099
  * invoke the readyToUnload function provided to it once it's ready to be unloaded.
7109
7100
  *
7110
- * @deprecated
7111
7101
  * @beta
7112
7102
  */
7113
- export function registerBeforeUnloadHandler(handler: registerBeforeUnloadHandlerFunctionType): void;
7103
+ function registerBeforeUnloadHandler(handler: registerBeforeUnloadHandlerFunctionType): void;
7114
7104
  /**
7115
7105
  * @hidden
7116
7106
  * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
@@ -7124,7 +7114,7 @@ export namespace teamsCore {
7124
7114
  *
7125
7115
  * @deprecated
7126
7116
  */
7127
- export function registerBeforeUnloadHandlerHelper(handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
7117
+ function registerBeforeUnloadHandlerHelper(handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
7128
7118
  /**
7129
7119
  * Checks if teamsCore capability is supported by the host
7130
7120
  *
@@ -7133,8 +7123,7 @@ export namespace teamsCore {
7133
7123
  * @throws Error if {@linkcode app.initialize} has not successfully completed
7134
7124
  *
7135
7125
  */
7136
- export function isSupported(): boolean;
7137
- export {};
7126
+ function isSupported(): boolean;
7138
7127
  }
7139
7128
 
7140
7129
  export namespace people {
@@ -7353,7 +7342,7 @@ export namespace videoEffects {
7353
7342
  * Represents a video frame
7354
7343
  * @beta
7355
7344
  */
7356
- export interface VideoBufferData {
7345
+ interface VideoBufferData {
7357
7346
  /**
7358
7347
  * Video frame width
7359
7348
  */
@@ -7387,7 +7376,7 @@ export namespace videoEffects {
7387
7376
  * Video frame format enum, currently only support NV12
7388
7377
  * @beta
7389
7378
  */
7390
- export enum VideoFrameFormat {
7379
+ enum VideoFrameFormat {
7391
7380
  /** Video format used for encoding and decoding YUV color data in video streaming and storage applications. */
7392
7381
  NV12 = "NV12"
7393
7382
  }
@@ -7395,7 +7384,7 @@ export namespace videoEffects {
7395
7384
  * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
7396
7385
  * @beta
7397
7386
  */
7398
- export interface VideoFrameConfig {
7387
+ interface VideoFrameConfig {
7399
7388
  /**
7400
7389
  * Video format
7401
7390
  */
@@ -7405,7 +7394,7 @@ export namespace videoEffects {
7405
7394
  * Video effect change type enum
7406
7395
  * @beta
7407
7396
  */
7408
- export enum EffectChangeType {
7397
+ enum EffectChangeType {
7409
7398
  /**
7410
7399
  * Current video effect changed
7411
7400
  */
@@ -7419,7 +7408,7 @@ export namespace videoEffects {
7419
7408
  * Predefined failure reasons for preparing the selected video effect
7420
7409
  * @beta
7421
7410
  */
7422
- export enum EffectFailureReason {
7411
+ enum EffectFailureReason {
7423
7412
  /**
7424
7413
  * A wrong effect id is provide.
7425
7414
  * Use this reason when the effect id is not found or empty, this may indicate a mismatch between the app and its manifest or a bug of the host.
@@ -7435,7 +7424,7 @@ export namespace videoEffects {
7435
7424
  * Return a Promise which will be resolved when the effect is prepared, or throw an {@link EffectFailureReason} on error.
7436
7425
  * @beta
7437
7426
  */
7438
- export type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
7427
+ type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
7439
7428
  /**
7440
7429
  * @beta
7441
7430
  * Video frame call back function definition
@@ -7444,20 +7433,20 @@ export namespace videoEffects {
7444
7433
  * The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
7445
7434
  * The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
7446
7435
  */
7447
- export type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType, notifyError: notifyErrorFunctionType) => void;
7436
+ type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType, notifyError: notifyErrorFunctionType) => void;
7448
7437
  /**
7449
7438
  * @beta
7450
7439
  * VideoFrame definition, align with the W3C spec: https://www.w3.org/TR/webcodecs/#videoframe-interface.
7451
7440
  * The current version of typescript doesn't have the definition of VideoFrame so we have to define it here.
7452
7441
  * At runtime it can be cast to VideoFrame directly: `(videoFrame as VideoFrame)`.
7453
7442
  */
7454
- export interface VideoFrame {
7443
+ interface VideoFrame {
7455
7444
  }
7456
7445
  /**
7457
7446
  * @beta
7458
7447
  * Video frame data extracted from the media stream. More properties may be added in the future.
7459
7448
  */
7460
- export type VideoFrameData = {
7449
+ type VideoFrameData = {
7461
7450
  /**
7462
7451
  * The video frame from the media stream.
7463
7452
  */
@@ -7471,12 +7460,12 @@ export namespace videoEffects {
7471
7460
  * The video app should resolve the promise to notify a successfully processed video frame.
7472
7461
  * The video app should reject the promise to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
7473
7462
  */
7474
- export type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<VideoFrame>;
7463
+ type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<VideoFrame>;
7475
7464
  /**
7476
7465
  * @beta
7477
7466
  * Callbacks and configuration supplied to the host to process the video frames.
7478
7467
  */
7479
- export type RegisterForVideoFrameParameters = {
7468
+ type RegisterForVideoFrameParameters = {
7480
7469
  /**
7481
7470
  * Callback function to process the video frames extracted from a media stream.
7482
7471
  */
@@ -7527,7 +7516,7 @@ export namespace videoEffects {
7527
7516
  * });
7528
7517
  * ```
7529
7518
  */
7530
- export function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
7519
+ function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
7531
7520
  /**
7532
7521
  * Video extension should call this to notify host that the current selected effect parameter changed.
7533
7522
  * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
@@ -7536,13 +7525,13 @@ export namespace videoEffects {
7536
7525
  * @param effectChangeType - the effect change type.
7537
7526
  * @param effectId - Newly selected effect id.
7538
7527
  */
7539
- export function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
7528
+ function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
7540
7529
  /**
7541
7530
  * Register a callback to be notified when a new video effect is applied.
7542
7531
  * @beta
7543
7532
  * @param callback - Function to be called when new video effect is applied.
7544
7533
  */
7545
- export function registerForVideoEffect(callback: VideoEffectCallback): void;
7534
+ function registerForVideoEffect(callback: VideoEffectCallback): void;
7546
7535
  /**
7547
7536
  * Checks if video capability is supported by the host.
7548
7537
  * @beta
@@ -7551,8 +7540,7 @@ export namespace videoEffects {
7551
7540
  * @throws Error if {@linkcode app.initialize} has not successfully completed
7552
7541
  *
7553
7542
  */
7554
- export function isSupported(): boolean;
7555
- export {};
7543
+ function isSupported(): boolean;
7556
7544
  }
7557
7545
 
7558
7546
  /**
@@ -7653,7 +7641,7 @@ export namespace search {
7653
7641
  */
7654
7642
  export namespace sharing {
7655
7643
  /** shareWebContent callback function type */
7656
- type shareWebContentCallbackFunctionType = (err?: SdkError) => void;
7644
+ export type shareWebContentCallbackFunctionType = (err?: SdkError) => void;
7657
7645
  /** Type of message that can be sent or received by the sharing APIs */
7658
7646
  export const SharingAPIMessages: {
7659
7647
  /**
@@ -7930,19 +7918,19 @@ export namespace appInitialization {
7930
7918
  }
7931
7919
 
7932
7920
  /** Execute deep link on complete function type */
7933
- type executeDeepLinkOnCompleteFunctionType = (status: boolean, reason?: string) => void;
7921
+ export type executeDeepLinkOnCompleteFunctionType = (status: boolean, reason?: string) => void;
7934
7922
  /** Callback function type */
7935
- type callbackFunctionType = () => void;
7923
+ export type callbackFunctionType = () => void;
7936
7924
  /** Get context callback function type */
7937
- type getContextCallbackFunctionType = (context: Context) => void;
7925
+ export type getContextCallbackFunctionType = (context: Context) => void;
7938
7926
  /** Get tab instances callback function type */
7939
- type getTabInstancesCallbackFunctionType = (tabInfo: TabInformation) => void;
7927
+ export type getTabInstancesCallbackFunctionType = (tabInfo: TabInformation) => void;
7940
7928
  /** Register back button handler function type */
7941
- type registerBackButtonHandlerFunctionType = () => boolean;
7929
+ export type registerBackButtonHandlerFunctionType = () => boolean;
7942
7930
  /** Register full screen handler function type */
7943
- type registerFullScreenHandlerFunctionType = (isFullScreen: boolean) => void;
7931
+ export type registerFullScreenHandlerFunctionType = (isFullScreen: boolean) => void;
7944
7932
  /** Register on theme change handler function type */
7945
- type registerOnThemeChangeHandlerFunctionType = (theme: string) => void;
7933
+ export type registerOnThemeChangeHandlerFunctionType = (theme: string) => void;
7946
7934
  /**
7947
7935
  * @deprecated
7948
7936
  * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
@@ -8139,10 +8127,9 @@ export function setFrameContext(frameContext: FrameContext): void;
8139
8127
  * They must have https: protocol otherwise they will be ignored. Example: https:www.example.com
8140
8128
  */
8141
8129
  export function initializeWithFrameContext(frameContext: FrameContext, callback?: callbackFunctionType, validMessageOrigins?: string[]): void;
8142
- export {};
8143
8130
 
8144
8131
  /** Navigation on complete handler function type */
8145
- type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
8132
+ export type onCompleteHandlerFunctionType = (status: boolean, reason?: string) => void;
8146
8133
  /**
8147
8134
  * @deprecated
8148
8135
  * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
@@ -8186,7 +8173,6 @@ export function navigateCrossDomain(url: string, onComplete?: onCompleteHandlerF
8186
8173
  * @param onComplete - The callback to invoke when the action is complete.
8187
8174
  */
8188
8175
  export function navigateBack(onComplete?: onCompleteHandlerFunctionType): void;
8189
- export {};
8190
8176
 
8191
8177
  /**
8192
8178
  * @deprecated
@@ -8241,7 +8227,7 @@ export namespace settings {
8241
8227
  *
8242
8228
  * @param validityState - Indicates whether the save or remove button is enabled for the user.
8243
8229
  */
8244
- export function setValidityState(validityState: boolean): void;
8230
+ function setValidityState(validityState: boolean): void;
8245
8231
  /**
8246
8232
  * @deprecated
8247
8233
  * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
@@ -8250,7 +8236,7 @@ export namespace settings {
8250
8236
  *
8251
8237
  * @param callback - The callback to invoke when the {@link Settings} object is retrieved.
8252
8238
  */
8253
- export function getSettings(callback: getSettingsCallbackFunctionType): void;
8239
+ function getSettings(callback: getSettingsCallbackFunctionType): void;
8254
8240
  /**
8255
8241
  * @deprecated
8256
8242
  * As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
@@ -8260,7 +8246,7 @@ export namespace settings {
8260
8246
  *
8261
8247
  * @param - Set the desired settings for this instance.
8262
8248
  */
8263
- export function setSettings(instanceSettings: Settings, onComplete?: setSettingsOnCompleteFunctionType): void;
8249
+ function setSettings(instanceSettings: Settings, onComplete?: setSettingsOnCompleteFunctionType): void;
8264
8250
  /**
8265
8251
  * @deprecated
8266
8252
  * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead.
@@ -8272,7 +8258,7 @@ export namespace settings {
8272
8258
  *
8273
8259
  * @param handler - The handler to invoke when the user selects the save button.
8274
8260
  */
8275
- export function registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void;
8261
+ function registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void;
8276
8262
  /**
8277
8263
  * @deprecated
8278
8264
  * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
@@ -8284,8 +8270,7 @@ export namespace settings {
8284
8270
  *
8285
8271
  * @param handler - The handler to invoke when the user selects the remove button.
8286
8272
  */
8287
- export function registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void;
8288
- export {};
8273
+ function registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void;
8289
8274
  }
8290
8275
 
8291
8276
  /**
@@ -8314,7 +8299,7 @@ export namespace tasks {
8314
8299
  * @param taskInfo - An object containing the parameters of the task module
8315
8300
  * @param submitHandler - Handler to call when the task module is completed
8316
8301
  */
8317
- export function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
8302
+ function startTask(taskInfo: TaskInfo, submitHandler?: startTaskSubmitHandlerFunctionType): IAppWindow;
8318
8303
  /**
8319
8304
  * @deprecated
8320
8305
  * As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
@@ -8323,7 +8308,7 @@ export namespace tasks {
8323
8308
  *
8324
8309
  * @param taskInfo - An object containing width and height properties
8325
8310
  */
8326
- export function updateTask(taskInfo: TaskInfo): void;
8311
+ function updateTask(taskInfo: TaskInfo): void;
8327
8312
  /**
8328
8313
  * @deprecated
8329
8314
  * As of 2.8.0, please use {@link dialog.url.submit} instead.
@@ -8333,15 +8318,14 @@ export namespace tasks {
8333
8318
  * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
8334
8319
  * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
8335
8320
  */
8336
- export function submitTask(result?: string | object, appIds?: string | string[]): void;
8321
+ function submitTask(result?: string | object, appIds?: string | string[]): void;
8337
8322
  /**
8338
8323
  * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
8339
8324
  * otherwise uses the height and width values corresponding to {@link DialogDimension | TaskModuleDimension.Small}
8340
8325
  * @param taskInfo TaskInfo object from which to extract size info, if specified
8341
8326
  * @returns TaskInfo with height and width specified
8342
8327
  */
8343
- export function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
8344
- export {};
8328
+ function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
8345
8329
  }
8346
8330
 
8347
8331
  /**