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

Inherits: OpenEdge.Mobile.PushNotificationService

Copyright (c) 2018 by Progress Software Corporation. All rights reserved.
File:KinveyPushNotificationService
Author(s):htirunag
Created:Fri May 25 12:46:01 IST 2018
Purpose: Constructor.




Method Summary
Options Name Purpose
Destroy () /* Destroy/Shutdown/Anti-Initializer */
Inherited from OpenEdge.Mobile.PushNotificationService
Initialize () /* Initializer/Startup */
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
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 */
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. @return JsonConstruct The result of the request. Can be an object or array, depending on success or failure. */
Overrides OpenEdge.Mobile.PushNotificationService:SendNotification (JsonObject)

Constructor Summary
Options Name Purpose
KinveyPushNotificationService (character) /** Constructor. @param character An API key for this service. This is the base64-encoded username/password for HTTP Basic authorization */
KinveyPushNotificationService (character, character, Credentials) /** Factory method for retrieving an instance of the server. @param URI A URI representing the notification server @param character A (mandatory) ApplicationName representing the Kinvey @param character A (mandatory) CustomEndpointName representing the Kinvey @param Credentials The (mandatory) Credentials to authenticate */
KinveyPushNotificationService (URI, character) /** Constructor. @param URI A URI representing the notification server @param character An API key for this service. This is the base64-encoded username/password for HTTP Basic authorization. */
KinveyPushNotificationService (URI, Credentials) /** Constructor. @param URI A URI representing the notification server @param Credentials The (mandatory) Credentials to authenticate */

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


Method Detail
Top

PUBLIC Destroy ()
Inherited from OpenEdge.Mobile.PushNotificationService
/* Destroy/Shutdown/Anti-Initializer
Top

PUBLIC Initialize ()
Inherited from OpenEdge.Mobile.PushNotificationService
/* Initializer/Startup
Top

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

PUBLIC OpenEdge.Mobile.PushNotificationService Instance (URI, character)
Inherited from OpenEdge.Mobile.PushNotificationService
Purpose: Factory method for retrieving an instance of the server.
Parameters:
poURI OpenEdge.Net.URI
pcApiKey CHARACTER
Returns OpenEdge.Mobile.PushNotificationService
Top

PUBLIC OpenEdge.Mobile.PushNotificationService Instance (URI, Credentials)
Inherited from OpenEdge.Mobile.PushNotificationService
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

PROTECTED ProcessResponse (IHttpResponse)
Purpose: Processes a response from the Notification service. Creates and throws
a NotificationServiceError if necessary.
@throws NotificationServiceError Throws an error if the return code is
not 200 or 204
Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
Top

PUBLIC ScheduleNotification (character, integer, datetime-tz, logical)
Inherited from OpenEdge.Mobile.PushNotificationService
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

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

PUBLIC Progress.Json.ObjectModel.JsonConstruct SendNotification (JsonObject)
Overrides OpenEdge.Mobile.PushNotificationService: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

PUBLIC KinveyPushNotificationService (character)
Purpose: Constructor.
Parameters:
pcApiKey CHARACTER
Top

PUBLIC KinveyPushNotificationService (character, character, Credentials)
Purpose: Factory method for retrieving an instance of the server.
Parameters:
pApplicationName CHARACTER
pCustomEndpoint CHARACTER
pCredentials OpenEdge.Net.HTTP.Credentials
Top

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

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


Property Detail
Top

PUBLIC CHARACTER ApiKey
Inherited from OpenEdge.Mobile.PushNotificationService
Returns CHARACTER
Top

PUBLIC BuilderRegistry Registry
Inherited from OpenEdge.Mobile.PushNotificationService
Returns BuilderRegistry
Top

PROTECTED IHttpClient RestClient
Inherited from OpenEdge.Mobile.PushNotificationService
Returns IHttpClient
Top

PUBLIC OpenEdge.Net.HTTP.Credentials ServerCredentials
Inherited from OpenEdge.Mobile.PushNotificationService
Returns OpenEdge.Net.HTTP.Credentials
Top

PUBLIC OpenEdge.Net.URI ServerUri
Inherited from OpenEdge.Mobile.PushNotificationService
Returns OpenEdge.Net.URI


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0