Namespace: OpenEdge.Mobile
Class
KinveyPushNotificationMessageBuilder
Parent classes:
Inherits: OpenEdge.Mobile.PushNotificationMessageBuilder

Copyright (c) 2018 by Progress Software Corporation. All rights reserved.
File:KinveyPushNotificationMessageBuilder
Author(s):htirunag
Created:Fri May 25 15:14:18 IST 2018




Method Summary
Options Name Purpose
OpenEdge.Mobile.PushNotificationMessageBuilder At (datetime-tz) /** UNSUPPORTED OPERATION Sets the time at which to schedule the notification. No-op if this is a send-immediate message. @param datetime-tz A time in the future (at least the following minute) at which to send the notification. @return PushNotificationMessageBuilder This builder */
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeChannels (JsonArray) /** UNSUPPORTED OPERATION Excludes the array of named channels. @param JsonArray An array of channels. @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeDevice (character) /** UNSUPPORTED OPERATION Exclude the device from the Push notification filter . @param character A device ID @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludePlatform (ApplicationPlatformEnum) /** UNSUPPORTED OPERATION Excludes the given platform (can be multiple) @param ApplicationPlatformEnum The mobile platform to include @return PushNotificationMessageBuilder The current builder */
OpenEdge.Mobile.PushNotificationMessageBuilder ExpiresAt (datetime-tz) /** UNSUPPORTED OPERATION Sets the time at which to scheduled notification expire. No-op if this is a send-immediate message. @param datetime-tz A time in the future (at least the following minute) at which to expire the notification. @return PushNotificationMessageBuilder This builder */
OpenEdge.Mobile.PushNotificationMessageBuilder IncludeChannels (JsonArray) /** UNSUPPORTED OPERATION Includes the array of named channels. @param JsonArray An array of channels. @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder IncludeDevice (character) /** UNSUPPORTED OPERATION Include the device in the Push notification filter . @param character A device ID @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder IncludePlatform (ApplicationPlatformEnum) /** UNSUPPORTED OPERATION Includes the given platform @param ApplicationPlatformEnum The mobile platform to include @return PushNotificationMessageBuilder The current builder */
OpenEdge.Mobile.PushNotificationMessageBuilder MatchAny () /* UNSUPPORTED OPERATION Sets the filter match operand to "Any". @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder MatchChannels (JsonArray) /** UNSUPPORTED OPERATION Filter for matching the array of named channels. @param JsonArray An array of channels. @return PushNotificationMessageBuilder This builder object */
Progress.Json.ObjectModel.JsonObject NewPayload () /** Returns a useable Payload based on the config. @return JsonObject A useable push notification message payload */
OpenEdge.Mobile.PushNotificationMessageBuilder NotOnDevice (character) /** UNSUPPORTED OPERATION Push notification for all devices except for the given device id @param character A device ID @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder NotOnPlatform (ApplicationPlatformEnum) /** UNSUPPORTED OPERATION Exclude only the specified platform from the notification. @param ApplicationPlatformEnum The mobile platform to include @return PushNotificationMessageBuilder The current builder */
OpenEdge.Mobile.PushNotificationMessageBuilder OnDevice (character) /** UNSUPPORTED OPERATION Push notification for the given device id only. @param character A device ID @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder OnPlatform (ApplicationPlatformEnum) /** UNSUPPORTED OPERATION Send the notification to only this platform. @param ApplicationPlatformEnum The mobile platform to include @return PushNotificationMessageBuilder The current builder */
OpenEdge.Mobile.PushNotificationMessageBuilder Titled (character) /* UNSUPPORTED OPERATION Sets the title of the notification message @param character The non-null title @return PushNotificationMessageBuilder This builder object */
OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone () /** UNSUPPORTED OPERATION Tells the notification to use the device's timezone (not the timezone of the scheduled time). No-op for a send-immediate message. @return PushNotificationMessageBuilder This builder */
OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone (logical) /** UNSUPPORTED OPERATION Tells the notification to use the device's timezone (not the timezone of the scheduled time). No-op for a send-immediate message. @param logical TRUE if we are to use the device time zone. @return PushNotificationMessageBuilder The current builder */

Property Summary
Options Name Purpose
Progress.Json.ObjectModel.JsonObject Payload


Method Detail
Top

OpenEdge.Mobile.PushNotificationMessageBuilder At (datetime-tz)

Purpose: UNSUPPORTED OPERATION
Sets the time at which to schedule the notification. No-op if this is a
send-immediate message.
at which to send the notification.
Parameters:
ptSendAt DATETIME-TZ
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeChannels (JsonArray)

Purpose: UNSUPPORTED OPERATION
Excludes the array of named channels.
Parameters:
poChannels Progress.Json.ObjectModel.JsonArray
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeDevice (character)

Purpose: UNSUPPORTED OPERATION
Exclude the device from the Push notification filter .
Parameters:
pcDeviceId CHARACTER
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder ExcludePlatform (ApplicationPlatformEnum)

Purpose: UNSUPPORTED OPERATION
Excludes the given platform (can be multiple)
Parameters:
poPlatform OpenEdge.Mobile.ApplicationPlatformEnum
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder The current builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder ExpiresAt (datetime-tz)

Purpose: UNSUPPORTED OPERATION
Sets the time at which to scheduled notification expire. No-op if this is a
send-immediate message.
at which to expire the notification.
Parameters:
ptExpireAt DATETIME-TZ
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder IncludeChannels (JsonArray)

Purpose: UNSUPPORTED OPERATION
Includes the array of named channels.
Parameters:
poChannels Progress.Json.ObjectModel.JsonArray
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder IncludeDevice (character)

Purpose: UNSUPPORTED OPERATION
Include the device in the Push notification filter .
Parameters:
pcDeviceId CHARACTER
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder IncludePlatform (ApplicationPlatformEnum)

Purpose: UNSUPPORTED OPERATION
Includes the given platform
Parameters:
poPlatform OpenEdge.Mobile.ApplicationPlatformEnum
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder The current builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder MatchAny ()

/* UNSUPPORTED OPERATION
Sets the filter match operand to "Any".
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder MatchChannels (JsonArray)

Purpose: UNSUPPORTED OPERATION
Filter for matching the array of named channels.
Parameters:
poChannels Progress.Json.ObjectModel.JsonArray
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

Progress.Json.ObjectModel.JsonObject NewPayload ()

Purpose: Returns a useable Payload based on the config.
Returns Progress.Json.ObjectModel.JsonObject
JsonObject A useable push notification message payload
Top

OpenEdge.Mobile.PushNotificationMessageBuilder NotOnDevice (character)

Purpose: UNSUPPORTED OPERATION
Push notification for all devices except for the given device id
Parameters:
pcDeviceId CHARACTER
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder NotOnPlatform (ApplicationPlatformEnum)

Purpose: UNSUPPORTED OPERATION
Exclude only the specified platform from the notification.
Parameters:
poPlatform OpenEdge.Mobile.ApplicationPlatformEnum
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder The current builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder OnDevice (character)

Purpose: UNSUPPORTED OPERATION
Push notification for the given device id only.
Parameters:
pcDeviceId CHARACTER
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder OnPlatform (ApplicationPlatformEnum)

Purpose: UNSUPPORTED OPERATION
Send the notification to only this platform.
Parameters:
poPlatform OpenEdge.Mobile.ApplicationPlatformEnum
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder The current builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder Titled (character)

/* UNSUPPORTED OPERATION
Sets the title of the notification message
Parameters:
pcTitle CHARACTER
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder object
Top

OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone ()

Purpose: UNSUPPORTED OPERATION
Tells the notification to use the device's timezone (not the timezone
of the scheduled time). No-op for a send-immediate message.
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder This builder
Top

OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone (logical)

Purpose: UNSUPPORTED OPERATION
Tells the notification to use the device's timezone (not the timezone
of the scheduled time). No-op for a send-immediate message.
Parameters:
plUseDeviceTimeZone LOGICAL
Returns OpenEdge.Mobile.PushNotificationMessageBuilder
PushNotificationMessageBuilder The current builder


Property Detail
Top

Progress.Json.ObjectModel.JsonObject Payload

Returns Progress.Json.ObjectModel.JsonObject


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15