Namespace: OpenEdge.Mobile
Class 
PushNotificationService
Parent classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.ISupportInitialize
ABSTRACT

Copyright (c) 2014, 2015 by Progress Software Corporation. All rights reserved.
File:PushNotificationService
Purpose:Sends push notifications to a device or devices.
Author(s):pjudge
Created:Mon Feb 10 16:41:36 EST 2014




Method Summary
Options Name Purpose
# Destroy () /* Destroy/Shutdown/Anti-Initializer */
# Initialize () /* Initializer/Startup */
+ InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
# OpenEdge.Mobile.PushNotificationService Instance (character) /** Factory method for retrieving an instance of the server. @param character The (mandatory) API key to enable notifications */
# 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 */
# 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. */
# 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). */
# A 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. @return JsonConstruct The result of the request. Can be an object or array, depending on success or failure. */

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

Property Summary
Options Name Purpose
# CHARACTER ApiKey /** (mandatory) The API key for the push notification */
# OpenEdge.Net.HTTP.BuilderRegistry Registry /** Registry for mapping build types to their implementations */
OpenEdge.Net.HTTP.IHttpClient RestClient /* The library doing the actual work */
# OpenEdge.Net.URI ServerUri /** (mandatory) The host/URI of the notification service */


Method Detail
Top

PROTECTED Destroy ()

/* Destroy/Shutdown/Anti-Initializer
Top

PROTECTED Initialize ()

/* Initializer/Startup
Top

PUBLIC InitializeRegistry (BuilderRegistry)

Purpose: Adds initial values into the registry
Parameters:
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
Top

PROTECTED OpenEdge.Mobile.PushNotificationService Instance (character)

Purpose: Factory method for retrieving an instance of the server.
Parameters:
pcApiKey CHARACTER
Returns OpenEdge.Mobile.PushNotificationService
Top

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

Purpose: Factory method for retrieving an instance of the server.
Parameters:
poURI OpenEdge.Net.URI
pcApiKey CHARACTER
Returns OpenEdge.Mobile.PushNotificationService
Top

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

Purpose: Sends an immediate notification. Defaults to a no-filter query.
in a particular timezone, or at that time in the
device's timezone.
Parameters:
pcMessage CHARACTER
piBadge INTEGER
ptSendAt DATETIME-TZ
plUseDeviceTimeZone LOGICAL
Top

PROTECTED SendNotification (character, integer)

Purpose: Sends an immediate notification. Defaults to a no-filter query.
Parameters:
pcMessage CHARACTER
piBadge INTEGER
Top

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

Purpose: 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.
depending on success or failure.
Parameters:
poPayload Progress.Json.ObjectModel.JsonObject
Returns Progress.Json.ObjectModel.JsonConstruct
JsonConstruct The result of the request. Can be an object or array,


Constructor Detail
Top

PROTECTED PushNotificationService (URI, character)

Purpose: Constructor.
Parameters:
poURI OpenEdge.Net.URI
pcApiKey CHARACTER


Property Detail
Top

PROTECTED CHARACTER ApiKey

Purpose: (mandatory) The API key for the push notification
Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.BuilderRegistry Registry

Purpose: Registry for mapping build types to their implementations
Returns OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.IHttpClient RestClient

/* The library doing the actual work
Returns OpenEdge.Net.HTTP.IHttpClient
Top

PROTECTED OpenEdge.Net.URI ServerUri

Purpose: (mandatory) The host/URI of the notification service
Returns OpenEdge.Net.URI


10.27.2015 12:36:32