Class: Vk::API::Board::Methods::GetComments

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

Overview

Returns a list of comments on a topic on a community's discussion board.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :group_id (Integer)

    ID of the community that owns the discussion board.

  • :topic_id (Integer)

    Topic ID.

  • :need_likes (Boolean)

    '1' — to return the 'likes' field; '0' — not to return the 'likes' field (default)

  • :start_comment_id (Integer)
  • :offset (Integer)

    Offset needed to return a specific subset of comments.

  • :count (Integer)

    Number of comments to return.

  • :extended (Boolean)

    '1' — to return information about users who posted comments; '0' — to return no additional fields (default)

  • :sort (String)

    Sort order:; 'asc' — by creation date in chronological order; 'desc' — by creation date in reverse chronological order;


# File 'lib/vk/api/board/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/board/methods/get_comments.rb', line 40

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

#extendedBoolean

Returns '1' — to return information about users who posted comments; '0' — to return no additional fields (default).

Returns:

  • (Boolean)

    '1' — to return information about users who posted comments; '0' — to return no additional fields (default)


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

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

#group_idInteger

Returns ID of the community that owns the discussion board.

Returns:

  • (Integer)

    ID of the community that owns the discussion board.


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

attribute :group_id, API::Types::Coercible::Int

#need_likesBoolean

Returns '1' — to return the 'likes' field; '0' — not to return the 'likes' field (default).

Returns:

  • (Boolean)

    '1' — to return the 'likes' field; '0' — not to return the 'likes' field (default)


34
# File 'lib/vk/api/board/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/board/methods/get_comments.rb', line 38

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

#sortString

Returns Sort order:; 'asc' — by creation date in chronological order; 'desc' — by creation date in reverse chronological order;.

Returns:

  • (String)

    Sort order:; 'asc' — by creation date in chronological order; 'desc' — by creation date in reverse chronological order;


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

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

#start_comment_idInteger


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

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

#topic_idInteger

Returns Topic ID.

Returns:

  • (Integer)

    Topic ID.


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

attribute :topic_id, API::Types::Coercible::Int