Class: Vk::API::Messages::Methods::GetHistoryAttachments

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/messages/methods/get_history_attachments.rb

Overview

Returns media files from the dialog or group chat.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Messages::Methods::GetHistoryAttachments

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :peer_id (Integer) —

    Peer ID.; ; "; For group chat:; '2000000000 + chat ID' ; ; For community:; '-community ID'"

  • :media_type (String) —

    Type of media files to return:; *'photo';; *'video';; *'audio';; *'doc';; *'link'.;

  • :start_from (String) —

    Message ID to start return results from.

  • :count (Integer) —

    Number of objects to return.

  • :photo_sizes (Boolean) —

    '1' — to return photo sizes in a

  • :fields (Array) —

    Additional to return.




# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of objects to return.

Returns:

  • (Integer) —

    Number of objects to return.



34
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 34

attribute :count, API::Types::Coercible::Int.optional.default(30)

#fields ⇒ Array

Returns Additional to return.

Returns:

  • (Array) —

    Additional to return.



38
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 38

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

#media_type ⇒ String

Returns Type of media files to return:; *'photo';; *'video';; *'audio';; *'doc';; *'link'.;.

Returns:

  • (String) —

    Type of media files to return:; *'photo';; *'video';; *'audio';; *'doc';; *'link'.;



30
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 30

attribute :media_type, API::Types::Coercible::String.enum("photo", "video", "doc", "audio", "link", "market", "wall", "share").optional.default("photo")

#peer_id ⇒ Integer

Returns Peer ID.; ; "; For group chat:; '2000000000 + chat ID' ; ; For community:; '-community ID'".

Returns:

  • (Integer) —

    Peer ID.; ; "; For group chat:; '2000000000 + chat ID' ; ; For community:; '-community ID'"



28
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 28

attribute :peer_id, API::Types::Coercible::Int

#photo_sizes ⇒ Boolean

Returns '1' — to return photo sizes in a.

Returns:

  • (Boolean) —

    '1' — to return photo sizes in a



36
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 36

attribute :photo_sizes, API::Types::Form::Bool.optional.default(nil)

#start_from ⇒ String

Returns Message ID to start return results from.

Returns:

  • (String) —

    Message ID to start return results from.



32
 
# File 'lib/vk/api/messages/methods/get_history_attachments.rb', line 32

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