com.urbanairship.api.channel

Class ChannelRequest

java.lang.Object

com.urbanairship.api.channel.ChannelRequest

All Implemented Interfaces:

Request<ChannelResponse>

public class ChannelRequest
extends java.lang.Object
implements Request<ChannelResponse>

The ChannelRequest class builds channel listing requests to be executed in the UrbanAirshipClient.

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<ChannelResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static ChannelRequest	newEmailLookupRequest(java.lang.String email) Create a request for looking up an email channel.
static ChannelRequest	newRequest() Create new request for channel listing.
static ChannelRequest	newRequest(java.lang.String channel) Create new request for single channel lookup.
static ChannelRequest	newRequest(java.net.URI nextPage) Create a request for channel listing using a next page URI.
static ChannelRequest	newSmsLookupRequest(java.lang.String msisdn, java.lang.String sender) Create a request for looking up an sms channel.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static ChannelRequest newRequest(java.lang.String channel)

Create new request for single channel lookup.

Parameters:

channel - String

Returns:

ChannelRequest

newRequest

public static ChannelRequest newRequest()

Create new request for channel listing.

Returns:

ChannelRequest

newRequest

public static ChannelRequest newRequest(java.net.URI nextPage)

Create a request for channel listing using a next page URI.

Parameters:

nextPage - URI

Returns:

ChannelRequest

newSmsLookupRequest

public static ChannelRequest newSmsLookupRequest(java.lang.String msisdn,
                                                 java.lang.String sender)

Create a request for looking up an sms channel.

Parameters:

msisdn - The mobile phone number you want to look up. Must be numerical characters with no leading zeros.

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

Returns:

ChannelRequest

newEmailLookupRequest

public static ChannelRequest newEmailLookupRequest(java.lang.String email)

Create a request for looking up an email channel.

Parameters:

email - The mobile phone number you want to look up. Must be numerical characters with no leading zeros.

Returns:

ChannelRequest

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<ChannelResponse>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<ChannelResponse>

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<ChannelResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<ChannelResponse>

getUri

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

Specified by:

getUri in interface Request<ChannelResponse>

getResponseParser

public ResponseParser<ChannelResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<ChannelResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<ChannelResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<ChannelResponse>