Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Result Paging in Chat Client SDKs

Twilio's Programmable Chat client SDKs use paging to improve performance when accessing potentially large collections of chat objects.

Paginators

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 the 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:

  • A way to obtain the items
  • A boolean property indicating if there are subsequent pages
  • A method taking the same callback mechanism as the original call to request the next page
        
        
        
        

        Messages (Android, iOS)

        The messages collection behaves a bit differently than channels and members since there is a temporal quality to how the objects are typically presented.

        The messages collection objects offer the following ways to access items:

        • getLastMessages fetches the specified number of messages, starting with the most recent in the collection
        • getMessagesBefore fetches messages before (and including) the anchor message index specified
        • getMessagesAfter fetches messages after (and including) the anchor message index specified
        • messageWithConsumptionIndex fetches the message with the specified index or, if that message is no longer available, the message directly before it
        • messageWithIndex fetches the message specified by the index, if available
              
              
              
              
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.