Namespace: OpenEdge.Mobile
Class
PushNotificationService
Parent classes:
Progress.Lang.Object
OpenEdge.Mobile.PushNotificationService

Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.ISupportInitialize

Copyright (c) 2014, 2015, 2018 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
Purpose: Registry for mapping build types to their implementations




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 */
OpenEdge.Mobile.PushNotificationService Instance (URI, Credentials) /** Factory method for retrieving an instance of the server. @param URI A URI representing the notification server @param Credentials The (mandatory) Credentials to authenticate */
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). */
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 */
PushNotificationService (URI, Credentials) /** Constructor. @param URI A URI representing the notification server @param character The (mandatory) Credenatials to authenticate */

Property Summary
Options Name Purpose
CHARACTER ApiKey
OpenEdge.Net.HTTP.BuilderRegistry Registry
OpenEdge.Net.HTTP.IHttpClient RestClient
OpenEdge.Net.HTTP.Credentials ServerCredentials
OpenEdge.Net.URI ServerUri


Method Detail
Top

Destroy ()
/* Destroy/Shutdown/Anti-Initializer
Top

Initialize ()
/* Initializer/Startup
Top

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

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

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

OpenEdge.Mobile.PushNotificationService Instance (URI, Credentials)
Purpose: Factory method for retrieving an instance of the server.
Parameters:
poURI OpenEdge.Net.URI
pCredentials OpenEdge.Net.HTTP.Credentials
Returns OpenEdge.Mobile.PushNotificationService
Top

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

SendNotification (character, integer)
Purpose: Sends an immediate notification. Defaults to a no-filter query.
Parameters:
pcMessage CHARACTER
piBadge INTEGER
Top

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

PushNotificationService (URI, character)
Purpose: Constructor.
Parameters:
poURI OpenEdge.Net.URI
pcApiKey CHARACTER
Top

PushNotificationService (URI, Credentials)
Purpose: Constructor.
Parameters:
poURI OpenEdge.Net.URI
oCredentials OpenEdge.Net.HTTP.Credentials


Property Detail
Top

CHARACTER ApiKey
Returns CHARACTER
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry
Returns OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.IHttpClient RestClient
Returns OpenEdge.Net.HTTP.IHttpClient
Top

OpenEdge.Net.HTTP.Credentials ServerCredentials
Returns OpenEdge.Net.HTTP.Credentials
Top

OpenEdge.Net.URI ServerUri
Returns OpenEdge.Net.URI


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15