@microsoft/teams-js 2.11.0-beta.0 → 2.11.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1182,8 +1182,11 @@ function v4(options, buf, offset) {
1182
1182
  */
1183
1183
  var FileOpenPreference;
1184
1184
  (function (FileOpenPreference) {
1185
+ /** Indicates that the user should be prompted to open the file in inline. */
1185
1186
  FileOpenPreference["Inline"] = "inline";
1187
+ /** Indicates that the user should be prompted to open the file in the native desktop application associated with the file type. */
1186
1188
  FileOpenPreference["Desktop"] = "desktop";
1189
+ /** Indicates that the user should be prompted to open the file in a web browser. */
1187
1190
  FileOpenPreference["Web"] = "web";
1188
1191
  })(FileOpenPreference || (FileOpenPreference = {}));
1189
1192
  /**
@@ -1193,20 +1196,26 @@ var FileOpenPreference;
1193
1196
  */
1194
1197
  var ActionObjectType;
1195
1198
  (function (ActionObjectType) {
1199
+ /** Represents content within a Microsoft 365 application. */
1196
1200
  ActionObjectType["M365Content"] = "m365content";
1197
1201
  })(ActionObjectType || (ActionObjectType = {}));
1198
1202
  /**
1199
- * These correspond with field names in the MSGraph
1200
- *
1203
+ * These correspond with field names in the MSGraph.
1204
+ * See (commonly accessed resources)[https://learn.microsoft.com/en-us/graph/api/resources/onedrive?view=graph-rest-1.0#commonly-accessed-resources].
1201
1205
  * @beta
1202
1206
  */
1203
1207
  var SecondaryM365ContentIdName;
1204
1208
  (function (SecondaryM365ContentIdName) {
1209
+ /** OneDrive ID */
1205
1210
  SecondaryM365ContentIdName["DriveId"] = "driveId";
1211
+ /** Teams Group ID */
1206
1212
  SecondaryM365ContentIdName["GroupId"] = "groupId";
1213
+ /** SharePoint ID */
1207
1214
  SecondaryM365ContentIdName["SiteId"] = "siteId";
1215
+ /** User ID */
1208
1216
  SecondaryM365ContentIdName["UserId"] = "userId";
1209
1217
  })(SecondaryM365ContentIdName || (SecondaryM365ContentIdName = {}));
1218
+ /** Error codes used to identify different types of errors that can occur while developing apps. */
1210
1219
  var ErrorCode;
1211
1220
  (function (ErrorCode) {
1212
1221
  /**
@@ -1278,24 +1287,36 @@ var DevicePermission;
1278
1287
  })(DevicePermission || (DevicePermission = {}));
1279
1288
 
1280
1289
  ;// CONCATENATED MODULE: ./src/public/constants.ts
1290
+ /** HostClientType represents the different client platforms on which host can be run. */
1281
1291
  var HostClientType;
1282
1292
  (function (HostClientType) {
1293
+ /** Represents the desktop client of host, which is installed on a user's computer and runs as a standalone application. */
1283
1294
  HostClientType["desktop"] = "desktop";
1295
+ /** Represents the web-based client of host, which runs in a web browser. */
1284
1296
  HostClientType["web"] = "web";
1297
+ /** Represents the Android mobile client of host, which runs on Android devices such as smartphones and tablets. */
1285
1298
  HostClientType["android"] = "android";
1299
+ /** Represents the iOS mobile client of host, which runs on iOS devices such as iPhones. */
1286
1300
  HostClientType["ios"] = "ios";
1301
+ /** Represents the iPadOS client of host, which runs on iOS devices such as iPads. */
1287
1302
  HostClientType["ipados"] = "ipados";
1288
1303
  /**
1289
1304
  * @deprecated
1290
1305
  * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
1291
1306
  */
1292
1307
  HostClientType["rigel"] = "rigel";
1308
+ /** Represents the client of host, which runs on surface hub devices. */
1293
1309
  HostClientType["surfaceHub"] = "surfaceHub";
1310
+ /** Represents the client of host, which runs on Teams Rooms on Windows devices. More information on Microsoft Teams Rooms on Windows can be found [Microsoft Teams Rooms (Windows)](https://support.microsoft.com/office/microsoft-teams-rooms-windows-help-e667f40e-5aab-40c1-bd68-611fe0002ba2)*/
1294
1311
  HostClientType["teamsRoomsWindows"] = "teamsRoomsWindows";
1312
+ /** Represents the client of host, which runs on Teams Rooms on Android devices. More information on Microsoft Teams Rooms on Android can be found [Microsoft Teams Rooms (Android)].(https://support.microsoft.com/office/get-started-with-teams-rooms-on-android-68517298-d513-46be-8d6d-d41db5e6b4b2)*/
1295
1313
  HostClientType["teamsRoomsAndroid"] = "teamsRoomsAndroid";
1314
+ /** Represents the client of host, which runs on Teams phones. More information can be found [Microsoft Teams Phones](https://support.microsoft.com/office/get-started-with-teams-phones-694ca17d-3ecf-40ca-b45e-d21b2c442412) */
1296
1315
  HostClientType["teamsPhones"] = "teamsPhones";
1316
+ /** Represents the client of host, which runs on Teams displays devices. More information can be found [Microsoft Teams Displays](https://support.microsoft.com/office/get-started-with-teams-displays-ff299825-7f13-4528-96c2-1d3437e6d4e6) */
1297
1317
  HostClientType["teamsDisplays"] = "teamsDisplays";
1298
1318
  })(HostClientType || (HostClientType = {}));
1319
+ /** HostName indicates the possible hosts for your application. */
1299
1320
  var HostName;
1300
1321
  (function (HostName) {
1301
1322
  /**
@@ -1324,16 +1345,36 @@ var HostName;
1324
1345
  */
1325
1346
  HostName["teamsModern"] = "TeamsModern";
1326
1347
  })(HostName || (HostName = {}));
1327
- // Ensure these declarations stay in sync with the framework.
1348
+ /**
1349
+ * FrameContexts provides information about the context in which the app is running within the host.
1350
+ * Developers can use FrameContexts to determine how their app should behave in different contexts,
1351
+ * and can use the information provided by the context to adapt the app to the user's needs.
1352
+ *
1353
+ * @example
1354
+ * If your app is running in the "settings" context, you should be displaying your apps configuration page.
1355
+ * If the app is running in the content context, the developer may want to display information relevant to
1356
+ * the content the user is currently viewing.
1357
+ */
1328
1358
  var FrameContexts;
1329
1359
  (function (FrameContexts) {
1360
+ /**
1361
+ * App's frame context from where settings page can be accessed.
1362
+ * See [how to create a configuration page.]( https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/create-tab-pages/configuration-page?tabs=teamsjs-v2)
1363
+ */
1330
1364
  FrameContexts["settings"] = "settings";
1365
+ /** The default context for the app where all the content of the app is displayed. */
1331
1366
  FrameContexts["content"] = "content";
1367
+ /** Frame context used when app is running in the authentication window launched by calling {@link authentication.authenticate} */
1332
1368
  FrameContexts["authentication"] = "authentication";
1369
+ /** The page shown when the user uninstalls the app. */
1333
1370
  FrameContexts["remove"] = "remove";
1371
+ /** A task module is a pop-up window that can be used to display a form, a dialog, or other interactive content within the host. */
1334
1372
  FrameContexts["task"] = "task";
1373
+ /** The side panel is a persistent panel that is displayed on the right side of the host and can be used to display content or UI that is relevant to the current page or tab. */
1335
1374
  FrameContexts["sidePanel"] = "sidePanel";
1375
+ /** The stage is a large area that is displayed at the center of the host and can be used to display content or UI that requires a lot of space, such as a video player or a document editor. */
1336
1376
  FrameContexts["stage"] = "stage";
1377
+ /** App's frame context from where meetingStage can be accessed in a meeting session, which is the primary area where video and presentation content is displayed during a meeting. */
1337
1378
  FrameContexts["meetingStage"] = "meetingStage";
1338
1379
  })(FrameContexts || (FrameContexts = {}));
1339
1380
  /**
@@ -1342,10 +1383,15 @@ var FrameContexts;
1342
1383
  */
1343
1384
  var TeamType;
1344
1385
  (function (TeamType) {
1386
+ /** Represents a standard or classic team in host that is designed for ongoing collaboration and communication among a group of people. */
1345
1387
  TeamType[TeamType["Standard"] = 0] = "Standard";
1388
+ /** Represents an educational team in host that is designed for classroom collaboration and communication among students and teachers. */
1346
1389
  TeamType[TeamType["Edu"] = 1] = "Edu";
1390
+ /** Represents a class team in host that is designed for classroom collaboration and communication among students and teachers in a structured environment. */
1347
1391
  TeamType[TeamType["Class"] = 2] = "Class";
1392
+ /** Represents a professional learning community (PLC) team in host that is designed for educators to collaborate and share resources and best practices. */
1348
1393
  TeamType[TeamType["Plc"] = 3] = "Plc";
1394
+ /** Represents a staff team in host that is designed for staff collaboration and communication among staff members.*/
1349
1395
  TeamType[TeamType["Staff"] = 4] = "Staff";
1350
1396
  })(TeamType || (TeamType = {}));
1351
1397
  /**
@@ -1353,8 +1399,11 @@ var TeamType;
1353
1399
  */
1354
1400
  var UserTeamRole;
1355
1401
  (function (UserTeamRole) {
1402
+ /** Represents that the user is an owner or administrator of the team. */
1356
1403
  UserTeamRole[UserTeamRole["Admin"] = 0] = "Admin";
1404
+ /** Represents that the user is a standard member of the team. */
1357
1405
  UserTeamRole[UserTeamRole["User"] = 1] = "User";
1406
+ /** Represents that the user does not have any role in the team. */
1358
1407
  UserTeamRole[UserTeamRole["Guest"] = 2] = "Guest";
1359
1408
  })(UserTeamRole || (UserTeamRole = {}));
1360
1409
  /**
@@ -1362,8 +1411,11 @@ var UserTeamRole;
1362
1411
  */
1363
1412
  var DialogDimension;
1364
1413
  (function (DialogDimension) {
1414
+ /** Represents a large-sized dialog box, which is typically used for displaying large amounts of content or complex workflows that require more space. */
1365
1415
  DialogDimension["Large"] = "large";
1416
+ /** Represents a medium-sized dialog box, which is typically used for displaying moderate amounts of content or workflows that require less space. */
1366
1417
  DialogDimension["Medium"] = "medium";
1418
+ /** Represents a small-sized dialog box, which is typically used for displaying simple messages or workflows that require minimal space.*/
1367
1419
  DialogDimension["Small"] = "small";
1368
1420
  })(DialogDimension || (DialogDimension = {}));
1369
1421
 
@@ -1378,10 +1430,16 @@ var TaskModuleDimension = DialogDimension;
1378
1430
  */
1379
1431
  var ChannelType;
1380
1432
  (function (ChannelType) {
1433
+ /** The default channel type. Type of channel is used for general collaboration and communication within a team. */
1381
1434
  ChannelType["Regular"] = "Regular";
1435
+ /** Type of channel is used for sensitive or confidential communication within a team and is only accessible to members of the channel. */
1382
1436
  ChannelType["Private"] = "Private";
1437
+ /** Type of channel is used for collaboration between multiple teams or groups and is accessible to members of all the teams or groups. */
1383
1438
  ChannelType["Shared"] = "Shared";
1384
1439
  })(ChannelType || (ChannelType = {}));
1440
+ /** An error object indicating that the requested operation or feature is not supported on the current platform or device.
1441
+ * @typedef {Object} SdkError
1442
+ */
1385
1443
  var errorNotSupportedOnPlatform = { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
1386
1444
  /**
1387
1445
  * @hidden
@@ -2001,7 +2059,11 @@ var _minRuntimeConfigToUninitialize = {
2001
2059
  };
2002
2060
 
2003
2061
  ;// CONCATENATED MODULE: ./src/public/version.ts
2004
- var version = "2.11.0-beta.0";
2062
+ /**
2063
+ * @hidden
2064
+ * Package version.
2065
+ */
2066
+ var version = "2.11.0-beta.2";
2005
2067
 
2006
2068
  ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
2007
2069
 
@@ -3098,6 +3160,13 @@ var menus;
3098
3160
  var navBarMenuItemPressHandler;
3099
3161
  var actionMenuItemPressHandler;
3100
3162
  var viewConfigItemPressHandler;
3163
+ /**
3164
+ * @hidden
3165
+ * Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
3166
+ *
3167
+ * @internal
3168
+ * Limited to Microsoft-internal use.
3169
+ */
3101
3170
  function initialize() {
3102
3171
  registerHandler('navBarMenuItemPress', handleNavBarMenuItemPress, false);
3103
3172
  registerHandler('actionMenuItemPress', handleActionMenuItemPress, false);
@@ -3347,10 +3416,15 @@ var app;
3347
3416
  (function (app) {
3348
3417
  var appLogger = getLogger('app');
3349
3418
  // ::::::::::::::::::::::: MicrosoftTeams client SDK public API ::::::::::::::::::::
3419
+ /** App Initialization Messages */
3350
3420
  app.Messages = {
3421
+ /** App loaded. */
3351
3422
  AppLoaded: 'appInitialization.appLoaded',
3423
+ /** App initialized successfully. */
3352
3424
  Success: 'appInitialization.success',
3425
+ /** App initialization failed. */
3353
3426
  Failure: 'appInitialization.failure',
3427
+ /** App initialization expected failure. */
3354
3428
  ExpectedFailure: 'appInitialization.expectedFailure',
3355
3429
  };
3356
3430
  /**
@@ -4123,16 +4197,16 @@ var pages;
4123
4197
  }
4124
4198
  config.registerOnRemoveHandlerHelper = registerOnRemoveHandlerHelper;
4125
4199
  function handleSave(result) {
4126
- var saveEvent = new SaveEventImpl(result);
4200
+ var saveEventType = new SaveEventImpl(result);
4127
4201
  if (saveHandler) {
4128
- saveHandler(saveEvent);
4202
+ saveHandler(saveEventType);
4129
4203
  }
4130
4204
  else if (Communication.childWindow) {
4131
4205
  sendMessageEventToChild('settings.save', [result]);
4132
4206
  }
4133
4207
  else {
4134
4208
  // If no handler is registered, we assume success.
4135
- saveEvent.notifySuccess();
4209
+ saveEventType.notifySuccess();
4136
4210
  }
4137
4211
  }
4138
4212
  /**
@@ -4174,16 +4248,16 @@ var pages;
4174
4248
  return SaveEventImpl;
4175
4249
  }());
4176
4250
  function handleRemove() {
4177
- var removeEvent = new RemoveEventImpl();
4251
+ var removeEventType = new RemoveEventImpl();
4178
4252
  if (removeHandler) {
4179
- removeHandler(removeEvent);
4253
+ removeHandler(removeEventType);
4180
4254
  }
4181
4255
  else if (Communication.childWindow) {
4182
4256
  sendMessageEventToChild('settings.remove', []);
4183
4257
  }
4184
4258
  else {
4185
4259
  // If no handler is registered, we assume success.
4186
- removeEvent.notifySuccess();
4260
+ removeEventType.notifySuccess();
4187
4261
  }
4188
4262
  }
4189
4263
  /**
@@ -4206,7 +4280,7 @@ var pages;
4206
4280
  };
4207
4281
  RemoveEventImpl.prototype.ensureNotNotified = function () {
4208
4282
  if (this.notified) {
4209
- throw new Error('The removeEvent may only notify success or failure once.');
4283
+ throw new Error('The removeEventType may only notify success or failure once.');
4210
4284
  }
4211
4285
  };
4212
4286
  return RemoveEventImpl;
@@ -4232,6 +4306,13 @@ var pages;
4232
4306
  var backStack;
4233
4307
  (function (backStack) {
4234
4308
  var backButtonPressHandler;
4309
+ /**
4310
+ * @hidden
4311
+ * Register backButtonPress handler.
4312
+ *
4313
+ * @internal
4314
+ * Limited to Microsoft-internal use.
4315
+ */
4235
4316
  function _initialize() {
4236
4317
  registerHandler('backButtonPress', handleBackButtonPress, false);
4237
4318
  }
@@ -5607,6 +5688,11 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
5607
5688
 
5608
5689
  var appInstallDialog;
5609
5690
  (function (appInstallDialog) {
5691
+ /**
5692
+ * Displays a dialog box that allows users to install a specific app within the host environment.
5693
+ *
5694
+ * @param openAPPInstallDialogParams - See {@link OpenAppInstallDialogParams | OpenAppInstallDialogParams} for more information.
5695
+ */
5610
5696
  function openAppInstallDialog(openAPPInstallDialogParams) {
5611
5697
  return new Promise(function (resolve) {
5612
5698
  ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
@@ -5662,6 +5748,9 @@ var __extends = (undefined && undefined.__extends) || (function () {
5662
5748
 
5663
5749
 
5664
5750
 
5751
+ /**
5752
+ * Interact with media, including capturing and viewing images.
5753
+ */
5665
5754
  var media;
5666
5755
  (function (media) {
5667
5756
  /**
@@ -5669,7 +5758,9 @@ var media;
5669
5758
  */
5670
5759
  var FileFormat;
5671
5760
  (function (FileFormat) {
5761
+ /** Base64 encoding */
5672
5762
  FileFormat["Base64"] = "base64";
5763
+ /** File id */
5673
5764
  FileFormat["ID"] = "id";
5674
5765
  })(FileFormat = media.FileFormat || (media.FileFormat = {}));
5675
5766
  /**
@@ -5759,6 +5850,7 @@ var media;
5759
5850
  this.getMediaViaHandler(callback);
5760
5851
  }
5761
5852
  };
5853
+ /** Function to retrieve media content, such as images or videos, via callback. */
5762
5854
  Media.prototype.getMediaViaCallback = function (callback) {
5763
5855
  var helper = {
5764
5856
  mediaMimeType: this.mimeType,
@@ -5794,6 +5886,7 @@ var media;
5794
5886
  }
5795
5887
  sendMessageToParent('getMedia', localUriId, handleGetMediaCallbackRequest);
5796
5888
  };
5889
+ /** Function to retrieve media content, such as images or videos, via handler. */
5797
5890
  Media.prototype.getMediaViaHandler = function (callback) {
5798
5891
  var actionName = generateGUID();
5799
5892
  var helper = {
@@ -5892,9 +5985,11 @@ var media;
5892
5985
  function VideoController() {
5893
5986
  return _super !== null && _super.apply(this, arguments) || this;
5894
5987
  }
5988
+ /** Gets media type video. */
5895
5989
  VideoController.prototype.getMediaType = function () {
5896
5990
  return MediaType.Video;
5897
5991
  };
5992
+ /** Notify or send an event related to the playback and control of video content to a registered application. */
5898
5993
  VideoController.prototype.notifyEventToApp = function (mediaEvent) {
5899
5994
  if (!this.controllerCallback) {
5900
5995
  // Early return as app has not registered with the callback
@@ -5917,7 +6012,9 @@ var media;
5917
6012
  */
5918
6013
  var MediaControllerEvent;
5919
6014
  (function (MediaControllerEvent) {
6015
+ /** Start recording. */
5920
6016
  MediaControllerEvent[MediaControllerEvent["StartRecording"] = 1] = "StartRecording";
6017
+ /** Stop recording. */
5921
6018
  MediaControllerEvent[MediaControllerEvent["StopRecording"] = 2] = "StopRecording";
5922
6019
  })(MediaControllerEvent = media.MediaControllerEvent || (media.MediaControllerEvent = {}));
5923
6020
  /**
@@ -5925,9 +6022,13 @@ var media;
5925
6022
  */
5926
6023
  var CameraStartMode;
5927
6024
  (function (CameraStartMode) {
6025
+ /** Photo mode. */
5928
6026
  CameraStartMode[CameraStartMode["Photo"] = 1] = "Photo";
6027
+ /** Document mode. */
5929
6028
  CameraStartMode[CameraStartMode["Document"] = 2] = "Document";
6029
+ /** Whiteboard mode. */
5930
6030
  CameraStartMode[CameraStartMode["Whiteboard"] = 3] = "Whiteboard";
6031
+ /** Business card mode. */
5931
6032
  CameraStartMode[CameraStartMode["BusinessCard"] = 4] = "BusinessCard";
5932
6033
  })(CameraStartMode = media.CameraStartMode || (media.CameraStartMode = {}));
5933
6034
  /**
@@ -5935,7 +6036,9 @@ var media;
5935
6036
  */
5936
6037
  var Source;
5937
6038
  (function (Source) {
6039
+ /** Image source is camera. */
5938
6040
  Source[Source["Camera"] = 1] = "Camera";
6041
+ /** Image source is gallery. */
5939
6042
  Source[Source["Gallery"] = 2] = "Gallery";
5940
6043
  })(Source = media.Source || (media.Source = {}));
5941
6044
  /**
@@ -5943,9 +6046,13 @@ var media;
5943
6046
  */
5944
6047
  var MediaType;
5945
6048
  (function (MediaType) {
6049
+ /** Media type photo or image */
5946
6050
  MediaType[MediaType["Image"] = 1] = "Image";
6051
+ /** Media type video. */
5947
6052
  MediaType[MediaType["Video"] = 2] = "Video";
6053
+ /** Media type video and image. */
5948
6054
  MediaType[MediaType["VideoAndImage"] = 3] = "VideoAndImage";
6055
+ /** Media type audio. */
5949
6056
  MediaType[MediaType["Audio"] = 4] = "Audio";
5950
6057
  })(MediaType = media.MediaType || (media.MediaType = {}));
5951
6058
  /**
@@ -5953,7 +6060,9 @@ var media;
5953
6060
  */
5954
6061
  var ImageUriType;
5955
6062
  (function (ImageUriType) {
6063
+ /** Image Id. */
5956
6064
  ImageUriType[ImageUriType["ID"] = 1] = "ID";
6065
+ /** Image URL. */
5957
6066
  ImageUriType[ImageUriType["URL"] = 2] = "URL";
5958
6067
  })(ImageUriType = media.ImageUriType || (media.ImageUriType = {}));
5959
6068
  /**
@@ -5961,7 +6070,9 @@ var media;
5961
6070
  */
5962
6071
  var ImageOutputFormats;
5963
6072
  (function (ImageOutputFormats) {
6073
+ /** Outputs image. */
5964
6074
  ImageOutputFormats[ImageOutputFormats["IMAGE"] = 1] = "IMAGE";
6075
+ /** Outputs pdf. */
5965
6076
  ImageOutputFormats[ImageOutputFormats["PDF"] = 2] = "PDF";
5966
6077
  })(ImageOutputFormats = media.ImageOutputFormats || (media.ImageOutputFormats = {}));
5967
6078
  /**
@@ -6659,6 +6770,10 @@ function getAdaptiveCardSchemaVersion() {
6659
6770
 
6660
6771
 
6661
6772
 
6773
+ /**
6774
+ * An object that application can utilize to establish communication
6775
+ * with the child window it opened, which contains the corresponding task.
6776
+ */
6662
6777
  var ChildAppWindow = /** @class */ (function () {
6663
6778
  function ChildAppWindow() {
6664
6779
  }
@@ -6687,10 +6802,16 @@ var ChildAppWindow = /** @class */ (function () {
6687
6802
  return ChildAppWindow;
6688
6803
  }());
6689
6804
 
6805
+ /**
6806
+ * An object that is utilized to facilitate communication with a parent window
6807
+ * that initiated the opening of current window. For instance, a dialog or task
6808
+ * module would utilize it to transmit messages to the application that launched it.
6809
+ */
6690
6810
  var ParentAppWindow = /** @class */ (function () {
6691
6811
  function ParentAppWindow() {
6692
6812
  }
6693
6813
  Object.defineProperty(ParentAppWindow, "Instance", {
6814
+ /** Get the parent window instance. */
6694
6815
  get: function () {
6695
6816
  // Do you need arguments? Make it a regular method instead.
6696
6817
  return this._instance || (this._instance = new this());
@@ -6850,6 +6971,11 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
6850
6971
 
6851
6972
 
6852
6973
 
6974
+ /**
6975
+ * Interact with meetings, including retrieving meeting details, getting mic status, and sharing app content.
6976
+ * This namespace is used to handle meeting related functionality like
6977
+ * get meeting details, get/update state of mic, sharing app content and more.
6978
+ */
6853
6979
  var meeting;
6854
6980
  (function (meeting) {
6855
6981
  /**
@@ -6881,18 +7007,28 @@ var meeting;
6881
7007
  MeetingReactionType["surprised"] = "surprised";
6882
7008
  MeetingReactionType["applause"] = "applause";
6883
7009
  })(MeetingReactionType = meeting.MeetingReactionType || (meeting.MeetingReactionType = {}));
7010
+ /** Represents the type of a meeting */
6884
7011
  var MeetingType;
6885
7012
  (function (MeetingType) {
7013
+ /** Used when the meeting type is not known. */
6886
7014
  MeetingType["Unknown"] = "Unknown";
7015
+ /** Used for ad hoc meetings that are created on the fly. */
6887
7016
  MeetingType["Adhoc"] = "Adhoc";
7017
+ /** Used for meetings that have been scheduled in advance. */
6888
7018
  MeetingType["Scheduled"] = "Scheduled";
7019
+ /** Used for meetings that occur on a recurring basis. */
6889
7020
  MeetingType["Recurring"] = "Recurring";
7021
+ /** Used for live events or webinars. */
6890
7022
  MeetingType["Broadcast"] = "Broadcast";
7023
+ /** Used for meetings that are created on the fly, but with a more polished experience than ad hoc meetings. */
6891
7024
  MeetingType["MeetNow"] = "MeetNow";
6892
7025
  })(MeetingType = meeting.MeetingType || (meeting.MeetingType = {}));
7026
+ /** Represents the type of a call. */
6893
7027
  var CallType;
6894
7028
  (function (CallType) {
7029
+ /** Represents a call between two people. */
6895
7030
  CallType["OneOnOneCall"] = "oneOnOneCall";
7031
+ /** Represents a call between more than two people. */
6896
7032
  CallType["GroupCall"] = "groupCall";
6897
7033
  })(CallType = meeting.CallType || (meeting.CallType = {}));
6898
7034
  /**
@@ -7362,8 +7498,16 @@ var monetization;
7362
7498
 
7363
7499
 
7364
7500
 
7501
+ /**
7502
+ * Interact with the user's calendar, including opening calendar items and composing meetings.
7503
+ */
7365
7504
  var calendar;
7366
7505
  (function (calendar) {
7506
+ /**
7507
+ * Opens a calendar item.
7508
+ *
7509
+ * @param openCalendarItemParams - object containing unique ID of the calendar item to be opened.
7510
+ */
7367
7511
  function openCalendarItem(openCalendarItemParams) {
7368
7512
  return new Promise(function (resolve) {
7369
7513
  ensureInitialized(runtime, FrameContexts.content);
@@ -7377,6 +7521,11 @@ var calendar;
7377
7521
  });
7378
7522
  }
7379
7523
  calendar.openCalendarItem = openCalendarItem;
7524
+ /**
7525
+ * Compose a new meeting in the user's calendar.
7526
+ *
7527
+ * @param composeMeetingParams - object containing various properties to set up the meeting details.
7528
+ */
7380
7529
  function composeMeeting(composeMeetingParams) {
7381
7530
  return new Promise(function (resolve) {
7382
7531
  ensureInitialized(runtime, FrameContexts.content);
@@ -7409,8 +7558,16 @@ var calendar;
7409
7558
 
7410
7559
 
7411
7560
 
7561
+ /**
7562
+ * Used to interact with mail capability, including opening and composing mail.
7563
+ */
7412
7564
  var mail;
7413
7565
  (function (mail) {
7566
+ /**
7567
+ * Opens a mail message in the host.
7568
+ *
7569
+ * @param openMailItemParams - Object that specifies the ID of the mail message.
7570
+ */
7414
7571
  function openMailItem(openMailItemParams) {
7415
7572
  return new Promise(function (resolve) {
7416
7573
  ensureInitialized(runtime, FrameContexts.content);
@@ -7424,6 +7581,12 @@ var mail;
7424
7581
  });
7425
7582
  }
7426
7583
  mail.openMailItem = openMailItem;
7584
+ /**
7585
+ * Compose a new email in the user's mailbox.
7586
+ *
7587
+ * @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
7588
+ *
7589
+ */
7427
7590
  function composeMail(composeMailParams) {
7428
7591
  return new Promise(function (resolve) {
7429
7592
  ensureInitialized(runtime, FrameContexts.content);
@@ -7444,11 +7607,16 @@ var mail;
7444
7607
  return ensureInitialized(runtime) && runtime.supports.mail ? true : false;
7445
7608
  }
7446
7609
  mail.isSupported = isSupported;
7610
+ /** Defines compose mail types. */
7447
7611
  var ComposeMailType;
7448
7612
  (function (ComposeMailType) {
7613
+ /** Compose a new mail message. */
7449
7614
  ComposeMailType["New"] = "new";
7615
+ /** Compose a reply to the sender of an existing mail message. */
7450
7616
  ComposeMailType["Reply"] = "reply";
7617
+ /** Compose a reply to all recipients of an existing mail message. */
7451
7618
  ComposeMailType["ReplyAll"] = "replyAll";
7619
+ /** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
7452
7620
  ComposeMailType["Forward"] = "forward";
7453
7621
  })(ComposeMailType = mail.ComposeMailType || (mail.ComposeMailType = {}));
7454
7622
  })(mail || (mail = {}));
@@ -7656,6 +7824,7 @@ var video;
7656
7824
  */
7657
7825
  var VideoFrameFormat;
7658
7826
  (function (VideoFrameFormat) {
7827
+ /** Video format used for encoding and decoding YUV color data in video streaming and storage applications. */
7659
7828
  VideoFrameFormat[VideoFrameFormat["NV12"] = 0] = "NV12";
7660
7829
  })(VideoFrameFormat = video.VideoFrameFormat || (video.VideoFrameFormat = {}));
7661
7830
  /**
@@ -7899,7 +8068,12 @@ var search;
7899
8068
  */
7900
8069
  var sharing;
7901
8070
  (function (sharing) {
8071
+ /** Type of message that can be sent or received by the sharing APIs */
7902
8072
  sharing.SharingAPIMessages = {
8073
+ /**
8074
+ * Share web content message.
8075
+ * @internal
8076
+ */
7903
8077
  shareWebContent: 'sharing.shareWebContent',
7904
8078
  };
7905
8079
  function shareWebContent(shareWebContentRequest, callback) {
@@ -8077,14 +8251,23 @@ var webStorage;
8077
8251
 
8078
8252
 
8079
8253
 
8254
+ /**
8255
+ * Used to interact with call functionality, including starting calls with other users.
8256
+ */
8080
8257
  var call;
8081
8258
  (function (call) {
8259
+ /** Modalities that can be associated with a call. */
8082
8260
  var CallModalities;
8083
8261
  (function (CallModalities) {
8262
+ /** Indicates that the modality is unknown or undefined. */
8084
8263
  CallModalities["Unknown"] = "unknown";
8264
+ /** Indicates that the call includes audio. */
8085
8265
  CallModalities["Audio"] = "audio";
8266
+ /** Indicates that the call includes video. */
8086
8267
  CallModalities["Video"] = "video";
8268
+ /** Indicates that the call includes video-based screen sharing. */
8087
8269
  CallModalities["VideoBasedScreenSharing"] = "videoBasedScreenSharing";
8270
+ /** Indicates that the call includes data sharing or messaging. */
8088
8271
  CallModalities["Data"] = "data";
8089
8272
  })(CallModalities = call.CallModalities || (call.CallModalities = {}));
8090
8273
  /**
@@ -8258,7 +8441,7 @@ function getContext(callback) {
8258
8441
  }
8259
8442
  /**
8260
8443
  * @deprecated
8261
- * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
8444
+ * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void} instead.
8262
8445
  *
8263
8446
  * Registers a handler for theme changes.
8264
8447
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8270,7 +8453,7 @@ function registerOnThemeChangeHandler(handler) {
8270
8453
  }
8271
8454
  /**
8272
8455
  * @deprecated
8273
- * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
8456
+ * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void} instead.
8274
8457
  *
8275
8458
  * Registers a handler for changes from or to full-screen view for a tab.
8276
8459
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8282,7 +8465,7 @@ function registerFullScreenHandler(handler) {
8282
8465
  }
8283
8466
  /**
8284
8467
  * @deprecated
8285
- * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
8468
+ * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: callbackFunctionType): void} instead.
8286
8469
  *
8287
8470
  * Registers a handler for clicking the app button.
8288
8471
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8294,7 +8477,7 @@ function registerAppButtonClickHandler(handler) {
8294
8477
  }
8295
8478
  /**
8296
8479
  * @deprecated
8297
- * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
8480
+ * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: callbackFunctionType): void} instead.
8298
8481
  *
8299
8482
  * Registers a handler for entering hover of the app button.
8300
8483
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8306,7 +8489,7 @@ function registerAppButtonHoverEnterHandler(handler) {
8306
8489
  }
8307
8490
  /**
8308
8491
  * @deprecated
8309
- * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
8492
+ * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: callbackFunctionType): void} instead.
8310
8493
  *
8311
8494
  * Registers a handler for exiting hover of the app button.
8312
8495
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8318,7 +8501,7 @@ function registerAppButtonHoverLeaveHandler(handler) {
8318
8501
  }
8319
8502
  /**
8320
8503
  * @deprecated
8321
- * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
8504
+ * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void} instead.
8322
8505
  *
8323
8506
  * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
8324
8507
  * navigation stack should use this handler to navigate the user back within their frame. If an app finds
@@ -8344,7 +8527,7 @@ function registerOnLoadHandler(handler) {
8344
8527
  }
8345
8528
  /**
8346
8529
  * @deprecated
8347
- * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
8530
+ * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void} instead.
8348
8531
  *
8349
8532
  * @hidden
8350
8533
  * Registers a handler to be called before the page is unloaded.
@@ -8369,7 +8552,7 @@ function registerFocusEnterHandler(handler) {
8369
8552
  }
8370
8553
  /**
8371
8554
  * @deprecated
8372
- * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
8555
+ * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void} instead.
8373
8556
  *
8374
8557
  * Registers a handler for when the user reconfigurated tab.
8375
8558
  *
@@ -8456,7 +8639,7 @@ function setFrameContext(frameContext) {
8456
8639
  }
8457
8640
  /**
8458
8641
  * @deprecated
8459
- * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
8642
+ * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void} instead.
8460
8643
  *
8461
8644
  * Initialize with FrameContext
8462
8645
  *
@@ -8475,9 +8658,6 @@ function initializeWithFrameContext(frameContext, callback, validMessageOrigins)
8475
8658
 
8476
8659
 
8477
8660
 
8478
- /**
8479
- * Navigation specific part of the SDK.
8480
- */
8481
8661
  /**
8482
8662
  * @deprecated
8483
8663
  * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
@@ -8620,7 +8800,7 @@ var settings;
8620
8800
  settings.setSettings = setSettings;
8621
8801
  /**
8622
8802
  * @deprecated
8623
- * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
8803
+ * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead.
8624
8804
  *
8625
8805
  * Registers a handler for when the user attempts to save the settings. This handler should be used
8626
8806
  * to create or update the underlying resource powering the content.
@@ -8635,7 +8815,7 @@ var settings;
8635
8815
  settings.registerOnSaveHandler = registerOnSaveHandler;
8636
8816
  /**
8637
8817
  * @deprecated
8638
- * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
8818
+ * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
8639
8819
  *
8640
8820
  * Registers a handler for user attempts to remove content. This handler should be used
8641
8821
  * to remove the underlying resource powering the content.