Package com.dropbox.core.v2.paper

Class DocsListBuilder

java.lang.Object
com.dropbox.core.v2.paper.DocsListBuilder
public class DocsListBuilder extends Object
The request builder returned by DbxUserPaperRequests.docsListBuilder().

Use this class to set optional request parameters and complete the request.

  • Method Details

    • withFilterBy

      public DocsListBuilder withFilterBy(ListPaperDocsFilterBy filterBy)
      Set value for optional field.

      If left unset or set to null, defaults to ListPaperDocsFilterBy.DOCS_ACCESSED.

      Parameters:
      filterBy - Allows user to specify how the Paper docs should be filtered. Must not be null. Defaults to ListPaperDocsFilterBy.DOCS_ACCESSED when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withSortBy

      public DocsListBuilder withSortBy(ListPaperDocsSortBy sortBy)
      Set value for optional field.

      If left unset or set to null, defaults to ListPaperDocsSortBy.ACCESSED.

      Parameters:
      sortBy - Allows user to specify how the Paper docs should be sorted. Must not be null. Defaults to ListPaperDocsSortBy.ACCESSED when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withSortOrder

      public DocsListBuilder withSortOrder(ListPaperDocsSortOrder sortOrder)
      Set value for optional field.

      If left unset or set to null, defaults to ListPaperDocsSortOrder.ASCENDING.

      Parameters:
      sortOrder - Allows user to specify the sort order of the result. Must not be null. Defaults to ListPaperDocsSortOrder.ASCENDING when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withLimit

      public DocsListBuilder withLimit(Integer limit)
      Set value for optional field.

      If left unset or set to null, defaults to 1000.

      Parameters:
      limit - Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error. Must be greater than or equal to 1 and be less than or equal to 1000. Defaults to 1000 when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withStopAtDate

      public DocsListBuilder withStopAtDate(Date stopAtDate)
      Set value for optional field.
      Parameters:
      stopAtDate - Do not return results beyond this date. Behavior depends on sort order.
      Returns:
      this builder

    • start

      public ListPaperDocsResponse start() throws DbxApiException, DbxException
      Issues the request.
      Throws:
      DbxApiException
      DbxException