com.vk.api.sdk.queries.video

Class VideoGetCommentsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<VideoGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

com.vk.api.sdk.queries.video.VideoGetCommentsQueryWithExtended

public class VideoGetCommentsQueryWithExtended
extends AbstractQueryBuilder<VideoGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

Query for Video.getComments method

Constructor Summary

Constructors

Constructor and Description
VideoGetCommentsQueryWithExtended(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
VideoGetCommentsQueryWithExtended	commentId(java.lang.Integer value) Set comment id
VideoGetCommentsQueryWithExtended	count(java.lang.Integer value) Number of comments to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected VideoGetCommentsQueryWithExtended	extended(java.lang.Boolean value) Set extended
VideoGetCommentsQueryWithExtended	fields(java.util.List<java.lang.String> value) Set fields
VideoGetCommentsQueryWithExtended	fields(java.lang.String... value) fields Set fields
protected VideoGetCommentsQueryWithExtended	getThis() Get reference to this object
VideoGetCommentsQueryWithExtended	needLikes(java.lang.Boolean value) '1' - to return an additional 'likes' field
VideoGetCommentsQueryWithExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of comments.
VideoGetCommentsQueryWithExtended	ownerId(java.lang.Long value) ID of the user or community that owns the video.
VideoGetCommentsQueryWithExtended	sort(GetCommentsSort value) Sort order: 'asc' - oldest comment first, 'desc' - newest comment first
VideoGetCommentsQueryWithExtended	startCommentId(java.lang.Integer value) Set start comment id
VideoGetCommentsQueryWithExtended	threadItemsCount(java.lang.Integer value) Set thread items count
VideoGetCommentsQueryWithExtended	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

VideoGetCommentsQueryWithExtended

public VideoGetCommentsQueryWithExtended(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.

Method Detail

ownerId

public VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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

protected VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended 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 VideoGetCommentsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<VideoGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

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<VideoGetCommentsQueryWithExtended,GetCommentsExtendedResponse>

Returns:

list of names