Static
_allStatic
apiStatic
apiStatic
authAuth Provider to use. This is only relevant for OAuthBackend, but specifying here as Backend is the only class users import.
Static
capabilitiesStatic
defaultStatic
defaultStatic
fileStatic
hooksStatic
oStatic
phrasesStatic
urlsStatic
allStatic
authservices.json from the auth provider will be cached here. You could also set this manually to avoid the network request.
Static
hostReturn the hostname of the first URL pattern in the urls
array, if not variable.
This is used to facilitate relative URLs when constructing Backends directly.
Subclasses with variable hostnames can override this.
Static
oStatic
titleStatic
tokenPrivate
#getLow-level method to fetch data from the backend. Subclasses should override this method.
Clients should not call this method directly, but use load()
instead.
reference to data to fetch, if different from that provided in the constructor
null
if not foundHigher-level method for reading data from the backend. Subclasses should usually NOT override this method.
URL to fetch, if different from that provided in the constructor
Rest
...args: any[]null
if not foundHelper for making OAuth requests with JSON-based APIs.
API endpoint
Optional
data: anyData to send with the request
Optional
method: string = "GET"HTTP method
Optional
req: { Extra request options
Extra headers
Response type
Sync the logged in user, i.e. log in passively when another backend has logged in and log out when another backend has logged out. Generally intended to be used for backends with the same authentication mechanism. Syncing is not two-way, you need to call this on the other backend as well to make it so.
Static
findStatic
fromStatic
getOAuthStatic
loadStatic
parseURLStatic
phraseStatic
registerStatic
testGenerated using TypeDoc
URL string describing the data location