@microsoft/teams-js 2.0.0-beta.7-dev.1 → 2.0.0-beta.7-dev.4

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.
@@ -1277,8 +1277,7 @@ export namespace authentication {
1277
1277
  function initialize(): void;
1278
1278
  /**
1279
1279
  * @deprecated
1280
- * As of 2.0.0-beta.1.
1281
- *
1280
+ * As of 2.0.0, this function has been deprecated in favor of a Promise-based pattern.
1282
1281
  * Registers the authentication Communication.handlers
1283
1282
  *
1284
1283
  * @param authenticateParameters - A set of values that configure the authentication pop-up.
@@ -1297,7 +1296,7 @@ export namespace authentication {
1297
1296
  function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
1298
1297
  /**
1299
1298
  * @deprecated
1300
- * As of 2.0.0-beta.1, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
1299
+ * As of 2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
1301
1300
  *
1302
1301
  * Initiates an authentication request, which opens a new window with the specified settings.
1303
1302
  *
@@ -1316,7 +1315,7 @@ export namespace authentication {
1316
1315
  function getAuthToken(authTokenRequest?: AuthTokenRequestParameters): Promise<string>;
1317
1316
  /**
1318
1317
  * @deprecated
1319
- * As of 2.0.0-beta.1, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
1318
+ * As of 2.0.0, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
1320
1319
  *
1321
1320
  * Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
1322
1321
  * if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
@@ -1338,7 +1337,7 @@ export namespace authentication {
1338
1337
  function getUser(): Promise<UserProfile>;
1339
1338
  /**
1340
1339
  * @deprecated
1341
- * As of 2.0.0-beta.1, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
1340
+ * As of 2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
1342
1341
  *
1343
1342
  * @hidden
1344
1343
  * Hide from docs.
@@ -1373,22 +1372,27 @@ export namespace authentication {
1373
1372
  function notifyFailure(reason?: string, callbackUrl?: string): void;
1374
1373
  /**
1375
1374
  * @deprecated
1376
- * As of 2.0.0-beta.1.
1375
+ * As of 2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
1376
+ *-------------------------
1377
+ * Used in {@link AuthenticateParameters} and {@link AuthTokenRequest}
1377
1378
  */
1378
1379
  interface LegacyCallBacks {
1379
1380
  /**
1380
1381
  * @deprecated
1381
- * As of 2.0.0-beta.1.
1382
+ * As of 2.0.0, this property has been deprecated in favor of a Promise-based pattern.
1382
1383
  * A function that is called if the request succeeds.
1383
1384
  */
1384
1385
  successCallback?: (result: string) => void;
1385
1386
  /**
1386
1387
  * @deprecated
1387
- * As of 2.0.0-beta.1.
1388
+ * As of 2.0.0, this property has been deprecated in favor of a Promise-based pattern.
1388
1389
  * A function that is called if the request fails, with the reason for the failure.
1389
1390
  */
1390
1391
  failureCallback?: (reason: string) => void;
1391
1392
  }
1393
+ /**
1394
+ * Describes the authentication pop-up parameters
1395
+ */
1392
1396
  interface AuthenticatePopUpParameters {
1393
1397
  /**
1394
1398
  * The URL for the authentication pop-up.
@@ -1409,9 +1413,12 @@ export namespace authentication {
1409
1413
  }
1410
1414
  /**
1411
1415
  * @deprecated
1412
- * As of 2.0.0-beta.1, please use {@link AuthenticatePopUpParameters} instead.
1416
+ * As of 2.0.0, please use {@link AuthenticatePopUpParameters} instead.
1413
1417
  */
1414
1418
  type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
1419
+ /**
1420
+ * Describes authentication token request parameters
1421
+ */
1415
1422
  interface AuthTokenRequestParameters {
1416
1423
  /**
1417
1424
  * An optional list of resource for which to acquire the access token; only used for full trust apps.
@@ -1428,7 +1435,7 @@ export namespace authentication {
1428
1435
  }
1429
1436
  /**
1430
1437
  * @deprecated
1431
- * As of 2.0.0-beta.1, please use {@link AuthTokenRequestParameters} instead.
1438
+ * As of 2.0.0, please use {@link AuthTokenRequestParameters} instead.
1432
1439
  */
1433
1440
  type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
1434
1441
  /**
@@ -1528,10 +1535,12 @@ export namespace authentication {
1528
1535
  }
1529
1536
  /**
1530
1537
  * @deprecated
1531
- * As of 2.0.0-beta.1.
1538
+ * As of 2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
1532
1539
  * @hidden
1533
1540
  * Hide from docs.
1534
1541
  * ------
1542
+ * Describes the UserRequest. Success callback describes how a successful request is handled.
1543
+ * Failure callback describes how a failed request is handled.
1535
1544
  * @internal
1536
1545
  */
1537
1546
  interface UserRequest {
@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
1122
1122
  });
1123
1123
 
1124
1124
  ;// CONCATENATED MODULE: ./src/internal/constants.ts
1125
- var version = "2.0.0-beta.7-dev.1";
1125
+ var version = "2.0.0-beta.7-dev.4";
1126
1126
  /**
1127
1127
  * @hidden
1128
1128
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1983,8 +1983,7 @@ var authentication;
1983
1983
  var authParams;
1984
1984
  /**
1985
1985
  * @deprecated
1986
- * As of 2.0.0-beta.1.
1987
- *
1986
+ * As of 2.0.0, this function has been deprecated in favor of a Promise-based pattern.
1988
1987
  * Registers the authentication Communication.handlers
1989
1988
  *
1990
1989
  * @param authenticateParameters - A set of values that configure the authentication pop-up.