Class: Vk::API::Photos::Methods::GetAllComments

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

Overview

Returns a list of comments on a specific photo album or all albums of the user sorted in reverse chronological order.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Photos::Methods::GetAllComments

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of the user or community that owns the album(s).

  • :album_id (Integer)

    Album ID. If the parameter is not set, comments on all of the user's albums will be returned.

  • :need_likes (Boolean)

    '1' — to return an additional 'likes' field; '0' — (default)

  • :offset (Integer)

    Offset needed to return a specific subset of comments. By default, '0'.

  • :count (Integer)

    Number of comments to return. By default, '20'. Maximum value, '100'.


# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 15

Instance Method Details

#album_idInteger

Returns Album ID. If the parameter is not set, comments on all of the user's albums will be returned.

Returns:

  • (Integer)

    Album ID. If the parameter is not set, comments on all of the user's albums will be returned.


29
# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 29

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

#countInteger

Returns Number of comments to return. By default, '20'. Maximum value, '100'.

Returns:

  • (Integer)

    Number of comments to return. By default, '20'. Maximum value, '100'.


35
# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 35

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

#need_likesBoolean

Returns '1' — to return an additional 'likes' field; '0' — (default).

Returns:

  • (Boolean)

    '1' — to return an additional 'likes' field; '0' — (default)


31
# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 31

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

#offsetInteger

Returns Offset needed to return a specific subset of comments. By default, '0'.

Returns:

  • (Integer)

    Offset needed to return a specific subset of comments. By default, '0'.


33
# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 33

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

#owner_idInteger

Returns ID of the user or community that owns the album(s).

Returns:

  • (Integer)

    ID of the user or community that owns the album(s).


27
# File 'lib/vk/api/photos/methods/get_all_comments.rb', line 27

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