Package com.vk.api.sdk.queries.docs

Class DocsAddQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DocsAddQuery,java.lang.Integer>

com.vk.api.sdk.queries.docs.DocsAddQuery

public class DocsAddQuery
extends AbstractQueryBuilder<DocsAddQuery,java.lang.Integer>

Query for Docs.add method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocsAddQuery	accessKey(java.lang.String value)	Access key.
protected DocsAddQuery	docId(int value)	Document ID.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected DocsAddQuery	getThis()	Get reference to this object
protected DocsAddQuery	ownerId(int value)	ID of the user or community that owns the document.

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

DocsAddQuery

public DocsAddQuery(VkApiClient client,
                    UserActor actor,
                    int ownerId,
                    int docId)

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

ownerId - value of "owner id" parameter.

docId - value of "doc id" parameter. Minimum is 0.

Method Detail

ownerId

protected DocsAddQuery ownerId(int value)

ID of the user or community that owns the document. Use a negative value to designate a community ID.

Parameters:

value - value of "owner id" parameter.

Returns:

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

docId

protected DocsAddQuery docId(int value)

Document ID.

Parameters:

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

Returns:

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

accessKey

public DocsAddQuery accessKey(java.lang.String value)

Access key. This parameter is required if 'access_key' was returned with the document's data.

Parameters:

value - value of "access key" parameter.

Returns:

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

getThis

protected DocsAddQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DocsAddQuery,java.lang.Integer>

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<DocsAddQuery,java.lang.Integer>

Returns:

list of names