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

Class DocsDeleteQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DocsDeleteQuery,OkResponse>

com.vk.api.sdk.queries.docs.DocsDeleteQuery

public class DocsDeleteQuery
extends AbstractQueryBuilder<DocsDeleteQuery,OkResponse>

Query for Docs.delete method

Constructor Summary

Constructors

Constructor	Description
DocsDeleteQuery(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
protected DocsDeleteQuery	docId(int value)	Document ID.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected DocsDeleteQuery	getThis()	Get reference to this object
protected DocsDeleteQuery	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

DocsDeleteQuery

public DocsDeleteQuery(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 DocsDeleteQuery 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 DocsDeleteQuery 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.

getThis

protected DocsDeleteQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DocsDeleteQuery,OkResponse>

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<DocsDeleteQuery,OkResponse>

Returns:

list of names