Namespace: OpenEdge.Mobile
Class 
TelerikPushNotificationAdmin
Parent classes:
Inherits: OpenEdge.Mobile.TelerikPushNotificationService

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:TelerikPushNotificationAdmin
Purpose:Adminstrative service for Telerik Push services
Author(s):pjudge
Created:Tue Apr 07 13:49:22 EDT 2015
Notes:* this class must be manually instantiated; it is not registered
in the PushNotificationService:Registry




Method Summary
Options Name Purpose
# DeleteNotification (character) /** Deletes a notification from the server @param character The id of the notification to delete */
# Destroy () /* Destroy/Shutdown/Anti-Initializer */
Inherited from OpenEdge.Mobile.PushNotificationService
# INTEGER GetDeviceCount () /** Returns the count of all devices that are currently registered for push notifications with Telerik Backend Services @return integer The count of devices */
# Progress.Json.ObjectModel.JsonObject GetDevices () /** Returns all devices for a user's master key per the provided filter @return JsonObject The notifications returned. Errors are raised otherwise */
# Progress.Json.ObjectModel.JsonObject GetDevices (JsonObject) /** Returns all devices for a user's master key per the provided filter @param JsonObject JSON representation of a filter @return JsonObject The notifications returned. Errors are raised otherwise */
# Progress.Json.ObjectModel.JsonObject GetNotifications () /** Returns all notifications for a user's master key @return JsonObject The notifications returned. Errors are raised otherwise */
# Progress.Json.ObjectModel.JsonObject GetNotifications (JsonObject) /** Returns all notifications for a user's master key per the provided filter @param JsonObject JSON representation of a filter @return JsonObject The notifications returned. Errors are raised otherwise */
# Initialize () /* Initializer/Startup */
Overrides OpenEdge.Mobile.PushNotificationService:Initialize ()
+ InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
Inherited from OpenEdge.Mobile.PushNotificationService
# 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
# 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
# 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
# A 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.TelerikPushNotificationService:SendNotification (JsonObject)
# UpdateNotification (character, JsonObject) /** Updates a notification on the server @param character The id of the notification to update @param JsonObject A new set of properties to apply to the notification. The structure of these notification messages is at http://docs.telerik.com/platform/backend-services/features/push-notifications/structure */

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

Property Summary
Options Name Purpose
# CHARACTER ApiKey /** (mandatory) The API key for the push notification */
Inherited from OpenEdge.Mobile.PushNotificationService
# CHARACTER MasterKey /** (mandatory) The API key for the push notification */
# 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


Method Detail
Top

PROTECTED DeleteNotification (character)

Purpose: Deletes a notification from the server
Parameters:
pcNotificationId CHARACTER
Top

PROTECTED Destroy ()

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

PROTECTED INTEGER GetDeviceCount ()

Purpose: Returns the count of all devices that are currently registered for push notifications with
Telerik Backend Services
Returns INTEGER
integer The count of devices
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetDevices ()

Purpose: Returns all devices for a user's master key per the provided
filter
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The notifications returned. Errors are raised otherwise
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetDevices (JsonObject)

Purpose: Returns all devices for a user's master key per the provided
filter
Parameters:
poFilter Progress.Json.ObjectModel.JsonObject
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The notifications returned. Errors are raised otherwise
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetNotifications ()

Purpose: Returns all notifications for a user's master key
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The notifications returned. Errors are raised otherwise
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetNotifications (JsonObject)

Purpose: Returns all notifications for a user's master key per the provided
filter
Parameters:
poFilter Progress.Json.ObjectModel.JsonObject
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The notifications returned. Errors are raised otherwise
Top

PROTECTED Initialize ()

Overrides OpenEdge.Mobile.PushNotificationService:Initialize ()
/* Initializer/Startup
Top

PUBLIC InitializeRegistry (BuilderRegistry)

Inherited from OpenEdge.Mobile.PushNotificationService
Purpose: Adds initial values into the registry
Parameters:
poRegistry BuilderRegistry
Top

PROTECTED PushNotificationService Instance (character)

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

PROTECTED 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 PushNotificationService
Top

PROTECTED 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

PROTECTED 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

PROTECTED JsonConstruct SendNotification (JsonObject)

Overrides OpenEdge.Mobile.TelerikPushNotificationService: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 JsonConstruct
JsonConstruct The result of the request. Can be an object or array,
Top

PROTECTED UpdateNotification (character, JsonObject)

Purpose: Updates a notification on the server
The structure of these notification messages is at
http://docs.telerik.com/platform/backend-services/features/push-notifications/structure
Parameters:
pcNotificationId CHARACTER
poUpdateValue Progress.Json.ObjectModel.JsonObject


Constructor Detail
Top

PROTECTED TelerikPushNotificationAdmin (character, character)

Purpose: Constructor.
Parameters:
pcApiKey CHARACTER
pcMasterKey CHARACTER
Top

PROTECTED TelerikPushNotificationAdmin (URI, character, character)

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


Property Detail
Top

PROTECTED CHARACTER ApiKey

Inherited from OpenEdge.Mobile.PushNotificationService
Purpose: (mandatory) The API key for the push notification
Returns CHARACTER
Top

PROTECTED CHARACTER MasterKey

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

PROTECTED BuilderRegistry Registry

Inherited from OpenEdge.Mobile.PushNotificationService
Purpose: Registry for mapping build types to their implementations
Returns BuilderRegistry
Top

PROTECTED OpenEdge.Net.URI ServerUri

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


10.27.2015 12:36:33