Document how to force refresh access token (#1720)

This commit is contained in:
Cathal Geoghegan 2023-03-13 10:38:14 +00:00 committed by GitHub
parent edbefcc372
commit 252abf87a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -556,7 +556,8 @@ Returns true if the token has less than minValidity seconds left before it expir
*updateToken(minValidity)*
If the token expires within minValidity seconds (minValidity is optional, if not specified 5 is used) the token is refreshed.
If the session status iframe is enabled, the session status is also checked.
If -1 is passed as the minValidity, the token will be forcibly refreshed.
If the session status iframe is enabled, the session status is also checked.
Returns a promise that resolves with a boolean indicating whether or not the token has been refreshed.