Attribute operation.
Registration updated delegate.
Attribute queue results delegate.
Event queue results delegate.
Inbox messages results delegate.
IBM Mobile Push interface
This class stores, manages and executes InApp messages.
This property returns a singleton object for the manager.
This method will find the next InApp message with the specified rule to be displayed and execute it.
rules: A list of rules to look for.
frame: The current apps Frame object to insert the message on to.
This method will delete an InApp message before it is expired or overviewed
message: Message to be deleted.
Class representing a single InAppMessage
Unique primary key for identifying InAppMessages
Template name to be used to display message.
Maximum number of views for the message.
The number of times the message has been shown to the user.
The Unix timestamp that the message should start showing up.
TriggerTimestamp in ISO8601 format
TriggerTimestamp in DateTimeOffset format
The campaign name associated with this InApp message
Json formatted string representing rich content, template developer defined.
JsonArray of Rules for this message.
This property returns the Content property in the form of a JsonObject.
Unique primary key for identifying InAppMessages
Gets or sets the in app message identifier.
The in app message identifier.
Gets or sets the in app rule identifier.
The in app rule identifier.
This method returns true if the InAppMessage is triggered, false otherwise.
Return Value:
Empty default constructor
JsonObject to InAppMessage parser/constructor.
jsonObject:
Initializes a new instance of the See: T:IBMMobilePush.Forms.InAppMessageRule class.
Initializes a new instance of the See: T:IBMMobilePush.Forms.InAppMessageRule class.
inAppMessageId: In app message identifier.
inAppRuleId: In app rule identifier.
Class to register InApp templates with.
This property returns a singleton object for the registry.
Register template handler with registry to be used to display InboxMessage previews and messages.
template: Template handler.
templateName: Template name.
Retrieve registered handler for template name.
templateName: Template name.
Return Value: InboxTemplate registered for specified template name.
Inbox message.
Gets or sets the inbox message identifier.
The inbox message identifier.
Gets or sets the rich content identifier.
The rich content identifier.
Gets or sets the expiration date.
The expiration date.
Gets or sets the send date.
The send date.
Gets or sets the name of the template.
The name of the template.
Gets or sets the attribution or campaign name.
The attribution.
Gets or sets a value indicating whether this instance is read.
true
if this instance is read; otherwise, false
.
Gets or sets a value indicating whether this instance is deleted.
true
if this instance is deleted; otherwise, false
.
Initializes a new instance of the See: T:IBMMobilePush.Forms.InboxMessage class.
Rich content of Inbox Message.
Gets or sets the rich content identifier.
The rich content identifier.
Gets or sets the content.
The content.
Initializes a new instance of the See: T:IBMMobilePush.Forms.RichContent class.
Interface for inbox templates.
Push action base abstract class.
Handles the action.
action: Action as a JSON Object.
payload: Entire payload as a JSON Object.
attribution: Attribution or campaign name of sending push.
id: Push identifier used only in Android to remove a notification already sent.
IBMMobilePush SDK Main forms interface class.
The logging level for C# code. Not currently connected to specified logging level in MceConfig.json.
Gets or sets the registration updated callback delegate.
The registration updated.
Gets or sets the attribute queue callback delegate.
The attribute queue results.
Gets or sets the event queue result delegate.
The event queue results.
Gets or sets the badge.
The badge.
Gets or sets the icon used in pushed messages.
The icon.
Gets or sets the inbox messages update callback delegate.
The inbox messages update.
UserId for current user.
Return Value: UserId
ChannelId for the current device.
Return Value: ChannelId
Application AppKey currently in use.
Return Value: AppKey
Native SDK Version number.
Replace current user attributes with specified attribute.
key: Key.
value: Value.
callback: Callback.
Add or replace specified user attribute.
key: Key.
value: Value.
callback: Callback.
Delete specified user attribute.
key: Key.
callback: Callback.
Replace current channel attributes with specified attribute.
key: Key.
value: Value.
callback: Callback.
Add or replace specified channel attribute.
key: Key.
value: Value.
callback: Callback.
Delete specified channel attribute.
key: Key.
callback: Callback.
Queue replacement of current user attributes with specified attribute.
key: Key.
value: Value.
Queue adding or replacing specified user attribute.
key: Key.
value: Value.
Queue removal of sepcified user attribute.
key: Key.
Queue replacement of current channel attributes with specified attribute.
key: Key.
value: Value.
Queue adding or replacing specified channel attribute.
key: Key.
value: Value.
Queue removal of sepcified channel attribute.
key: Key.
Add event to event queue to be sent to the server.
name: Name.
type: Type.
timestamp: Timestamp.
attribution: Attribution.
attributes: Attributes.
flush: If set to true
flush.
Send event to server.
name: Name.
type: Type.
timestamp: Timestamp.
attribution: Attribution.
attributes: Attributes.
callback: Callback.
Flushs the queued event queue to server.
Query if SDK has registered with MCE server.
Return Value: true
if registered with MCE; otherwise, false
.
Query if device has registered with push provider.
Return Value: true
if this device has registered with push provider; otherwise, false
.
Query if device has registered with push provider and SDK is registered with MCE.
Return Value: true
if this instance is registered with MCE and Push Provider; otherwise, false
.
Registers a custom action handler.
name: Name.
handler: Handler.
Executes SDK phone home immediately, useful after login / user merge.
Syncs the inbox messages with server.
Fetchs the RichContent for a specified richContentId.
richContentId: Rich content identifier.
Return Value: The rich content.
Fetchs the inbox message using a specified inboxMessageId.
inboxMessageId: Inbox message identifier.
callback: Callback.
Deletes the specified inbox message.
message: Message.
Sets the read status to true for specified inbox message.
message: Message.
Fetchs the inbox message for the specified richContentId.
richContentId: Rich content identifier.
callback: Callback.
Fetchs the inbox messages from the database.
completion: Completion.
ascending: If set to true
ascending.
Get current status bar height.
Return Value: The bar height.
Get current screen size.
Return Value: The size.
Get SQLite connection for specifed filename.
filename: Filename.
Return Value: The connection.
Deletes specified InApp message.
inAppMessage: In app message.
Execute next InApp message that has any of specified rules.
rules: Rules.
Register an InApp template.
templateName: Template name.
template: Template.
Executes the specified Action.
action: Action.
attribution: Attribution.
source: Source.
Executes the specified inbox action.
action: Action.
attribution: Attribution.
Executes the specfied InApp action.
action: Action.
attribution: Attribution.
Registers the specified inbox template handler for the specified name.
templateName: Template name.
template: Template.
Return the registered template handler for the speicifed name.
templateName: Template name.
Return Value: The inbox template.
Database base class.
Base class for all messages that can expire after a specific time has passed (such as Inbox and InApp messages).
The Unix timestamp that the message shouldn't show up after.
ExpirationTimestamp in ISO8601 format
ExpirationTimestamp in DateTimeOffset format
This method returns true if the Message is expired, false otherwise.
Return Value:
This enumerated type represents logging levels.
This value represents no logging.
This value represents logging only error messages.
This value represents logging error and warning messages.
This value represents logging error, warning and info messages.
This value represents all logging turned on.
Logging.
Error the specified message.
message: Message.
Error the specified message and ex.
message: Message.
ex: Ex.
Warn the specified message.
message: Message.
Warn the specified message and ex.
message: Message.
ex: Ex.
Info the specified message.
message: Message.
Info the specified message and ex.
message: Message.
ex: Ex.
Verbose the specified message.
message: Message.
Verbose the specified message and ex.
message: Message.
ex: Ex.