@microsoft/teams-js 2.55.0 → 2.55.1-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.
@@ -52,7 +52,7 @@ export declare function isHostClientMobile(): boolean;
52
52
  export declare function throwExceptionIfMobileApiIsNotSupported(requiredVersion?: string): void;
53
53
  /**
54
54
  * @hidden
55
- * Processes the valid origins specifuied by the user, de-duplicates and converts them into a regexp
55
+ * Processes the valid origins specified by the user, de-duplicates and converts them into a regexp
56
56
  * which is used later for message source/origin validation
57
57
  *
58
58
  * @internal
@@ -155,14 +155,19 @@ export declare function notifyFailure(result?: string): void;
155
155
  export interface LegacyCallBacks {
156
156
  /**
157
157
  * @deprecated
158
- * As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
158
+ * As of TeamsJS v2.0.0, this property has been deprecated in favor of the `Promise` returned from
159
+ * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
160
+ * and {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>}.
159
161
  *
160
162
  * A function that is called if the request succeeds.
161
163
  */
162
164
  successCallback?: (result: string) => void;
163
165
  /**
164
166
  * @deprecated
165
- * As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
167
+ * As of TeamsJS v2.0.0, this property has been deprecated in favor of the `Promise` returned from
168
+ * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
169
+ * and {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>},
170
+ * which rejects with the reason for the failure.
166
171
  *
167
172
  * A function that is called if the request fails, with the reason for the failure.
168
173
  */
@@ -398,7 +403,8 @@ export declare enum DataResidency {
398
403
  }
399
404
  /**
400
405
  * @deprecated
401
- * As of TeamsJS v2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
406
+ * As of TeamsJS v2.0.0, this interface has been deprecated in favor of the `Promise` returned from
407
+ * {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>}.
402
408
  * @hidden
403
409
  * Describes the UserRequest. Success callback describes how a successful request is handled.
404
410
  * Failure callback describes how a failed request is handled.
@@ -12,6 +12,10 @@ export type getLocationCallbackFunctionType = (error: SdkError, location: Locati
12
12
  export type showLocationCallbackFunctionType = (error: SdkError, status: boolean) => void;
13
13
  /**
14
14
  * @deprecated
15
+ * As of 2.1.0, this interface is no longer needed. Instead of setting `allowChooseLocation`, call one of the following functions:
16
+ * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<geoLocation.Location\>} to get the current location.
17
+ * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<geoLocation.Location\>} to choose location on map.
18
+ *
15
19
  * Data Structure to set the location properties in getLocation call.
16
20
  */
17
21
  export interface LocationProps {
@@ -31,7 +35,9 @@ export interface LocationProps {
31
35
  }
32
36
  /**
33
37
  * @deprecated
34
- * Data struture to represent the location information
38
+ * As of 2.1.0, please use {@link geoLocation.Location} instead.
39
+ *
40
+ * Data structure to represent the location information
35
41
  */
36
42
  export interface Location {
37
43
  /**
@@ -54,8 +60,8 @@ export interface Location {
54
60
  /**
55
61
  * @deprecated
56
62
  * As of 2.1.0, please use one of the following functions:
57
- * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
58
- * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
63
+ * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<geoLocation.Location\>} to get the current location.
64
+ * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<geoLocation.Location\>} to choose location on map.
59
65
  *
60
66
  * Fetches user location
61
67
  * @param props {@link LocationProps} - Specifying how the location request is handled
@@ -64,7 +70,7 @@ export interface Location {
64
70
  export declare function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
65
71
  /**
66
72
  * @deprecated
67
- * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
73
+ * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: geoLocation.Location): Promise\<void\>} instead.
68
74
  *
69
75
  * Shows the location on map corresponding to the given coordinates
70
76
  *
@@ -66,15 +66,15 @@ export interface FileResult {
66
66
  */
67
67
  error?: SdkError;
68
68
  /**
69
- * File chunk which will be assemebled and converted into a blob
69
+ * File chunk which will be assembled and converted into a blob
70
70
  */
71
71
  fileChunk: FileChunk;
72
72
  /**
73
- * File index of the file for which chunk data is getting recieved
73
+ * File index of the file for which chunk data is getting received
74
74
  */
75
75
  fileIndex: number;
76
76
  /**
77
- * File type/MIME type which is getting recieved
77
+ * File type/MIME type which is getting received
78
78
  */
79
79
  fileType: string;
80
80
  /**
@@ -1 +1 @@
1
- const o="2.55.0";export{o as version};
1
+ const t="2.55.1-beta.0";export{t as version};
@@ -4695,7 +4695,7 @@ function isSerializable(arg) {
4695
4695
  * @hidden
4696
4696
  * Package version.
4697
4697
  */
4698
- const version = "2.55.0";
4698
+ const version = "2.55.1-beta.0";
4699
4699
 
4700
4700
  ;// ./src/public/featureFlags.ts
4701
4701
  // All build feature flags are defined inside this object. Any build feature flag must have its own unique getter and setter function. This pattern allows for client apps to treeshake unused code and avoid including code guarded by this feature flags in the final bundle. If this property isn't desired, use the below runtime feature flags object.
@@ -5044,7 +5044,7 @@ function throwExceptionIfMobileApiIsNotSupported(requiredVersion = defaultSDKVer
5044
5044
  }
5045
5045
  /**
5046
5046
  * @hidden
5047
- * Processes the valid origins specifuied by the user, de-duplicates and converts them into a regexp
5047
+ * Processes the valid origins specified by the user, de-duplicates and converts them into a regexp
5048
5048
  * which is used later for message source/origin validation
5049
5049
  *
5050
5050
  * @internal
@@ -16890,8 +16890,8 @@ const locationTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
16890
16890
  /**
16891
16891
  * @deprecated
16892
16892
  * As of 2.1.0, please use one of the following functions:
16893
- * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
16894
- * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
16893
+ * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<geoLocation.Location\>} to get the current location.
16894
+ * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<geoLocation.Location\>} to choose location on map.
16895
16895
  *
16896
16896
  * Fetches user location
16897
16897
  * @param props {@link LocationProps} - Specifying how the location request is handled
@@ -16915,7 +16915,7 @@ function getLocation(props, callback) {
16915
16915
  }
16916
16916
  /**
16917
16917
  * @deprecated
16918
- * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
16918
+ * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: geoLocation.Location): Promise\<void\>} instead.
16919
16919
  *
16920
16920
  * Shows the location on map corresponding to the given coordinates
16921
16921
  *