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

Class NotesGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<NotesGetByIdQuery,GetByIdResponse>

com.vk.api.sdk.queries.notes.NotesGetByIdQuery

public class NotesGetByIdQuery
extends AbstractQueryBuilder<NotesGetByIdQuery,GetByIdResponse>

Query for Notes.getById method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected NotesGetByIdQuery	getThis()	Get reference to this object
NotesGetByIdQuery	needWiki(java.lang.Boolean value)	Set need wiki
protected NotesGetByIdQuery	noteId(int value)	Note ID.
NotesGetByIdQuery	ownerId(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

NotesGetByIdQuery

public NotesGetByIdQuery(VkApiClient client,
                         UserActor actor,
                         int noteId)

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

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

Method Detail

noteId

protected NotesGetByIdQuery noteId(int 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 NotesGetByIdQuery ownerId(java.lang.Integer value)

Note owner ID.

Parameters:

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

Returns:

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

needWiki

public NotesGetByIdQuery needWiki(java.lang.Boolean value)

Set need wiki

Parameters:

value - value of "need wiki" parameter. By default 0.

Returns:

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

getThis

protected NotesGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<NotesGetByIdQuery,GetByIdResponse>

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<NotesGetByIdQuery,GetByIdResponse>

Returns:

list of names