Package com.subaio.subaio

Class SubaioManager

java.lang.Object

com.subaio.subaio.SubaioManager

public final class SubaioManager
extends java.lang.Object

Singleton-class for managing global setup of subaio-views. Before creating views, `SubaioManager.getInstance().configure` and `SubaioManager.getInstance().setLanguage should be invoked. The manager automatically maintains a valid token and requests new ones using the `TokenHandler.onTokenRequired` callback whenever necessary.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubaioManager.ConfigurationHandler	Handle the async result of configuration.
static class	SubaioManager.ConfigurationResult	Indicated if configuration was successful
static interface	SubaioManager.TokenHandler	Callback invoked when token needs to be refreshed.

Method Summary

Modifier and Type	Method	Description
void	configure(SubaioConfiguration configuration, SubaioManager.TokenHandler handler)	Configure Subaio Manager to use specified configuration object.
SubaioConfiguration	getConfiguration()
static SubaioManager	getInstance()	Shared instance of the Subaio Manager.
java.lang.String	getLanguage()	Current language as a BCP-47 string.
com.subaio.subaio.TemplateHelper	getTemplateHelper()
Token	getToken()	Token to be used by Subaio for all calls to Subaio backend.
static void	init(android.content.Context context)
java.lang.Boolean	isInitialized()	Whether the SubaioManager has been initialized or not.
java.lang.Boolean	isInitializing()	Whether the SubaioManager is being initialized or not.
void	refreshToken()	Force a refresh of the token.
void	setConfigurationHandler(SubaioManager.ConfigurationHandler configurationHandler)
void	setLanguage(java.lang.String language)	Language to be used by all Subaio views as a BCP-47 string.
void	setToken(java.lang.String jwtToken)	Token to be used by Subaio for all calls to Subaio backend.
void	setTokenHandler(SubaioManager.TokenHandler tokenHandler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setToken

public void setToken(@Nullable
                     java.lang.String jwtToken)

Token to be used by Subaio for all calls to Subaio backend. The token should be set from the `TokenHandler` provided to `configure`. Additionally, the token may be set to `null` when the user becomes unauthenticated.

Parameters:

jwtToken - JWT token.

setLanguage

public void setLanguage(@Nullable
                        java.lang.String language)

Language to be used by all Subaio views as a BCP-47 string. Assigning `language` automatically updates all views and triggers a token refetch if configure has already been called. If it is set to nil or not set, views will never exit their loading-state.

Parameters:

language - Language code.

getLanguage

@Nullable
public java.lang.String getLanguage()

Current language as a BCP-47 string.

Returns:

language code.

getToken

@Nullable
public Token getToken()

Token to be used by Subaio for all calls to Subaio backend.

isInitialized

public java.lang.Boolean isInitialized()

Whether the SubaioManager has been initialized or not.

isInitializing

public java.lang.Boolean isInitializing()

Whether the SubaioManager is being initialized or not.

getTemplateHelper

public com.subaio.subaio.TemplateHelper getTemplateHelper()

getConfiguration

public SubaioConfiguration getConfiguration()

setConfigurationHandler

public void setConfigurationHandler(SubaioManager.ConfigurationHandler configurationHandler)

setTokenHandler

public void setTokenHandler(SubaioManager.TokenHandler tokenHandler)

init

public static void init(android.content.Context context)

getInstance

public static final SubaioManager getInstance()

Shared instance of the Subaio Manager. Use this to set token and configure Subaio.

Returns:

SubaioManager

configure

public void configure(@NonNull
                      SubaioConfiguration configuration,
                      @NonNull
                      SubaioManager.TokenHandler handler)

Configure Subaio Manager to use specified configuration object. Completion handler returns when Subaio is ready to be used. - parameter configuration: The configuration to be used. - parameter handler: The handler for handling token updates.

refreshToken

public void refreshToken()

Force a refresh of the token. This is necessary if the user changes authentication status (user logs out, user logs in, user is changed) to ensure that the token (or lack thereof) is correct. Only works after configure and setLanguage has been called.