Class: Vk::API::Video::Methods::Report

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

Overview

Reports (submits a complaint about) a video.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the video.

  • :video_id (Integer)

    Video ID.

  • :reason (Integer)

    Reason for the complaint:; '0' – spam; '1' – child pornography; '2' – extremism; '3' – violence; '4' – drug propaganda; '5' – adult material; '6' – insult; abuse

  • :comment (String)

    Comment describing the complaint.

  • :search_query (String) — default: If the video was found in search results.

    Search query string.


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

Instance Method Details

#commentString

Returns Comment describing the complaint.

Returns:

  • (String)

    Comment describing the complaint.


33
# File 'lib/vk/api/video/methods/report.rb', line 33

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

#owner_idInteger

Returns ID of the user or community that owns the video.

Returns:

  • (Integer)

    ID of the user or community that owns the video.


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

attribute :owner_id, API::Types::Coercible::Int

#reasonInteger

Returns Reason for the complaint:; '0' – spam; '1' – child pornography; '2' – extremism; '3' – violence; '4' – drug propaganda; '5' – adult material; '6' – insult; abuse.

Returns:

  • (Integer)

    Reason for the complaint:; '0' – spam; '1' – child pornography; '2' – extremism; '3' – violence; '4' – drug propaganda; '5' – adult material; '6' – insult; abuse


31
# File 'lib/vk/api/video/methods/report.rb', line 31

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

#search_queryString

Returns (If the video was found in search results.) Search query string.

Returns:

  • (String)

    (If the video was found in search results.) Search query string.


35
# File 'lib/vk/api/video/methods/report.rb', line 35

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

#video_idInteger

Returns Video ID.

Returns:

  • (Integer)

    Video ID.


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

attribute :video_id, API::Types::Coercible::Int