Result Paging in Chat Client SDKs

Public Channels, User Channels, and the Members list for each channel are exposed through Paginators. In JavaScript, Messages are also paged using Paginators. When requesting an initial set of any of these entities, your provided callback mechanism will receive a result indicating the success or failure of the operation as well as a paginator to access the items.

While the signature of the individual methods will vary by SDK platform, each paginator has the following accessors:

Node.js

Java

Objective-C

Swift


_34// Get messages from the newest to oldest
_34channel
_34  .getMessages(20 /* by pages of 20 messages */)
_34  .then(function(messagesPage) {
_34    messagesPage.items.forEach(function(message) {
_34      // do stuff for each message
_34    });
_34    // note, that by default pages are in "backwards" order,
_34    // so you should ask for previous page, not the next one
_34    if (messagesPage.hasPrevPage) {
_34      return messagesPage.prevPage(); // here we can ask for following page
_34    }
_34  });
_34
_34// Get messages from the message with id 3 to newest
_34channel.getMessages(20, 3, 'forward').then(function(messagesPage) {
_34  /* handle page the same way as above */
_34});
_34
_34// Handle multiple pages
_34// Unfortunately, js has no asynchronous iterators yet, so there should be
_34// some boilerplate here. One of the way to go through all messages would be
_34// like this:
_34function processPage(page) {
_34  page.items.forEach(function(message) {
_34    /* do something for message */
_34  });
_34  if (page.hasNextPage) {
_34    page.nextPage().then(processPage);
_34  } else {
_34    // all messages read!
_34  }
_34}
_34channel.getMessage(10, null, 'forward').then(processPage);

Result Paging in Chat Client SDKs

Danger

Paginators

Result Paging: Obtain a List of Public Channel Descriptors

Messages (Android, iOS)

Result Paging: Messages