webStorage module

Package:

@microsoft/teams-js

Note

This namespace is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Contains functionality enabling apps to query properties about how the host manages web storage (Window.LocalStorage)

Functions

isSupported()	Checks if webStorage capability is supported by the host
isWebStorageClearedOnUserLogOut()	Checks if web storage (Window.LocalStorage) gets cleared when a user logs out from host

Function Details

isSupported()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Checks if webStorage capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the webStorage capability is supported

isWebStorageClearedOnUserLogOut()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Checks if web storage (Window.LocalStorage) gets cleared when a user logs out from host

function isWebStorageClearedOnUserLogOut(): Promise<boolean>

Returns

Promise<boolean>

true if web storage gets cleared on logout and false if not