com.urbanairship.api.channel

Class SmsRegistrationRequest

java.lang.Object

com.urbanairship.api.channel.SmsRegistrationRequest

All Implemented Interfaces:

Request<SmsRegistrationResponse>

public class SmsRegistrationRequest
extends java.lang.Object
implements Request<SmsRegistrationResponse>

Nested Class Summary

Nested classes/interfaces inherited from interface com.urbanairship.api.client.Request

Request.HttpMethod

Field Summary

Fields inherited from interface com.urbanairship.api.client.Request

CONTENT_ENCODING_GZIP, CONTENT_TYPE_JSON, CONTENT_TYPE_TEXT_CSV, UA_VERSION_CSV, UA_VERSION_JSON

Method Summary

Modifier and Type	Method and Description
boolean	bearerTokenAuthRequired()
boolean	canUseBearerTokenAuth()
ContentType	getContentType()
Request.HttpMethod	getHttpMethod()
java.lang.String	getRequestBody()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
ResponseParser<SmsRegistrationResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static SmsRegistrationRequest	newOptOutRequest(java.lang.String sender, java.lang.String msisdn) This will mark an SMS channel as opted-out (inactive) and it will not receive alerts even when they are addressed in the future.
static SmsRegistrationRequest	newRegistrationRequest(java.lang.String sender, java.lang.String msisdn) Begin the opt-in process for a new SMS channel.
static SmsRegistrationRequest	newRegistrationRequest(java.lang.String sender, java.lang.String msisdn, DateTime optedIn) Begin the opt-in process for a new SMS channel.
static SmsRegistrationRequest	newUninstallRequest(java.lang.String sender, java.lang.String msisdn) Removes phone numbers and accompanying data from Urban Airship.

Methods inherited from class java.lang.Object

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

Method Detail

newOptOutRequest

public static SmsRegistrationRequest newOptOutRequest(java.lang.String sender,
                                                      java.lang.String msisdn)

This will mark an SMS channel as opted-out (inactive) and it will not receive alerts even when they are addressed in the future.

Parameters:

sender - The SMS sender ID provided by Urban Airship. Must be numeric characters only.

msisdn - The mobile phone number you want to opt-out of SMS messages.

Returns:

SmsRegistrationRequest

newUninstallRequest

public static SmsRegistrationRequest newUninstallRequest(java.lang.String sender,
                                                         java.lang.String msisdn)

Removes phone numbers and accompanying data from Urban Airship. Use with caution. Uninstalling an SMS channel will prevent you from retrieving opt-in and opt-out history for the corresponding msisdn. If the uninstalled msisdn opts-in again, it will generate a new channel_id. The new channel_id cannot be reassociated with any opt-in information, tags, named users, insight reports, or other information from the uninstalled SMS channel.

Parameters:

sender - A number the app is configured to send from, provided by Urban Airship.

msisdn - The mobile phone number you want to register as an SMS channel (or send a request to opt-in).

Returns:

SmsRegistrationRequest

newRegistrationRequest

public static SmsRegistrationRequest newRegistrationRequest(java.lang.String sender,
                                                            java.lang.String msisdn)

Begin the opt-in process for a new SMS channel.

Parameters:

sender - A number the app is configured to send from, provided by Urban Airship.

msisdn - The mobile phone number you want to register as an SMS channel.

Returns:

SmsRegistrationRequest

newRegistrationRequest

public static SmsRegistrationRequest newRegistrationRequest(java.lang.String sender,
                                                            java.lang.String msisdn,
                                                            DateTime optedIn)

Begin the opt-in process for a new SMS channel.

Parameters:

sender - A number the app is configured to send from, provided by Urban Airship.

msisdn - The mobile phone number you want to register as an SMS channel.

optedIn - The datetime that represents the date and time when explicit permission was received from the user to receive messages.

Returns:

SmsRegistrationRequest

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<SmsRegistrationResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<SmsRegistrationResponse>

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<SmsRegistrationResponse>

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Specified by:

getRequestHeaders in interface Request<SmsRegistrationResponse>

getUri

public java.net.URI getUri(java.net.URI baseUri)
                    throws java.net.URISyntaxException

Specified by:

getUri in interface Request<SmsRegistrationResponse>

Throws:

java.net.URISyntaxException

getResponseParser

public ResponseParser<SmsRegistrationResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<SmsRegistrationResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<SmsRegistrationResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<SmsRegistrationResponse>