|
Options |
Name |
Purpose |
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddArrayFilter (character, JsonConstruct, PushNotificationFilterOperandEnum)
|
/** General method to add array filters to the payload.
Supported operands: Includes/NotIncludes/Matches/Equals
@param character The name of the type of filter (type/deviceID/etc)
@param JsonConstruct The value to add. Could be Object (matches only)
or array (Includes/NotIncludes)
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddArrayFilter (character, JsonConstruct, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddDateFilter (character, datetime, PushNotificationFilterOperandEnum)
|
/** A general method to add Date filter values to the notification
query/filter.
Supported operands: eq/ne/gt/ge/lt/le/
@param character The filter name
@param datetime The filter value
@param PushNotificationFilterOperandEnum The operand (eg Equals or NotEqual)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddDateFilter (character, datetime, PushNotificationFilterOperandEnum)
|
|
|
|
AddFilter (JsonConstruct)
|
/* Adds a filter clause to the filter set.
@param JsonConstruct The filter data - an array or an object */
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddGeoFilter (character, JsonObject, PushNotificationFilterOperandEnum)
|
/** General method to add Geolocations filters to the payload. Note that the
objects required by the GEO type must have particular properties,
but this method only validates some of the properties.
Supported operands: near/nearSphere/within/Intersects
@param character The name of the type of filter (type/deviceID/etc)
@param JsonObject The value to add.
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddGeoFilter (character, JsonObject, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddLogicalFilter (character, logical, PushNotificationFilterOperandEnum)
|
/** A general method to add logical/boolean filter values to the notification
query/filter. Only Equals and NotEqual supported
@param character The filter name
@param logical The filter value
@param PushNotificationFilterOperandEnum The operand (eg Equals or NotEqual)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddLogicalFilter (character, logical, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddNumericFilter (character, decimal, PushNotificationFilterOperandEnum)
|
/** A general method to add numeric(decimal) filter values to the notification
query/filter.
Supported operands: eq/eq/gt/ge/lt/le/inc/ninc
@param character The filter name
@param decimal The filter value
@param PushNotificationFilterOperandEnum The operand (eg Equals or NotEqual)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddNumericFilter (character, decimal, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddObjectFilter (character, JsonConstruct, PushNotificationFilterOperandEnum)
|
/** General method to add object filters to the payload. Note that the
arrays required by Includes/NotIncludes must contain objects themselves,
but this method does NOT validate the contents of the array. The notification
service will do so.
Supported operands: Includes/NotIncludes/Equals/NotEqual
@param character The name of the type of filter (type/deviceID/etc)
@param JsonConstruct The value to add. Could be Object (EqualEquals/NotEqual )
or array (Includes/NotIncludes)
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddObjectFilter (character, JsonConstruct, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddPointerFilter (character, JsonObject, PushNotificationFilterOperandEnum)
|
/** UNSUPPORTED OPERATION
General method to add object filters to the payload. Note that the
objects required by the Pointer type must have particular properties,
but this method validates some of the properties.
@param character The name of the type of filter (type/deviceID/etc)
@param JsonObject The value to add.
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddPointerFilter (character, JsonObject, PushNotificationFilterOperandEnum)
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddStringFilter (character, character, PushNotificationFilterOperandEnum)
|
/** General method to add string/character filters to the payload.
Supported operands: Equals/NotEqual/Includes/NotIncludes
@param character The name of the type of filter (type/deviceID/etc)
@param character The value to add
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return PushNotificationMessageBuilder This builder object */
Overrides OpenEdge.Mobile.PushNotificationMessageBuilder:AddStringFilter (character, character, PushNotificationFilterOperandEnum)
|
|
|
|
LOGICAL AppendArrayCharacterValue (character, character)
|
/** Appends a character value to an array (convenience)
@param character The option name
@param character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder At (datetime-tz)
|
/** 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 */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Badges (integer)
|
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Build ()
|
/** 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.PushNotificationMessageBuilder
|
|
|
|
ClearOptions ()
|
/** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeChannels (JsonArray)
|
/** Excludes the array of named channels.
@param JsonArray An array of channels.
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludeDevice (character)
|
/** Exclude the device from the Push notification filter .
@param character A device ID
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder ExcludePlatform (ApplicationPlatformEnum)
|
/** Excludes the given platform (can be multiple)
@param ApplicationPlatformEnum The mobile platform to include
@return PushNotificationMessageBuilder The current builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder ExpiresAt (datetime-tz)
|
/** 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 */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
LOGICAL FindConfigRecord (buffer, character)
|
/** Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
@param buffer The buffer of the ConfigOption table.
@param character The config name
@return logical True if a config record was found. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
CHARACTER FormatDate (date)
|
/* Helper method to return date/time/-tz in a decent format
@param date A date value to format
@return character ISO-DATE format */
|
|
|
|
CHARACTER FormatDate (datetime)
|
/* Helper method to return date/time/-tz in a decent format
@param datetime A datetime value to format
@return character ISO-DATE format */
|
|
|
|
CHARACTER FormatDate (datetime-tz)
|
/* Helper method to return date/time/-tz in a decent format
@param datetime-tz A datetime-tz value to format
@return character ISO-DATE format */
|
|
|
|
Progress.Json.ObjectModel.JsonArray GetArrayProperty (JsonObject, character)
|
/** Returns an Array for the property, even if another value was previously
set.
@param JsonObject The parent
@param character The property name
@return JsonArray The corresponding property's value (always JsonArray) */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
Progress.Json.ObjectModel.JsonObject GetObjectProperty (JsonObject, character)
|
/** Returns an object for the property, even if another value was previously
set.
@param JsonObject The parent
@param character The property name
@return JsonObject The corresponding property's value (always JsonObject) */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
DATETIME-TZ GetOptionDateTimeValue (character)
|
/** Returns an option's datetime value
@param character The option name
@return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL GetOptionLogicalValue (character)
|
/** Returns an option's logical value
@param character The option name
@return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LONGCHAR GetOptionLongcharValue (character)
|
/** Returns an option's longchar value
@param character The option name
@return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
DECIMAL GetOptionNumericValue (character)
|
/** Returns an option's decimal value
@param character The option name
@return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
Object GetOptionObjectValue (character)
|
/** Returns an option's object value
@param character The option name
@return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
CHARACTER GetOptionStringArrayValue (character)
|
/** Returns an option's character array value
@param character The option name
@return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
CHARACTER GetOptionStringValue (character)
|
/** Returns an option's character value
@param character The option name
@return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL HasOption (character)
|
/** Checks whether a config option already exists
@param character The option name
@return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder IncludeChannels (JsonArray)
|
/** Includes the array of named channels.
@param JsonArray An array of channels.
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder IncludeDevice (character)
|
/** Include the device in the Push notification filter .
@param character A device ID
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder IncludePlatform (ApplicationPlatformEnum)
|
/** Includes the given platform
@param ApplicationPlatformEnum The mobile platform to include
@return PushNotificationMessageBuilder The current builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder MatchAll ()
|
/* Sets the filter match operand to "All".
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder MatchAny ()
|
/* Sets the filter match operand to "Any".
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder MatchChannels (JsonArray)
|
/** Filter for matching the array of named channels.
@param JsonArray An array of channels.
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Message (character)
|
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
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)
|
/** Push notification for all devices except for the given device id
@param character A device ID
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder NotOnPlatform (ApplicationPlatformEnum)
|
/** Exclude only the specified platform from the notification.
@param ApplicationPlatformEnum The mobile platform to include
@return PushNotificationMessageBuilder The current builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder OnDevice (character)
|
/** Push notification for the given device id only.
@param character A device ID
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder OnPlatform (ApplicationPlatformEnum)
|
/** Send the notification to only this platform.
@param ApplicationPlatformEnum The mobile platform to include
@return PushNotificationMessageBuilder The current builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
LOGICAL RemoveOption (character)
|
/** Removes an option
@param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Schedule (character, integer)
|
/** Factory for this builder, for messages to schedule for future sending
@param character The message text to be sent.
@param integer The badge counter (only used for iOS).
@return PushNotificationMessageBuilder The new builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Send (character, integer)
|
/** Factory for this builder, for messages to send immediately.
@param character The message text to be sent.
@param integer The badge counter (only used for iOS).
@return PushNotificationMessageBuilder The new builder */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder SendNow (logical)
|
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
LOGICAL SetOption (character, character)
|
/** Stores an value as an option
@param character The option name
@param character the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, character[])
|
/** Stores an value as an option
@param character The option name
@param character the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, datetime-tz)
|
/** Stores a datetime-tzvalue as an option
@param character The option name
@param datetime-tz the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, decimal)
|
/** Stores an numeric value as an option
@param character The option name
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, logical)
|
/** Stores a logical value as an option
@param character The option name
@param logical the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (character, Object)
|
/** Stores an object value as an option
@param character The option name
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
LOGICAL SetOption (Class, Object)
|
/** Stores an object value as an option
@param Progress.Lang>Class The option name (as a type)
@param Object the value
@return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder Titled (character)
|
/* Sets the title of the notification message
@param character The non-null title
@return PushNotificationMessageBuilder This builder object */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone ()
|
/** 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 */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|
|
|
|
OpenEdge.Mobile.PushNotificationMessageBuilder UseDeviceTimeZone (logical)
|
/** 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 */
Inherited from OpenEdge.Mobile.PushNotificationMessageBuilder
|