Message Persistence API for Objective-C SDK

Message Persistence gives you real-time access to the history of messages published to PubNub. Each message is timestamped to the nearest 10 nanoseconds and stored across multiple availability zones in several geographic locations. You can encrypt stored messages with AES-256 so they are not readable on PubNub’s network. For details, see Message Persistence.

You control how long messages are stored through your account’s retention policy. Options include: 1 day, 7 days, 30 days, 3 months, 6 months, 1 year, or Unlimited.

You can retrieve the following:

Messages
Message reactions
Files (using the File Sharing API)

Fetch history

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Fetch historical messages from one or more channels. Use includeMessageActions to include message actions.

You can control how messages are returned and in what order.

If you specify only the start parameter (without end), you receive messages older than the start timetoken.
If you specify only the end parameter (without start), you receive messages from that end timetoken and newer.
If you specify both start and end, you retrieve messages between those timetokens (inclusive of the end value).

You can receive up to 100 messages for a single channel. For multiple channels (up to 500), you can receive up to 25 messages per channel. If more messages match the time range, make iterative calls and adjust the start timetoken to page through the results.

Method(s)

Use the following method(s) in the Objective-C SDK:

history()
    .channels(NSArray *)
    .start(NSNumber *)
    .end(NSNumber *)
    .limit(NSUInteger)
    .reverse(BOOL)
    .includeMetadata(BOOL)
    .includeMessageType(BOOL)
    .includeCustomMessageType(BOOL)
    .includeUUID(BOOL)
    .includeMessageActions(BOOL)
    .includeTimeToken(BOOL)
    .performWithCompletion(PNHistoryCompletionBlock);

* required

Parameter	Description
`channels` * Type: NSString	List of channels to fetch history messages from (up to 500).
`start` Type: NSNumber	Timetoken delimiting the start (exclusive) of the time slice.
`end` Type: NSNumber	Timetoken delimiting the end (inclusive) of the time slice.
`limit` Type: NSUInteger	Number of historical messages to return per channel. Default and maximum are 100 (single), 25 (multi), and 25 with `includeMessageActions`.
`reverse` Type: BOOL	Whether to traverse from oldest to newest.
`includeMetadata` Type: BOOL	Whether to include metadata in the response.
`includeMessageType` Type: BOOL	Whether to include message type. Default is `YES`.
`includeCustomMessageType` Type: BOOL	Whether to include custom message type. Default is `YES`. See Retrieving Messages.
`includeUUID` Type: BOOL	Whether to include the publisher uuid. Default is `YES`.
`includeMessageActions` Type: BOOL	Whether to include message actions in the response. If `YES`, only one channel is allowed.
`includeTimeToken` Type: BOOL	Whether to include event timetokens in the response.
`block` * Type: PNHistoryCompletionBlock	History completion block.

tip

Using the reverse parameter

Messages 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.

Sample code

#import <Foundation/Foundation.h>
#import <PubNub/PubNub.h>

// Basic configuration
PNConfiguration *config = [PNConfiguration configurationWithPublishKey:@"demo"
                                                          subscribeKey:@"demo"
                                                                userID:@"historyUser"];

// Create a PubNub client instance
PubNub *client = [PubNub clientWithConfiguration:config];

// Add listener for PubNub events
[client addListener:self];

// Publish sample messages for history demo
show all 156 lines

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.
 *
show all 41 lines

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;

show all 16 lines

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.
show all 20 lines

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.
show all 20 lines

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 {
            /**
show all 22 lines

Delete messages from history

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Remove messages from the history of a specific channel.

Required setting

Enable Delete-From-History for your key in the Admin Portal and initialize the SDK with a secret key.

Method(s)

To Delete Messages from History you can use the following method(s) in the Objective-C SDK.

- (void)deleteMessagesFromChannel:(NSString *)channel 
                            start:(nullable NSNumber *)startDate 
                              end:(nullable NSNumber *)endDate 
                   withCompletion:(nullable PNMessageDeleteCompletionBlock)block;

Sample code

[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

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Remove messages from the history of a specific channel.

Required setting

Enable Delete-From-History for your key in the Admin Portal and initialize the SDK with a secret key.

Method(s)

To Delete Messages from History you can use the following method(s) in the Objective-C SDK.

deleteMessage()
    .channel(NSString *)
    .start(NSNumber *)
    .end(NSNumber *)
    .performWithCompletion(PNAcknowledgmentStatus *);

Sample code

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];
        */
show all 17 lines

Message counts

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Return the number of messages published since the given time. The count is the number of messages with a timetoken greater than or equal to the value in timetokens.

Unlimited message retention

Only messages from the last 30 days are counted.

Method(s)

You can use the following method(s) in the Objective-C 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.

Sample code

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]
            */
show all 17 lines

Returns

Note

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;
show all 17 lines

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]
            */
show all 17 lines

History (deprecated)

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Alternative method

This method is deprecated. Use fetch history instead.

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 reverse to YES.
Page through results by providing a start OR end timetoken.
Retrieve a slice of the time line by providing both a start AND end timetoken.
Limit the number of messages to a specific quantity using the limit parameter.

Start & End parameter usage clarity

If only the start parameter is specified (without end), you receive messages that are older than and up to that start timetoken value. If only the end parameter is specified (without start) you receive messages that match that end timetoken value and newer. Specifying values for both start and end parameters returns messages between those timetoken values (inclusive on the end value). Keep in mind that you still receive a maximum of 100 messages even if more messages meet the timetoken values. Iterative calls to history adjusting the start timetoken are 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 Objective-C SDK:

- (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.

- (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`.

- (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`.

- (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`.

- (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.
`startDate` Type: NSNumber	Reference on timetoken for the oldest event (exclusive) to start pulling messages from.
`endDate` Type: NSNumber	Reference on timetoken for the latest event (inclusive) to stop pulling messages at.
`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.

- (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.
`startDate` Type: NSNumber	Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally.
`endDate` Type: 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`.

- (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.
`startDate` Type: NSNumber	Timetoken for oldest event starting from which next should be returned events. Value will be converted to required precision internally.
`endDate` Type: 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`.

- (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.
`startDate` Type: NSNumber	Reference on timetoken for the oldest event (exclusive) to start pulling messages from.
`endDate` Type: NSNumber	Reference on timetoken for the latest event (inclusive) to stop pulling messages at.
`limit` * Type: NSUInteger	Maximum number of events to return (not more than 100).
`shouldReverseOrder` * Type: Bool	Whether to reverse the order (oldest to newest).
`shouldIncludeTimeToken` * Type: Bool	Whether to include timetokens in the response.
`block` * Type: PNHistoryCompletionBlock	History pull completion 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.
`startDate` Type: NSNumber	Reference on timetoken for the oldest event (exclusive) to start pulling messages from.
`endDate` Type: NSNumber	Reference on timetoken for the latest event (inclusive) to stop pulling messages at.
`shouldIncludeTimeToken` * Type: Bool	Whether to include timetokens in the response.
`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.

- (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.
`startDate` Type: NSNumber	Reference on timetoken for oldest event starting from which next should be returned events.
`endDate` Type: 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.

- (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.
`startDate` Type: NSNumber	Reference on timetoken for oldest event starting from which next should be returned events.
`endDate` Type: 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: 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.

- (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.
`startDate` Type: NSNumber	Reference on timetoken for oldest event starting from which next should be returned events.
`endDate` Type: 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

Using the reverse parameter

Sample code

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 {

        /**
show all 24 lines

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;
show all 17 lines

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 {

        /**
show all 24 lines

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 {

        /**
show all 24 lines

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 {

        /**
show all 24 lines

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];
show all 50 lines

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.
        *
show all 19 lines

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.
        *
show all 19 lines

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.
show all 20 lines

Fetch history​

Requires Message Persistence

Method(s)​

tip

Sample code​

Response​

Other examples​

Fetch messages with metadata​

Fetch messages with actions​

Fetch messages with metadata and actions​

Delete messages from history​

Requires Message Persistence

Required setting

Method(s)​

Sample code​

Other examples​

Delete specific message from history​

Delete messages from history (builder pattern)​

Requires Message Persistence

Required setting

Method(s)​

Sample code​

Message counts​

Requires Message Persistence

Unlimited message retention

Method(s)​

Sample code​

Returns​

Note

Other examples​

Retrieve count of messages using different timetokens for each channel​

History (deprecated)​

Requires Message Persistence

Alternative method

Start & End parameter usage clarity

Method(s)​

tip

Sample code​

Response​

Other examples​

Use historyForChannel to retrieve the three oldest messages by retrieving from the time line in reverse​

Response​

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)​

Response​

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)​

Response​

History paging example​

Usage

Fetch messages with metadata​

Fetch messages with actions​

Fetch messages with metadata and actions​

Fetch history

Method(s)

Sample code

Response

Other examples

Fetch messages with metadata

Fetch messages with actions

Fetch messages with metadata and actions

Delete messages from history

Method(s)

Sample code

Other examples

Delete specific message from history

Delete messages from history (builder pattern)

Method(s)

Sample code

Message counts

Method(s)

Sample code

Returns

Other examples

Retrieve count of messages using different timetokens for each channel

History (deprecated)

Method(s)

Sample code

Response

Other examples

Use historyForChannel to retrieve the three oldest messages by retrieving from the time line in reverse

Response

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)

Response

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)

Response

History paging example

Fetch messages with metadata

Fetch messages with actions

Fetch messages with metadata and actions