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

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Docs::Methods::Edit

Defined in:

lib/vk/api/docs/methods/edit.rb

Overview

Edits a document.

Arguments

• #doc_id ⇒ Integer

  Document ID.

• #owner_id ⇒ Integer

  User ID or community ID.

• #tags ⇒ Array

  Document tags.

• #title ⇒ String

  Document title.

Instance Method Summary

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

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_id ⇒ Integer

Returns Document ID.

Returns:

• (Integer) —

  Document ID.

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

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

#owner_id ⇒ Integer

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.

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

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

#tags ⇒ Array

Returns Document tags.

Returns:

• (Array) —

  Document tags.

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

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

#title ⇒ String

Returns Document title.

Returns:

• (String) —

  Document title.

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

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