Interface: OAuth.ITokenRefresher

ITokenRefresher | Matterport SDK

Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.

A helper to automatically refresh tokens

Hierarchy

ITokenRefresher

Index

Methods

dispose
on

Methods

dispose

dispose(): void

Shut down, stop refreshing, and clean up resources

Returns void

on

on(event: "refresh", callback: function): ISubscription
on(event: "error", callback: function): ISubscription
on(refreshObserver: OAuth.IRefreshObserver): ISubscription

Listen for successful refreshes of the token

Parameters
- event: "refresh"
  
  The 'refresh' event type
- callback: function
  
  The callback to call on a refresh
  - - (): void
    - Returns void
Returns ISubscription
Listen for errors when refreshing the token

Parameters
- event: "error"
  
  The 'error' event type
- callback: function
  
  The callback to call on error
  - - (e: Error): void
    - Parameters
      - e: Error
      Returns void
Returns ISubscription
Attach an observer that can listen for refresh or error events

Parameters
- refreshObserver: OAuth.IRefreshObserver
Returns ISubscription