com.scvngr.levelup.core.net.request.factory

Class GcmDeviceRequestFactory

java.lang.Object

com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

com.scvngr.levelup.core.net.request.factory.GcmDeviceRequestFactory

@ThreadSafe
 @LevelUpApi(contract=PUBLIC)
public final class GcmDeviceRequestFactory
extends AbstractRequestFactory

Request builder for requests to the GCM Devices endpoint on the LevelUp web service.

Constructor Summary

Constructors

Constructor and Description
GcmDeviceRequestFactory(Context context, AccessTokenRetriever retriever)

Method Summary

Modifier and Type	Method and Description
AbstractRequest	buildRegisterGcmDeviceRequest(String registrationId) Builds a request which associates a GCM registration ID with a mobile device.
AbstractRequest	buildUnregisterGcmDeviceRequest(String registrationId) Builds a request which dissociates a GCM registration ID from the platform.

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

getAccessTokenRetriever, getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GcmDeviceRequestFactory

public GcmDeviceRequestFactory(Context context,
                               AccessTokenRetriever retriever)

Parameters:

context - Application context.

retriever - The AccessTokenRetriever to use to retrieve the AccessToken.

Method Detail

buildRegisterGcmDeviceRequest

public AbstractRequest buildRegisterGcmDeviceRequest(String registrationId)

Builds a request which associates a GCM registration ID with a mobile device. This allows the LevelUp web service to send messages with the appropriate app-specific GCM registration ID. If an access token is available, the GCM registration ID will also become associated with the User's LevelUp account. The request may be performed with or without an access token. With an access token, this request requires the Permissions.PERMISSION_CREATE_ORDERS and Permissions.PERMISSION_READ_QR_CODE permissions.

Parameters:

registrationId - Google-issued GCM registration ID received by the app.

Returns:

AbstractRequest to register a GCM device with the platform.

buildUnregisterGcmDeviceRequest

public AbstractRequest buildUnregisterGcmDeviceRequest(String registrationId)

Builds a request which dissociates a GCM registration ID from the platform. This will remove the association of the specified ID from any users.

Parameters:

registrationId - Google-issued GCM registration ID received by the app.

Returns:

AbstractRequest to unregister a GCM device from the platform.