UAInboxMessage Class Reference
Inherits from | NSObject |
Declared in | UAInboxMessage.h |
Overview
This class represents a Rich Push Inbox message. It contains all the available information about a message, including the URLs where the message can be retrieved.
Tasks
Message Properties
-
messageID
property -
messageBodyURL
property -
messageURL
property -
contentType
property -
unread
property -
deleted
property -
messageSent
property -
messageExpiration
property -
title
property -
extra
property -
rawMessageObject
property -
inbox
property -
– markMessageReadWithCompletionHandler:
-
– isExpired
Properties
contentType
The MIME content type for the message (e.g., text/html).
@property (nonatomic, readonly) NSString *contentType
Declared In
UAInboxMessage.h
deleted
YES if the message is deleted, otherwise NO.
@property (nonatomic, readonly) BOOL deleted
Declared In
UAInboxMessage.h
extra
The message’s extra dictionary. This dictionary can be populated with arbitrary key-value data at the time the message is composed.
@property (nonatomic, readonly) NSDictionary *extra
Declared In
UAInboxMessage.h
inbox
The parent inbox.
@property (nonatomic, readonly, weak) UAInboxMessageList *inbox
Discussion
Note that this object is not retained by the message.
Declared In
UAInboxMessage.h
messageBodyURL
The URL for the message body itself. This URL may only be accessed with Basic Auth credentials set to the user ID and password.
@property (nonatomic, readonly) NSURL *messageBodyURL
Declared In
UAInboxMessage.h
messageExpiration
The date and time the message will expire.
@property (nonatomic, readonly, nullable) NSDate *messageExpiration
Discussion
A nil value indicates it will never expire.
Declared In
UAInboxMessage.h
messageID
The Urban Airship message ID. This ID may be used to match an incoming push notification to a specific message.
@property (nonatomic, readonly) NSString *messageID
Declared In
UAInboxMessage.h
messageSent
The date and time the message was sent (UTC).
@property (nonatomic, readonly) NSDate *messageSent
Declared In
UAInboxMessage.h
messageURL
The URL for the message. This URL may only be accessed with Basic Auth credentials set to the user ID and password.
@property (nonatomic, readonly) NSURL *messageURL
Declared In
UAInboxMessage.h
rawMessageObject
The raw message dictionary. This is the dictionary that originally created the message. It can contain more values then the message.
@property (nonatomic, readonly) NSDictionary *rawMessageObject
Declared In
UAInboxMessage.h
Instance Methods
isExpired
YES if the message is expired, NO otherwise
- (BOOL)isExpired
Declared In
UAInboxMessage.h
markMessageReadWithCompletionHandler:
Mark the message as read.
- (nullable UADisposable *)markMessageReadWithCompletionHandler:(nullable UAInboxMessageCallbackBlock)completionHandler
Parameters
- completionHandler
A block to be executed on completion.
Return Value
A UADisposable which can be used to cancel callback execution, or nil if the message is already marked read.
Declared In
UAInboxMessage.h