Cocoa Message Persistence API Reference for Real-time Apps
Message Persistence provides real-time access to the history of all messages published to PubNub. Each published message is timestamped to the nearest 10 nanoseconds and is stored across multiple availability zones in several geographical locations. Stored messages can be encrypted with AES-256 message encryption, ensuring that they are not readable while stored on PubNub's network. For more information, refer to Message Persistence.
Messages can be stored for a configurable duration or forever, as controlled by the retention policy that is configured on your account. The following options are available: 1 day, 7 days, 30 days, 3 months, 6 months, 1 year, or Unlimited.
You can retrieve the following:
- Messages
- Message reactions
- File Sharing (using File Sharing API)
History
Requires Message Persistence
This method requires that Message Persistence is enabled for your key in the Admin Portal.
This function fetches historical messages of a channel.
It is possible to control how messages are returned and in what order, for example you can:
- Search for messages starting on the newest end of the timeline (default behavior -
reverse=NO) - Search for messages from the oldest end of the timeline by setting
reversetoYES. - Page through results by providing a
startORendtimetoken. - Retrieve a slice of the time line by providing both a
startANDendtimetoken. - Limit the number of messages to a specific quantity using the
limitparameter.
Start & End parameter usage clarity
If only the start parameter is specified (without end), you will receive messages that are older than and up to that start timetoken value. If only the end parameter is specified (without start) you will receive messages that match that end timetoken value and newer Specifying values for both start and end parameters will return messages between those timetoken values (inclusive on the end value). Keep in mind that you will still receive a maximum of 100 messages even if there are more messages that meet the timetoken values. Iterative calls to history adjusting the start timetoken is necessary to page through the full set of results if more than 100 messages meet the timetoken values.
Method(s)
To run History you can use the following method(s) in the Cocoa SDK:
History with block
- (void)historyForChannel:(NSString *)channel
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments: result - in case of successful request processing data field will contain results of history request operation; status - in case if error occurred during request processing. |
History with metadata and block
- (void)historyForChannel:(NSString *)channel
withMetadata:(BOOL)shouldIncludeMetadata
completion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
shouldIncludeMetadata *Type: BOOL | Whether event metadata should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with message reactions and block
- (void)historyForChannel:(NSString *)channel
withMessageActions:(BOOL)shouldIncludeMessageActions
completion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
shouldIncludeMessageActions *Type: BOOL | Whether event actions should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with metadata, message reactions, and block
- (void)historyForChannel:(NSString *)channel
withMetadata:(BOOL)shouldIncludeMetadata
messageActions:(BOOL)shouldIncludeMessageActions
completion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
shouldIncludeMetadata *Type: BOOL | Whether event metadata should be included in response or not. |
shouldIncludeMessageActions *Type: BOOL | Whether event actions should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with dates and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments: result - in case of successful request processing data field will contain results of history request operation; status - in case if error occurred during request processing. |
History with dates, metadata, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
includeMetadata:(BOOL)shouldIncludeMetadata
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally. |
endDateType: NSNumber | Timetoken for latest event till which events should be pulled out. Value will be converted to required precision internally. |
shouldIncludeMetadata *Type: BOOL | Whether event metadata should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with dates, message reactions, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
includeMessageActions:(BOOL)shouldIncludeMessageActions
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally. |
endDateType: NSNumber | Timetoken for latest event till which events should be pulled out. Value will be converted to required precision internally. |
shouldIncludeMessageActions *Type: BOOL | Whether event actions should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with dates, metadata, message reactions, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
includeMetadata:(BOOL)shouldIncludeMetadata
includeMessageActions:(BOOL)shouldIncludeMessageActions
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally. |
endDateType: NSNumber | Timetoken for latest event till which events should be pulled out. Value will be converted to required precision internally. |
shouldIncludeMetadata *Type: BOOL | Whether event metadata should be included in response or not. |
shouldIncludeMessageActions *Type: BOOL | Whether event actions should be included in response or not. Throws an exception in case if API called with more than one channel. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
History with dates, limits, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
limit:(NSUInteger)limit
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
limit *Type: NSUInteger | Maximum number of events which should be returned in response (not more then 100). |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments: result - in case of successful request processing data field will contain results of history request operation; status - in case if error occurred during request processing. |
History with dates, timetoken, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
includeTimeToken:(BOOL)shouldIncludeTimeToken
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
shouldIncludeTimeToken *Type: Bool | Whether event dates (timetokens) should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments:
|
History with dates, limits, timetoken, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
limit:(NSUInteger)limit
includeTimeToken:(BOOL)shouldIncludeTimeToken
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
limit *Type: NSUInteger | Maximum number of events which should be returned in response (not more then 100). |
shouldIncludeTimeToken *Type: Bool | Whether event dates (timetokens) should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments: result - in case of successful request processing data field will contain results of history request operation; status - in case if error occurred during request processing. |
History with dates, limit, resersed order, and block
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
limit:(NSUInteger)limit
reverse:(BOOL)shouldReverseOrder
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
limit *Type: NSUInteger | Maximum number of events which should be returned in response (not more then 100). |
shouldReverseOrder *Type: Bool | Whether events order in response should be reversed or not. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments:
|
History with dates, limits, timetoken, and block, in reverse order
- (void)historyForChannel:(NSString *)channel
start:(nullable NSNumber *)startDate
end:(nullable NSNumber *)endDate
limit:(NSUInteger)limit
reverse:(BOOL)shouldReverseOrder
includeTimeToken:(BOOL)shouldIncludeTimeToken
withCompletion:(PNHistoryCompletionBlock)block;
* required
| Parameter | Description |
|---|---|
channel *Type: NSString | Channel name to retrieve the History information. |
startDateType: NSNumber | Reference on timetoken for oldest event starting from which next should be returned events. |
endDateType: NSNumber | Reference on timetoken for latest event till which events should be pulled out. |
limit *Type: NSUInteger | Maximum number of events which should be returned in response (not more then 100). |
shouldReverseOrder *Type: Bool | Whether events order in response should be reversed or not. |
shouldIncludeTimeToken *Type: Bool | Whether event dates (timetokens) should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull processing completion block which pass two arguments: result - in case of successful request processing data field will contain results of history request operation; status - in case if error occurred during request processing. |
tip
reverse parameterMessages are always returned sorted in ascending time direction from history regardless of reverse. The reverse direction matters when you have more than 100 (or limit, if it's set) messages in the time interval, in which case reverse determines the end of the time interval from which it should start retrieving the messages.
Basic Usage
Retrieve the last 100 messages on a channel:
[self.client historyForChannel: @"my_channel" start:nil end:nil limit:100
withCompletion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status) {
/**
Handle downloaded history using:
result.data.start - oldest message time stamp in response
result.data.end - newest message time stamp in response
result.data.messages - list of messages
*/
}
else {
/**
Response
The response object which is returned by the client when the history API is used:
@interface PNHistoryData : PNServiceData
// Channel history messages.
@property (nonatomic, readonly, strong) NSArray *messages;
// History time frame start time.
@property (nonatomic, readonly, strong) NSNumber *start;
// History time frame end time.
@property (nonatomic, readonly, strong) NSNumber *end;
@end
@interface PNHistoryResult : PNResult
// Stores reference on channel history request processing information.
@property (nonatomic, readonly, strong) PNHistoryData *data;
Other Examples
Use historyForChannel to retrieve the three oldest messages by retrieving from the time line in reverse
[self.client historyForChannel:@"my_channel" start:nil end:nil limit:3 reverse:YES
withCompletion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status) {
/**
Handle downloaded history using:
result.data.start - oldest message time stamp in response
result.data.end - newest message time stamp in response
result.data.messages - list of messages
*/
}
else {
/**
Response
[
["Pub1","Pub2","Pub3"],
13406746729185766,
13406746780720711
]
Use historyForChannel to retrieve messages newer than a given timetoken by paging from oldest message to newest message starting at a single point in time (exclusive)
[self.client historyForChannel:@"my_channel" start:@(13406746780720711) end:nil limit:100
reverse:YES withCompletion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status) {
/**
Handle downloaded history using:
result.data.start - oldest message time stamp in response
result.data.end - newest message time stamp in response
result.data.messages - list of messages
*/
}
else {
/**
Response
[
["Pub3","Pub4","Pub5"],
13406746780720711,
13406746845892666
]
Use historyForChannel to retrieve messages until a given timetoken by paging from newest message to oldest message until a specific end point in time (inclusive)
[self.client historyForChannel:@"my_channel" start:nil end:@(13406746780720711) limit:100
includeTimeToken:NO withCompletion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status) {
/**
Handle downloaded history using:
result.data.start - oldest message time stamp in response
result.data.end - newest message time stamp in response
result.data.messages - list of messages
*/
}
else {
/**
Response
[
["Pub3","Pub4","Pub5"],
13406746780720711,
13406746845892666
]
History Paging Example
Usage
You can call the method by passing 0 or a valid timetoken as the argument.
// Pull out all messages newer than message sent at 14395051270438477.
[self historyFromStartDate:@(14395051270438477) onChannel:@"history_channel"
withCompletionBlock:^(NSArray *messages) {
NSLog(@"Messages from history: %@", messages);
}];
- (void)historyNewerThan:(NSNumber *)beginTime onChannel:(NSString *)channelName
withCompletionBlock:(void (^)(NSArray *messages))block {
NSMutableArray *msgs = [NSMutableArray new];
[self historyFromStartDate:beginTime onChannel:channelName
withProgress:^(NSArray *objects) {
[msgs addObjectsFromArray:objects];
Fetch messages with metadata
[self.client historyForChannel:@"storage" withMetadata:YES
completion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries as value. Each entry will include two keys: "message" - for
* body and "metadata" for meta which has been added during message publish.
*/
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
*
Fetch messages with actions
[self.client historyForChannel:@"chat" withMessageActions:YES
completion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries. Each entry will include two keys: "message" - for body and
* "actions" for list of added actions.
*/
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
*
Fetch messages with metadata and actions
[self.client historyForChannel:@"chat" withMetadata:YES messageActions:YES
completion:^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries. Each entry will include three keys: "message" - for body,
* "metadata" for meta which has been added during message publish and "actions"
* for list of added actions.
*/
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
History (Builder Pattern)
This function fetches historical messages of a channel.
This method uses the builder pattern; you can omit any optional arguments.
Method(s)
To get channel history using the Builder pattern, use the following method(s) in the Cocoa SDK:
history()
.channels(NSArray *)
.start(NSNumber *)
.end(NSNumber *)
.limit(NSUInteger)
.reverse(BOOL)
.includeMetadata(BOOL)
.shouldIncludeMessageType(BOOL)
.shouldIncludeUUID(BOOL)
.includeMessageActions(BOOL)
.includeTimeToken(BOOL)
.performWithCompletion(PNHistoryCompletionBlock);
* required
| Parameter | Description |
|---|---|
channels *Type: NSString | List of channels for which history should be returned. |
startType: NSNumber | Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally. |
endType: NSNumber | Timetoken for latest event till which events should be pulled out. Value will be converted to required precision internally. |
limitType: NSUInteger | Maximum number of messages which should be returned for each channel. Default and maximum value is 100 for a single channel, 25 for multiple channels, and 25 when includeMessageActions is YES. |
reverseType: BOOL | Setting to YES traverses the time line in reverse, starting with the oldest message first. |
includeMetadataType: BOOL | Whether event metadata should be included in response or not. |
shouldIncludeMessageTypeType: BOOL | Pass YES to receive the message type with each history message. Default is YES. |
shouldIncludeUUIDType: BOOL | Pass YES to receive the publisher uuid with each history message. Default is YES. |
includeMessageActionsType: BOOL | Whether event actions should be included in response or not. When YES, throws an exception if you call the method with more than one channel. |
includeTimeTokenType: BOOL | Whether event dates (timetokens) should be included in response or not. |
block *Type: PNHistoryCompletionBlock | History pull completion block. |
tip
reverse parameterMessages are always returned sorted in ascending time direction from history regardless of reverse. The reverse direction matters when you have more than 100 (or limit, if it's set) messages in the time interval, in which case reverse determines the end of the time interval from which it should start retrieving the messages.
Basic Usage
self.client.history()
.channels(@[@"my_channel"])
.limit(15)
.performWithCompletion(^(PNHistoryResult *result, PNErrorStatus *status) {
if (status == nil) {
/**
Handle downloaded history using:
result.data.channels - dictionary with channels' history. Each key is channel name and value is
list of fetched messages.
*/
}
else {
Response
Response objects which is returned by client when fetch messages Message Persistence API is used:
@interface PNHistoryData : PNServiceData
/**
* Channel history messages.
*
* Set only for PNHistoryOperation operation and will be empty array for other operation types.
*/
@property (nonatomic, readonly, strong) NSArray *messages;
/**
* Channels history.
*
* Each key represent name of channel for which messages has been received and values is list of
* messages from channel's storage.
*
Error response which is used in case of Message Persistence API call failure:
@interface PNErrorData : PNServiceData
// Stringified error information.
@property (nonatomic, readonly, strong) NSString *information;
@end
@interface PNErrorStatus : PNStatus
// Whether status object represent error or not.
@property (nonatomic, readonly, assign, getter = isError) BOOL error;
// Additional information related to error status object.
@property (nonatomic, readonly, strong) PNErrorData *errorData;
Other Examples
Fetch messages with metadata
self.client.history()
.channel(@"storage")
.includeMetadata(YES)
.performWithCompletion(^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries as value. Each entry will include two keys: "message" - for
* body and "metadata" for meta which has been added during message publish.
*/
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
Fetch messages with actions
self.client.history()
.channel(@"chat")
.includeMessageActions(YES)
.performWithCompletion(^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries. Each entry will include two keys: "message" - for body and
* "actions" for list of added actions.
*/
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
Fetch messages with metadata and actions
self.client.history()
.channel(@"chat")
.includeMetadata(YES)
.includeMessageActions(YES)
.performWithCompletion(^(PNHistoryResult *result, PNErrorStatus *status) {
if (!status.isError) {
/**
* Fetched data available here:
* result.data.channels - dictionary with single key (name of requested channel) and
* list of dictionaries. Each entry will include three keys: "message" - for body,
* "metadata" for meta which has been added during message publish and "actions"
* for list of added actions.
*/
} else {
/**
Delete Messages from History
Requires Message Persistence
This method requires that Message Persistence is enabled for your key in the Admin Portal.
Removes the messages from the history of a specific channel.
Delete-From-History
There is a setting to accept delete from history requests for a key, which you must enable by checking the Enable Delete-From-History checkbox in the key settings for your key in the Admin Portal.
Requires Initialization with secret key.
Method(s)
To Delete Messages from History you can use the following method(s) in the Cocoa SDK.
- (void)deleteMessagesFromChannel:(NSString *)channel start:(nullable NSNumber *)startDate end:(nullable NSNumber *)endDate withCompletion:(nullable PNMessageDeleteCompletionBlock)block
Basic Usage
[self.client deleteMessagesFromChannel:@"channel" start:@15101397027611671 end:@15101397427611671
withCompletion:^(PNAcknowledgmentStatus *status) {
if (!status.isError) {
// Messages within specified time frame has been removed.
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
*
* Request can be resent using: [status retry];
*/
}
}];
Other Examples
Delete specific message from history
To delete a specific message, pass the publish timetoken (received from a successful publish) in the End parameter and timetoken +/- 1 in the Start parameter. e.g. if 15526611838554310 is the publish timetoken, pass 15526611838554309 in Start and 15526611838554310 in End parameters respectively as shown in the following code snippet.
[self.client deleteMessagesFromChannel:@"channel" start:@15526611838554309 end:@15526611838554310
withCompletion:^(PNAcknowledgmentStatus *status) {
if (!status.isError) {
// Messages within specified time frame has been removed.
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
*
* Request can be resent using: [status retry];
*/
}
}];
Delete Messages from History (Builder Pattern)
Requires Message Persistence
This method requires that Message Persistence is enabled for your key in the Admin Portal.
Removes the messages from the history of a specific channel.
Delete-From-History
There is a setting to accept delete from history requests for a key, which you must enable by checking the Enable Delete-From-History checkbox in the key settings for your key in the Admin Portal.
Requires Initialization with secret key.
Method(s)
To Delete Messages from History you can use the following method(s) in the Cocoa SDK.
- deleteMessage()
.channel(NSString *)
.start(NSNumber *)
.end(NSNumber *)
.performWithCompletion(nullable PNAcknowledgmentStatus *);
Basic Usage
self.client.deleteMessage().channel(@"channel").start(@15101397027611671).end(@15101397427611671)
.performWithCompletion(^(PNAcknowledgmentStatus *status) {
if (!status.isError) {
// Messages within specified time frame has been removed.
} else {
/**
* Handle message history download error. Check 'category' property to find out possible
* issue because of which request did fail.
*
* Request can be resent using: [status retry];
*/
}
});
Message Counts
Requires Message Persistence
This method requires that Message Persistence is enabled for your key in the Admin Portal.
Returns the number of messages published on one or more channels since a given time. The count returned is the number of messages in history with a timetoken value greater than or equal to than the passed value in the timetokensparameter.
Unlimited message retention
For keys with unlimited message retention enabled, this method considers only messages published in the last 30 days.
Method(s)
You can use the following method(s) in the Cocoa SDK:
messageCounts()
.channels(NSArray<NSString *> *)
.timetokens(NSArray<NSNumber *> *)
.performWithCompletion(PNMessageCountCompletionBlock);
* required
| Parameter | Description |
|---|---|
channels *Type: NSArray <NSString *> *Default: n/a | The channels to fetch the message count |
timetokens *Type: NSArray <NSNumber *> *Default: n/a | List with single or multiple timetokens, where each timetoken position in correspond to target channel location in channel names list. |
completion *Type: PNMessageCountCompletionBlock Default: n/a | Messages count fetch completion closure which pass two arguments: result - in case of successful request processing data field will contain results of message count fetch operation; status - in case of error occurred during request processing. |
Basic Usage
self.client.messageCounts().channels(@[@"unread-channel-1", @"unread-channel-2"])
.timetokens(@[@(15501015683744028)])
.performWithCompletion(^(PNMessageCountResult *result, PNErrorStatus *status) {
if (!status.isError) {
// Client state retrieved number of messages for channels.
} else {
/**
Handle client state modification error. Check 'category' property
to find out possible reason because of which request did fail.
Review 'errorData' property (which has PNErrorData data type) of status
object to get additional information about issue.
Request can be resent using: [status retry]
*/
Returns
Channels count
Channels without messages have a count of 0. Channels with 10,000 messages or more have a count of 10000.
@interface PNMessageCountData : PNServiceData
/**
* @brief Dictionary where each key is name of channel and value is number of messages in it.
*/
@property (nonatomic, readonly, strong) NSDictionary<NSString *, NSNumber *> *channels;
@end
@interface PNMessageCountResult : PNResult
/**
* @brief Message count request processing information.
*/
@property (nonatomic, readonly, strong) PNMessageCountData *data;
Other Examples
Retrieve count of messages using different timetokens for each channel
self.client.messageCounts().channels(@[@"unread-channel-1", @"unread-channel-2"])
.timetokens(@[@(15501015683744028), @(15501015683744130)])
.performWithCompletion(^(PNMessageCountResult *result, PNErrorStatus *status) {
if (!status.isError) {
// Client state retrieved number of messages for channels.
} else {
/**
Handle client state modification error. Check 'category' property
to find out possible reason because of which request did fail.
Review 'errorData' property (which has PNErrorData data type) of status
object to get additional information about issue.
Request can be resent using: [status retry]
*/