Class: Vk::API::Video::Methods::GetComments

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

Overview

Returns a list of comments on a video.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):


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

Instance Method Details

#countInteger

Returns Number of comments to return.

Returns:

  • (Integer)

    Number of comments to return.


40
# File 'lib/vk/api/video/methods/get_comments.rb', line 40

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

#extendedBoolean


44
# File 'lib/vk/api/video/methods/get_comments.rb', line 44

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

#need_likesBoolean

Returns '1' — to return an additional 'likes' field.

Returns:

  • (Boolean)

    '1' — to return an additional 'likes' field


34
# File 'lib/vk/api/video/methods/get_comments.rb', line 34

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

#offsetInteger

Returns Offset needed to return a specific subset of comments.

Returns:

  • (Integer)

    Offset needed to return a specific subset of comments.


38
# File 'lib/vk/api/video/methods/get_comments.rb', line 38

attribute :offset, API::Types::Coercible::Int.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.


30
# File 'lib/vk/api/video/methods/get_comments.rb', line 30

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

#sortString

Returns Sort order:; 'asc' — oldest comment first; 'desc' — newest comment first.

Returns:

  • (String)

    Sort order:; 'asc' — oldest comment first; 'desc' — newest comment first


42
# File 'lib/vk/api/video/methods/get_comments.rb', line 42

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

#start_comment_idInteger


36
# File 'lib/vk/api/video/methods/get_comments.rb', line 36

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

#video_idInteger

Returns Video ID.

Returns:

  • (Integer)

    Video ID.


32
# File 'lib/vk/api/video/methods/get_comments.rb', line 32

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