com.vk.api.sdk.queries.notes

Class NotesGetCommentsQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.notes.NotesGetCommentsQuery

public class NotesGetCommentsQuery
extends AbstractQueryBuilder<NotesGetCommentsQuery,GetCommentsResponse>

Query for Notes.getComments method

Constructor Summary

Constructors

Constructor and Description
NotesGetCommentsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
NotesGetCommentsQuery(VkApiClient client, UserActor actor, java.lang.Integer noteId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
NotesGetCommentsQuery	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 NotesGetCommentsQuery	getThis() Get reference to this object
NotesGetCommentsQuery	noteId(java.lang.Integer value) Note ID.
NotesGetCommentsQuery	offset(java.lang.Integer value) Set offset
NotesGetCommentsQuery	ownerId(java.lang.Long value) Note owner ID.
NotesGetCommentsQuery	sort(GetCommentsSort value) Set sort

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

NotesGetCommentsQuery

public NotesGetCommentsQuery(VkApiClient client,
                             UserActor actor,
                             java.lang.Integer noteId)

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

noteId - value of "note id" parameter. Minimum is 0.

NotesGetCommentsQuery

public NotesGetCommentsQuery(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

noteId

public NotesGetCommentsQuery noteId(java.lang.Integer value)

Note ID.

Parameters:

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

Returns:

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

ownerId

public NotesGetCommentsQuery ownerId(java.lang.Long value)

Note owner ID.

Parameters:

value - value of "owner id" parameter. Minimum is 0. Entity - owner

Returns:

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

sort

public NotesGetCommentsQuery sort(GetCommentsSort value)

Set sort

Parameters:

value - value of "sort" parameter. Minimum is 0. By default 0.

Returns:

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

offset

public NotesGetCommentsQuery offset(java.lang.Integer value)

Set offset

Parameters:

value - value of "offset" parameter. Minimum is 0. By default 0.

Returns:

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

count

public NotesGetCommentsQuery 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.

getThis

protected NotesGetCommentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<NotesGetCommentsQuery,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<NotesGetCommentsQuery,GetCommentsResponse>

Returns:

list of names