Class: Vk::API::Messages::Methods::GetChat

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

Overview

Returns information about a chat.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

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.rb', line 15

Instance Method Details

#chat_idInteger

Returns Chat ID.

Returns:

  • (Integer)

    Chat ID.


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

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

#chat_idsArray

Returns Chat IDs.

Returns:

  • (Array)

    Chat IDs.


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

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

#fieldsArray

Returns Profile fields to return.;.

Returns:

  • (Array)

    Profile fields to return.;


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

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

#name_caseString

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.rb', line 32

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