org.jboss.aerogear.android.unifiedpush.gcm

Class AeroGearGCMPushConfiguration

java.lang.Object

org.jboss.aerogear.android.unifiedpush.PushConfiguration<AeroGearGCMPushConfiguration>

org.jboss.aerogear.android.unifiedpush.gcm.AeroGearGCMPushConfiguration

All Implemented Interfaces:

org.jboss.aerogear.android.core.Config<AeroGearGCMPushConfiguration>

public class AeroGearGCMPushConfiguration
extends PushConfiguration<AeroGearGCMPushConfiguration>

A Push Configuration which builds AeroGearGCMPushRegistrar instances.

Constructor Summary

Constructors

Constructor and Description
AeroGearGCMPushConfiguration()

Method Summary

Modifier and Type	Method and Description
AeroGearGCMPushConfiguration	addCategory(String category) The categories specifies a channel which may be used to send messages
AeroGearGCMPushConfiguration	addSenderId(String senderId) SenderIds is a collection of all GCM sender Id elements registered for this application.
protected AeroGearGCMPushRegistrar	buildRegistrar() Protected builder method.
String	getAlias() The Alias is an identifier of the user of the system.
List<String>	getCategories() The categories specifies a channel which may be used to send messages
String	getDeviceToken() The device token Identifies the device within its Push Network.
String	getDeviceType() Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server Defaults to ANDROID
String	getOperatingSystem() The name of the operating system.
String	getOsVersion() The version of the operating system running.
URI	getPushServerURI() RegistryURL is the URL of the 3rd party application server
String	getSecret() Secret of the Variant from the AeroGear UnifiedPush Server.
Set<String>	getSenderIds() SenderIds is a collection of all GCM sender Id elements registered for this application.
String	getVariantID() ID of the Variant from the AeroGear UnifiedPush Server.
AeroGearGCMPushConfiguration	setAlias(String alias) The Alias is an identifier of the user of the system.
AeroGearGCMPushConfiguration	setCategories(List<String> categories) The categories specifies a channel which may be used to send messages
AeroGearGCMPushConfiguration	setCategories(String... categories) The categories specifies a channel which may be used to send messages
AeroGearGCMPushConfiguration	setDeviceToken(String deviceToken) The device token Identifies the device within its Push Network.
AeroGearGCMPushConfiguration	setDeviceType(String deviceType) Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server.
AeroGearGCMPushConfiguration	setOperatingSystem(String operatingSystem) The name of the operating system.
AeroGearGCMPushConfiguration	setOsVersion(String osVersion) The version of the operating system running.
AeroGearGCMPushConfiguration	setPushServerURI(URI pushServerURI) RegistryURL is the URL of the 3rd party application server
AeroGearGCMPushConfiguration	setSecret(String secret) Secret of the Variant from the AeroGear UnifiedPush Server.
AeroGearGCMPushConfiguration	setSenderIds(String... senderIds) SenderIds is a collection of all GCM sender Id elements registered for this application.
AeroGearGCMPushConfiguration	setVariantID(String variantID) ID of the Variant from the AeroGear UnifiedPush Server.

Methods inherited from class org.jboss.aerogear.android.unifiedpush.PushConfiguration

addOnPushRegistrarCreatedListener, asRegistrar, getName, getOnAuthenticationCreatedListeners, setName, setOnPushRegistrarCreatedListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

AeroGearGCMPushConfiguration

public AeroGearGCMPushConfiguration()

Method Detail

getDeviceToken

public String getDeviceToken()

The device token Identifies the device within its Push Network. It is the value = GoogleCloudMessaging.getInstance(context).register(SENDER_ID);

Returns:

the current device token

setDeviceToken

public AeroGearGCMPushConfiguration setDeviceToken(String deviceToken)

The device token Identifies the device within its Push Network. It is the value = GoogleCloudMessaging.getInstance(context).register(SENDER_ID);

Parameters:

deviceToken - the new device token

Returns:

the current configuration

getVariantID

public String getVariantID()

ID of the Variant from the AeroGear UnifiedPush Server.

Returns:

the current variant id

setVariantID

public AeroGearGCMPushConfiguration setVariantID(String variantID)

ID of the Variant from the AeroGear UnifiedPush Server.

Parameters:

variantID - the new variantID

Returns:

the current configuration

getSecret

public String getSecret()

Secret of the Variant from the AeroGear UnifiedPush Server.

Returns:

the current Secret

setSecret

public AeroGearGCMPushConfiguration setSecret(String secret)

Secret of the Variant from the AeroGear UnifiedPush Server.

Parameters:

secret - the new secret

Returns:

the current configuration

getDeviceType

public String getDeviceType()

Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server Defaults to ANDROID

Returns:

the device type

setDeviceType

public AeroGearGCMPushConfiguration setDeviceType(String deviceType)

Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server. Defaults to ANDROID

Parameters:

deviceType - a new device type

Returns:

the current configuration

getOperatingSystem

public String getOperatingSystem()

The name of the operating system. Defaults to Android

Returns:

the operating system

setOperatingSystem

public AeroGearGCMPushConfiguration setOperatingSystem(String operatingSystem)

The name of the operating system. Defaults to Android

Parameters:

operatingSystem - the new operating system

Returns:

the current configuration

getOsVersion

public String getOsVersion()

The version of the operating system running. Defaults to the value provided by android.os.Build.VERSION.RELEASE

Returns:

the current OSversion

setOsVersion

public AeroGearGCMPushConfiguration setOsVersion(String osVersion)

The version of the operating system running. Defaults to the value provided by android.os.Build.VERSION.RELEASE

Parameters:

osVersion - the new osVersion

Returns:

the current configuration

getAlias

public String getAlias()

The Alias is an identifier of the user of the system. Examples are an email address or a username

Returns:

alias

setAlias

public AeroGearGCMPushConfiguration setAlias(String alias)

The Alias is an identifier of the user of the system. Examples are an email address or a username

Parameters:

alias - the new alias

Returns:

the current configuration

getCategories

public List<String> getCategories()

The categories specifies a channel which may be used to send messages

Returns:

the current categories

setCategories

public AeroGearGCMPushConfiguration setCategories(List<String> categories)

The categories specifies a channel which may be used to send messages

Parameters:

categories - the new categories

Returns:

the current configuration

setCategories

public AeroGearGCMPushConfiguration setCategories(String... categories)

The categories specifies a channel which may be used to send messages

Parameters:

categories - the new categories

Returns:

the current configuration

addCategory

public AeroGearGCMPushConfiguration addCategory(String category)

The categories specifies a channel which may be used to send messages

Parameters:

category - a new category to be added to the current list.

Returns:

the current configuration

getPushServerURI

public URI getPushServerURI()

RegistryURL is the URL of the 3rd party application server

Returns:

the current pushServerURI

setPushServerURI

public AeroGearGCMPushConfiguration setPushServerURI(URI pushServerURI)

RegistryURL is the URL of the 3rd party application server

Parameters:

pushServerURI - a new URI

Returns:

the current configuration

getSenderIds

public Set<String> getSenderIds()

SenderIds is a collection of all GCM sender Id elements registered for this application.

Returns:

a copy of the current set of senderIds.

setSenderIds

public AeroGearGCMPushConfiguration setSenderIds(String... senderIds)

SenderIds is a collection of all GCM sender Id elements registered for this application.

Parameters:

senderIds - the new sender Ids to set.

Returns:

the current configuration.

addSenderId

public AeroGearGCMPushConfiguration addSenderId(String senderId)

SenderIds is a collection of all GCM sender Id elements registered for this application.

Parameters:

senderId - a new sender Id to add to the current set of senderIds.

Returns:

the current configuration.

buildRegistrar

protected final AeroGearGCMPushRegistrar buildRegistrar()

Protected builder method.

Specified by:

buildRegistrar in class PushConfiguration<AeroGearGCMPushConfiguration>

Returns:

A configured AeroGearGCMPushRegistrar

Throws:

IllegalStateException - if pushServerURI is null or if senderIds is null or empty.