com.microstrategy.ushersdk

Class SignUpParam

java.lang.Object

com.microstrategy.ushersdk.SignUpParam

public abstract class SignUpParam
extends java.lang.Object

The SignUpParam abstract class wraps various properties related to the parameter surrounding user account registration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignUpParam.Builder The SignUpParam.Builder abstract class allows the user to create and return a SignUpParam object.

Method Summary

Modifier and Type	Method and Description
static SignUpParam.Builder	builder() Returns the SignUpParam.Builder object for the SignUpParam abstract class.
abstract boolean	bypassClientCheck() Returns a boolean of whether to bypass client check for password.
abstract java.lang.String	city() Returns a String of the user's city of residence.
abstract java.lang.String	country() Returns a String of the user's country of residence.
abstract java.lang.String	email() Returns a String of the user's email address.
abstract com.google.gson.JsonElement	extra() Returns the JsonObject that contains the extra information.
abstract java.lang.String	firstName() Returns a String of the user's first name.
abstract java.lang.String	lastName() Returns a String of the user's last name.
abstract java.lang.String	mobile() Returns a String of the user's mobile phone number, including country code.
abstract com.google.common.collect.ImmutableList<java.lang.Character>	password() Returns a ImmutableList of the user's password.
abstract java.lang.String	sessionId() Returns a String of the session id.
abstract java.lang.String	state() Returns a String of the user's state of residence.
abstract java.lang.String	street1() Returns a String of the user's primary address.
abstract java.lang.String	street2() Returns a String of the user's secondary address.
abstract java.lang.String	zip() Returns a String of the user's ZIP Code.

Methods inherited from class java.lang.Object

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

Method Detail

sessionId

@Nullable
public abstract java.lang.String sessionId()

Returns a String of the session id.

Returns:

the session id.

city

@Nullable
public abstract java.lang.String city()

Returns a String of the user's city of residence.

Returns:

the user's city of residence.

country

@Nullable
public abstract java.lang.String country()

Returns a String of the user's country of residence.

Returns:

the user's country of residence.

email

public abstract java.lang.String email()

Returns a String of the user's email address.

Returns:

the user's email address.

firstName

public abstract java.lang.String firstName()

Returns a String of the user's first name.

Returns:

the user's first name.

lastName

public abstract java.lang.String lastName()

Returns a String of the user's last name.

Returns:

the user's last name.

mobile

@Nullable
public abstract java.lang.String mobile()

Returns a String of the user's mobile phone number, including country code. For example, if the user was in the United States, then a "1" would precede the user's mobile phone number.

Returns:

the user's mobile phone number, including country code.

password

public abstract com.google.common.collect.ImmutableList<java.lang.Character> password()

Returns a ImmutableList of the user's password.

Returns:

the user's password.

state

@Nullable
public abstract java.lang.String state()

Returns a String of the user's state of residence.

Returns:

the user's state of residence.

street1

@Nullable
public abstract java.lang.String street1()

Returns a String of the user's primary address.

Returns:

the user's primary address.

street2

@Nullable
public abstract java.lang.String street2()

Returns a String of the user's secondary address. This may include information such as apartment number and/or floor number. May be null.

Returns:

the user's secondary address.

zip

@Nullable
public abstract java.lang.String zip()

Returns a String of the user's ZIP Code.

Returns:

the user's ZIP Code.

extra

@Nullable
public abstract com.google.gson.JsonElement extra()

Returns the JsonObject that contains the extra information.

Returns:

the extra information that you would like to send to server.

bypassClientCheck

public abstract boolean bypassClientCheck()

Returns a boolean of whether to bypass client check for password.

Returns:

the whether to bypass client check for password.

builder

public static SignUpParam.Builder builder()

Returns the SignUpParam.Builder object for the SignUpParam abstract class.

Returns:

the SignUpParam.Builder object for the SignUpParam abstract class.