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 and Description
VideoGetCommentsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
VideoGetCommentsQuery(VkApiClient client, UserActor actor, java.lang.Integer videoId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
VideoGetCommentsQuery	commentId(java.lang.Integer value) Set comment id
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.util.List<java.lang.String> value) Set fields
VideoGetCommentsQuery	fields(java.lang.String... value) fields 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.Long 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
VideoGetCommentsQuery	threadItemsCount(java.lang.Integer value) Set thread items count
VideoGetCommentsQuery	videoId(java.lang.Integer value) Video ID.

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

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

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

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, 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,
                             java.lang.Integer videoId)

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

Parameters:

client - VK API client

actor - actor with access token

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

VideoGetCommentsQuery

public VideoGetCommentsQuery(VkApiClient client,
                             UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

ownerId

public VideoGetCommentsQuery ownerId(java.lang.Long value)

ID of the user or community that owns the video.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

videoId

public VideoGetCommentsQuery videoId(java.lang.Integer 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.

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. By default asc.

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.

commentId

public VideoGetCommentsQuery commentId(java.lang.Integer value)

Set comment id

Parameters:

value - value of "comment id" parameter.

Returns:

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

threadItemsCount

public VideoGetCommentsQuery threadItemsCount(java.lang.Integer value)

Set thread items count

Parameters:

value - value of "thread items count" parameter. Maximum is 10. Minimum is 0. By default 0.

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