org.jboss.aerogear.android.unifiedpush.gcm

Class UnifiedPushConfig

java.lang.Object

org.jboss.aerogear.android.unifiedpush.gcm.UnifiedPushConfig

public final class UnifiedPushConfig
extends Object

Constructor Summary

Constructors

Constructor and Description
UnifiedPushConfig()

Method Summary

Methods

Modifier and Type	Method and Description
UnifiedPushConfig	addCategories(List<String> categories) The categories specifies a channel which may be used to send messages
UnifiedPushConfig	addCategory(String category) The categories specifies a channel which may be used to send messages
void	checkRequiredFields()
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.
String	getSenderId() SenderId is a GCM sender Id (usually a project number) registered for this application.
String	getVariantID() ID of the Variant from the AeroGear UnifiedPush Server.
UnifiedPushConfig	setAlias(String alias) The Alias is an identifier of the user of the system.
UnifiedPushConfig	setCategories(List<String> categories) The categories specifies a channel which may be used to send messages
UnifiedPushConfig	setCategories(String... categories) The categories specifies a channel which may be used to send messages
UnifiedPushConfig	setDeviceType(String deviceType) Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server.
UnifiedPushConfig	setOperatingSystem(String operatingSystem) The name of the operating system.
UnifiedPushConfig	setPushServerURI(URI pushServerURI) RegistryURL is the URL of the 3rd party application server
UnifiedPushConfig	setSecret(String secret) Secret of the Variant from the AeroGear UnifiedPush Server.
UnifiedPushConfig	setSenderId(String senderId) SenderId is a GCM sender Id (usually a project number) registered for this application.
UnifiedPushConfig	setVariantID(String variantID) ID of the Variant from the AeroGear UnifiedPush Server.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnifiedPushConfig

public UnifiedPushConfig()

Method Detail

getPushServerURI

public URI getPushServerURI()

RegistryURL is the URL of the 3rd party application server

Returns:

the current pushServerURI

setPushServerURI

public UnifiedPushConfig setPushServerURI(URI pushServerURI)

RegistryURL is the URL of the 3rd party application server

Parameters:

pushServerURI - a new URI

Returns:

the current configuration

getSenderId

public String getSenderId()

SenderId is a GCM sender Id (usually a project number) registered for this application.

Returns:

the current senderId.

setSenderId

public UnifiedPushConfig setSenderId(String senderId)

SenderId is a GCM sender Id (usually a project number) registered for this application.

Parameters:

senderId - the new senderId to set.

Returns:

the current configuration.

getVariantID

public String getVariantID()

ID of the Variant from the AeroGear UnifiedPush Server.

Returns:

the current variant id

setVariantID

public UnifiedPushConfig 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 UnifiedPushConfig setSecret(String secret)

Secret of the Variant from the AeroGear UnifiedPush Server.

Parameters:

secret - the new secret

Returns:

the current configuration

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

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 UnifiedPushConfig 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 UnifiedPushConfig 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

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 UnifiedPushConfig 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 UnifiedPushConfig 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 UnifiedPushConfig 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 UnifiedPushConfig 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

addCategories

public UnifiedPushConfig addCategories(List<String> categories)

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

Parameters:

categories - a category collection to be added to the current list.

Returns:

the current configuration

checkRequiredFields

public void checkRequiredFields()