com.gigya.android.sdk

Class Gigya<T extends GigyaAccount>

java.lang.Object

com.gigya.android.sdk.Gigya<T>

Type Parameters:

T - Generic account scheme. Extended from base GigyaAccount model.

public class Gigya<T extends GigyaAccount>
extends java.lang.Object

Gigya SDK main interface. Provides access to the Gigya services.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Gigya(android.app.Application context, Config config, ConfigFactory configFactory, ISessionService sessionService, IAccountService<T> accountService, IBusinessApiService<T> businessApiService, ISessionVerificationService sessionVerificationService, IInterruptionResolverFactory interruptionsHandler, IPresenter<T> presenter, IProviderFactory providerFactory, IoCContainer container)

Method Summary

Modifier and Type	Method and Description
void	addConnection(java.lang.String socialProvider, GigyaLoginCallback<T> loginCallback) Add a social connection to existing account.
IGigyaWebBridge<T>	createWebBridge() Create an new instance of the GigyaWebBridge.
void	forgotPassword(java.util.Map<java.lang.String,java.lang.Object> params, GigyaCallback<GigyaApiResponse> gigyaCallback) Send a reset email password to verified email attached to the users loginId.
void	forgotPassword(java.lang.String loginId, GigyaCallback<GigyaApiResponse> gigyaCallback) Send a reset email password to verified email attached to the users loginId.
void	getAccount(boolean invalidateCache, GigyaCallback<T> gigyaCallback) Request account info.
void	getAccount(GigyaCallback<T> gigyaCallback) Request account info.
void	getAccount(java.util.Map<java.lang.String,java.lang.Object> params, GigyaCallback<T> gigyaCallback) Request account info given parameters map.
void	getAccount(java.lang.String[] include, java.lang.String[] profileExtraFields, GigyaCallback<T> gigyaCallback) Request account info given comma separated array of include parameters & comma separated array of profile extra fields.
java.lang.Class<T>	getAccountSchema()
static IoCContainer	getContainer()
android.content.Context	getContext()
static Gigya<? extends GigyaAccount>	getInstance()
static <V extends GigyaAccount> Gigya<V>	getInstance(java.lang.Class<V> accountClazz)
SessionInfo	getSession() Get current session.
Provider	getUsedSocialProvider(java.lang.String name) Request reference to used Gigya social provider.
void	handleInterruptions(boolean sdkHandles) Update interruption handling.
void	init(java.lang.String apiKey) Explicitly initialize the SDK.
void	init(java.lang.String apiKey, java.lang.String apiDomain) Explicitly initialize the SDK.
boolean	interruptionsEnabled() Return SDK interruptions state.
boolean	isLoggedIn() Check if we currently have a valid session.
void	login(java.util.Map<java.lang.String,java.lang.Object> params, GigyaLoginCallback<T> gigyaLoginCallback) Login with given parameters.
void	login(java.lang.String socialProvider, java.util.Map<java.lang.String,java.lang.Object> params, GigyaLoginCallback<T> gigyaLoginCallback) Login given a specific 3rd party provider.
void	login(java.lang.String loginId, java.lang.String password, GigyaLoginCallback<T> gigyaCallback) Login with provided id and password.
void	logout() Logout of Gigya services.
void	logout(GigyaCallback<GigyaApiResponse> gigyaCallback) Logout of Gigya services.
void	notifySocialLogin(java.util.Map<java.lang.String,java.lang.Object> params, GigyaLoginCallback<T> gigyaLoginCallback) Login to with social provider when the provider session is available (obtained via specific provider login process).
void	register(java.lang.String email, java.lang.String password, GigyaLoginCallback<T> callback) Register account using email and password combination.
void	register(java.lang.String email, java.lang.String password, java.util.Map<java.lang.String,java.lang.Object> params, GigyaLoginCallback<T> callback) Register account using email and password combination.
void	removeConnection(java.lang.String socialProvider, GigyaCallback<GigyaApiResponse> gigyaCallback) Remove a social connection from an existing account.
void	send(java.lang.String api, java.util.Map<java.lang.String,java.lang.Object> params, GigyaCallback<GigyaApiResponse> gigyaCallback) Send request to Gigya servers.
<V> void	send(java.lang.String api, java.util.Map<java.lang.String,java.lang.Object> params, int requestMethod, java.lang.Class<V> clazz, GigyaCallback<V> gigyaCallback) Send a generic type request to Gigya servers.
void	setAccount(java.util.Map<java.lang.String,java.lang.Object> params, GigyaCallback<T> gigyaCallback) Set account info given update parameters.
void	setAccount(T account, GigyaCallback<T> gigyaCallback) Set account info
static void	setApplication(android.app.Application appContext)
void	setSession(SessionInfo session) Manually set the current session.
void	showScreenSet(java.lang.String screensSet, boolean fullScreen, java.util.Map<java.lang.String,java.lang.Object> params, GigyaPluginCallback<T> gigyaPluginCallback) Show Gigya ScreenSets flow using the PluginFragment.
void	socialLoginWith(java.util.List<java.lang.String> providers, java.util.Map<java.lang.String,java.lang.Object> params, GigyaLoginCallback<T> gigyaLoginCallback) Present social login selection list.
void	updateDeviceInfo(java.lang.String newPushToken) Update device information in server.
void	verifyLogin(java.lang.String UID, GigyaCallback<T> gigyaCallback) Request verify login given account UID/

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

Gigya

protected Gigya(android.app.Application context,
                Config config,
                ConfigFactory configFactory,
                ISessionService sessionService,
                IAccountService<T> accountService,
                IBusinessApiService<T> businessApiService,
                ISessionVerificationService sessionVerificationService,
                IInterruptionResolverFactory interruptionsHandler,
                IPresenter<T> presenter,
                IProviderFactory providerFactory,
                IoCContainer container)

Method Detail

getContainer

public static IoCContainer getContainer()

setApplication

public static void setApplication(android.app.Application appContext)

getInstance

public static Gigya<? extends GigyaAccount> getInstance()

getInstance

public static <V extends GigyaAccount> Gigya<V> getInstance(java.lang.Class<V> accountClazz)

init

public void init(java.lang.String apiKey)

Explicitly initialize the SDK. Using this init() method will set the SDK domain to the default "us1.gigya.com" see init(String, String) to explicitly set the required domain.

Parameters:

apiKey - Client API-KEY.

init

public void init(java.lang.String apiKey,
                 java.lang.String apiDomain)

Explicitly initialize the SDK.

Parameters:

apiKey - Client API-KEY

apiDomain - Request Domain.

getAccountSchema

public java.lang.Class<T> getAccountSchema()

getContext

public android.content.Context getContext()

handleInterruptions

public void handleInterruptions(boolean sdkHandles)

Update interruption handling. By default, the Gigya SDK will handle various API interruptions to allow simple resolving of certain common errors. Setting interruptions to FALSE will force the end user to handle his own errors.

Parameters:

sdkHandles - False if manually handling all errors.

interruptionsEnabled

public boolean interruptionsEnabled()

Return SDK interruptions state. if TRUE, interruption handling will be optional via the GigyaLoginCallback.

send

public void send(java.lang.String api,
                 java.util.Map<java.lang.String,java.lang.Object> params,
                 GigyaCallback<GigyaApiResponse> gigyaCallback)

Send request to Gigya servers.

Parameters:

api - Request method identifier.

params - Additional parameters.

gigyaCallback - Response listener callback.

send

public <V> void send(java.lang.String api,
                     java.util.Map<java.lang.String,java.lang.Object> params,
                     int requestMethod,
                     java.lang.Class<V> clazz,
                     GigyaCallback<V> gigyaCallback)

Send a generic type request to Gigya servers.

Parameters:

api - Request method identifier.

params - Additional parameters.

requestMethod - Request method (GET, POST).

clazz - Response class scheme.

gigyaCallback - Response listener callback.

getSession

public SessionInfo getSession()

Get current session.

Returns:

SessionInfo instance.

setSession

public void setSession(SessionInfo session)

Manually set the current session. Setting a session manually will update the current session persistence state and login state.

Parameters:

session - SessionInfo instance.

isLoggedIn

public boolean isLoggedIn()

Check if we currently have a valid session.

logout

public void logout()

Logout of Gigya services. This will clean all session related data persistence.

logout

public void logout(GigyaCallback<GigyaApiResponse> gigyaCallback)

Logout of Gigya services. This will clean all session related data persistence.

Parameters:

gigyaCallback - Response listener callback.

login

public void login(java.lang.String loginId,
                  java.lang.String password,
                  GigyaLoginCallback<T> gigyaCallback)

Login with provided id and password.

Parameters:

loginId - LoginID.

password - Login password.

gigyaCallback - Response listener callback.

login

public void login(java.util.Map<java.lang.String,java.lang.Object> params,
                  GigyaLoginCallback<T> gigyaLoginCallback)

Login with given parameters.

Parameters:

params - parameters map.

gigyaLoginCallback - Login response callback.

login

public void login(java.lang.String socialProvider,
                  java.util.Map<java.lang.String,java.lang.Object> params,
                  GigyaLoginCallback<T> gigyaLoginCallback)

Login given a specific 3rd party provider.

Parameters:

socialProvider - Selected providers GigyaDefinitions.Providers.SocialProvider.

params - Parameters map.

gigyaLoginCallback - Login response callback.

getAccount

public void getAccount(GigyaCallback<T> gigyaCallback)

Request account info.

Parameters:

gigyaCallback - Response listener callback.

getAccount

public void getAccount(boolean invalidateCache,
                       GigyaCallback<T> gigyaCallback)

Request account info.

Parameters:

invalidateCache - Should override the account caching option. When set to true, the SDK will not cache the account object.

gigyaCallback - Response listener callback.

getAccount

public void getAccount(java.util.Map<java.lang.String,java.lang.Object> params,
                       GigyaCallback<T> gigyaCallback)

Request account info given parameters map.

Parameters:

params - Request parameter map.

gigyaCallback - Response listener callback.

getAccount

public void getAccount(java.lang.String[] include,
                       java.lang.String[] profileExtraFields,
                       GigyaCallback<T> gigyaCallback)

Request account info given comma separated array of include parameters & comma separated array of profile extra fields.

Parameters:

include - String[] array.

profileExtraFields - String[] array.

gigyaCallback - Response listener callback.

setAccount

public void setAccount(T account,
                       GigyaCallback<T> gigyaCallback)

Set account info

Parameters:

account - Updated account object.

gigyaCallback - Response listener callback.

setAccount

public void setAccount(java.util.Map<java.lang.String,java.lang.Object> params,
                       GigyaCallback<T> gigyaCallback)

Set account info given update parameters.

Parameters:

params - Updated account parameters.

gigyaCallback - Response listener callback.

verifyLogin

public void verifyLogin(java.lang.String UID,
                        GigyaCallback<T> gigyaCallback)

Request verify login given account UID/

Parameters:

UID - Account UID identifier.

gigyaCallback - Response listener callback.

register

public void register(java.lang.String email,
                     java.lang.String password,
                     java.util.Map<java.lang.String,java.lang.Object> params,
                     GigyaLoginCallback<T> callback)

Register account using email and password combination. Additional parameters are included to allow additional parameters to be added such as profile.

Parameters:

email - User email identifier.

password - User password.

params - Additional parameters.

callback - Response listener callback.

register

public void register(java.lang.String email,
                     java.lang.String password,
                     GigyaLoginCallback<T> callback)

Register account using email and password combination.

Parameters:

email - User email identifier.

password - User password.

callback - Response listener callback.

forgotPassword

public void forgotPassword(java.lang.String loginId,
                           GigyaCallback<GigyaApiResponse> gigyaCallback)

Send a reset email password to verified email attached to the users loginId.

Parameters:

loginId - User login id.

gigyaCallback - Response listener callback.

forgotPassword

public void forgotPassword(java.util.Map<java.lang.String,java.lang.Object> params,
                           GigyaCallback<GigyaApiResponse> gigyaCallback)

Send a reset email password to verified email attached to the users loginId.

Parameters:

params - Parameter map.

gigyaCallback - Response listener callback.

See Also:

accounts.resetPassword REST for available parameters.

addConnection

public void addConnection(java.lang.String socialProvider,
                          GigyaLoginCallback<T> loginCallback)

Add a social connection to existing account.

Parameters:

socialProvider - Social provider identifier.

loginCallback - Response listener callback.

removeConnection

public void removeConnection(java.lang.String socialProvider,
                             GigyaCallback<GigyaApiResponse> gigyaCallback)

Remove a social connection from an existing account.

Parameters:

socialProvider - Social provider identifier.

gigyaCallback - Response listener callback.

notifySocialLogin

public void notifySocialLogin(java.util.Map<java.lang.String,java.lang.Object> params,
                              GigyaLoginCallback<T> gigyaLoginCallback)

Login to with social provider when the provider session is available (obtained via specific provider login process).

Parameters:

params - Parameter map.

gigyaLoginCallback - Response listener callback.

getUsedSocialProvider

public Provider getUsedSocialProvider(java.lang.String name)

Request reference to used Gigya social provider. Currently supported provider (GOOGLE, FACEBOOK, LINE, WECHAT).

Parameters:

name - Provider name.

Returns:

Provider reference or null if not available.

socialLoginWith

public void socialLoginWith(java.util.List<java.lang.String> providers,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            GigyaLoginCallback<T> gigyaLoginCallback)

Present social login selection list.

Parameters:

providers - List of selected social providers GigyaDefinitions.Providers.SocialProvider.

params - Request parameters.

gigyaLoginCallback - Login response callback.

showScreenSet

public void showScreenSet(java.lang.String screensSet,
                          boolean fullScreen,
                          java.util.Map<java.lang.String,java.lang.Object> params,
                          GigyaPluginCallback<T> gigyaPluginCallback)

Show Gigya ScreenSets flow using the PluginFragment. UI will be presented via WebView.

Parameters:

screensSet - Main ScreensSet group identifier

fullScreen - Show in fullscreen mode.

params - ScreensSet flow parameters.

gigyaPluginCallback - Plugin callback.

updateDeviceInfo

public void updateDeviceInfo(java.lang.String newPushToken)

Update device information in server. Device information includes: platform, manufacturer, os & push token. Use this method manually if your flow requires to update the push service token. Additional device info is generated at runtime.

Parameters:

newPushToken - New provided push token.

createWebBridge

public IGigyaWebBridge<T> createWebBridge()

Create an new instance of the GigyaWebBridge.

Returns:

GigyaWebBridge instance.