@staffbase/widget-sdk 3.6.3 → 3.7.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.
- package/dist/widget-api.d.ts +1 -5
- package/docs/WidgetApi.md +2 -6
- package/package.json +1 -1
package/dist/widget-api.d.ts
CHANGED
|
@@ -53,16 +53,12 @@ export interface WidgetApi {
|
|
|
53
53
|
* refresh the token.
|
|
54
54
|
*
|
|
55
55
|
* @param type The name of the integration. ("ms365")
|
|
56
|
-
* @param refresh Force a refresh of the integration.
|
|
57
56
|
*
|
|
58
57
|
* @returns A promise containing the IntegrationInformation is returned. If the user session is
|
|
59
58
|
* not existing, the status is set to 'loggedOut' and the token is null. Additionally if the
|
|
60
59
|
* integration is not configured the status returns 'unavailable'.
|
|
61
60
|
*
|
|
62
61
|
* In case of an error, the promise is rejected.
|
|
63
|
-
*
|
|
64
|
-
* @deprecated Returns a IntegrationToken or null if the user is not logged in. This will be replaced
|
|
65
|
-
* completely by the IntegrationInformation, containing the token.
|
|
66
62
|
*/
|
|
67
|
-
getIntegration(type: IntegrationType
|
|
63
|
+
getIntegration(type: IntegrationType): Promise<IntegrationInformation>;
|
|
68
64
|
}
|
package/docs/WidgetApi.md
CHANGED
|
@@ -18,20 +18,16 @@ A class providing access to additional information about the Staffbase ecosystem
|
|
|
18
18
|
|
|
19
19
|
### getIntegration
|
|
20
20
|
|
|
21
|
-
▸ **getIntegration**(`type
|
|
21
|
+
▸ **getIntegration**(`type`): `Promise`<[`IntegrationInformation`](../wiki/IntegrationInformation)\>
|
|
22
22
|
|
|
23
23
|
Call to retrieve a valid token to access the Microsoft API. Includes a time value to
|
|
24
24
|
refresh the token.
|
|
25
25
|
|
|
26
|
-
**`deprecated`** Returns a IntegrationToken or null if the user is not logged in. This will be replaced
|
|
27
|
-
completely by the IntegrationInformation, containing the token.
|
|
28
|
-
|
|
29
26
|
#### Parameters
|
|
30
27
|
|
|
31
28
|
| Name | Type | Description |
|
|
32
29
|
| :------ | :------ | :------ |
|
|
33
30
|
| `type` | ``"ms365"`` | The name of the integration. ("ms365") |
|
|
34
|
-
| `refresh?` | `boolean` | Force a refresh of the integration. |
|
|
35
31
|
|
|
36
32
|
#### Returns
|
|
37
33
|
|
|
@@ -45,7 +41,7 @@ In case of an error, the promise is rejected.
|
|
|
45
41
|
|
|
46
42
|
#### Defined in
|
|
47
43
|
|
|
48
|
-
[lib/widget-api.ts:
|
|
44
|
+
[lib/widget-api.ts:70](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L70)
|
|
49
45
|
|
|
50
46
|
___
|
|
51
47
|
|