Class: Vk::API::Messages::Methods::MarkAsImportant

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Messages::Methods::MarkAsImportant

Defined in:

lib/vk/api/messages/methods/mark_as_important.rb

Overview

Marks and unmarks messages as important (starred).

Arguments

• #important ⇒ Integer

  '1' — to add a star (mark as important); '0' — to remove the star.

• #message_ids ⇒ Array

  IDs of messages to mark as important.

Instance Method Summary

• #initialize(arguments) ⇒ Messages::Methods::MarkAsImportant constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :message_ids (Array) —

  IDs of messages to mark as important.

• :important (Integer) —

  '1' — to add a star (mark as important); '0' — to remove the star

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

Instance Method Details

#important ⇒ Integer

Returns '1' — to add a star (mark as important); '0' — to remove the star.

Returns:

• (Integer) —

  '1' — to add a star (mark as important); '0' — to remove the star

# File 'lib/vk/api/messages/methods/mark_as_important.rb', line 26

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

#message_ids ⇒ Array

Returns IDs of messages to mark as important.

Returns:

• (Array) —

  IDs of messages to mark as important.

# File 'lib/vk/api/messages/methods/mark_as_important.rb', line 24

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