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

Class DocsSaveQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<DocsSaveQuery,SaveResponse>

com.vk.api.sdk.queries.docs.DocsSaveQuery

public class DocsSaveQuery
extends AbstractQueryBuilder<DocsSaveQuery,SaveResponse>

Query for Docs.save method

Constructor Summary

Constructors

Constructor	Description
DocsSaveQuery(VkApiClient client, GroupActor actor, java.lang.String file)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
DocsSaveQuery(VkApiClient client, UserActor actor, java.lang.String file)	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 DocsSaveQuery	file(java.lang.String value)	This parameter is returned when the file is [vk.com/dev/upload_files_2|uploaded to the server].
protected DocsSaveQuery	getThis()	Get reference to this object
DocsSaveQuery	returnTags(java.lang.Boolean value)	Set return tags
DocsSaveQuery	tags(java.lang.String value)	Document tags.
DocsSaveQuery	title(java.lang.String value)	Document 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

DocsSaveQuery

public DocsSaveQuery(VkApiClient client,
                     UserActor actor,
                     java.lang.String file)

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

file - value of "file" parameter.

DocsSaveQuery

public DocsSaveQuery(VkApiClient client,
                     GroupActor actor,
                     java.lang.String file)

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

file - value of "file" parameter.

Method Detail

file

protected DocsSaveQuery file(java.lang.String value)

This parameter is returned when the file is [vk.com/dev/upload_files_2|uploaded to the server].

Parameters:

value - value of "file" parameter.

Returns:

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

title

public DocsSaveQuery title(java.lang.String value)

Document title.

Parameters:

value - value of "title" parameter.

Returns:

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

tags

public DocsSaveQuery tags(java.lang.String value)

Document tags.

Parameters:

value - value of "tags" parameter.

Returns:

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

returnTags

public DocsSaveQuery 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.

getThis

protected DocsSaveQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<DocsSaveQuery,SaveResponse>

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<DocsSaveQuery,SaveResponse>

Returns:

list of names