Class: Vk::API::Users::Methods::Report

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/users/methods/report.rb

Overview

Reports (submits a complain about) a user.;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Users::Methods::Report

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_id (Integer)

    ID of the user about whom a complaint is being made.

  • :type (String)

    Type of complaint:; 'porn' – pornography; 'spam' – spamming; 'insult' – abusive behavior; 'advertisment' – disruptive advertisements

  • :comment (String)

    Comment describing the complaint.


# File 'lib/vk/api/users/methods/report.rb', line 15

Instance Method Details

#commentString

Returns Comment describing the complaint.

Returns:

  • (String)

    Comment describing the complaint.


29
# File 'lib/vk/api/users/methods/report.rb', line 29

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

#typeString

Returns Type of complaint:; 'porn' – pornography; 'spam' – spamming; 'insult' – abusive behavior; 'advertisment' – disruptive advertisements.

Returns:

  • (String)

    Type of complaint:; 'porn' – pornography; 'spam' – spamming; 'insult' – abusive behavior; 'advertisment' – disruptive advertisements


27
# File 'lib/vk/api/users/methods/report.rb', line 27

attribute :type, API::Types::Coercible::String

#user_idInteger

Returns ID of the user about whom a complaint is being made.

Returns:

  • (Integer)

    ID of the user about whom a complaint is being made.


25
# File 'lib/vk/api/users/methods/report.rb', line 25

attribute :user_id, API::Types::Coercible::Int