Class: Vk::API::Docs::Methods::Get

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/docs/methods/get.rb

Overview

Returns detailed information about user or community documents.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Docs::Methods::Get

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :count (Integer)

    Number of documents to return. By default, all documents.

  • :offset (Integer)

    Offset needed to return a specific subset of documents.

  • :owner_id (Integer)

    ID of the user or community that owns the documents. Use a negative value to designate a community ID.


# File 'lib/vk/api/docs/methods/get.rb', line 15

Instance Method Details

#countInteger

Returns Number of documents to return. By default, all documents.

Returns:

  • (Integer)

    Number of documents to return. By default, all documents.


25
# File 'lib/vk/api/docs/methods/get.rb', line 25

attribute :count, API::Types::Coercible::Int.optional.default(nil)

#offsetInteger

Returns Offset needed to return a specific subset of documents.

Returns:

  • (Integer)

    Offset needed to return a specific subset of documents.


27
# File 'lib/vk/api/docs/methods/get.rb', line 27

attribute :offset, API::Types::Coercible::Int.optional.default(nil)

#owner_idInteger

Returns ID of the user or community that owns the documents. Use a negative value to designate a community ID.

Returns:

  • (Integer)

    ID of the user or community that owns the documents. Use a negative value to designate a community ID.


29
# File 'lib/vk/api/docs/methods/get.rb', line 29

attribute :owner_id, API::Types::Coercible::Int.optional.default(nil)