Skip navigation links
A B C D E F G H I L M N O P R S T U V W Z 

A

acceptInviteByCode(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Returns a CompleteCallback after accepting an invitation for an IoT device for a user account.
AccountManager - Class in com.microstrategy.ushersdk
The AccountManager class collects all of the APIs related to account management.
AccountManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.AccountManager
Constructor for an AccountManager object with the lifecycle set.
AccountManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.AccountManager
Constructor for an AccountManager object with the lifecycle set.
AccountManager(Fragment) - Constructor for class com.microstrategy.ushersdk.AccountManager
Constructor for an AccountManager object with the lifecycle set.
AccountParam - Class in com.microstrategy.ushersdk
The AccountParam abstract class wraps key properties related to the user account.
AccountParam.Builder - Class in com.microstrategy.ushersdk
The AccountParam.Builder abstract class allows the user to create and return an AccountParam object.
AccountPolicyEntity - Class in com.microstrategy.ushersdk
The AccountPolicyEntity abstract class wraps various properties related to the password, verification, and OTP requirements for a user account.
AccountPolicyEntity() - Constructor for class com.microstrategy.ushersdk.AccountPolicyEntity
 
AccountPolicyEntity.Builder - Class in com.microstrategy.ushersdk
 
addIotDevice(IotParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.IotManager
Returns a CompleteCallback after adding an IoT device to a user account.
allAllowCharacterCheck() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not password is required to use allowed characters only, including [0-9a-zA-Z] and special characters allowed.
allAllowCharacterCheck(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
allowSpecialCharacter() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a String of the symbols/special characters allowed in the password.
allowSpecialCharacter(String) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
appCode() - Method in class com.microstrategy.ushersdk.AppCodeEntity
Returns a String of the app code set by the user.
appCodeConfigMap() - Method in class com.microstrategy.ushersdk.AccountPolicyEntity
Returns a Map of the app code configurations.
appCodeConfigMap(Map<String, Object>) - Method in class com.microstrategy.ushersdk.AccountPolicyEntity.Builder
AppCodeEntity - Class in com.microstrategy.ushersdk
The AppCodeEntity abstract class wraps various properties related to the app code.
AppCodeEntity() - Constructor for class com.microstrategy.ushersdk.AppCodeEntity
 
appCodeEntity() - Method in class com.microstrategy.ushersdk.UserSettingsEntity
Returns the AppCodeEntity object, which wraps various properties related to the app code.
appId(String) - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder
application(Application) - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder

B

build() - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Builds the AccountParam object that is used to wrap key properties related to the user account.
build() - Method in class com.microstrategy.ushersdk.AccountPolicyEntity.Builder
Builds the AccountPolicyEntity object that is used to wrap various properties related to the password, verification, and OTP requirements for a user account.
build() - Method in class com.microstrategy.ushersdk.ChangePasswordParam.Builder
Builds the ChangePasswordParam object that is used to wrap various properties related to changing the user account password.
build() - Method in class com.microstrategy.ushersdk.IotParam.Builder
Builds the IotParam object that is used to wrap various properties related to the parameter surrounding addition of a new IoT device to a user account.
build() - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Builds the MessageEntity object that is used to wrap various properties related to messages.
build() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
Builds the MessageEntity.Participant object that is used to wrap various properties related to the sender and receiver of the message.
build() - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Builds the MessageQueryParam object that is used to wrap key properties related to message queries.
build() - Method in class com.microstrategy.ushersdk.OtpRequestParam.Builder
 
build() - Method in class com.microstrategy.ushersdk.OtpVerifyParam.Builder
 
build() - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Builds the OwnerEntity object that is used to wrap various properties related to a driver.
build() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
build() - Method in class com.microstrategy.ushersdk.ResetPasswordParam.Builder
Builds the ResetPasswordParam object that is used to wrap various properties related to the user account password reset.
build() - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Builds the SendInviteParam object that is used to wrap various properties related to the parameter surrounding an invitation for a user account to access an IoT device.
build() - Method in class com.microstrategy.ushersdk.ServerResponseData.Builder
 
build() - Method in class com.microstrategy.ushersdk.SignInParam.Builder
Builds the SignInParam object that is used to wrap various properties related to changing the user account password.
build() - Method in class com.microstrategy.ushersdk.SignUpAndSignInParam.Builder
Builds the SignUpAndSignInParam object that is used to wrap various properties related to the parameter surrounding user account registration.
build() - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Builds the SignUpParam object that is used to wrap various properties related to the parameter surrounding user account registration.
build() - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder
Builds the UsherSdk.Configuration object that is used to initialize the UsherSdk object.
builder() - Static method in class com.microstrategy.ushersdk.AccountParam
Returns the AccountParam.Builder object for the AccountParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.AccountPolicyEntity
The AccountPolicyEntity.Builder abstract class allows the user to create and return a AccountPolicyEntity object.
builder() - Static method in class com.microstrategy.ushersdk.AppCodeEntity
Returns the Builder object for the AppCodeEntity abstract class.
builder() - Static method in class com.microstrategy.ushersdk.ChangePasswordParam
 
Builder() - Constructor for class com.microstrategy.ushersdk.ChangePasswordParam.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns the Builder object for the IotDeviceEntity abstract class.
builder() - Static method in class com.microstrategy.ushersdk.IotParam
Returns the IotParam.Builder object for the IotParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.MessageEntity
Returns the MessageEntity.Builder object for the MessageEntity abstract class.
builder() - Static method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns the MessageEntity.Participant.Builder object for the MessageEntity.Participant abstract class.
builder() - Static method in class com.microstrategy.ushersdk.MessageQueryParam
Returns the MessageQueryParam.Builder object for the MessageQueryParam abstract class.
Builder() - Constructor for class com.microstrategy.ushersdk.MessageQueryParam.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.OtpRequestParam
 
Builder() - Constructor for class com.microstrategy.ushersdk.OtpRequestParam.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.OtpVerifyParam
 
Builder() - Constructor for class com.microstrategy.ushersdk.OtpVerifyParam.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.OwnerEntity
Returns the OwnerEntity.Builder object for the OwnerEntity abstract class.
builder() - Static method in class com.microstrategy.ushersdk.PasswordPolicyEntity
 
Builder() - Constructor for class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.ResetPasswordParam
Returns the ResetPasswordParam.Builder object for the ResetPasswordParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.SendInviteParam
Returns the SendInviteParam.Builder object for the SendInviteParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.ServerResponseData
 
Builder() - Constructor for class com.microstrategy.ushersdk.ServerResponseData.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.SignInParam
 
Builder() - Constructor for class com.microstrategy.ushersdk.SignInParam.Builder
 
builder() - Static method in class com.microstrategy.ushersdk.SignUpAndSignInParam
Returns the SignUpAndSignInParam.Builder object for the SignUpAndSignInParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.SignUpParam
Returns the SignUpParam.Builder object for the SignUpParam abstract class.
builder() - Static method in class com.microstrategy.ushersdk.UserEntity
Returns the Builder object for the UserEntity abstract class.
builder() - Static method in class com.microstrategy.ushersdk.UserSettingsEntity
Returns the UserSettingsEntity.Builder object for the UserSettingsEntity abstract class.
builder(Application) - Static method in class com.microstrategy.ushersdk.UsherSdk.Configuration
Returns the UsherSdk.Configuration.Builder object for the UsherSdk.Configuration abstract class.
bypassClientCheck(boolean) - Method in class com.microstrategy.ushersdk.ChangePasswordParam.Builder
bypassClientCheck(boolean) - Method in class com.microstrategy.ushersdk.ResetPasswordParam.Builder
bypassClientCheck(boolean) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.bypassClientCheck() component of the SignUpParam object.
bypassClientCheck() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a boolean of whether to bypass client check for password.

C

changePassword(ChangePasswordParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.PasswordManager
Returns a CompleteCallback after changing the password for a user account.
ChangePasswordParam - Class in com.microstrategy.ushersdk
The ChangePasswordParam abstract class wraps various properties related to the user account changing password.
ChangePasswordParam() - Constructor for class com.microstrategy.ushersdk.ChangePasswordParam
 
ChangePasswordParam.Builder - Class in com.microstrategy.ushersdk
 
changeServerUrl(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.ServerManager
Returns a CompleteCallback after changing server
checkExistence(String, SingleCallback<Boolean>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not a user account exists in the system.
checkExistenceAndGetPhoneNumber(String, SingleCallback<String>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a String that represents a user's masked phone number in the system.
city(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.city() component of the AccountParam object.
city() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's city.
city(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.city() component of the SignUpParam object.
city() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's city of residence.
city() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's city of residence.
code(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.code() component of the MessageEntity object.
code() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a String of the message code.
code(String) - Method in class com.microstrategy.ushersdk.OtpVerifyParam.Builder
Returns the OtpVerifyParam.Builder for the OtpVerifyParam.code() component of the OtpVerifyParam object.
code() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the verification code.
codeExpiredTs(long) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.codeExpiredTs() component of the MessageEntity object.
codeExpiredTs() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a long of the time in seconds at which the code expires.
codeExpiredTs() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the time in seconds at which the code expires.
com.microstrategy.ushersdk - package com.microstrategy.ushersdk
 
CompleteCallback - Interface in com.microstrategy.ushersdk
The CompleteCallback interface represents an asynchronous callback without any value.
ConnectedIotDeviceManager - Class in com.microstrategy.ushersdk
The ConnectedIotDeviceManager class collects all of the APIs related to connected IoT device management.
ConnectedIotDeviceManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Constructor for a ConnectedIotDeviceManager object with the lifecycle set.
ConnectedIotDeviceManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Constructor for a ConnectedIotDeviceManager object with the lifecycle set.
ConnectedIotDeviceManager(Fragment) - Constructor for class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Constructor for a ConnectedIotDeviceManager object with the lifecycle set.
content(Map<String, String>) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.content() component of the MessageEntity object.
content() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns the content of the message.
content(Map<String, String>) - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Returns the SendInviteParam.Builder for the SendInviteParam.content() component of the SendInviteParam object.
content() - Method in class com.microstrategy.ushersdk.SendInviteParam
Returns a Map of the content.
country(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.country() component of the AccountParam object.
country() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's country.
country(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.country() component of the SignUpParam object.
country() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's country of residence.
country() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's country of residence.
createdTs(long) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.createdTs() component of the MessageEntity object.
createdTs() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a long of the time in seconds at which the message was created.
createdTs() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the time in seconds at which the request was created.

D

deleteAccount(CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after deleting an account.
deleteIotDevice(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.IotManager
Returns a CompleteCallback after deleting an IoT device from a user account.
disableBiometricsSignIn(CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after disabling biometrics log in for a user account.

E

email(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.email() component of the AccountParam object.
email() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's email address.
email(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.email() component of the OwnerEntity object.
email() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the email address of the driver.
email(String) - Method in class com.microstrategy.ushersdk.ResetPasswordParam.Builder
Returns the ResetPasswordParam.Builder for the ResetPasswordParam.email() component of the ResetPasswordParam object.
email(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.email() component of the SignUpParam object.
email() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's email address.
email() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's email address.
emailVerified() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a boolean that represents whether or not the user's email address has been verified.
enableBiometricsSignIn(ObservableCallback<FingerprintVerificationResult>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a FingerprintVerificationResult object after enabling biometric login for a user account.
enabled() - Method in class com.microstrategy.ushersdk.AppCodeEntity
Returns a boolean that represents whether or not the app code is enabled by the user.
enableTrustOnFirstUse(boolean) - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder
When certificate pinning is enforced, the connection between the SDK and server will work on the trust-on-first-use (TOFU) model.
errorCode() - Method in class com.microstrategy.ushersdk.FingerprintVerificationResult
Returns a Integer error code if the verification fails.
errorMessage() - Method in class com.microstrategy.ushersdk.FingerprintVerificationResult
Returns a String of error message if the verification fails.
EXPIRED_REFRESH_TOKEN - Static variable in exception com.microstrategy.ushersdk.UsherException
10010, Expired refresh token.
expiredTs(long) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.expiredTs() component of the MessageEntity object.
expiredTs() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a long of the time in seconds at which the message was expired.
export(SingleCallback<String>) - Method in class com.microstrategy.ushersdk.LogManager
Returns a String of the absolute filepath to the JSON file, which contains the HTTP request history for the past 7 days.
extra(JsonElement) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
 
extra() - Method in class com.microstrategy.ushersdk.AccountParam
Returns the JsonObject that contains the extra information.
extra(JsonElement) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.extra() component of the SignUpParam object.
extra() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns the JsonObject that contains the extra information.
extra() - Method in class com.microstrategy.ushersdk.UserEntity
Returns the Map that contains the extra information.

F

fetch(SingleCallback<UserEntity>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a UserEntity object, which contains properties related to the user account that is currently logged in.
fetchToken(SingleCallback<String>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a String of the access token after requesting a new access token to authenticate with the server.
FINGERPRINT_NOT_SUPPORTED - Static variable in exception com.microstrategy.ushersdk.UsherException
10014, Fingerprint authentication not supported on device.
FINGERPRINT_SIGN_IN_NOT_ENABLED - Static variable in exception com.microstrategy.ushersdk.UsherException
10016, Fingerprint login not enabled.
FINGERPRINT_VERIFICATION_FAILED - Static variable in exception com.microstrategy.ushersdk.UsherException
10015, Fingerprint verification failure.
FingerprintVerificationResult - Class in com.microstrategy.ushersdk
 
FingerprintVerificationResult() - Constructor for class com.microstrategy.ushersdk.FingerprintVerificationResult
 
FingerprintVerificationResult.Status - Enum in com.microstrategy.ushersdk
The FingerprintVerificationResult.Status enum wraps three results for verifying fingerprints.
firstName(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.firstName() component of the AccountParam object.
firstName() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's first name.
firstName(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.firstName() component of the SignUpParam object.
firstName() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's first name.
firstName() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's first name.
forgotPassword(String, RecipientType, CompleteCallback) - Method in class com.microstrategy.ushersdk.PasswordManager
Returns a CompleteCallback after requesting a one-time password (OTP) to reset a password for a user account.

G

get(SingleCallback<UserEntity>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a UserEntity object, which contains properties related to the user account that is currently logged in.
get() - Static method in class com.microstrategy.ushersdk.UsherSdk
Returns the UsherSdk object.
getAccountPolicyEntity(SingleCallback<AccountPolicyEntity>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns an AccountPolicyEntity object.
getAppCodeSettings(SingleCallback<AppCodeEntity>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns an AppCodeEntity object for the account that is currently logged in.
getCode() - Method in exception com.microstrategy.ushersdk.UsherException
Returns an int of the exception code.
getLocale() - Method in class com.microstrategy.ushersdk.UsherSdk
Returns the Locale of the app.
getMessages(MessageQueryParam, SingleCallback<List<MessageEntity>>) - Method in class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Returns a List of MessageEntity objects, which contains the message and other properties related to them.
getPasswordPolicy(SingleCallback<PasswordPolicyEntity>) - Method in class com.microstrategy.ushersdk.PasswordManager
Returns a system level PasswordPolicyEntity object, which contains properties related to password requirements.
getServerResponseData() - Method in exception com.microstrategy.ushersdk.UsherException
 
getServerUrl() - Method in class com.microstrategy.ushersdk.ServerManager
Returns a String that represents the server url the SDK is currently connected to
getToken() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a String of the access token that is being used to authenticate with the server.

H

hasUser() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not a user has ever signed in, regardless of the current authentication status.
httpCode(int) - Method in class com.microstrategy.ushersdk.ServerResponseData.Builder
 
httpCode() - Method in class com.microstrategy.ushersdk.ServerResponseData
 

I

IDENTITY_NOT_VERIFIED - Static variable in exception com.microstrategy.ushersdk.UsherException
10030, Identity not verified.
init(UsherSdk.Configuration) - Static method in class com.microstrategy.ushersdk.UsherSdk
Initializes the UsherSdk object with the provided UsherSdk.Configuration.
init(Application, String, String) - Static method in class com.microstrategy.ushersdk.UsherSdk
Initializes the UsherSdk object with an application, server URL, and application ID.
INTERNAL_SERVER_ERROR - Static variable in exception com.microstrategy.ushersdk.UsherException
10012, Internal server error.
INVALID_ACCESS_TOKEN - Static variable in exception com.microstrategy.ushersdk.UsherException
10011, Invalid access token.
INVALID_CREDENTIAL - Static variable in exception com.microstrategy.ushersdk.UsherException
10001, Invalid login credentials.
INVALID_INPUT - Static variable in exception com.microstrategy.ushersdk.UsherException
10002, Invalid input.
INVALID_INPUT_PARAMETER - Static variable in exception com.microstrategy.ushersdk.UsherException
10034, Invalid input parameter
INVALID_SERVER_URL - Static variable in exception com.microstrategy.ushersdk.UsherException
10033, Invalid server url
IotDeviceEntity - Class in com.microstrategy.ushersdk
The IotDeviceEntity abstract class wraps various properties related to an IoT device.
IotDeviceEntity.Status - Enum in com.microstrategy.ushersdk
Enumerations of IotDeviceEntity.Status.
IotDeviceEntity.UserRole - Enum in com.microstrategy.ushersdk
Enumerations of IotDeviceEntity.UserRole.
iotId() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a String of the identification number of the IoT device.
iotId(String) - Method in class com.microstrategy.ushersdk.IotParam.Builder
Returns the IotParam.Builder for the IotParam.iotId() component of the IotParam object.
iotId() - Method in class com.microstrategy.ushersdk.IotParam
Returns a String of the identification number of the IoT device.
iotId(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.iotId() component of the MessageEntity object.
iotId() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a String of the identification number of the IoT device.
iotId(String) - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Returns the MessageQueryParam.Builder for the MessageQueryParam.iotId() component of the MessageQueryParam object.
iotId() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the identification number of the IoT device for the request.
iotId(String) - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Returns the SendInviteParam.Builder for the SendInviteParam.iotId() component of the SendInviteParam object.
iotId() - Method in class com.microstrategy.ushersdk.SendInviteParam
Returns a String of the identification number of the IoT device.
IotManager - Class in com.microstrategy.ushersdk
The IotManager class collects all of the APIs related to IoT device management.
IotManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.IotManager
Constructor for an IotManager object with the lifecycle set.
IotManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.IotManager
Constructor for an IotManager object with the lifecycle set.
IotManager(Fragment) - Constructor for class com.microstrategy.ushersdk.IotManager
Constructor for an IotManager object with the lifecycle set.
iotName(String) - Method in class com.microstrategy.ushersdk.IotParam.Builder
Returns the IotParam.Builder for the IotParam.iotName() component of the IotParam object.
iotName() - Method in class com.microstrategy.ushersdk.IotParam
Returns a String of the name of the IoT device.
IotParam - Class in com.microstrategy.ushersdk
The IotParam abstract class wraps various properties related to the parameter surrounding addition of a new IoT device to a user account.
IotParam.Builder - Class in com.microstrategy.ushersdk
The IotParam.Builder abstract class allows the user to create and return an IotParam object.
iotType(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.iotType() component of the MessageEntity object.
iotType() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a String of the type of IoT device.
iotType(String) - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Returns the MessageQueryParam.Builder for the MessageQueryParam.iotType() component of the MessageQueryParam object.
iotType() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the type of IoT device.
iotType(String) - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Returns the SendInviteParam.Builder for the SendInviteParam.iotType() component of the SendInviteParam object.
iotType() - Method in class com.microstrategy.ushersdk.SendInviteParam
Returns a String of the IoT device type.
isAuthenticated() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not the user account is currently signed in and authenticated.
isBiometricsSignInEnabled() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not the user account has the option of signing in via biometrics.
isBiometricsSignInEnabledBefore() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not the user account has enabled signing in via biometrics before.
isDebugLogMode() - Method in class com.microstrategy.ushersdk.UsherSdk
Returns the log mode of the app.
isExpired(boolean) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.isExpired() component of the MessageEntity object.
isExpired() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a boolean to indicate whether the message is expired or not.
isLoggedInWithTemporaryPassword(SingleCallback<Boolean>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not a user is logged in with a temporary password.
isStaySignedInEnabled() - Method in class com.microstrategy.ushersdk.AccountManager
Returns a boolean that represents whether or not the user account has the option of staying signed in between different openings of the app.

L

lastName(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.lastName() component of the AccountParam object.
lastName() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's last name.
lastName(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.lastName() component of the SignUpParam object.
lastName() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's last name.
lastName() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's last name.
listIotDevices(SingleCallback<List<IotDeviceEntity>>) - Method in class com.microstrategy.ushersdk.IotManager
Returns the List of IotDeviceEntity objects for a user account.
listSecondaryDriverByIotId(String, SingleCallback<List<OwnerEntity>>) - Method in class com.microstrategy.ushersdk.IotManager
Returns the List of secondary OwnerEntity objects for a IoT device.
localizedMessage(String) - Method in class com.microstrategy.ushersdk.ServerResponseData.Builder
 
localizedMessage() - Method in class com.microstrategy.ushersdk.ServerResponseData
 
LogManager - Class in com.microstrategy.ushersdk
The LogManager class provides access to all HTTP requests sent from the SDK.
LogManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.LogManager
Constructor for an LogManager object with the lifecycle set.
LogManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.LogManager
Constructor for an LogManager object with the lifecycle set.
LogManager(Fragment) - Constructor for class com.microstrategy.ushersdk.LogManager
Constructor for an LogManager object with the lifecycle set.

M

maximumPasswordLength(int) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
maximumPasswordLength() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns an int of the maximum password length allowed.
maxPasswordHistory(int) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
maxPasswordHistory() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns an int of the number of most recent passwords that cannot currently be reused.
message() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the the message content of the request.
MessageEntity - Class in com.microstrategy.ushersdk
The MessageEntity abstract class wraps various properties related to messages.
MessageEntity() - Constructor for class com.microstrategy.ushersdk.MessageEntity
 
MessageEntity.Builder - Class in com.microstrategy.ushersdk
 
MessageEntity.Participant - Class in com.microstrategy.ushersdk
The MessageEntity.Participant abstract class wraps various properties related to the sender and receiver of the message.
MessageEntity.Participant.Builder - Class in com.microstrategy.ushersdk
The MessageEntity.Participant.Builder abstract class allows the user to create and return an MessageEntity.Participant object.
MessageEntity.Purpose - Enum in com.microstrategy.ushersdk
Enumerations of MessageEntity.Purpose.
MessageEntity.Status - Enum in com.microstrategy.ushersdk
Enumerations of MessageEntity.Status.
MessageEntity.Type - Enum in com.microstrategy.ushersdk
Enumerations of MessageEntity.Type.
messageId(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.messageId() component of the MessageEntity object.
messageId() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a String of the identification number of the message.
messageId() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns an int of identification number of the message.
MessageQueryParam - Class in com.microstrategy.ushersdk
The MessageQueryParam abstract class wraps key properties related to messages queries.
MessageQueryParam() - Constructor for class com.microstrategy.ushersdk.MessageQueryParam
 
MessageQueryParam.Builder - Class in com.microstrategy.ushersdk
 
minimumPasswordLength(int) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
minimumPasswordLength() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns an int of the minimum password length allowed.
mobile(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.mobile() component of the SignUpParam object.
mobile() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's mobile phone number, including country code.
mobile() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's mobile phone number.
mobileVerified() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a boolean that represents whether or not the user's mobile phone number has been verified.

N

name(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.name() component of the OwnerEntity object.
name() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the first and last name of the driver.
NEED_TO_ENROLL_FINGERPRINT - Static variable in exception com.microstrategy.ushersdk.UsherException
10013, Fingerprint enrollment required.
NETWORK_INVALID_CERTIFICATE - Static variable in exception com.microstrategy.ushersdk.UsherException
10008, Invalid certificate for network.
NETWORK_OFFLINE - Static variable in exception com.microstrategy.ushersdk.UsherException
10006, Network offline.
NETWORK_OTHER_ERROR - Static variable in exception com.microstrategy.ushersdk.UsherException
10009, Other network error.
NETWORK_TIMEOUT - Static variable in exception com.microstrategy.ushersdk.UsherException
10007, Network timeout.
networkConnectionTimeout(int) - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder
NEW_PASSWORD_TOO_RECENT - Static variable in exception com.microstrategy.ushersdk.UsherException
10027, New password cannot be used because it was used too recently.
newPassword(List<Character>) - Method in class com.microstrategy.ushersdk.ChangePasswordParam.Builder
nickName() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a String of the name of the IoT device.

O

ObservableCallback<T> - Interface in com.microstrategy.ushersdk
The ObservableCallback abstract class represents an asynchronous callback returning multiple values.
OLD_PASSWORD_INCORRECT - Static variable in exception com.microstrategy.ushersdk.UsherException
10026, Incorrect old password.
oldPassword(List<Character>) - Method in class com.microstrategy.ushersdk.ChangePasswordParam.Builder
onComplete() - Method in interface com.microstrategy.ushersdk.CompleteCallback
Callback for when the request is successfully executed.
onError(UsherException) - Method in interface com.microstrategy.ushersdk.CompleteCallback
Callback for when the request encounters an error.
onError(UsherException) - Method in interface com.microstrategy.ushersdk.ObservableCallback
Callback for when the request encounters an error.
onError(UsherException) - Method in interface com.microstrategy.ushersdk.SingleCallback
Callback for when the request encounters an error.
onNext(T) - Method in interface com.microstrategy.ushersdk.ObservableCallback
Callback for when the request is successfully executed.
onSuccess(T) - Method in interface com.microstrategy.ushersdk.SingleCallback
Callback for when the request is successfully executed.
otpConfigMap(Map<String, Object>) - Method in class com.microstrategy.ushersdk.AccountPolicyEntity.Builder
otpConfigMap() - Method in class com.microstrategy.ushersdk.AccountPolicyEntity
Returns a Map of the OTP configurations.
OtpManager - Class in com.microstrategy.ushersdk
The OtpManager class collects all of the APIs related to one-time passwords (OTP).
OtpManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.OtpManager
Constructor for an OtpManager object with the lifecycle set.
OtpManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.OtpManager
Constructor for an OtpManager object with the lifecycle set.
OtpManager(Fragment) - Constructor for class com.microstrategy.ushersdk.OtpManager
Constructor for an OtpManager object with the lifecycle set.
OtpPurpose - Enum in com.microstrategy.ushersdk
Enumerations of the one-time password (OTP) purposes.
otpPurpose(OtpPurpose) - Method in class com.microstrategy.ushersdk.OtpRequestParam.Builder
Returns the OtpRequestParam.Builder for the OtpRequestParam.otpPurpose() component of the OtpRequestParam object.
otpPurpose(OtpPurpose) - Method in class com.microstrategy.ushersdk.OtpVerifyParam.Builder
Returns the OtpVerifyParam.Builder for the OtpVerifyParam.otpPurpose() component of the OtpVerifyParam object.
OtpRequestParam - Class in com.microstrategy.ushersdk
The OtpRequestParam class provides an entry point to build params to request an OTP.
OtpRequestParam() - Constructor for class com.microstrategy.ushersdk.OtpRequestParam
 
OtpRequestParam.Builder - Class in com.microstrategy.ushersdk
 
OtpVerifyParam - Class in com.microstrategy.ushersdk
The OtpVerifyParam class provides an entry point to build params to verify an OTP.
OtpVerifyParam() - Constructor for class com.microstrategy.ushersdk.OtpVerifyParam
 
OtpVerifyParam.Builder - Class in com.microstrategy.ushersdk
 
OwnerEntity - Class in com.microstrategy.ushersdk
The OwnerEntity abstract class wraps various properties related to a driver.
OwnerEntity.Builder - Class in com.microstrategy.ushersdk
The OwnerEntity.Builder abstract class allows the user to create and return a OwnerEntity object.

P

participant(MessageEntity.Participant) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.participant() component of the MessageEntity object.
participant() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns the MessageEntity.Participant of the message.
partner2Id() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a String of the identification number of the secondary driver.
partner2Id(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.partner2Id() component of the OwnerEntity object.
partner2Id() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the identification number of the secondary driver.
password(List<Character>) - Method in class com.microstrategy.ushersdk.ResetPasswordParam.Builder
password(List<Character>) - Method in class com.microstrategy.ushersdk.SignInParam.Builder
Returns the SignInParam.Builder for the SignInParam.password() component of the SignInParam object.
password(List<Character>) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.password() component of the SignUpParam object.
password() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a ImmutableList of the user's password.
PASSWORD_EMPTY - Static variable in exception com.microstrategy.ushersdk.UsherException
10017, Password empty.
PASSWORD_INVALID_SYMBOL - Static variable in exception com.microstrategy.ushersdk.UsherException
10024, Invalid symbol in password.
PASSWORD_NO_ALPHA_BETIC - Static variable in exception com.microstrategy.ushersdk.UsherException
10025, No alphabetic character in password.
PASSWORD_NO_LOWERCASE - Static variable in exception com.microstrategy.ushersdk.UsherException
10020, No lowercase character in password.
PASSWORD_NO_NUMBER - Static variable in exception com.microstrategy.ushersdk.UsherException
10022, No number in password.
PASSWORD_NO_REQUIRED_SYMBOL - Static variable in exception com.microstrategy.ushersdk.UsherException
10023, No symbol in password.
PASSWORD_NO_UPPERCASE - Static variable in exception com.microstrategy.ushersdk.UsherException
10021, No uppercase character in password.
PASSWORD_POLICY_FAIL - Static variable in exception com.microstrategy.ushersdk.UsherException
10031, Password policy not met.
PASSWORD_TOO_LONG - Static variable in exception com.microstrategy.ushersdk.UsherException
10019, Password too long.
PASSWORD_TOO_SHORT - Static variable in exception com.microstrategy.ushersdk.UsherException
10018, Password too short.
PasswordManager - Class in com.microstrategy.ushersdk
The PasswordManager class collects all of the APIs related to password management and validation.
PasswordManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.PasswordManager
Constructor for a PasswordManager object with the lifecycle set.
PasswordManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.PasswordManager
Constructor for a PasswordManager object with the lifecycle set.
PasswordManager(Fragment) - Constructor for class com.microstrategy.ushersdk.PasswordManager
Constructor for a PasswordManager object with the lifecycle set.
passwordPolicyEntity(PasswordPolicyEntity) - Method in class com.microstrategy.ushersdk.AccountPolicyEntity.Builder
passwordPolicyEntity() - Method in class com.microstrategy.ushersdk.AccountPolicyEntity
Returns a PasswordPolicyEntity object, which wraps various properties related to the password requirements for a user account.
PasswordPolicyEntity - Class in com.microstrategy.ushersdk
The PasswordPolicyEntity abstract class wraps various properties related to the password requirements for a user account.
PasswordPolicyEntity.Builder - Class in com.microstrategy.ushersdk
 
phone(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.phone() component of the OwnerEntity object.
phone() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the mobile phone number of the driver.
primaryDriverEntity() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a OwnerEntity object, which wraps properties related to the driver of the IoT device, for the primary driver.
purpose(MessageEntity.Purpose) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.purpose() component of the MessageEntity object.
purpose() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns the MessageEntity.Purpose of message.
purpose(MessageEntity.Purpose) - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Returns the MessageQueryParam.Builder for the MessageQueryParam.purpose() component of the MessageQueryParam object.
purpose() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String for the purpose of the request.

R

reason(String) - Method in class com.microstrategy.ushersdk.ServerResponseData.Builder
 
reason() - Method in class com.microstrategy.ushersdk.ServerResponseData
 
receiver(String) - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Returns the SendInviteParam.Builder for the SendInviteParam.receiver() component of the SendInviteParam object.
receiver() - Method in class com.microstrategy.ushersdk.SendInviteParam
Returns a String of the recipient of the invitation.
receiverId(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
receiverId() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the receiverId.
receiverType(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
receiverType() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the receiverType.
receiverType(String) - Method in class com.microstrategy.ushersdk.SendInviteParam.Builder
Returns the SendInviteParam.Builder for the SendInviteParam.receiverType() component of the SendInviteParam object.
receiverType() - Method in class com.microstrategy.ushersdk.SendInviteParam
Returns a String of the receiver type.
recipient(String) - Method in class com.microstrategy.ushersdk.OtpRequestParam.Builder
Returns the OtpRequestParam.Builder for the OtpRequestParam.recipient() component of the OtpRequestParam object.
recipient(String) - Method in class com.microstrategy.ushersdk.OtpVerifyParam.Builder
Returns the OtpVerifyParam.Builder for the OtpVerifyParam.recipient() component of the OtpVerifyParam object.
recipientId() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the identification number of the recipient.
recipientType(RecipientType) - Method in class com.microstrategy.ushersdk.OtpRequestParam.Builder
Returns the OtpRequestParam.Builder for the OtpRequestParam.recipientType() component of the OtpRequestParam object.
recipientType(RecipientType) - Method in class com.microstrategy.ushersdk.OtpVerifyParam.Builder
Returns the OtpVerifyParam.Builder for the OtpVerifyParam.recipientType() component of the OtpVerifyParam object.
RecipientType - Enum in com.microstrategy.ushersdk
Enumerations of the type of recipient for the one-time password (OTP).
recipientType() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the type of recipient for the request (e.g.
register(SignUpParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after user account registration.
registerAndSignIn(SignUpAndSignInParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after user account registration and signing in.
rejectInviteByCode(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Returns a CompleteCallback after rejecting an invitation for an IoT device for a user account.
RequestAccessEntity - Class in com.microstrategy.ushersdk
The RequestAccessEntity abstract class wraps various properties related to a user account requesting access to an IoT device.
requestEmail() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the the requester's email address.
requesterName() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the the name of the requester.
requestMobile() - Method in class com.microstrategy.ushersdk.RequestAccessEntity
Returns a String of the requester's mobile phone number.
requestOtp(OtpRequestParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.OtpManager
Returns a CompleteCallback after requesting a one-time password (OTP)
REQUIRE_PRIMARY_DRIVER - Static variable in exception com.microstrategy.ushersdk.UsherException
10028, IoT device requires a primary driver.
requireAlphabeticCharacter(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
requireAlphabeticCharacter() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not the password requires at least one alphabetic character.
REQUIRED_VALID_OTP_SESSION_REQUIRED - Static variable in exception com.microstrategy.ushersdk.UsherException
10029, A valid session ID was not provided when resetting the password.
requireLowercaseCharacter(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
requireLowercaseCharacter() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not the password requires at least one lowercase character.
requireNumbers(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
requireNumbers() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not the password requires at least one number.
requireSymbols(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
requireSymbols() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not the password requires at least one symbol/ special character.
requireUppercaseCharacter(boolean) - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity.Builder
 
requireUppercaseCharacter() - Method in class com.microstrategy.ushersdk.PasswordPolicyEntity
Returns a boolean that represents whether or not the password requires at least one uppercase character.
resetPassword(ResetPasswordParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.PasswordManager
Returns a CompleteCallback after resetting the password for a user account.
ResetPasswordParam - Class in com.microstrategy.ushersdk
The ResetPasswordParam abstract class wraps various properties related to the user account password reset.
ResetPasswordParam.Builder - Class in com.microstrategy.ushersdk
The ResetPasswordParam.Builder abstract class allows the user to create and return a ResetPasswordParam object.
revokeMessageById(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Returns a CompleteCallback after revoking access to an IoT device.
role(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.role() component of the OwnerEntity object.
role() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the user role of the driver.

S

secondaryDriverEntityList() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a List of OwnerEntity objects, which wraps properties related to the driver of the IoT device, for the secondary drivers.
senderEmail(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
senderEmail() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the senderEmail.
senderFirstName(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
senderFirstName() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the senderFirstName.
senderLastName(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
senderLastName() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the senderLastName.
senderPhone(String) - Method in class com.microstrategy.ushersdk.MessageEntity.Participant.Builder
senderPhone() - Method in class com.microstrategy.ushersdk.MessageEntity.Participant
Returns a String of the senderPhone.
sendInvite(SendInviteParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.ConnectedIotDeviceManager
Returns a CompleteCallback after sending an invitation for access to an IoT device.
SendInviteParam - Class in com.microstrategy.ushersdk
The SendInviteParam abstract class wraps various properties related to the parameter surrounding an invitation for a user account to access an IoT device.
SendInviteParam.Builder - Class in com.microstrategy.ushersdk
 
ServerManager - Class in com.microstrategy.ushersdk
The ServerManager class collects all of the APIs related to server switch.
ServerManager(Lifecycle) - Constructor for class com.microstrategy.ushersdk.ServerManager
Constructor for an ServerManager object with the lifecycle set.
ServerManager(AppCompatActivity) - Constructor for class com.microstrategy.ushersdk.ServerManager
Constructor for an ServerManager object with the lifecycle set.
ServerManager(Fragment) - Constructor for class com.microstrategy.ushersdk.ServerManager
Constructor for an ServerManager object with the lifecycle set.
ServerResponseData - Class in com.microstrategy.ushersdk
 
ServerResponseData() - Constructor for class com.microstrategy.ushersdk.ServerResponseData
 
ServerResponseData.Builder - Class in com.microstrategy.ushersdk
 
serverUrl(String) - Method in class com.microstrategy.ushersdk.UsherSdk.Configuration.Builder
SESSION_INVALID - Static variable in exception com.microstrategy.ushersdk.UsherException
10032, Session invalid, need to log in
sessionId(String) - Method in class com.microstrategy.ushersdk.ResetPasswordParam.Builder
sessionId(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
 
sessionId() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the session id.
setDebugLogMode(boolean) - Method in class com.microstrategy.ushersdk.UsherSdk
Set log mode for the app
setLocale(Locale) - Method in class com.microstrategy.ushersdk.UsherSdk
Set Locale for the app
showHttpRequestLog(Context) - Static method in class com.microstrategy.ushersdk.LogManager
Launches the activity to show all the HTTP request history.
signIn(SignInParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after signing into the user account.
SignInParam - Class in com.microstrategy.ushersdk
The SignInParam abstract class wraps various properties related to the user signing in account.
SignInParam() - Constructor for class com.microstrategy.ushersdk.SignInParam
 
SignInParam.Builder - Class in com.microstrategy.ushersdk
 
signInWithBiometrics(ObservableCallback<FingerprintVerificationResult>) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a FingerprintVerificationResult object after signing into a user account with biometrics.
signOut(CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after signing out of the user account.
SignUpAndSignInParam - Class in com.microstrategy.ushersdk
The SignUpAndSignInParam abstract class wraps various properties related to the parameter surrounding user account registration.
SignUpAndSignInParam() - Constructor for class com.microstrategy.ushersdk.SignUpAndSignInParam
 
SignUpAndSignInParam.Builder - Class in com.microstrategy.ushersdk
 
signUpParam(SignUpParam) - Method in class com.microstrategy.ushersdk.SignUpAndSignInParam.Builder
signUpParam() - Method in class com.microstrategy.ushersdk.SignUpAndSignInParam
Returns a SignUpParam, see SignUpParam.
SignUpParam - Class in com.microstrategy.ushersdk
The SignUpParam abstract class wraps various properties related to the parameter surrounding user account registration.
SignUpParam.Builder - Class in com.microstrategy.ushersdk
The SignUpParam.Builder abstract class allows the user to create and return a SignUpParam object.
SingleCallback<T> - Interface in com.microstrategy.ushersdk
The SingleCallback abstract class represents an asynchronous callback returning a single value.
state(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.state() component of the AccountParam object.
state() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's state of residence.
state(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.state() component of the SignUpParam object.
state() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's state of residence.
state() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's state of residence.
status() - Method in class com.microstrategy.ushersdk.FingerprintVerificationResult
Returns a Enum type FingerprintVerificationResult.Status of the verification result.
status() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns an enumeration of the IotDeviceEntity.Status of the IoT device.
status(MessageEntity.Status) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.status() component of the MessageEntity object.
status() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns the MessageEntity.Status of the message.
status(MessageEntity.Status) - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Returns the MessageQueryParam.Builder for the MessageQueryParam.status() component of the MessageQueryParam object.
status(String) - Method in class com.microstrategy.ushersdk.ServerResponseData.Builder
 
status() - Method in class com.microstrategy.ushersdk.ServerResponseData
 
staySignedIn(boolean) - Method in class com.microstrategy.ushersdk.SignInParam.Builder
Returns the SignInParam.Builder for the SignInParam.staySignedIn() component of the SignInParam object.
staySignedIn(boolean) - Method in class com.microstrategy.ushersdk.SignUpAndSignInParam.Builder
staySignedIn() - Method in class com.microstrategy.ushersdk.SignUpAndSignInParam
Returns a boolean of whether to stay signed in.
street1(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.street1() component of the AccountParam object.
street1() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's primary address.
street1(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.street1() component of the SignUpParam object.
street1() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's primary address.
street1() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's primary address.
street2(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.street2() component of the AccountParam object.
street2() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's secondary address.
street2(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.street2() component of the SignUpParam object.
street2() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's secondary address.
street2() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's secondary address.

T

toString() - Method in enum com.microstrategy.ushersdk.IotDeviceEntity.Status
Returns a String of the status.
toString() - Method in enum com.microstrategy.ushersdk.IotDeviceEntity.UserRole
Returns a String of the user role.
toString() - Method in enum com.microstrategy.ushersdk.MessageEntity.Purpose
Returns a String of the type of message.
toString() - Method in enum com.microstrategy.ushersdk.MessageEntity.Status
Returns a String of the status.
toString() - Method in enum com.microstrategy.ushersdk.MessageEntity.Type
Returns a String of the type of message.
toString() - Method in enum com.microstrategy.ushersdk.OtpPurpose
Returns a String of the OTP purpose.
toString() - Method in enum com.microstrategy.ushersdk.RecipientType
Returns a String of the recipient type.
toString() - Method in exception com.microstrategy.ushersdk.UsherException
Returns a String of the exception code and/or error message in default JSON format.
type(MessageEntity.Type) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.type() component of the MessageEntity object.
type() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns the MessageEntity.Type of message.
type(MessageEntity.Type) - Method in class com.microstrategy.ushersdk.MessageQueryParam.Builder
Returns the MessageQueryParam.Builder for the MessageQueryParam.type() component of the MessageQueryParam object.
typeAdapter(Gson) - Static method in class com.microstrategy.ushersdk.AppCodeEntity
 
typeAdapter(Gson) - Static method in class com.microstrategy.ushersdk.UserSettingsEntity
 

U

uid(String) - Method in class com.microstrategy.ushersdk.OwnerEntity.Builder
Returns the OwnerEntity.Builder for the OwnerEntity.uid() component of the OwnerEntity object.
uid() - Method in class com.microstrategy.ushersdk.OwnerEntity
Returns a String of the Usher ID of the driver.
uid() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's Usher ID.
update(AccountParam, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after updating the user account information.
updateAppCodeSettings(boolean, String, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after updating the app code settings.
updateIotDevice(String, String, CompleteCallback) - Method in class com.microstrategy.ushersdk.IotManager
Returns a CompleteCallback after updating an IoT device for a user account.
updatePhone(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after updating the user contact information.
updateTs(long) - Method in class com.microstrategy.ushersdk.MessageEntity.Builder
Returns the MessageEntity.Builder for the MessageEntity.updateTs() component of the MessageEntity object.
updateTs() - Method in class com.microstrategy.ushersdk.MessageEntity
Returns a long of the time in seconds at which the message was updated.
uploadDeviceNotificationToken(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.UsherSdk
Returns a CompleteCallback after uploading the device notification token to the server.
USER_ALREADY_EXIST - Static variable in exception com.microstrategy.ushersdk.UsherException
10003, User already exists.
USER_LOCKED - Static variable in exception com.microstrategy.ushersdk.UsherException
10004, User is locked due to too many incorrect login attempts.
USER_NOT_FOUND - Static variable in exception com.microstrategy.ushersdk.UsherException
10005, User not found.
UserEntity - Class in com.microstrategy.ushersdk
The UserEntity abstract class wraps all of the properties related to the user account.
userId(String) - Method in class com.microstrategy.ushersdk.SignInParam.Builder
Returns the SignInParam.Builder for the SignInParam.userId() component of the SignInParam object.
userRole() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns an enumeration of the IotDeviceEntity.UserRole of the current user of the IoT device.
userRoleUpdatedTs() - Method in class com.microstrategy.ushersdk.IotDeviceEntity
Returns a long of the time in seconds at which the user role was updated.
userSettings() - Method in class com.microstrategy.ushersdk.UserEntity
Returns the UserSettingsEntity object that wraps various properties related to user settings.
UserSettingsEntity - Class in com.microstrategy.ushersdk
The UserSettingsEntity abstract class wraps various properties related to user settings.
UserSettingsEntity() - Constructor for class com.microstrategy.ushersdk.UserSettingsEntity
 
USHER_SDK_ERROR - Static variable in exception com.microstrategy.ushersdk.UsherException
9999, Internal Usher SDK error.
UsherException - Exception in com.microstrategy.ushersdk
The UsherException class wraps all of the exceptions that can be encountered by the Usher SDK with an identifying name and unique code to help diagnose the root cause.
UsherException(int, String, ServerResponseData) - Constructor for exception com.microstrategy.ushersdk.UsherException
Constructor for a UsherException with the exception code and detail message set.
UsherException(int, String) - Constructor for exception com.microstrategy.ushersdk.UsherException
Constructor for a UsherException with the exception code and detail message set.
UsherException(int, ServerResponseData, Throwable) - Constructor for exception com.microstrategy.ushersdk.UsherException
Constructor for a UsherException with the exception code and the cause set.
UsherException(int, ServerResponseData) - Constructor for exception com.microstrategy.ushersdk.UsherException
Constructor for a UsherException with the exception code set.
UsherException(int) - Constructor for exception com.microstrategy.ushersdk.UsherException
Constructor for a UsherException with the exception code set.
UsherSdk - Class in com.microstrategy.ushersdk
The UsherSdk Singleton class provides initialization for the Usher SDK.
UsherSdk.Configuration - Class in com.microstrategy.ushersdk
The UsherSdk.Configuration abstract class wraps various properties related to the UsherSdk initialization.
UsherSdk.Configuration.Builder - Class in com.microstrategy.ushersdk
The UsherSdk.Configuration.Builder abstract class allows the user to create and return an UsherSdk.Configuration object.

V

validatePassword(List<Character>, SingleCallback<Boolean>) - Method in class com.microstrategy.ushersdk.PasswordManager
Returns a boolean that represents whether or not the user password satisfies the password policy.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.FingerprintVerificationResult.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.IotDeviceEntity.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.IotDeviceEntity.UserRole
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.MessageEntity.Purpose
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.MessageEntity.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.MessageEntity.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.OtpPurpose
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microstrategy.ushersdk.RecipientType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microstrategy.ushersdk.FingerprintVerificationResult.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.IotDeviceEntity.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.IotDeviceEntity.UserRole
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.MessageEntity.Purpose
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.MessageEntity.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.MessageEntity.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.OtpPurpose
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microstrategy.ushersdk.RecipientType
Returns an array containing the constants of this enum type, in the order they are declared.
verificationPolicyMap(Map<String, Object>) - Method in class com.microstrategy.ushersdk.AccountPolicyEntity.Builder
verificationPolicyMap() - Method in class com.microstrategy.ushersdk.AccountPolicyEntity
Returns a Map of the verification policies.
verifyAppCode(String, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after verifying the user's app code on the server.
verifyAppCode(String, boolean, CompleteCallback) - Method in class com.microstrategy.ushersdk.AccountManager
Returns a CompleteCallback after verifying the user's app code.
verifyOtp(OtpVerifyParam, SingleCallback<String>) - Method in class com.microstrategy.ushersdk.OtpManager
Returns a CompleteCallback after verifying the one-time password (OTP).

W

withUserSettings(UserSettingsEntity) - Method in class com.microstrategy.ushersdk.UserEntity
Constructor for a UserEntity object with the userSettings set.

Z

zip(String) - Method in class com.microstrategy.ushersdk.AccountParam.Builder
Returns the AccountParam.Builder for the AccountParam.zip() component of the AccountParam object.
zip() - Method in class com.microstrategy.ushersdk.AccountParam
Returns a String of the user's ZIP Code.
zip(String) - Method in class com.microstrategy.ushersdk.SignUpParam.Builder
Returns the SignUpParam.Builder for the SignUpParam.zip() component of the SignUpParam object.
zip() - Method in class com.microstrategy.ushersdk.SignUpParam
Returns a String of the user's ZIP Code.
zip() - Method in class com.microstrategy.ushersdk.UserEntity
Returns a String of the user's ZIP Code.
A B C D E F G H I L M N O P R S T U V W Z 
Skip navigation links