org.jboss.aerogear.unifiedpush.api

Class Installation

java.lang.Object

org.jboss.aerogear.unifiedpush.api.BaseModel

org.jboss.aerogear.unifiedpush.api.Installation

All Implemented Interfaces:

Serializable

@DeviceTokenCheck
public class Installation
extends BaseModel

One installation of a push-enabled client, running on a device (Android/iOS) or user-agent (SimplePush)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Installation()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlias()
Set<Category>	getCategories()
String	getDeviceToken()
String	getDeviceType()
String	getOperatingSystem()
String	getOsVersion()
String	getPlatform()
Variant	getVariant()
boolean	isEnabled()
void	setAlias(String alias) Application specific alias to identify users with the system.
void	setCategories(Set<Category> categories) Used to "tag" the clients.
void	setDeviceToken(String deviceToken) Identifies the device/user-agent within its PushNetwork.
void	setDeviceType(String deviceType) The device type of the device or the user agent.
void	setEnabled(boolean enabled) Flag if the actual client installation is enabled (default) or not.
void	setOperatingSystem(String operatingSystem) The (optional) name of the underlying Operating System.
void	setOsVersion(String osVersion) The (optional) version of the used Operating System.
void	setPlatform(String platform) A reliable way of determining the platform type for an installation.
void	setVariant(Variant variant)

Methods inherited from class org.jboss.aerogear.unifiedpush.api.BaseModel

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Installation

public Installation()

Method Detail

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Flag if the actual client installation is enabled (default) or not. Disabled installations are not receiving push notifications. Used by the admin UI to disable specific clients.

Parameters:

enabled - if true the Installation is marked as enabled, setting it to false disables it.

getDeviceToken

public String getDeviceToken()

setDeviceToken

public void setDeviceToken(String deviceToken)

Identifies the device/user-agent within its PushNetwork.

• APNs: deviceToken
• GCM: registrationId
• SimplePush: pushEndpoint

Parameters:

deviceToken - unique string to identify an Installation with its PushNetwork

getDeviceType

public String getDeviceType()

setDeviceType

public void setDeviceType(String deviceType)

The device type of the device or the user agent.

For SimplePush this will be Web For iOS that could be iPod, iPad or iPhone For Android that could be Phone or Tablet

Parameters:

deviceType - the type of the registered device

getOperatingSystem

public String getOperatingSystem()

setOperatingSystem

public void setOperatingSystem(String operatingSystem)

The (optional) name of the underlying Operating System.

Parameters:

operatingSystem - the name of the Operating System.

getOsVersion

public String getOsVersion()

setOsVersion

public void setOsVersion(String osVersion)

The (optional) version of the used Operating System.

Parameters:

osVersion - the version string of the mobile OS.

getAlias

public String getAlias()

setAlias

public void setAlias(String alias)

Application specific alias to identify users with the system. E.g. email address or username

Parameters:

alias - string to map the Installation to an actual user.

setCategories

public void setCategories(Set<Category> categories)

Used to "tag" the clients. E.g. apply sport, news etc

Parameters:

categories - set of all categories the client is in

getCategories

public Set<Category> getCategories()

setPlatform

public void setPlatform(String platform)

A reliable way of determining the platform type for an installation. FOR ADMIN UI ONLY - Helps with setting up Routes

Parameters:

platform - the name of the platform

getPlatform

public String getPlatform()

getVariant

public Variant getVariant()

setVariant

public void setVariant(Variant variant)