AeroGearGCMPushJsonConfiguration (AeroGear Android Push Library 3.0.1 API)

java.lang.Object
- org.jboss.aerogear.android.unifiedpush.PushConfiguration<AeroGearGCMPushJsonConfiguration>
- - org.jboss.aerogear.android.unifiedpush.gcm.AeroGearGCMPushJsonConfiguration

All Implemented Interfaces:

org.jboss.aerogear.android.core.Config<AeroGearGCMPushJsonConfiguration>
```
public class AeroGearGCMPushJsonConfiguration
extends PushConfiguration<AeroGearGCMPushJsonConfiguration>
```
A Push Configuration which builds AeroGearGCMPushRegistrar instances.

Constructor Summary

Constructors
Constructor and Description

AeroGearGCMPushJsonConfiguration()

Constructors
Constructor and Description
`AeroGearGCMPushJsonConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`AeroGearGCMPushJsonConfiguration`	`addCategories(List<String> categories)` The categories specifies a channel which may be used to send messages
`AeroGearGCMPushJsonConfiguration`	`addCategory(String category)` The categories specifies a channel which may be used to send messages
`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`	`getFileName()`
`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.
`AeroGearGCMPushJsonConfiguration`	`loadConfigJson(android.content.Context context)` Load push unified push informations from assets/push-config.json
`AeroGearGCMPushJsonConfiguration`	`setAlias(String alias)` The Alias is an identifier of the user of the system.
`AeroGearGCMPushJsonConfiguration`	`setCategories(List<String> categories)` The categories specifies a channel which may be used to send messages
`AeroGearGCMPushJsonConfiguration`	`setCategories(String... categories)` The categories specifies a channel which may be used to send messages
`AeroGearGCMPushJsonConfiguration`	`setDeviceType(String deviceType)` Device type determines which cloud messaging system will be used by the AeroGear Unified Push Server.
`void`	`setFileName(String fileName)`
`AeroGearGCMPushJsonConfiguration`	`setOperatingSystem(String operatingSystem)` The name of the operating system.
`AeroGearGCMPushJsonConfiguration`	`setSenderId(String senderId)` SenderId is a GCM sender Id (usually a project number) registered for this application.

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
  - AeroGearGCMPushJsonConfiguration
```
public AeroGearGCMPushJsonConfiguration()
```
- Method Detail
  - getFileName
```
public String getFileName()
```
  - setFileName
```
public void setFileName(String fileName)
```
  - getPushServerURI
```
public URI getPushServerURI()
```
    RegistryURL is the URL of the 3rd party application server
    
    Returns:
    the current pushServerURI
  - getSenderId
```
public String getSenderId()
```
    SenderId is a GCM sender Id (usually a project number) registered for this application.
    
    Returns:
    a copy of the current set of senderIds.
  - setSenderId
```
public AeroGearGCMPushJsonConfiguration setSenderId(String senderId)
```
    SenderId is a GCM sender Id (usually a project number) registered for this application.
    
    Parameters:
    senderId - a new sender Id to add to the current set of senderIds.
    
    Returns:
    the current configuration.
  - getVariantID
```
public String getVariantID()
```
    ID of the Variant from the AeroGear UnifiedPush Server.
    
    Returns:
    the current variant id
  - getSecret
```
public String getSecret()
```
    Secret of the Variant from the AeroGear UnifiedPush Server.
    
    Returns:
    the current Secret
  - 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 AeroGearGCMPushJsonConfiguration 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 AeroGearGCMPushJsonConfiguration 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 AeroGearGCMPushJsonConfiguration 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 AeroGearGCMPushJsonConfiguration 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
  - addCategories
```
public AeroGearGCMPushJsonConfiguration addCategories(List<String> categories)
```
    The categories specifies a channel which may be used to send messages
    
    Parameters:
    categories - add categories
    
    Returns:
    the current configuration
  - setCategories
```
public AeroGearGCMPushJsonConfiguration 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 AeroGearGCMPushJsonConfiguration 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
  - loadConfigJson
```
public AeroGearGCMPushJsonConfiguration loadConfigJson(android.content.Context context)
```
    Load push unified push informations from assets/push-config.json
```
 {
   "pushServerURL": "pushServerURL (e.g http(s)//host:port/context)",
   "android": {
     "senderID": "senderID (e.g Google Project ID only for android)",
     "variantID": "variantID (e.g. 1234456-234320)",
     "variantSecret": "variantSecret (e.g. 1234456-234320)"
 }
 
```
    Parameters:
    context - your application's context
    
    Returns:
    the current configuration
  - buildRegistrar
```
protected final AeroGearGCMPushRegistrar buildRegistrar()
```
    Protected builder method.
    
    Specified by:
    
    buildRegistrar in class PushConfiguration<AeroGearGCMPushJsonConfiguration>
    
    Returns:
    A configured AeroGearGCMPushRegistrar
    
    Throws:
    
    IllegalStateException - if pushServerURI, SenderID, Variant or VariantSecret is null or empty.

Class AeroGearGCMPushJsonConfiguration

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

AeroGearGCMPushJsonConfiguration

Method Detail

getFileName

setFileName

getPushServerURI

getSenderId

setSenderId

getVariantID

getSecret

getDeviceToken

getDeviceType

setDeviceType

getOperatingSystem

setOperatingSystem

getOsVersion

getAlias

setAlias

getCategories

setCategories

addCategories

setCategories

addCategory

loadConfigJson

buildRegistrar