Class: Vk::API::Messages::Methods::MarkAsRead

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

Overview

Marks messages as read.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :message_ids (Array) —

    IDs of messages to mark as read.

  • :peer_id (String) —

    Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; "

  • :start_message_id (Integer) —

    Message ID to start from.




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

Instance Method Details

#message_ids ⇒ Array

Returns IDs of messages to mark as read.

Returns:

  • (Array) —

    IDs of messages to mark as read.



25
 
# File 'lib/vk/api/messages/methods/mark_as_read.rb', line 25

attribute :message_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)

#peer_id ⇒ String

Returns Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; ".

Returns:

  • (String) —

    Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; "



27
 
# File 'lib/vk/api/messages/methods/mark_as_read.rb', line 27

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

#start_message_id ⇒ Integer

Returns Message ID to start from.

Returns:

  • (Integer) —

    Message ID to start from.



29
 
# File 'lib/vk/api/messages/methods/mark_as_read.rb', line 29

attribute :start_message_id, API::Types::Coercible::Int.optional.default(nil)