Class: Vk::API::Messages::Methods::RemoveChatUser

Inherits:

Schema::Method

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

Defined in:

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

Overview

Allows the current user to leave a chat or, if the current user started the chat, allows the user to remove another user from the chat.

Arguments

• #chat_id ⇒ Integer

  Chat ID.

• #user_id ⇒ String

  ID of the user to be removed from the chat.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :chat_id (Integer) —

  Chat ID.

• :user_id (String) —

  ID of the user to be removed from the chat.

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

Instance Method Details

#chat_id ⇒ Integer

Returns Chat ID.

Returns:

• (Integer) —

  Chat ID.

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

attribute :chat_id, API::Types::Coercible::Int

#user_id ⇒ String

Returns ID of the user to be removed from the chat.

Returns:

• (String) —

  ID of the user to be removed from the chat.

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

attribute :user_id, API::Types::Coercible::String