Package 

Interface AsyncPaginatedResult


  • 
    public interface AsyncPaginatedResult<T>
    
                        

    A type that represents a page of results from a paginated query. The response is accompanied by metadata that indicates the relative queries available.

    • Method Summary

      Modifier and Type Method Description
      abstract Array<T> items() Contains the current page of results; for example, an array of Message or PresenceMessage objects for a channel history request.
      abstract void first(Callback<AsyncPaginatedResult<T>> callback) Returns a new PaginatedResult for the first page of results.
      abstract void current(Callback<AsyncPaginatedResult<T>> callback) Returns a new PaginatedResult for the current page of results.
      abstract void next(Callback<AsyncPaginatedResult<T>> callback) Returns a new PaginatedResult loaded with the next page of results.If there are no further pages, then null is returned.
      abstract boolean hasFirst()
      abstract boolean hasCurrent()
      abstract boolean hasNext() Returns true if there are more pages available by calling next and returns false if this page is the last page available.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • items

         abstract Array<T> items()

        Contains the current page of results; for example, an array of Message or PresenceMessage objects for a channel history request.

        Spec: TG3

      • next

         abstract void next(Callback<AsyncPaginatedResult<T>> callback)

        Returns a new PaginatedResult loaded with the next page of results.If there are no further pages, then null is returned.

        Spec: TG4

      • hasNext

         abstract boolean hasNext()

        Returns true if there are more pages available by calling next and returns false if this page is the last page available.

        Spec: TG6