Class: Vk::API::Messages::Methods::GetChatUsers

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

Overview

Returns a list of IDs of users participating in a chat.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :chat_id (Integer) —

    Chat ID.

  • :chat_ids (Array) —

    Chat IDs.

  • :fields (Array) —

    Profile fields to return.;

  • :name_case (String) —

    Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive; 'dat' — dative; 'acc' — accusative; 'ins' — instrumental; 'abl' — prepositional




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

Instance Method Details

#chat_id ⇒ Integer

Returns Chat ID.

Returns:

  • (Integer) —

    Chat ID.



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

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

#chat_ids ⇒ Array

Returns Chat IDs.

Returns:

  • (Array) —

    Chat IDs.



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

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

#fields ⇒ Array

Returns Profile fields to return.;.

Returns:

  • (Array) —

    Profile fields to return.;



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

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

#name_case ⇒ String

Returns Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive; 'dat' — dative; 'acc' — accusative; 'ins' — instrumental; 'abl' — prepositional.

Returns:

  • (String) —

    Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive; 'dat' — dative; 'acc' — accusative; 'ins' — instrumental; 'abl' — prepositional



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

attribute :name_case, API::Types::Coercible::String.enum("nom", "gen", "dat", "acc", "ins", "abl").optional.default(nil)