Package 

Interface PaginatedResult


  • 
    public interface PaginatedResult<T>
    
                        

    Contains a page of results for message or presence history, stats, or REST presence requests. A PaginatedResult response from a REST API paginated query is also accompanied by metadata that indicates the relative queries available to the PaginatedResult object.

    • 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 PaginatedResult<T> first() Returns a new PaginatedResult for the first page of results.
      abstract PaginatedResult<T> current() Returns a new PaginatedResult for the current page of results.
      abstract PaginatedResult<T> next() 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.
      abstract boolean isLast() Returns true if this page is the last page and returns false if there are more pages available by calling next 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

      • first

         abstract PaginatedResult<T> first()

        Returns a new PaginatedResult for the first page of results.

        Spec: TG5

      • current

         abstract PaginatedResult<T> current()

        Returns a new PaginatedResult for the current page of results.

        Spec: TG5

      • next

         abstract PaginatedResult<T> next()

        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

      • isLast

         abstract boolean isLast()

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

        Spec: TG7