com.here.mobility.sdk.core

Class MobilitySdk

java.lang.Object

com.here.mobility.sdk.core.MobilitySdk

public class MobilitySdk
extends Object

The non-static entrance class for Here's Mobility SDK.

Method Summary

Modifier and Type	Method and Description
ResponseFuture<Void>	authenticateApplication(ApplicationAuthInfo authInfo) Authenticates the application.
ResponseFuture<Boolean>	forceLogsUpload() Uploading now the SDK's logs.
String	getApiKey() Returns the developer's API key.
static MobilitySdk	getInstance() The singleton getInstance method.
String	getLoggingId() Returns a logging id.
UserPreferences	getUserPreferences() Returns the user preferences.
String	getVersionName() Returns the SDK version name.
static void	init(Application app) Call this method from your app's Application.onCreate() method to initialize the SDK.
static void	init(Application app, String apiKey) Call this method from your app's Application.onCreate() method to initialize the SDK
boolean	isHereAgentProcess() Returns whether the current process is the SDK agent process.
static boolean	isInitialized() Checks if the MobilitySdk was initialized
boolean	isUserVerified() Is the current user is verified and eligible for operations that requires high level of verification, such as booking a ride.
ResponseFuture<Void>	sendVerificationEmail(String email) Send verification Email to the given email, that contains a pin code.
ResponseFuture<Void>	sendVerificationSms(String phone) Send verification SMS to the given phone number, that contains a pin code.
void	setUserPreferences(UserPreferences userPreferences) Sets the SDK user preferences.
void	userLogout() Logs out the current verified user.
ResponseFuture<Void>	verifyUserEmail(String email, String pinCode) Verifies the given email.
ResponseFuture<Void>	verifyUserPhoneNumber(String phoneNumber, String pinCode) Verifies the given phone number.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MobilitySdk getInstance()

The singleton getInstance method.

Throws:

HereSdkInitializationException - if called before calling MobilitySdk.init(android.app.Application)

init

public static void init(Application app)

Call this method from your app's Application.onCreate() method to initialize the SDK.

init

public static void init(Application app,
                        String apiKey)

Call this method from your app's Application.onCreate() method to initialize the SDK

Parameters:

app - the application instance

apiKey - api key to use. Will override the key in the manifest, if exists

isHereAgentProcess

public boolean isHereAgentProcess()

Returns whether the current process is the SDK agent process.

getVersionName

public String getVersionName()

Returns the SDK version name.

Returns:

sdk version name

getLoggingId

public String getLoggingId()

Returns a logging id. This id can be used to query Here Mobility SDK logs.

Returns:

logging id

authenticateApplication

public ResponseFuture<Void> authenticateApplication(ApplicationAuthInfo authInfo)

Authenticates the application. Call this before any demand or map operation of the SDK, to ensure your app is authorized. Note that for some SDK feature, an additional phone or email verification is needed

Parameters:

authInfo - the auth info.

Returns:

ResponseFuture that returns nothing in case of success, and contains the error in case of failure. This request can throw the following exceptions: HMAuthInternalException HMAuthException

sendVerificationSms

public ResponseFuture<Void> sendVerificationSms(String phone)

Send verification SMS to the given phone number, that contains a pin code. Call MobilitySdk.verifyUserPhoneNumber(String, String) with the given phone number and the pin code to verify the phone number, and allow access to the demand marketplace. This call will invalidate the previous validation (of either phone numebr or email).

Parameters:

phone - the phone number of the device. Should be in E.164 format

Returns:

ResponseFuture that return nothing in case the SMS was sent successfully. This request can throw the following exceptions: HMAuthInvalidArgumentsException in case of invalid phone number format HMAuthInternalException HMAuthException

sendVerificationEmail

public ResponseFuture<Void> sendVerificationEmail(String email)

Send verification Email to the given email, that contains a pin code. Call MobilitySdk.verifyUserEmail(String, String) with the given email and the pin code to verify the email, and allow access to the demand marketplace. This call will invalidate the previous validation (of either phone numebr or email).

Parameters:

email - the email of the user.

Returns:

ResponseFuture that return nothing in case the email was sent successfully. This request can throw the following exceptions: HMAuthInvalidArgumentsException in case of invalid email format HMAuthInternalException HMAuthException

verifyUserPhoneNumber

public ResponseFuture<Void> verifyUserPhoneNumber(String phoneNumber,
                                                  String pinCode)

Verifies the given phone number. Must be called before calling operations that requires high level of verification, such as booking a ride. Use this function after calling MobilitySdk.sendVerificationSms(String) and pass the pin code received by the SMS message. NOTE: MobilitySdk.authenticateApplication(ApplicationAuthInfo) must be called before calling this method.

Parameters:

phoneNumber - the phone number of the device. Should be in E.164 format

pinCode - the pin code that was received by SMS

Returns:

ResponseFuture that holds exception in case of failure, and return nothing in case the user was verified successfully. This request can throw the following exceptions: HMAuthInternalException HMAuthException

verifyUserEmail

public ResponseFuture<Void> verifyUserEmail(String email,
                                            String pinCode)

Verifies the given email. Must be called before calling operations that requires high level of verification, such as booking a ride. Use this function after calling MobilitySdk.sendVerificationEmail(String) and pass the pin code received by the email message. NOTE: MobilitySdk.authenticateApplication(ApplicationAuthInfo) must be called before calling this method.

Parameters:

email - the email of the user.

pinCode - the pin code that was received by email

Returns:

ResponseFuture that holds exception in case of failure, and return nothing in case the user was verified successfully. This request can throw the following exceptions: HMAuthInternalException HMAuthException

isUserVerified

public boolean isUserVerified()

Is the current user is verified and eligible for operations that requires high level of verification, such as booking a ride. The user is verified by calling MobilitySdk.verifyUserPhoneNumber(String, String)

Returns:

is the current user verified

userLogout

public void userLogout()

Logs out the current verified user. This call logs out the user that was previously verified by MobilitySdk.verifyUserPhoneNumber(String, String) or MobilitySdk.verifyUserEmail(String, String)

isInitialized

public static boolean isInitialized()

Checks if the MobilitySdk was initialized

Returns:

true if the MobilitySdk was initialized

getApiKey

public String getApiKey()

Returns the developer's API key.

getUserPreferences

public UserPreferences getUserPreferences()

Returns the user preferences.

setUserPreferences

public void setUserPreferences(UserPreferences userPreferences)

Sets the SDK user preferences. NOTE: The user preferences are not persisted to storage.

forceLogsUpload

public ResponseFuture<Boolean> forceLogsUpload()

Uploading now the SDK's logs.

Returns:

true if the logs uploaded successfully.