Class: Vk::API::Docs::Doc

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Docs::Doc

Defined in:

lib/vk/api/docs/doc.rb

Overview

See Also:

• https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

Instance Method Summary

• #access_key ⇒ String

  Access key for the document.

• #date ⇒ Integer

  Date when file has been uploaded in Unixtime.

• #ext ⇒ String

  File extension.

• #id ⇒ Integer

  Document ID.

• #owner_id ⇒ Integer

  Document owner ID.

• #preview ⇒ Object
• #size ⇒ Integer

  File size in bites.

• #title ⇒ String

  Document title.

• #type ⇒ Integer

  Document type.

• #url ⇒ String

  File URL.

Instance Method Details

#access_key ⇒ String

Returns Access key for the document.

Returns:

• (String) —

  Access key for the document

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

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

#date ⇒ Integer

Returns Date when file has been uploaded in Unixtime.

Returns:

• (Integer) —

  Date when file has been uploaded in Unixtime

# File 'lib/vk/api/docs/doc.rb', line 23

attribute :date, API::Types::Coercible::Int

#ext ⇒ String

Returns File extension.

Returns:

• (String) —

  File extension

# File 'lib/vk/api/docs/doc.rb', line 19

attribute :ext, API::Types::Coercible::String

#id ⇒ Integer

Returns Document ID.

Returns:

• (Integer) —

  Document ID

# File 'lib/vk/api/docs/doc.rb', line 11

attribute :id, API::Types::Coercible::Int

#owner_id ⇒ Integer

Returns Document owner ID.

Returns:

• (Integer) —

  Document owner ID

# File 'lib/vk/api/docs/doc.rb', line 13

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

#preview ⇒ Object

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Object) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

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

attribute :preview, API::Types::Coercible::Hash.optional.default(nil)

#size ⇒ Integer

Returns File size in bites.

Returns:

• (Integer) —

  File size in bites

# File 'lib/vk/api/docs/doc.rb', line 17

attribute :size, API::Types::Coercible::Int

#title ⇒ String

Returns Document title.

Returns:

• (String) —

  Document title

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

attribute :title, API::Types::Coercible::String

#type ⇒ Integer

Returns Document type.

Returns:

• (Integer) —

  Document type

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

attribute :type, API::Types::Coercible::Int

#url ⇒ String

Returns File URL.

Returns:

• (String) —

  File URL

# File 'lib/vk/api/docs/doc.rb', line 21

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