Class: Vk::API::Docs::Methods::Delete

Inherits:

Schema::Method

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

Defined in:

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

Overview

Deletes a user or community document.

Arguments

• #doc_id ⇒ Integer

  Document ID.

• #owner_id ⇒ Integer

  ID of the user or community that owns the document.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

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.

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

Instance Method Details

#doc_id ⇒ Integer

Returns Document ID.

Returns:

• (Integer) —

  Document ID.

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

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

#owner_id ⇒ Integer

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.

# File 'lib/vk/api/docs/methods/delete.rb', line 24

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