@microsoft/teams-js 2.7.2-beta.0 → 2.8.0-beta.1

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.
@@ -2220,6 +2220,9 @@ export namespace authentication {
2220
2220
  /**
2221
2221
  * Initiates an authentication request, which opens a new window with the specified settings.
2222
2222
  *
2223
+ * @remarks
2224
+ * The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
2225
+ *
2223
2226
  * @param authenticateParameters - The parameters for the authentication request. It is a required parameter since v2 upgrade
2224
2227
  *
2225
2228
  * @returns Promise that will be fulfilled with the result from the authentication pop-up if successful.
@@ -2234,6 +2237,9 @@ export namespace authentication {
2234
2237
  *
2235
2238
  * Initiates an authentication request, which opens a new window with the specified settings.
2236
2239
  *
2240
+ * @remarks
2241
+ * The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
2242
+ *
2237
2243
  * @param authenticateParameters - The parameters for the authentication request.
2238
2244
  *
2239
2245
  */
@@ -2647,6 +2653,12 @@ export enum ChannelType {
2647
2653
  Shared = "Shared"
2648
2654
  }
2649
2655
  export const errorNotSupportedOnPlatform: SdkError;
2656
+ /**
2657
+ * @hidden
2658
+ *
2659
+ * Minimum Adaptive Card version supported by the host.
2660
+ */
2661
+ export const minAdaptiveCardVersion: AdaptiveCardVersion;
2650
2662
 
2651
2663
  /**
2652
2664
  * Represents information about tabs for an app
@@ -3302,6 +3314,37 @@ export interface DeepLinkParameters {
3302
3314
  */
3303
3315
  subEntityWebUrl?: string;
3304
3316
  }
3317
+ /**
3318
+ * @hidden
3319
+ * Shared Dialog Properties
3320
+ */
3321
+ export interface BaseDialogInfo {
3322
+ size: DialogSize;
3323
+ /**
3324
+ * Title of the dialog module.
3325
+ */
3326
+ title?: string;
3327
+ }
3328
+ /**
3329
+ * Data structure to describe dialog information needed to open an Adaptive Card-based dialog.
3330
+ */
3331
+ export interface AdaptiveCardDialogInfo extends BaseDialogInfo {
3332
+ /**
3333
+ * JSON defining an Adaptive Card.
3334
+ */
3335
+ card: string;
3336
+ }
3337
+ /**
3338
+ * Data structure to describe dialog information needed to open a bot-based Adaptive Card-based dialog.
3339
+ */
3340
+ export interface BotAdaptiveCardDialogInfo extends AdaptiveCardDialogInfo {
3341
+ /**
3342
+ * Specifies a bot ID to send the result of the user's interaction with the dialog module.
3343
+ * The bot will receive a task/complete invoke event with a JSON object
3344
+ * in the event payload.
3345
+ */
3346
+ completionBotId: string;
3347
+ }
3305
3348
  /**
3306
3349
  * Data structure to represent the size of a dialog
3307
3350
  */
@@ -3316,22 +3359,17 @@ export interface DialogSize {
3316
3359
  width: DialogDimension | number;
3317
3360
  }
3318
3361
  /**
3319
- * Data structure to describe dialog information needed to open a url based dialog.
3362
+ * Data structure to describe dialog information needed to open a url-based dialog.
3320
3363
  */
3321
- export interface UrlDialogInfo {
3364
+ export interface UrlDialogInfo extends BaseDialogInfo {
3322
3365
  /**
3323
3366
  * The url to be rendered in the webview/iframe.
3324
3367
  *
3325
3368
  * @remarks
3326
3369
  * The domain of the url must match at least one of the
3327
- * valid domains specified in the validDomains block of the manifest
3370
+ * valid domains specified in the [validDomains block](https://learn.microsoft.com/microsoftteams/platform/resources/schema/manifest-schema#validdomains) of the app manifest
3328
3371
  */
3329
3372
  url: string;
3330
- size: DialogSize;
3331
- /**
3332
- * Title of the task module.
3333
- */
3334
- title?: string;
3335
3373
  /**
3336
3374
  * If client doesnt support the URL, the URL that needs to be opened in the browser.
3337
3375
  */
@@ -3508,6 +3546,17 @@ export enum DevicePermission {
3508
3546
  GeoLocation = "geolocation",
3509
3547
  Media = "media"
3510
3548
  }
3549
+ /** @hidden */
3550
+ export interface HostVersionsInfo {
3551
+ adaptiveCardSchemaVersion?: AdaptiveCardVersion;
3552
+ }
3553
+ /**
3554
+ * Represents the major and minor versions of the Adaptive Card schema in the current host
3555
+ */
3556
+ export interface AdaptiveCardVersion {
3557
+ majorVersion: number;
3558
+ minorVersion: number;
3559
+ }
3511
3560
 
3512
3561
  /**
3513
3562
  * Namespace to interact with app initialization and lifecycle.
@@ -3801,7 +3850,8 @@ export namespace app {
3801
3850
  */
3802
3851
  isPSTNCallingAllowed?: boolean;
3803
3852
  /**
3804
- * The license type for the current user.
3853
+ * The license type for the current user. Possible values are:
3854
+ * "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker"
3805
3855
  */
3806
3856
  licenseType?: string;
3807
3857
  /**
@@ -3901,7 +3951,7 @@ export namespace app {
3901
3951
  */
3902
3952
  meeting?: MeetingInfo;
3903
3953
  /**
3904
- * When hosted in SharePoint, this is the [SharePoint PageContext](https://learn.microsoft.com/en-us/javascript/api/sp-page-context/pagecontext?view=sp-typescript-latest), else `undefined`
3954
+ * When hosted in SharePoint, this is the [SharePoint PageContext](https://learn.microsoft.com/javascript/api/sp-page-context/pagecontext?view=sp-typescript-latest), else `undefined`
3905
3955
  */
3906
3956
  sharepoint?: any;
3907
3957
  /**
@@ -4166,7 +4216,7 @@ export namespace dialog {
4166
4216
  */
4167
4217
  err?: string;
4168
4218
  /**
4169
- * Value provided in the `result` parameter by the dialog when the {@linkcode submit} function
4219
+ * Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
4170
4220
  * was called.
4171
4221
  * If the dialog was closed by the user without submitting (e.g., using a control in the corner
4172
4222
  * of the dialog), this value will be `undefined` here.
@@ -4179,7 +4229,7 @@ export namespace dialog {
4179
4229
  */
4180
4230
  type PostMessageChannel = (message: any) => void;
4181
4231
  /**
4182
- * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode submit}
4232
+ * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
4183
4233
  * or an error if the dialog was closed by the user.
4184
4234
  * @beta
4185
4235
  */
@@ -4196,68 +4246,130 @@ export namespace dialog {
4196
4246
  * @beta
4197
4247
  */
4198
4248
  function initialize(): void;
4199
- /**
4200
- * Allows app to open a url based dialog.
4201
- *
4202
- * @remarks
4203
- * This function cannot be called from inside of a dialog
4204
- *
4205
- * @param urlDialogInfo - An object containing the parameters of the dialog module.
4206
- * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
4207
- * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
4208
- *
4209
- * @returns a function that can be used to send messages to the dialog.
4210
- *
4211
- * @beta
4212
- */
4213
- function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
4214
- /**
4215
- * Submit the dialog module and close the dialog
4216
- *
4217
- * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
4218
- * If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
4219
- *
4220
- * @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.
4221
- *
4222
- * @beta
4223
- */
4224
- function submit(result?: string | object, appIds?: string | string[]): void;
4225
- /**
4226
- * Send message to the parent from dialog
4227
- *
4228
- * @remarks
4229
- * This function is only called from inside of a dialog
4230
- *
4231
- * @param message - The message to send to the parent
4232
- *
4233
- * @beta
4234
- */
4235
- function sendMessageToParentFromDialog(message: any): void;
4236
- /**
4237
- * Send message to the dialog from the parent
4238
- *
4239
- * @param message - The message to send
4240
- *
4241
- * @beta
4242
- */
4243
- function sendMessageToDialog(message: any): void;
4244
- /**
4245
- * Register a listener that will be triggered when a message is received from the app that opened the dialog.
4246
- *
4247
- * @remarks
4248
- * This function is only called from inside of a dialog.
4249
- *
4250
- * @param listener - The listener that will be triggered.
4251
- *
4252
- * @beta
4253
- */
4254
- function registerOnMessageFromParent(listener: PostMessageChannel): void;
4249
+ namespace url {
4250
+ /**
4251
+ * Allows app to open a url based dialog.
4252
+ *
4253
+ * @remarks
4254
+ * This function cannot be called from inside of a dialog
4255
+ *
4256
+ * @param urlDialogInfo - An object containing the parameters of the dialog module.
4257
+ * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
4258
+ * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
4259
+ *
4260
+ * @beta
4261
+ */
4262
+ function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
4263
+ /**
4264
+ * Submit the dialog module and close the dialog
4265
+ *
4266
+ * @remarks
4267
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
4268
+ *
4269
+ * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
4270
+ * If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
4271
+ *
4272
+ * @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.
4273
+ *
4274
+ * @beta
4275
+ */
4276
+ function submit(result?: string | object, appIds?: string | string[]): void;
4277
+ /**
4278
+ * Send message to the parent from dialog
4279
+ *
4280
+ * @remarks
4281
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
4282
+ *
4283
+ * @param message - The message to send to the parent
4284
+ *
4285
+ * @beta
4286
+ */
4287
+ function sendMessageToParentFromDialog(message: any): void;
4288
+ /**
4289
+ * Send message to the dialog from the parent
4290
+ *
4291
+ * @param message - The message to send
4292
+ *
4293
+ * @beta
4294
+ */
4295
+ function sendMessageToDialog(message: any): void;
4296
+ /**
4297
+ * Register a listener that will be triggered when a message is received from the app that opened the dialog.
4298
+ *
4299
+ * @remarks
4300
+ * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
4301
+ *
4302
+ * @param listener - The listener that will be triggered.
4303
+ *
4304
+ * @beta
4305
+ */
4306
+ function registerOnMessageFromParent(listener: PostMessageChannel): void;
4307
+ /**
4308
+ * Checks if dialog.url module is supported by the host
4309
+ *
4310
+ * @returns boolean to represent whether dialog.url module is supported
4311
+ *
4312
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
4313
+ *
4314
+ * @beta
4315
+ */
4316
+ function isSupported(): boolean;
4317
+ /**
4318
+ * Namespace to open a dialog that sends results to the bot framework
4319
+ *
4320
+ * @beta
4321
+ */
4322
+ namespace bot {
4323
+ /**
4324
+ * Allows an app to open the dialog module using bot.
4325
+ *
4326
+ * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
4327
+ * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
4328
+ * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
4329
+ *
4330
+ * @returns a function that can be used to send messages to the dialog.
4331
+ *
4332
+ * @beta
4333
+ */
4334
+ function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
4335
+ /**
4336
+ * Checks if dialog.url.bot capability is supported by the host
4337
+ *
4338
+ * @returns boolean to represent whether dialog.url.bot is supported
4339
+ *
4340
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
4341
+ *
4342
+ * @beta
4343
+ */
4344
+ function isSupported(): boolean;
4345
+ }
4346
+ /**
4347
+ * @hidden
4348
+ *
4349
+ * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
4350
+ *
4351
+ * @internal
4352
+ * Limited to Microsoft-internal use
4353
+ */
4354
+ function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
4355
+ /**
4356
+ * @hidden
4357
+ *
4358
+ * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
4359
+ *
4360
+ * @internal
4361
+ * Limited to Microsoft-internal use
4362
+ */
4363
+ function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
4364
+ }
4255
4365
  /**
4256
4366
  * Checks if dialog capability is supported by the host
4257
4367
  * @returns boolean to represent whether dialog capabilty is supported
4258
4368
  *
4259
4369
  * @throws Error if {@linkcode app.initialize} has not successfully completed
4260
4370
  *
4371
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
4372
+ *
4261
4373
  * @beta
4262
4374
  */
4263
4375
  function isSupported(): boolean;
@@ -4286,55 +4398,91 @@ export namespace dialog {
4286
4398
  function isSupported(): boolean;
4287
4399
  }
4288
4400
  /**
4289
- * Namespace to open a dialog that sends results to the bot framework
4290
- *
4401
+ * Subcapability for interacting with adaptive card dialogs
4291
4402
  * @beta
4292
4403
  */
4293
- namespace bot {
4404
+ namespace adaptiveCard {
4294
4405
  /**
4295
- * Allows an app to open the dialog module using bot.
4406
+ * Allows app to open an adaptive card based dialog.
4296
4407
  *
4297
- * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
4298
- * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
4299
- * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
4408
+ * @remarks
4409
+ * This function cannot be called from inside of a dialog
4300
4410
  *
4301
- * @returns a function that can be used to send messages to the dialog.
4411
+ * @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
4412
+ * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode url.submit} function or when the user closes the dialog.
4302
4413
  *
4303
4414
  * @beta
4304
4415
  */
4305
- function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
4416
+ function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
4306
4417
  /**
4307
- * Checks if dialog.bot capability is supported by the host
4308
- * @returns boolean to represent whether dialog.bot is supported
4418
+ * Checks if dialog.adaptiveCard module is supported by the host
4419
+ *
4420
+ * @returns boolean to represent whether dialog.adaptiveCard module is supported
4309
4421
  *
4310
4422
  * @throws Error if {@linkcode app.initialize} has not successfully completed
4311
4423
  *
4312
4424
  * @beta
4313
4425
  */
4314
4426
  function isSupported(): boolean;
4427
+ /**
4428
+ * Namespace for interaction with adaptive card dialogs that need to communicate with the bot framework
4429
+ *
4430
+ * @beta
4431
+ */
4432
+ namespace bot {
4433
+ /**
4434
+ * Allows an app to open an adaptive card-based dialog module using bot.
4435
+ *
4436
+ * @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
4437
+ * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
4438
+ *
4439
+ * @beta
4440
+ */
4441
+ function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
4442
+ /**
4443
+ * Checks if dialog.adaptiveCard.bot capability is supported by the host
4444
+ *
4445
+ * @returns boolean to represent whether dialog.adaptiveCard.bot is supported
4446
+ *
4447
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
4448
+ *
4449
+ * @beta
4450
+ */
4451
+ function isSupported(): boolean;
4452
+ }
4453
+ /**
4454
+ * @hidden
4455
+ * Hide from docs
4456
+ * --------
4457
+ * Convert AdaptiveCardDialogInfo to DialogInfo to send the information to host in {@linkcode adaptiveCard.open} API.
4458
+ *
4459
+ * @internal
4460
+ */
4461
+ function getDialogInfoFromAdaptiveCardDialogInfo(adaptiveCardDialogInfo: AdaptiveCardDialogInfo): DialogInfo;
4462
+ /**
4463
+ * @hidden
4464
+ * Hide from docs
4465
+ * --------
4466
+ * Convert BotAdaptiveCardDialogInfo to DialogInfo to send the information to host in {@linkcode adaptiveCard.open} API.
4467
+ *
4468
+ * @internal
4469
+ */
4470
+ function getDialogInfoFromBotAdaptiveCardDialogInfo(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo): DialogInfo;
4471
+ /**
4472
+ * @hidden
4473
+ * Converts {@link TaskInfo} to {@link AdaptiveCardDialogInfo}
4474
+ * @param taskInfo - TaskInfo object to convert
4475
+ * @returns - converted AdaptiveCardDialogInfo
4476
+ */
4477
+ function getAdaptiveCardDialogInfoFromTaskInfo(taskInfo: TaskInfo): AdaptiveCardDialogInfo;
4478
+ /**
4479
+ * @hidden
4480
+ * Converts {@link TaskInfo} to {@link BotAdaptiveCardDialogInfo}
4481
+ * @param taskInfo - TaskInfo object to convert
4482
+ * @returns - converted BotAdaptiveCardDialogInfo
4483
+ */
4484
+ function getBotAdaptiveCardDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotAdaptiveCardDialogInfo;
4315
4485
  }
4316
- /**
4317
- * @hidden
4318
- *
4319
- * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
4320
- *
4321
- * @internal
4322
- * Limited to Microsoft-internal use
4323
- *
4324
- * @beta
4325
- */
4326
- function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
4327
- /**
4328
- * @hidden
4329
- *
4330
- * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
4331
- *
4332
- * @internal
4333
- * Limited to Microsoft-internal use
4334
- *
4335
- * @beta
4336
- */
4337
- function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
4338
4486
  }
4339
4487
 
4340
4488
  /**
@@ -4438,6 +4586,12 @@ export namespace geoLocation {
4438
4586
  }
4439
4587
  }
4440
4588
 
4589
+ /**
4590
+ * @returns The {@linkcode AdaptiveCardVersion} representing the Adaptive Card schema
4591
+ * version supported by the host, or undefined if the host does not support Adaptive Cards
4592
+ */
4593
+ export function getAdaptiveCardSchemaVersion(): AdaptiveCardVersion | undefined;
4594
+
4441
4595
  /**
4442
4596
  * Navigation-specific part of the SDK.
4443
4597
  */
@@ -4844,7 +4998,7 @@ export namespace pages {
4844
4998
  interface NavigateWithinAppParams {
4845
4999
  /**
4846
5000
  * The developer-defined unique ID for the page defined in the manifest or when first configuring
4847
- * the page. (Known as {entityId} prior to TeamsJS v.2.0.0)
5001
+ * the page. (Known as {@linkcode Context.entityId} prior to TeamsJS v.2.0.0)
4848
5002
  */
4849
5003
  pageId: string;
4850
5004
  /**
@@ -5700,45 +5854,126 @@ export namespace meeting {
5700
5854
  /**
5701
5855
  * Property bag for the meeting reaction received event
5702
5856
  *
5857
+ * @hidden
5858
+ * Hide from docs.
5859
+ *
5860
+ * @internal
5861
+ * Limited to Microsoft-internal use
5862
+ *
5703
5863
  * @beta
5704
5864
  */
5705
5865
  interface MeetingReactionReceivedEventData {
5706
5866
  /**
5707
5867
  * Indicates the type of meeting reaction received
5868
+ *
5869
+ * @hidden
5870
+ * Hide from docs.
5708
5871
  */
5709
5872
  meetingReactionType?: MeetingReactionType;
5710
5873
  /**
5711
5874
  * error object in case there is a failure
5875
+ *
5876
+ * @hidden
5877
+ * Hide from docs.
5712
5878
  */
5713
5879
  error?: SdkError;
5714
5880
  }
5715
5881
  /**
5716
5882
  * Interface for raiseHandState properties
5717
5883
  *
5884
+ * @hidden
5885
+ * Hide from docs.
5886
+ *
5887
+ * @internal
5888
+ * Limited to Microsoft-internal use
5889
+ *
5718
5890
  * @beta
5719
5891
  */
5720
5892
  interface IRaiseHandState {
5721
- /** Indicates whether the selfParticipant's hand is raised or not*/
5893
+ /** Indicates whether the selfParticipant's hand is raised or not
5894
+ *
5895
+ * @hidden
5896
+ * Hide from docs.
5897
+ */
5722
5898
  isHandRaised: boolean;
5723
5899
  }
5724
5900
  /**
5725
5901
  * Property bag for the raiseHandState changed event
5726
5902
  *
5903
+ * @hidden
5904
+ * Hide from docs.
5905
+ *
5906
+ * @internal
5907
+ * Limited to Microsoft-internal use
5908
+ *
5727
5909
  * @beta
5728
5910
  */
5729
5911
  interface RaiseHandStateChangedEventData {
5730
5912
  /**
5731
5913
  * entire raiseHandState object for the selfParticipant
5914
+ *
5915
+ * @hidden
5916
+ * Hide from docs.
5732
5917
  */
5733
5918
  raiseHandState: IRaiseHandState;
5734
5919
  /**
5735
5920
  * error object in case there is a failure
5921
+ *
5922
+ * @hidden
5923
+ * Hide from docs.
5736
5924
  */
5737
5925
  error?: SdkError;
5738
5926
  }
5927
+ /**
5928
+ * Interface for mic state change
5929
+ *
5930
+ * @hidden
5931
+ * Hide from docs.
5932
+ *
5933
+ * @internal
5934
+ * Limited to Microsoft-internal use
5935
+ *
5936
+ * @beta
5937
+ */
5938
+ interface MicState {
5939
+ /**
5940
+ * Indicates the mute status of the mic
5941
+ */
5942
+ isMicMuted: boolean;
5943
+ }
5944
+ /**
5945
+ * Interface for RequestAppAudioHandling properties
5946
+ *
5947
+ * @hidden
5948
+ * Hide from docs.
5949
+ *
5950
+ * @internal
5951
+ * Limited to Microsoft-internal use
5952
+ *
5953
+ * @beta
5954
+ */
5955
+ interface RequestAppAudioHandlingParams {
5956
+ /**
5957
+ * Indicates whether the app is requesting to start handling audio, or if
5958
+ * it's giving audio back to the host
5959
+ */
5960
+ isAppHandlingAudio: boolean;
5961
+ /**
5962
+ * Callback for the host to tell the app to change its microphone state
5963
+ * @param micState The microphone state for the app to use
5964
+ * @returns A promise with the updated microphone state
5965
+ */
5966
+ micMuteStateChangedCallback: (micState: MicState) => Promise<MicState>;
5967
+ }
5739
5968
  /**
5740
5969
  * Different types of meeting reactions that can be sent/received
5741
5970
  *
5971
+ * @hidden
5972
+ * Hide from docs.
5973
+ *
5974
+ * @internal
5975
+ * Limited to Microsoft-internal use
5976
+ *
5742
5977
  * @beta
5743
5978
  */
5744
5979
  enum MeetingReactionType {
@@ -5893,6 +6128,12 @@ export namespace meeting {
5893
6128
  *
5894
6129
  * @param handler The handler to invoke when the selfParticipant's (current user's) raiseHandState changes.
5895
6130
  *
6131
+ * @hidden
6132
+ * Hide from docs.
6133
+ *
6134
+ * @internal
6135
+ * Limited to Microsoft-internal use
6136
+ *
5896
6137
  * @beta
5897
6138
  */
5898
6139
  function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
@@ -5902,6 +6143,12 @@ export namespace meeting {
5902
6143
  *
5903
6144
  * @param handler The handler to invoke when the selfParticipant (current user) successfully sends a meeting reaction
5904
6145
  *
6146
+ * @hidden
6147
+ * Hide from docs.
6148
+ *
6149
+ * @internal
6150
+ * Limited to Microsoft-internal use
6151
+ *
5905
6152
  * @beta
5906
6153
  */
5907
6154
  function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
@@ -5938,6 +6185,46 @@ export namespace meeting {
5938
6185
  */
5939
6186
  function setOptions(shareInformation: ShareInformation): void;
5940
6187
  }
6188
+ /**
6189
+ * Have the app handle audio (mic & speaker) and turn off host audio.
6190
+ *
6191
+ * When {@link RequestAppAudioHandlingParams.isAppHandlingAudio} is true, the host will switch to audioless mode
6192
+ * Registers for mic mute status change events, which are events that the app can receive from the host asking the app to
6193
+ * mute or unmute the microphone.
6194
+ *
6195
+ * When {@link RequestAppAudioHandlingParams.isAppHandlingAudio} is false, the host will switch out of audioless mode
6196
+ * Unregisters the mic mute status change events so the app will no longer receive these events
6197
+ *
6198
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
6199
+ * @throws Error if {@link RequestAppAudioHandlingParams.micMuteStateChangedCallback} parameter is not defined
6200
+ *
6201
+ * @param requestAppAudioHandlingParams - {@link RequestAppAudioHandlingParams} object with values for the audio switchover
6202
+ * @param callback - Callback with one parameter, the result
6203
+ * can either be true (the host is now in audioless mode) or false (the host is not in audioless mode)
6204
+ *
6205
+ * @hidden
6206
+ * Hide from docs.
6207
+ *
6208
+ * @internal
6209
+ * Limited to Microsoft-internal use
6210
+ *
6211
+ * @beta
6212
+ */
6213
+ function requestAppAudioHandling(requestAppAudioHandlingParams: RequestAppAudioHandlingParams, callback: (isHostAudioless: boolean) => void): void;
6214
+ /**
6215
+ * Notifies the host that the microphone state has changed in the app.
6216
+ * @param micState - The new state that the microphone is in
6217
+ * isMicMuted - Boolean to indicate the current mute status of the mic.
6218
+ *
6219
+ * @hidden
6220
+ * Hide from docs.
6221
+ *
6222
+ * @internal
6223
+ * Limited to Microsoft-internal use
6224
+ *
6225
+ * @beta
6226
+ */
6227
+ function updateMicState(micState: MicState): void;
5941
6228
  }
5942
6229
 
5943
6230
  export namespace monetization {
@@ -6529,7 +6816,7 @@ export namespace search {
6529
6816
 
6530
6817
  /**
6531
6818
  * Namespace to open a share dialog for web content.
6532
- * For more info, see {@link https://learn.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/share-to-teams-from-personal-app-or-tab Share to Teams from personal app or tab}
6819
+ * For more info, see [Share to Teams from personal app or tab](https://learn.microsoft.com/microsoftteams/platform/concepts/build-and-test/share-to-teams-from-personal-app-or-tab)
6533
6820
  */
6534
6821
  export namespace sharing {
6535
6822
  export const SharingAPIMessages: {
@@ -7119,9 +7406,9 @@ export namespace settings {
7119
7406
  export namespace tasks {
7120
7407
  /**
7121
7408
  * @deprecated
7122
- * As of 2.0.0, please use {@link dialog.open dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
7123
- * and {@link dialog.bot.open dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot based dialogs. In Teams,
7124
- * this function can be used for adaptive card based dialogs. Support for adaptive card based dialogs is coming to other hosts in the future.
7409
+ * As of 2.8.0, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
7410
+ * and {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot-based dialogs. In Teams,
7411
+ * this function can be used for Adaptive Card-based dialogs. Support for Adaptive Card-based dialogs is coming to other hosts in the future.
7125
7412
  *
7126
7413
  * Allows an app to open the task module.
7127
7414
  *
@@ -7140,7 +7427,7 @@ export namespace tasks {
7140
7427
  function updateTask(taskInfo: TaskInfo): void;
7141
7428
  /**
7142
7429
  * @deprecated
7143
- * As of 2.0.0, please use {@link dialog.submit} instead.
7430
+ * As of 2.8.0, please use {@link dialog.url.submit} instead.
7144
7431
  *
7145
7432
  * Submit the task module.
7146
7433
  *