Package com.vk.api.sdk.queries.notes

Class NotesGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<NotesGetQuery,GetResponse>

com.vk.api.sdk.queries.notes.NotesGetQuery

public class NotesGetQuery
extends AbstractQueryBuilder<NotesGetQuery,GetResponse>

Query for Notes.get method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NotesGetQuery	count(java.lang.Integer value)	Number of notes to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected NotesGetQuery	getThis()	Get reference to this object
NotesGetQuery	noteIds(java.lang.Integer... value)	note_ids Note IDs.
NotesGetQuery	noteIds(java.util.List<java.lang.Integer> value)	Note IDs.
NotesGetQuery	offset(java.lang.Integer value)	Set offset
NotesGetQuery	sort(GetSort value)	Set sort
NotesGetQuery	userId(java.lang.Integer value)	Note owner 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

NotesGetQuery

public NotesGetQuery(VkApiClient client,
                     UserActor actor)

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

Method Detail

userId

public NotesGetQuery userId(java.lang.Integer value)

Note owner ID.

Parameters:

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

Returns:

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

offset

public NotesGetQuery 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 NotesGetQuery count(java.lang.Integer value)

Number of notes 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 NotesGetQuery sort(GetSort 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.

noteIds

public NotesGetQuery noteIds(java.lang.Integer... value)

note_ids Note IDs.

Parameters:

value - value of "note ids" parameter.

Returns:

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

noteIds

public NotesGetQuery noteIds(java.util.List<java.lang.Integer> value)

Note IDs.

Parameters:

value - value of "note ids" parameter.

Returns:

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

getThis

protected NotesGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<NotesGetQuery,GetResponse>

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<NotesGetQuery,GetResponse>

Returns:

list of names