OpenEdge Corelib and Netlib Libraries

Namespace:

OpenEdge.Mobile

Class

ApperyPushNotificationService

Parent classes:

Progress.Lang.Object

OpenEdge.Mobile.PushNotificationService

OpenEdge.Mobile.ApperyPushNotificationService

Inherits:

OpenEdge.Mobile.PushNotificationService

	Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:	ApperyPushNotificationService
Purpose:	Sends push notifications to a device or devices.
Author(s):	pjudge
Created:	Mon Feb 10 16:41:36 EST 2014
Notes:	* Doc at http://docs.mobile.rollbase.com/documentation/backendservices/push/
	requests, see the JSON generated when using the
	"Devices filtered using query builder" functionality in the
	Push Notifications / Send push notification page at
	https://mobile.rollbase.com/push/.
	to the according URL. �filter� is the optional parameter, when
	it�s empty Push Notification is sent to all devices.
	�schedule� is the optional parameter, when it�s not empty
	Push Notification can be scheduled.
	curl -X POST \
	-H "X-Appery-Push-API-Key:<pushAPIKey>" \
	-H "Content-Type: application/json" \
	-d '{"payload":{"message" : <message>, "badge" : <badge>}[, "filter" : {"deviceID" : <deviceID criteria>,"<param1>" : <criteria>, ...}][, "schedule": {"scheduledTime": <scheduled_time>, "useTimeZone": <use_time_zone>}]}' \
	https://api.appery.io/rest/push/msg
	where:
	<pushAPIKey> is a unique key, issued by server, which allows sending Push Notifications;
	<message> is the message text (mandatory);
	<badge> is the number shown with app icon in iOS (optional, if empty - badge is not changed on device);
	<deviceID criteria> is deviceID criteria for searching device;
	<param1> is a custom field of _devices table;
	<criteria> is param1 criteria for searching device;
	<scheduled_time> is the date when Push Notification should be sent (it is always truncated to minute);
	<use_time_zone> is a boolean parameter indicating whether Push Notification should be sent in device time zone.
	If Push Notification is scheduled, server returns HTTP 200 and list of saved Push Notifications, else server returns HTTP 204 NO CONTENT status even if no messages were sent or delivered.
	Error HTTP Code Description
	Push API Key not found 404 PNMM004 Master Key: <pushAPIKey> not found
	Empty message 400 PNMM017 Message can�t be empty
	Badge negative 400 PNMM062 Badge cannot be negative
	No iOS certificate 400 PNMM082 iOS Push certificate is not set
	No android API key 400 PNMM084 Android API key is not set
	No iOS certificate password 400 PNMM085 iOS Push certificate password is not set

Options	Name	Purpose
#	Destroy ()	/* Destroy/Shutdown/Anti-Initializer / Inherited from OpenEdge.Mobile.PushNotificationService*
#	Initialize ()	/* Initializer/Startup / Inherited from OpenEdge.Mobile.PushNotificationService*
+	InitializeRegistry (BuilderRegistry)	/** Adds initial values into the registry @param BuilderRegistry The registry to populate / Inherited from OpenEdge.Mobile.PushNotificationService*
#	OpenEdge.Mobile.PushNotificationService Instance (character)	/** Factory method for retrieving an instance of the server. @param character The (mandatory) API key to enable notifications / Inherited from OpenEdge.Mobile.PushNotificationService*
#	OpenEdge.Mobile.PushNotificationService Instance (URI, character)	/** Factory method for retrieving an instance of the server. @param URI A URI representing the notification server @param character The (mandatory) API key to enable notifications / Inherited from OpenEdge.Mobile.PushNotificationService*
	ProcessResponse (IHttpResponse)	/** Processes a response from the Notification service. Creates and throws a NotificationServiceError if necessary. @param HttpResponse The result of the REST request. @throws NotificationServiceError Throws an error if the return code is not 200 or 204 */
#	ScheduleNotification (character, integer, datetime-tz, logical)	/** Sends an immediate notification. Defaults to a no-filter query. @param character The message to be sent. @param integer The badge counter (only used for iOS). @param datetime-tz The time at which to send the notification @param logical Whether the notification should be sent at that time in a particular timezone, or at that time in the device's timezone. / Inherited from OpenEdge.Mobile.PushNotificationService*
#	SendNotification (character, integer)	/** Sends an immediate notification. Defaults to a no-filter query. @param character The message to be sent. @param integer The badge counter (only used for iOS). / Inherited from OpenEdge.Mobile.PushNotificationService*
#	Progress.Json.ObjectModel.JsonConstruct SendNotification (JsonObject)	/** Sends a notification for a given payload. The payload may be built by one of the methods in this class, or created by the PushNotificationMessageBuilder class (which is also used internally). This method performs the actual request to the Notification Service. @param JsonObject The notification payload. / Overrides OpenEdge.Mobile.PushNotificationService:SendNotification (JsonObject)*

Options

Name

Purpose

Destroy ()

/* Destroy/Shutdown/Anti-Initializer */
Inherited from OpenEdge.Mobile.PushNotificationService

Initialize ()

/* Initializer/Startup */
Inherited from OpenEdge.Mobile.PushNotificationService

InitializeRegistry (BuilderRegistry)

/** Adds initial values into the registry @param BuilderRegistry The registry to populate */
Inherited from OpenEdge.Mobile.PushNotificationService

OpenEdge.Mobile.PushNotificationService Instance (character)

/** Factory method for retrieving an instance of the server. @param character The (mandatory) API key to enable notifications */
Inherited from OpenEdge.Mobile.PushNotificationService

OpenEdge.Mobile.PushNotificationService Instance (URI, character)

/** Factory method for retrieving an instance of the server. @param URI A URI representing the notification server @param character The (mandatory) API key to enable notifications */
Inherited from OpenEdge.Mobile.PushNotificationService

ProcessResponse (IHttpResponse)

/** Processes a response from the Notification service. Creates and throws a NotificationServiceError if necessary. @param HttpResponse The result of the REST request. @throws NotificationServiceError Throws an error if the return code is not 200 or 204 */

ScheduleNotification (character, integer, datetime-tz, logical)

/** Sends an immediate notification. Defaults to a no-filter query. @param character The message to be sent. @param integer The badge counter (only used for iOS). @param datetime-tz The time at which to send the notification @param logical Whether the notification should be sent at that time in a particular timezone, or at that time in the device's timezone. */
Inherited from OpenEdge.Mobile.PushNotificationService

SendNotification (character, integer)

/** Sends an immediate notification. Defaults to a no-filter query. @param character The message to be sent. @param integer The badge counter (only used for iOS). */
Inherited from OpenEdge.Mobile.PushNotificationService

Progress.Json.ObjectModel.JsonConstruct SendNotification (JsonObject)

/** Sends a notification for a given payload. The payload may be built by one of the methods in this class, or created by the PushNotificationMessageBuilder class (which is also used internally). This method performs the actual request to the Notification Service. @param JsonObject The notification payload. */
Overrides OpenEdge.Mobile.PushNotificationService:SendNotification (JsonObject)

	Options	Name	Purpose
	#	ApperyPushNotificationService (character)	/** Constructor. @param character The (mandatory) API key to enable notifications */
	#	ApperyPushNotificationService (URI, character)	/** Constructor. @param URI A URI representing the notification server @param character The (mandatory) API key to enable notifications */

Options

Name

Purpose

ApperyPushNotificationService (character)

/** Constructor. @param character The (mandatory) API key to enable notifications */

ApperyPushNotificationService (URI, character)

/** Constructor. @param URI A URI representing the notification server @param character The (mandatory) API key to enable notifications */

Options	Name	Purpose
#	CHARACTER ApiKey	/** (mandatory) The API key for the push notification / Inherited from OpenEdge.Mobile.PushNotificationService*
#	BuilderRegistry Registry	/** Registry for mapping build types to their implementations / Inherited from OpenEdge.Mobile.PushNotificationService*
#	OpenEdge.Net.URI ServerUri	/** (mandatory) The host/URI of the notification service / Inherited from OpenEdge.Mobile.PushNotificationService*

Options

Name

Purpose

CHARACTER ApiKey

/** (mandatory) The API key for the push notification */
Inherited from OpenEdge.Mobile.PushNotificationService

BuilderRegistry Registry

/** Registry for mapping build types to their implementations */
Inherited from OpenEdge.Mobile.PushNotificationService

OpenEdge.Net.URI ServerUri

/** (mandatory) The host/URI of the notification service */
Inherited from OpenEdge.Mobile.PushNotificationService

PROTECTED Destroy ()

PROTECTED Initialize ()

PUBLIC InitializeRegistry (BuilderRegistry)

PROTECTED OpenEdge.Mobile.PushNotificationService Instance (character)

PROTECTED OpenEdge.Mobile.PushNotificationService Instance (URI, character)

ProcessResponse (IHttpResponse)

PROTECTED ScheduleNotification (character, integer, datetime-tz, logical)

PROTECTED SendNotification (character, integer)

PROTECTED Progress.Json.ObjectModel.JsonConstruct SendNotification (JsonObject)

PROTECTED ApperyPushNotificationService (character)

PROTECTED ApperyPushNotificationService (URI, character)

PROTECTED CHARACTER ApiKey

PROTECTED BuilderRegistry Registry

PROTECTED OpenEdge.Net.URI ServerUri