Class: Vk::API::Messages::Methods::DeleteDialog

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

Overview

Deletes all private messages in a conversation.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_id (String) —

    User ID. To clear a chat history use 'chat_id'

  • :peer_id (Integer) —

    Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; "

  • :offset (Integer) —

    Offset needed to return a specific subset of messages.

  • :count (Integer) —

    Number of messages to delete.; "NOTE: If the number of messages exceeds the maximum, the method shall be called several times."




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

Instance Method Details

#count ⇒ Integer

Returns Number of messages to delete.; "NOTE: If the number of messages exceeds the maximum, the method shall be called several times.".

Returns:

  • (Integer) —

    Number of messages to delete.; "NOTE: If the number of messages exceeds the maximum, the method shall be called several times."



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

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of messages.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of messages.



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

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

#peer_id ⇒ Integer

Returns Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; ".

Returns:

  • (Integer) —

    Destination ID.; ; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'chat_id', e.g. '2000000001'.; ; For community:; '- community ID', e.g. '-12345'.; "



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

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

#user_id ⇒ String

Returns User ID. To clear a chat history use 'chat_id'.

Returns:

  • (String) —

    User ID. To clear a chat history use 'chat_id'



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

attribute :user_id, API::Types::Coercible::String.optional.default(nil)