Class: Vk::API::Docs::Methods::Edit

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

Overview

Edits a document.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    User ID or community ID. Use a negative value to designate a community ID.

  • :doc_id (Integer)

    Document ID.

  • :title (String)

    Document title.

  • :tags (Array)

    Document tags.


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

Instance Method Details

#doc_idInteger

Returns Document ID.

Returns:

  • (Integer)

    Document ID.


28
# File 'lib/vk/api/docs/methods/edit.rb', line 28

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

#owner_idInteger

Returns User ID or community ID. Use a negative value to designate a community ID.

Returns:

  • (Integer)

    User ID or community ID. Use a negative value to designate a community ID.


26
# File 'lib/vk/api/docs/methods/edit.rb', line 26

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

#tagsArray

Returns Document tags.

Returns:

  • (Array)

    Document tags.


32
# File 'lib/vk/api/docs/methods/edit.rb', line 32

attribute :tags, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#titleString

Returns Document title.

Returns:

  • (String)

    Document title.


30
# File 'lib/vk/api/docs/methods/edit.rb', line 30

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