com.microstrategy.ushersdk

Class SignUpParam.Builder

java.lang.Object

com.microstrategy.ushersdk.SignUpParam.Builder

Enclosing class:

SignUpParam

public abstract static class SignUpParam.Builder
extends java.lang.Object

The SignUpParam.Builder abstract class allows the user to create and return a SignUpParam object. For example,
return SignUpParam.builder()
.firstName("John")
.lastName("Doe")
.mobile("1234567890")
.email("johndoe@johndoe.com")
.street1("123 Cherry St")
.street2(null)
.city("Washington")
.state("DC")
.zip("20001")
.country("USA")
.password("hunter2")
.build();

Method Summary

Modifier and Type	Method and Description
abstract SignUpParam	build() Builds the SignUpParam object that is used to wrap various properties related to the parameter surrounding user account registration.
abstract SignUpParam.Builder	bypassClientCheck(boolean bypassClientCheck) Returns the SignUpParam.Builder for the SignUpParam.bypassClientCheck() component of the SignUpParam object.
abstract SignUpParam.Builder	city(java.lang.String city) Returns the SignUpParam.Builder for the SignUpParam.city() component of the SignUpParam object.
abstract SignUpParam.Builder	country(java.lang.String country) Returns the SignUpParam.Builder for the SignUpParam.country() component of the SignUpParam object.
abstract SignUpParam.Builder	email(java.lang.String email) Returns the SignUpParam.Builder for the SignUpParam.email() component of the SignUpParam object.
abstract SignUpParam.Builder	extra(com.google.gson.JsonElement extra) Returns the SignUpParam.Builder for the SignUpParam.extra() component of the SignUpParam object.
abstract SignUpParam.Builder	firstName(java.lang.String firstName) Returns the SignUpParam.Builder for the SignUpParam.firstName() component of the SignUpParam object.
abstract SignUpParam.Builder	lastName(java.lang.String lastName) Returns the SignUpParam.Builder for the SignUpParam.lastName() component of the SignUpParam object.
abstract SignUpParam.Builder	mobile(java.lang.String mobile) Returns the SignUpParam.Builder for the SignUpParam.mobile() component of the SignUpParam object.
abstract SignUpParam.Builder	password(java.util.List<java.lang.Character> password) Returns the SignUpParam.Builder for the SignUpParam.password() component of the SignUpParam object.
abstract SignUpParam.Builder	sessionId(java.lang.String sessionId)
abstract SignUpParam.Builder	state(java.lang.String state) Returns the SignUpParam.Builder for the SignUpParam.state() component of the SignUpParam object.
abstract SignUpParam.Builder	street1(java.lang.String street1) Returns the SignUpParam.Builder for the SignUpParam.street1() component of the SignUpParam object.
abstract SignUpParam.Builder	street2(java.lang.String street2) Returns the SignUpParam.Builder for the SignUpParam.street2() component of the SignUpParam object.
abstract SignUpParam.Builder	zip(java.lang.String zip) Returns the SignUpParam.Builder for the SignUpParam.zip() component of the SignUpParam object.

Methods inherited from class java.lang.Object

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

Method Detail

city

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

Returns the SignUpParam.Builder for the SignUpParam.city() component of the SignUpParam object.

Parameters:

city - the user's city of residence

Returns:

the SignUpParam.Builder for the SignUpParam.city() component of the SignUpParam object.

country

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

Returns the SignUpParam.Builder for the SignUpParam.country() component of the SignUpParam object.

Parameters:

country - the user's country of residence

Returns:

the SignUpParam.Builder for the SignUpParam.country() component of the SignUpParam object.

email

public abstract SignUpParam.Builder email(java.lang.String email)

Returns the SignUpParam.Builder for the SignUpParam.email() component of the SignUpParam object.

Parameters:

email - the user's email address

Returns:

the SignUpParam.Builder for the SignUpParam.email() component of the SignUpParam object.

firstName

public abstract SignUpParam.Builder firstName(java.lang.String firstName)

Returns the SignUpParam.Builder for the SignUpParam.firstName() component of the SignUpParam object.

Parameters:

firstName - the user's first name

Returns:

the SignUpParam.Builder for the SignUpParam.firstName() component of the SignUpParam object.

lastName

public abstract SignUpParam.Builder lastName(java.lang.String lastName)

Returns the SignUpParam.Builder for the SignUpParam.lastName() component of the SignUpParam object.

Parameters:

lastName - the user's last name

Returns:

the SignUpParam.Builder for the SignUpParam.lastName() component of the SignUpParam object.

mobile

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

Returns the SignUpParam.Builder for the SignUpParam.mobile() component of the SignUpParam object.

Parameters:

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

Returns:

the SignUpParam.Builder for the SignUpParam.mobile() component of the SignUpParam object.

password

public abstract SignUpParam.Builder password(java.util.List<java.lang.Character> password)

Returns the SignUpParam.Builder for the SignUpParam.password() component of the SignUpParam object.

Parameters:

password - the user's password

Returns:

the SignUpParam.Builder for the SignUpParam.password() component of the SignUpParam object.

state

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

Returns the SignUpParam.Builder for the SignUpParam.state() component of the SignUpParam object.

Parameters:

state - the user's state of residence

Returns:

the SignUpParam.Builder for the SignUpParam.state() component of the SignUpParam object.

street1

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

Returns the SignUpParam.Builder for the SignUpParam.street1() component of the SignUpParam object.

Parameters:

street1 - the user's primary address

Returns:

the SignUpParam.Builder for the SignUpParam.street1() component of the SignUpParam object.

street2

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

Returns the SignUpParam.Builder for the SignUpParam.street2() component of the SignUpParam object.

Parameters:

street2 - the user's secondary address. This may include information such as apartment number and/or floor number

Returns:

the SignUpParam.Builder for the SignUpParam.street2() component of the SignUpParam object.

zip

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

Returns the SignUpParam.Builder for the SignUpParam.zip() component of the SignUpParam object.

Parameters:

zip - the user's ZIP code

Returns:

the SignUpParam.Builder for the SignUpParam.zip() component of the SignUpParam object.

sessionId

public abstract SignUpParam.Builder sessionId(java.lang.String sessionId)

extra

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

Returns the SignUpParam.Builder for the SignUpParam.extra() component of the SignUpParam object. It could be null.

Parameters:

extra - the extra user's information

Returns:

the SignUpParam.Builder for the SignUpParam.extra() component of the SignUpParam object.

bypassClientCheck

public abstract SignUpParam.Builder bypassClientCheck(boolean bypassClientCheck)

Returns the SignUpParam.Builder for the SignUpParam.bypassClientCheck() component of the SignUpParam object.

Parameters:

bypassClientCheck - whether to bypass client check for password. true if bypass client check for password false otherwise

build

public abstract SignUpParam build()

Builds the SignUpParam object that is used to wrap various properties related to the parameter surrounding user account registration.

Returns:

the SignUpParam object that is used to wrap various properties related to the parameter surrounding user account registration.