Package com.vk.api.sdk.queries.video

Class VideoGetCommentsQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<VideoGetCommentsQuery,GetCommentsResponse>

com.vk.api.sdk.queries.video.VideoGetCommentsQuery

public class VideoGetCommentsQuery
extends AbstractQueryBuilder<VideoGetCommentsQuery,GetCommentsResponse>

Query for Video.getComments method

Constructor Summary

Constructors

Constructor	Description
VideoGetCommentsQuery(VkApiClient client, UserActor actor, int videoId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
VideoGetCommentsQuery	count(java.lang.Integer value)	Number of comments to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
VideoGetCommentsQuery	extended(java.lang.Boolean value)	Set extended
VideoGetCommentsQuery	fields(java.lang.String... value)	fields Set fields
VideoGetCommentsQuery	fields(java.util.List<java.lang.String> value)	Set fields
protected VideoGetCommentsQuery	getThis()	Get reference to this object
VideoGetCommentsQuery	needLikes(java.lang.Boolean value)	'1' — to return an additional 'likes' field
VideoGetCommentsQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of comments.
VideoGetCommentsQuery	ownerId(java.lang.Integer value)	ID of the user or community that owns the video.
VideoGetCommentsQuery	sort(GetCommentsSort value)	Sort order: 'asc' — oldest comment first, 'desc' — newest comment first
VideoGetCommentsQuery	startCommentId(java.lang.Integer value)	Set start comment id
protected VideoGetCommentsQuery	videoId(int value)	Video ID.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoGetCommentsQuery

public VideoGetCommentsQuery(VkApiClient client,
                             UserActor actor,
                             int videoId)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

videoId - value of "video id" parameter. Minimum is 0.

Method Detail

ownerId

public VideoGetCommentsQuery ownerId(java.lang.Integer value)

ID of the user or community that owns the video.

Parameters:

value - value of "owner id" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

videoId

protected VideoGetCommentsQuery videoId(int value)

Video ID.

Parameters:

value - value of "video id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

needLikes

public VideoGetCommentsQuery needLikes(java.lang.Boolean value)

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

Parameters:

value - value of "need likes" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

startCommentId

public VideoGetCommentsQuery startCommentId(java.lang.Integer value)

Set start comment id

Parameters:

value - value of "start comment id" parameter. Minimum is 0.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

offset

public VideoGetCommentsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of comments.

Parameters:

value - value of "offset" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

count

public VideoGetCommentsQuery count(java.lang.Integer value)

Number of comments to return.

Parameters:

value - value of "count" parameter. Maximum is 100. Minimum is 0. By default 20.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

sort

public VideoGetCommentsQuery sort(GetCommentsSort value)

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

Parameters:

value - value of "sort" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

extended

public VideoGetCommentsQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public VideoGetCommentsQuery fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public VideoGetCommentsQuery fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected VideoGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoGetCommentsQuery,GetCommentsResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<VideoGetCommentsQuery,GetCommentsResponse>

Returns:

list of names