Class: Vk::API::Docs::Methods::Add

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

Overview

Copies a document to a user's or community's document list.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

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

  • :doc_id (Integer)

    Document ID.

  • :access_key (String)

    Access key. This parameter is required if 'access_key' was returned with the document's data.


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

Instance Method Details

#access_keyString

Returns Access key. This parameter is required if 'access_key' was returned with the document's data.

Returns:

  • (String)

    Access key. This parameter is required if 'access_key' was returned with the document's data.


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

attribute :access_key, API::Types::Coercible::String.optional.default(nil)

#doc_idInteger

Returns Document ID.

Returns:

  • (Integer)

    Document ID.


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

attribute :doc_id, API::Types::Coercible::Int

#owner_idInteger

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

Returns:

  • (Integer)

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


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

attribute :owner_id, API::Types::Coercible::Int