com.vk.api.sdk.queries.docs

Class DocsGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DocsGetByIdQuery,java.util.List<GetByIdResponse>>

com.vk.api.sdk.queries.docs.DocsGetByIdQuery

public class DocsGetByIdQuery
extends AbstractQueryBuilder<DocsGetByIdQuery,java.util.List<GetByIdResponse>>

Query for Docs.getById method

Constructor Summary

Constructors

Constructor and Description
DocsGetByIdQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
DocsGetByIdQuery(VkApiClient client, GroupActor actor, java.util.List<java.lang.String> docs) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
DocsGetByIdQuery(VkApiClient client, GroupActor actor, java.lang.String... docs) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
DocsGetByIdQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
DocsGetByIdQuery(VkApiClient client, UserActor actor, java.util.List<java.lang.String> docs) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
DocsGetByIdQuery(VkApiClient client, UserActor actor, java.lang.String... docs) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
DocsGetByIdQuery	docs(java.util.List<java.lang.String> value) Document IDs.
DocsGetByIdQuery	docs(java.lang.String... value) docs Document IDs.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected DocsGetByIdQuery	getThis() Get reference to this object
DocsGetByIdQuery	returnTags(java.lang.Boolean value) Set return tags

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

DocsGetByIdQuery

public DocsGetByIdQuery(VkApiClient client,
                        GroupActor actor,
                        java.lang.String... docs)

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

docs - value of "docs" parameter.

DocsGetByIdQuery

public DocsGetByIdQuery(VkApiClient client,
                        GroupActor actor,
                        java.util.List<java.lang.String> docs)

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

docs - value of "docs" parameter.

DocsGetByIdQuery

public DocsGetByIdQuery(VkApiClient client,
                        GroupActor actor)

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

DocsGetByIdQuery

public DocsGetByIdQuery(VkApiClient client,
                        UserActor actor,
                        java.lang.String... docs)

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

docs - value of "docs" parameter.

DocsGetByIdQuery

public DocsGetByIdQuery(VkApiClient client,
                        UserActor actor,
                        java.util.List<java.lang.String> docs)

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

docs - value of "docs" parameter.

DocsGetByIdQuery

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

returnTags

public DocsGetByIdQuery returnTags(java.lang.Boolean value)

Set return tags

Parameters:

value - value of "return tags" parameter. By default false.

Returns:

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

docs

public DocsGetByIdQuery docs(java.lang.String... value)

docs Document IDs. Example: , "66748_91488,66748_91455",

Parameters:

value - value of "docs" parameter.

Returns:

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

docs

public DocsGetByIdQuery docs(java.util.List<java.lang.String> value)

Document IDs. Example: , "66748_91488,66748_91455",

Parameters:

value - value of "docs" parameter.

Returns:

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

getThis

protected DocsGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DocsGetByIdQuery,java.util.List<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<DocsGetByIdQuery,java.util.List<GetByIdResponse>>

Returns:

list of names