Class: Vk::API::Photos::Methods::GetComments
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Photos::Methods::GetComments
- Defined in:
- lib/vk/api/photos/methods/get_comments.rb
Overview
Returns a list of comments on a photo.
Arguments collapse
- #access_key ⇒ String
-
#count ⇒ Integer
Number of comments to return.
- #extended ⇒ Boolean
- #fields ⇒ Array
-
#need_likes ⇒ Boolean
'1' — to return an additional 'likes' field; '0' — (default).
-
#offset ⇒ Integer
Offset needed to return a specific subset of comments.
-
#owner_id ⇒ Integer
ID of the user or community that owns the photo.
-
#photo_id ⇒ Integer
Photo ID.
-
#sort ⇒ String
Sort order:; 'asc' — old first; 'desc' — new first.
- #start_comment_id ⇒ Integer
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Photos::Methods::GetComments
|
# File 'lib/vk/api/photos/methods/get_comments.rb', line 15
|
Instance Method Details
#access_key ⇒ String
46 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 46 attribute :access_key, API::Types::Coercible::String.optional.default(nil) |
#count ⇒ Integer
Returns Number of comments to return.
42 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 42 attribute :count, API::Types::Coercible::Int.optional.default(20) |
#extended ⇒ Boolean
48 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 48 attribute :extended, API::Types::Form::Bool.optional.default(nil) |
#fields ⇒ Array
50 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 50 attribute :fields, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil) |
#need_likes ⇒ Boolean
Returns '1' — to return an additional 'likes' field; '0' — (default).
36 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 36 attribute :need_likes, API::Types::Form::Bool.optional.default(nil) |
#offset ⇒ Integer
Returns Offset needed to return a specific subset of comments. By default, '0'.
40 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 40 attribute :offset, API::Types::Coercible::Int.optional.default(nil) |
#owner_id ⇒ Integer
Returns ID of the user or community that owns the photo.
32 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 32 attribute :owner_id, API::Types::Coercible::Int.optional.default(nil) |
#photo_id ⇒ Integer
Returns Photo ID.
34 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 34 attribute :photo_id, API::Types::Coercible::Int |
#sort ⇒ String
Returns Sort order:; 'asc' — old first; 'desc' — new first.
44 |
# File 'lib/vk/api/photos/methods/get_comments.rb', line 44 attribute :sort, API::Types::Coercible::String.optional.default(nil) |