Class: Vk::API::Messages::Methods::GetDialogs

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

Overview

Returns a list of the current user's conversations.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :offset (Integer)

    Offset needed to return a specific subset of messages.

  • :count (Integer)

    Number of messages to return.

  • :start_message_id (Integer)

    ID of the message from what to return dialogs.

  • :preview_length (Integer)

    Number of characters after which to truncate a previewed message. To preview the full message, specify '0'.; "NOTE: Messages are not truncated by default. Messages are truncated by words."

  • :unread (Boolean)

    '1' — return unread messages only.


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

Instance Method Details

#countInteger

Returns Number of messages to return.

Returns:

  • (Integer)

    Number of messages to return.


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

attribute :count, API::Types::Coercible::Int.optional.default(20)

#offsetInteger

Returns Offset needed to return a specific subset of messages.

Returns:

  • (Integer)

    Offset needed to return a specific subset of messages.


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

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

#preview_lengthInteger

Returns Number of characters after which to truncate a previewed message. To preview the full message, specify '0'.; "NOTE: Messages are not truncated by default. Messages are truncated by words.".

Returns:

  • (Integer)

    Number of characters after which to truncate a previewed message. To preview the full message, specify '0'.; "NOTE: Messages are not truncated by default. Messages are truncated by words."


33
# File 'lib/vk/api/messages/methods/get_dialogs.rb', line 33

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

#start_message_idInteger

Returns ID of the message from what to return dialogs.

Returns:

  • (Integer)

    ID of the message from what to return dialogs.


31
# File 'lib/vk/api/messages/methods/get_dialogs.rb', line 31

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

#unreadBoolean

Returns '1' — return unread messages only.

Returns:

  • (Boolean)

    '1' — return unread messages only.


35
# File 'lib/vk/api/messages/methods/get_dialogs.rb', line 35

attribute :unread, API::Types::Form::Bool.optional.default(nil)