Namespace: OpenEdge.Mobile
Type: Class TelerikPushNotificationAdmin
Parent Classes:
Progress.Lang.Object
OpenEdge.Mobile.PushNotificationService
OpenEdge.Mobile.TelerikPushNotificationService
OpenEdge.Mobile.TelerikPushNotificationAdmin

Inherits: OpenEdge.Mobile.TelerikPushNotificationService

Copyright (c) 2015, 2021 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
Purpose: (mandatory) The API key for the push notification



Method Summary
  Options Name Purpose
  DeleteNotification (character) /** Deletes a notification from the server @param character The id of the notification to delete */
  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 */
  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 MasterKey


Method Detail
Top

DeleteNotification (character)

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

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

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

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

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

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

Initialize ()

/* Initializer/Startup
Top

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

TelerikPushNotificationAdmin (character, character)

Purpose: Constructor.
Parameters:
pcApiKey CHARACTER
 
pcMasterKey CHARACTER
 
Top

TelerikPushNotificationAdmin (URI, character, character)

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


Property Detail
Top

CHARACTER MasterKey

Returns CHARACTER