Package com.vk.api.sdk.queries.pages

Class PagesGetQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.pages.PagesGetQuery

public class PagesGetQuery
extends AbstractQueryBuilder<PagesGetQuery,GetResponse>

Query for Pages.get method

Constructor Summary

Constructors

Constructor	Description
PagesGetQuery(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
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected PagesGetQuery	getThis()	Get reference to this object
PagesGetQuery	global(java.lang.Boolean value)	'1' — to return information about a global wiki page
PagesGetQuery	needHtml(java.lang.Boolean value)	'1' — to return the page as HTML,
PagesGetQuery	needSource(java.lang.Boolean value)	Set need source
PagesGetQuery	ownerId(java.lang.Integer value)	Page owner ID.
PagesGetQuery	pageId(java.lang.Integer value)	Wiki page ID.
PagesGetQuery	sitePreview(java.lang.Boolean value)	'1' — resulting wiki page is a preview for the attached link
PagesGetQuery	title(java.lang.String value)	Wiki page title.

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

PagesGetQuery

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

ownerId

public PagesGetQuery ownerId(java.lang.Integer value)

Page owner ID.

Parameters:

value - value of "owner id" parameter.

Returns:

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

pageId

public PagesGetQuery pageId(java.lang.Integer value)

Wiki page ID.

Parameters:

value - value of "page id" parameter.

Returns:

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

global

public PagesGetQuery global(java.lang.Boolean value)

'1' — to return information about a global wiki page

Parameters:

value - value of "global" parameter.

Returns:

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

sitePreview

public PagesGetQuery sitePreview(java.lang.Boolean value)

'1' — resulting wiki page is a preview for the attached link

Parameters:

value - value of "site preview" parameter.

Returns:

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

title

public PagesGetQuery title(java.lang.String value)

Wiki page title.

Parameters:

value - value of "title" parameter.

Returns:

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

needSource

public PagesGetQuery needSource(java.lang.Boolean value)

Set need source

Parameters:

value - value of "need source" parameter.

Returns:

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

needHtml

public PagesGetQuery needHtml(java.lang.Boolean value)

'1' — to return the page as HTML,

Parameters:

value - value of "need html" parameter.

Returns:

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

getThis

protected PagesGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PagesGetQuery,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<PagesGetQuery,GetResponse>

Returns:

list of names