Package com.vk.api.sdk.queries.docs

Class DocsGetQuery

java.lang.Object
com.vk.api.sdk.client.ApiRequest<R>
com.vk.api.sdk.client.AbstractQueryBuilder<DocsGetQuery,​GetResponse>
com.vk.api.sdk.queries.docs.DocsGetQuery
public class DocsGetQuery
extends AbstractQueryBuilder<DocsGetQuery,​GetResponse>
Query for Docs.get method

  • Constructor Details

    • DocsGetQuery

      public DocsGetQuery​(VkApiClient client, UserActor actor)
      Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
      Parameters:
      client - VK API client
      actor - actor with access token

  • Method Details

    • count

      public DocsGetQuery count​(java.lang.Integer value)
      Number of documents to return. By default, all documents.
      Parameters:
      value - value of "count" parameter. Minimum is 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • offset

      public DocsGetQuery offset​(java.lang.Integer value)
      Offset needed to return a specific subset of documents.
      Parameters:
      value - value of "offset" parameter. Minimum is 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • type

      public DocsGetQuery type​(GetType value)
      Set type
      Parameters:
      value - value of "type" parameter. Minimum is 0. By default 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • ownerId

      public DocsGetQuery ownerId​(java.lang.Integer value)
      ID of the user or community that owns the documents. Use a negative value to designate a community ID.
      Parameters:
      value - value of "owner id" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • returnTags

      public DocsGetQuery returnTags​(java.lang.Boolean value)
      Set return tags
      Parameters:
      value - value of "return tags" parameter. By default false.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • getThis

      protected DocsGetQuery getThis()
      Description copied from class: AbstractQueryBuilder
      Get reference to this object
      Specified by:
      getThis in class AbstractQueryBuilder<DocsGetQuery,​GetResponse>
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • essentialKeys

      protected java.util.List<java.lang.String> essentialKeys()
      Description copied from class: AbstractQueryBuilder
      Get list of required parameter names
      Specified by:
      essentialKeys in class AbstractQueryBuilder<DocsGetQuery,​GetResponse>
      Returns:
      list of names