Class: Installation

Installation

Installation Model connects a mobile application to a device, the user and
other information for the server side to locate devices using application
id/version, user id, device type, and subscriptions. Users may have many
devices, or Installations, which can receive Notifications from the Application.

Class Properties

Name

Type

Description

appId

String

The unique identifier for the application this {{Installation}} is registered for.

appVersion

String

Version of the application currently running on the client (optional).

badge

Number

The number of the last displayed badge icon (iOS only).

created

Date

The date the Installation was created.

deviceToken

String

The device token as provided by GCM or APN.

deviceType

String

The device type such as ios.

modified

Date

The date the Installation was last updated.

status

String

Status of the installation, provider dependent, like 'Active'.

subscriptions

Array

The type of notifications the device is subscribed to.

timeZone

String

The Time Zone ID of the device, ex: America/Vancouver.

userId

String

The user id that reported by the device.

Class: Installation Static Methods

Installation.findByApp(deviceType, appId, [appVersion], cb)

Find installations by application id/version

Arguments

Name

Type

Description

deviceType

String

The type of device (android, ios)

appId

String

The application id

[appVersion]

String

The application version

cb

function(Error|undefined, Array.<Installation>)

Callback function passed to find() with cb(err, obj[]) signature.

Installation.findBySubscriptions(deviceType, subscriptions, cb)

Find installations by subscriptions

Arguments

Name

Type

Description

deviceType

String

The type of device (android, ios)

subscriptions

String or Array.<String>

Either a comma/space delimited string or array of subscriptions

cb

function(Error|undefined, Array.<Installation>)

Callback function passed to find() with cb(err, obj[]) signature.

Installation.findByUser(deviceType, userId, cb)

Find installations by user id

Arguments

Name

Type

Description

deviceType

String

The type of device (android, ios)

userId

String

The user id

cb

function(Error|undefined, Array.<Installation>)

Callback function passed to find() with cb(err, obj[]) signature.

Class: Notification

Notification

Notification Model

See the official documentation for more details on provider-specific
properties.

An arbitrary string (such as "Updates Available") used to collapse a group of like messages when the device is offline,
so only the last message gets sent to the client (Android only).

created

Date

The date that the notification is created.

delayWhileIdle

Boolean

If the device is idle, do not send the message immediately. The server will wait for the device to become active, and then only the last message for
each collapse_key value will be sent (Android only).

deviceToken

String

The device token as provided by GCM or APN.

deviceType

String

The device type such as ios. Set to -1 to increment the current value by one (iOS only).

expirationInterval

Number

The expiration interval in seconds. The interval starts at the time when the notification is sent to the push notification provider.

expirationTime

Date

The time that the notification expires.

message

String

The notification's message (Android only - use alert on iOS).

modified

Date

The date that the notifcation is modified.

scheduledTime

Date

The time that the notification should be sent (not supported yet).

sound

String

The name of a sound file in the application bundle (iOS only).

status

String

Status of the notification (not supported yet).

Class: PushManager(settings)

The PushManager class.
See the options
for more information on the settings parameters.

Arguments

Name

Type

Description

settings

Object

The push settings.

settings

Name

Type

Description

ttlInSeconds

Number

Time-to-live, in seconds.

checkPeriodInSeconds

Number

A number in seconds for the automatic delete check interval

Class: PushManager Instance Methods

pushManager.configureApplication(appId, deviceType, cb)

Lookup or set up push notification service for the given appId

Arguments

Name

Type

Description

appId

String

The application id

deviceType

String

The type of device (android, ios)

cb

function(Error|undefined, Application)

Callback function called with cb(err, obj) signature.

pushManager.configureProvider(deviceType, pushSettings)

Configure push notification for a given device type. Return null when
no provider is registered for the device type.