lithium.community.android.sdk.manager

Class LiSDKManager

java.lang.Object

lithium.community.android.sdk.manager.LiSDKManager

public final class LiSDKManager
extends java.lang.Object

Interface to Lithium Community Android SDK. Provides the entry point into the Community REST api v2 using OAuth2 implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected LiAppCredentials	liAppCredentials

Method Summary

Modifier and Type	Method and Description
void	fetchFreshAccessToken(android.content.Context context, LiAuthService.FreshTokenCallBack mFreshTokenCallBack) Fetches Fresh Access Token and Persists it.
android.net.Uri	getCommunityUrl() Returns community URI.
java.lang.String	getCoreSDKVersion() gets the core sdk version
java.lang.String	getFromSecuredPreferences(android.content.Context context, java.lang.String key)
static LiSDKManager	getInstance() Instance of this.
LiAppCredentials	getLiAppCredentials() Returns AppCredentials.
LiDeviceTokenProvider	getLiDeviceTokenProvider()
LiUser	getLoggedInUser() Fetches the current logged in User.
boolean	getNeedsTokenRefresh() Checks if need to getch fresh access tokens.
java.lang.String	getNewAuthToken() Returns Access Token.
java.lang.String	getProxyHost() Returns proxy host received along with auth code .
java.lang.String	getRefreshToken() Returns Refresh Token.
java.lang.String	getTenant() Returns tenant id received along with auth code .
static LiSDKManager	init(android.content.Context context, LiAppCredentials liAppCredentials) Initiales LiSDKManager and initiates the login flow.
void	initLoginFlow(android.content.Context context) Login flow is initiated from here and then call goes to LiAuthService
void	initLoginFlow(android.content.Context context, LiDeviceTokenProvider liDeviceTokenProvider) Login flow is initiated from here and then call goes to LiAuthService
void	initLoginFlow(android.content.Context context, java.lang.String ssoToken) Login flow is initiated from here and then call goes to LiAuthService
void	initLoginFlow(android.content.Context context, java.lang.String ssoToken, LiDeviceTokenProvider liDeviceTokenProvider) Login flow is initiated from here and then call goes to LiAuthService
static boolean	isEnvironmentInitialized() Checks whether the SDK is initialized.
boolean	isUserLoggedIn() Checks if the user is logged in.
void	logout(android.content.Context context) Flushes auth state when a call to logout is made.
void	persistAuthState(android.content.Context context, LiSSOAuthResponse authorizationResponse) persists Auth State in shared preference when Authorization Response is received
void	persistAuthState(android.content.Context context, LiTokenResponse response) persists Auth State in shared preference when Token Response is received
boolean	putInSecuredPreferences(android.content.Context context, java.lang.String key, java.lang.String value)
boolean	removeFromSecuredPreferences(android.content.Context context, java.lang.String key)
lithium.community.android.sdk.manager.LiAuthState	restoreAuthState(android.content.Context context) Fetches Auth State from Shared Preference.
void	setLiDeviceTokenProvider(LiDeviceTokenProvider liDeviceTokenProvider)
void	setLoggedInUser(android.content.Context context, LiUser user) Sets User
void	syncWithCommunity(android.content.Context context)

Methods inherited from class java.lang.Object

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

Field Detail

liAppCredentials

protected final LiAppCredentials liAppCredentials

Method Detail

isEnvironmentInitialized

public static boolean isEnvironmentInitialized()

Checks whether the SDK is initialized.

Returns:

true or false depending on whether the SDK is initialized

init

public static LiSDKManager init(android.content.Context context,
                                LiAppCredentials liAppCredentials)
                         throws java.net.URISyntaxException

Initiales LiSDKManager and initiates the login flow. This also fetches SDK settings after login.

Parameters:

context - Context

liAppCredentials - LiAppCredentials

Returns:

Instance of LiSDKManager

Throws:

java.net.URISyntaxException - URISyntaxException

getInstance

public static LiSDKManager getInstance()

Instance of this.

syncWithCommunity

public void syncWithCommunity(android.content.Context context)

getCommunityUrl

public android.net.Uri getCommunityUrl()

Returns community URI.

getLiAppCredentials

public LiAppCredentials getLiAppCredentials()

Returns AppCredentials.

getCoreSDKVersion

public java.lang.String getCoreSDKVersion()

gets the core sdk version

getLiDeviceTokenProvider

public LiDeviceTokenProvider getLiDeviceTokenProvider()

setLiDeviceTokenProvider

public void setLiDeviceTokenProvider(LiDeviceTokenProvider liDeviceTokenProvider)

getLoggedInUser

public LiUser getLoggedInUser()

Fetches the current logged in User.

Returns:

user details.

setLoggedInUser

public void setLoggedInUser(android.content.Context context,
                            LiUser user)

Sets User

Parameters:

user -

getNewAuthToken

public java.lang.String getNewAuthToken()

Returns Access Token.

getRefreshToken

public java.lang.String getRefreshToken()

Returns Refresh Token.

initLoginFlow

public void initLoginFlow(android.content.Context context)
                   throws java.net.URISyntaxException

Login flow is initiated from here and then call goes to LiAuthService

Parameters:

context - Context

Throws:

java.net.URISyntaxException

initLoginFlow

public void initLoginFlow(android.content.Context context,
                          java.lang.String ssoToken)
                   throws java.net.URISyntaxException

Login flow is initiated from here and then call goes to LiAuthService

Parameters:

context - Android context

ssoToken - pass the Single Sign-on token if the community uses its own identity provider

Throws:

java.net.URISyntaxException

initLoginFlow

public void initLoginFlow(android.content.Context context,
                          LiDeviceTokenProvider liDeviceTokenProvider)
                   throws java.net.URISyntaxException

Login flow is initiated from here and then call goes to LiAuthService

Parameters:

context - Android context

liDeviceTokenProvider - this provider fetches device token id based upon whatever the app is using. Either Firebase or GCM

Throws:

java.net.URISyntaxException

initLoginFlow

public void initLoginFlow(android.content.Context context,
                          java.lang.String ssoToken,
                          LiDeviceTokenProvider liDeviceTokenProvider)
                   throws java.net.URISyntaxException

Login flow is initiated from here and then call goes to LiAuthService

Parameters:

ssoToken - pass the Single Sign-on token if the community uses its own identity provider

liDeviceTokenProvider - this provider fetches device token id based upon whatever the app is using. Either Firebase or GCM

context - Context

Throws:

java.net.URISyntaxException

removeFromSecuredPreferences

public boolean removeFromSecuredPreferences(android.content.Context context,
                                            java.lang.String key)

putInSecuredPreferences

public boolean putInSecuredPreferences(android.content.Context context,
                                       java.lang.String key,
                                       java.lang.String value)

getFromSecuredPreferences

public java.lang.String getFromSecuredPreferences(android.content.Context context,
                                                  java.lang.String key)

persistAuthState

public void persistAuthState(android.content.Context context,
                             LiSSOAuthResponse authorizationResponse)

persists Auth State in shared preference when Authorization Response is received

Parameters:

context - Context

authorizationResponse - LiSSOAuthResponse

persistAuthState

public void persistAuthState(android.content.Context context,
                             LiTokenResponse response)

persists Auth State in shared preference when Token Response is received

Parameters:

context - Context

response - LiTokenResponse

logout

public void logout(android.content.Context context)

Flushes auth state when a call to logout is made.

Parameters:

context - Context

isUserLoggedIn

public boolean isUserLoggedIn()

Checks if the user is logged in.

Returns:

true or false depending whether user is logged in.

restoreAuthState

public final lithium.community.android.sdk.manager.LiAuthState restoreAuthState(android.content.Context context)

Fetches Auth State from Shared Preference.

Parameters:

context - Context

Returns:

the LiAuthState class.

getProxyHost

public java.lang.String getProxyHost()

Returns proxy host received along with auth code .

getTenant

public java.lang.String getTenant()

Returns tenant id received along with auth code .

getNeedsTokenRefresh

public boolean getNeedsTokenRefresh()

Checks if need to getch fresh access tokens.

fetchFreshAccessToken

public void fetchFreshAccessToken(android.content.Context context,
                                  LiAuthService.FreshTokenCallBack mFreshTokenCallBack)
                           throws java.net.URISyntaxException,
                                  LiRestResponseException

Fetches Fresh Access Token and Persists it.

Parameters:

context - Context

mFreshTokenCallBack - LiAuthService.FreshTokenCallBack

Throws:

java.net.URISyntaxException - URISyntaxException

LiRestResponseException - LiRestResponseException