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 and Description
DocsAddQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
DocsAddQuery(VkApiClient client, UserActor actor, java.lang.Long ownerId, java.lang.Integer docId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
DocsAddQuery	accessKey(java.lang.String value) Access key.
DocsAddQuery	docId(java.lang.Integer 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
DocsAddQuery	ownerId(java.lang.Long 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, 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

DocsAddQuery

public DocsAddQuery(VkApiClient client,
                    UserActor actor,
                    java.lang.Long ownerId,
                    java.lang.Integer docId)

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

ownerId - value of "owner id" parameter. Entity - owner

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

DocsAddQuery

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

ownerId

public DocsAddQuery ownerId(java.lang.Long 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. Entity - owner

Returns:

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

docId

public DocsAddQuery docId(java.lang.Integer 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