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

• #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

• #initialize(arguments) ⇒ Photos::Methods::GetComments constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of the user or community that owns the photo.

• :photo_id (Integer) —

  Photo ID.

• :need_likes (Boolean) —

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

• :start_comment_id (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :offset (Integer) —

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

• :count (Integer) —

  Number of comments to return.

• :sort (String) —

  Sort order:; 'asc' — old first; 'desc' — new first

• :access_key (String) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :extended (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :fields (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

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

Instance Method Details

#access_key ⇒ String

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (String) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# 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.

Returns:

• (Integer) —

  Number of comments to return.

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

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

#extended ⇒ Boolean

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Boolean) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/photos/methods/get_comments.rb', line 48

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

#fields ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# 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).

Returns:

• (Boolean) —

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

# 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'.

Returns:

• (Integer) —

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

# 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.

Returns:

• (Integer) —

  ID of the user or community that owns the photo.

# 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.

Returns:

• (Integer) —

  Photo ID.

# 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.

Returns:

• (String) —

  Sort order:; 'asc' — old first; 'desc' — new first

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

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

#start_comment_id ⇒ Integer

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

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

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