|
Options |
Name |
Purpose |
|
#
|
OpenEdge.Mobile.PushNotificationMessageBuilder AddArrayFilter (character, JsonConstruct, PushNotificationFilterOperandEnum)
|
/** General method to add array filters to the payload.
Supported operands: Includes/NotIncludes/Matches
@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)
|
|
#
|
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
@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)
|
/** 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.
Supported operands: Equals/NotEqual
@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)
|
|
#
|
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
|
|
#
|
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 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 MatchChannels (JsonObject)
|
/** 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
|
|
#
|
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
|
|
#
|
OpenEdge.Mobile.PushNotificationMessageBuilder Titled (character)
|
/** CHANNELS END **/ 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
|
|
+
|
LOGICAL ValidateOperand (JsonObject, character, PushNotificationFilterOperandEnum)
|
/** Validates the incoming operand with any existing operand. The operand
cannot be changed once set.
@param JsonObject The object representing the 'filter' property.
@param character The name of the type of filter (type/deviceID/etc)
@param PushNotificationFilterOperandEnum The operand (eq/ne/etc)
@return logical True if a filter already exists */
|