BasicAuthorization
Class used to authorize a mobile user against Oracle Mobile Hub
with the Basic Authentication security schema. Callers should use
MobileBackend's authorization property.
- Source:
Extends
Members
isAuthorized :Boolean
Is SDK authorized.
Returns true if a user has been authorized, false otherwise.
A user can be authorized by calling authenticate() or authenticateAnonymous().
Type:
- Boolean
- Inherited From:
- Source:
Methods
authenticate(username, password) → {Promise.<NetworkResponse>}
Authenticate.
Authenticates a user with the given credentials against the service.
The user remains logged in until logout() is called.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
String | The username of the credentials. |
password |
String | The password of the credentials. |
- Source:
Returns:
- Type
- Promise.<NetworkResponse>
authenticateAnonymous() → {Promise.<NetworkResponse>}
Authenticate anonymously.
Authenticates an anonymous user against the service. The user remains logged in until logout() is called.
- Source:
Returns:
- Type
- Promise.<NetworkResponse>
getAccessToken() → {String}
Get access token.
Returns the current access token from user credentials.
- Inherited From:
- Source:
Returns:
current access token from user credentials.
- Type
- String
getAuthorizedUserName() → {String}
Get authorized user name.
Returns the username of the current authorized user if any, null otherwise.
- Source:
Returns:
- Type
- String
isTokenValid() → {Boolean}
Is token valid.
Checks to see if the authorization token is null, undefined, NaN,an empty string (""), 0, or false.
- Source:
Returns:
- Type
- Boolean
logout()
Log out.
Logs out the current user and clears credentials and tokens.
- Source:
onAuthentication(callback)
On authentication event.
Subscribe for on authentication event
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
Authorization~OnAuthenticationCallback | The callback that will be called when authentication happen. |
- Inherited From:
- Source:
refreshToken() → {Promise.<NetworkResponse>}
Refresh token.
For BasicAuth, there is no need to call this function, because the token never expires.
This function only exists here because it inherits from the Authorization object, which is also used for other types of authentication in which the token can expire.
- Source:
Returns:
- Type
- Promise.<NetworkResponse>