Package com.cheetahdigital.corekit.authentication.core.api

Class AuthenticationAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.corekit.authentication.core.api.AuthenticationAPI

All Implemented Interfaces:

RestController

public class AuthenticationAPI
extends Controller

Loyalty Authentication API Module A Authentication represents one User's Authentication Details.

Field Summary

Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
AuthenticationAPI()

Method Summary

Modifier and Type	Method	Description
void	changePassword(AuthenticationQueryParams queryParams, AuthenticationFieldParams fieldParams, ListenerModel<BaseModel<java.lang.Object>,java.lang.Object> listener)	Reset a Password
SuccessResponse	deRegisterFcmId(AuthenticationFieldParams fieldParams, AuthenticationQueryParams queryParams)
void	login(AuthenticationFieldParams fieldParams, Listener<Authentication> callback)	Login an account
Authentication	refreshToken(AuthenticationFieldParams fieldParams)	Refresh the currently stored Loyalty API Access Token.
BaseModel<RegistrationData>	registerFcmId(AuthenticationFieldParams fieldParams, AuthenticationQueryParams queryParams)	Register a FCM ID to receive push notification
void	requestPasswordReset(AuthenticationFieldParams fieldParams, ListenerModel<BaseModel<Message>,Message> listener)	Request password reset.
void	resendEmailConfirmation(AuthenticationFieldParams fieldParams, ListenerModel<BaseModel<Message>,Message> listener)	Resend the Email Confirmation
void	resetPassword(AuthenticationFieldParams fieldParams, Listener<SuccessResponse> listener)	Reset password via secure token.
void	revokeAccessToken(AuthenticationFieldParams fieldParams, AuthenticationQueryParams queryParams, Listener<SuccessResponse> listener)	Revoke an access token
void	signup(AuthenticationFieldParams fieldParams, Listener<SuccessResponse> listener)	Sign up the current user with the given credentials.
void	updateProfile(AuthenticationQueryParams queryParams, AuthenticationFieldParams fieldParams, Listener<SuccessResponse> listener)	Update profile details

Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationAPI

public AuthenticationAPI()

Method Detail

signup

public void signup(AuthenticationFieldParams fieldParams,
                   Listener<SuccessResponse> listener)

Sign up the current user with the given credentials.

Parameters:

fieldParams - AuthenticationFieldParams

listener - listener once user sign up is successful or not

login

public void login(AuthenticationFieldParams fieldParams,
                  Listener<Authentication> callback)

Login an account

Parameters:

fieldParams - the AuthenticationFieldParams

callback - handles the result of API

refreshToken

public Authentication refreshToken(AuthenticationFieldParams fieldParams)

Refresh the currently stored Loyalty API Access Token. Usually done after checking if Sdk.isTokenExpired(). If error 4005 is encountered, logout the app.

Parameters:

fieldParams - AuthenticationFieldParams

Returns:

Authentication

registerFcmId

public BaseModel<RegistrationData> registerFcmId(AuthenticationFieldParams fieldParams,
                                                 AuthenticationQueryParams queryParams)

Register a FCM ID to receive push notification

Parameters:

fieldParams - AuthenticationFieldParams

queryParams - AuthenticationQueryParams

Returns:

BaseModel

deRegisterFcmId

public SuccessResponse deRegisterFcmId(AuthenticationFieldParams fieldParams,
                                       AuthenticationQueryParams queryParams)

changePassword

public void changePassword(AuthenticationQueryParams queryParams,
                           AuthenticationFieldParams fieldParams,
                           ListenerModel<BaseModel<java.lang.Object>,java.lang.Object> listener)

Reset a Password

Parameters:

queryParams - AuthenticationQueryParams

fieldParams - AuthenticationFieldParams

listener - callback when change password is successful or not

updateProfile

public void updateProfile(AuthenticationQueryParams queryParams,
                          AuthenticationFieldParams fieldParams,
                          Listener<SuccessResponse> listener)

Update profile details

Parameters:

queryParams - AuthenticationQueryParams

fieldParams - AuthenticationFieldParams

listener - listener if profile is successfully updated or not

resendEmailConfirmation

public void resendEmailConfirmation(AuthenticationFieldParams fieldParams,
                                    ListenerModel<BaseModel<Message>,Message> listener)

Resend the Email Confirmation

Parameters:

fieldParams - AuthenticationFieldParams

listener - callback when resend email is successful or not

revokeAccessToken

public void revokeAccessToken(AuthenticationFieldParams fieldParams,
                              AuthenticationQueryParams queryParams,
                              Listener<SuccessResponse> listener)

Revoke an access token

Parameters:

fieldParams - AuthenticationFieldParams

queryParams - AuthenticationQueryParams

listener - callback when revoke access token is successful or not

requestPasswordReset

public void requestPasswordReset(AuthenticationFieldParams fieldParams,
                                 ListenerModel<BaseModel<Message>,Message> listener)

Request password reset. Remember to set the AuthenticationFieldParams.setClientId(String) and AuthenticationFieldParams.setClientSecret(String) and provide one of the following: AuthenticationFieldParams.setEmail(String), AuthenticationFieldParams.setEmailAlias(String) (String)}, AuthenticationFieldParams.setCardId(String) (String)},

Parameters:

fieldParams - AuthenticationFieldParams

listener - callback when revoke access token is successful or not

resetPassword

public void resetPassword(AuthenticationFieldParams fieldParams,
                          Listener<SuccessResponse> listener)

Reset password via secure token. Remember to set the following:

• AuthenticationFieldParams.setClientId(String)
• AuthenticationFieldParams.setClientSecret(String) (String)}
• AuthenticationFieldParams.setResetPasswordToken(String) (String)}
• AuthenticationFieldParams.setPassword(String) (String)}
• AuthenticationFieldParams.setPasswordConfirmation(String) (String)}

Parameters:

fieldParams - AuthenticationFieldParams

listener - callback when revoke access token is successful or not