com.vk.api.sdk.actions

Class Docs

java.lang.Object

com.vk.api.sdk.client.AbstractAction

com.vk.api.sdk.actions.Docs

public class Docs
extends AbstractAction

List of Docs methods

Constructor Summary

Constructors

Constructor and Description
Docs(VkApiClient client) Constructor

Method Summary

Modifier and Type	Method and Description
DocsAddQuery	add(UserActor actor) Copies a document to a user's or community's document list.
DocsAddQuery	add(UserActor actor, java.lang.Long ownerId, java.lang.Integer docId) Copies a document to a user's or community's document list.
DocsDeleteQuery	delete(UserActor actor) Deletes a user or community document.
DocsDeleteQuery	delete(UserActor actor, java.lang.Long ownerId, java.lang.Integer docId) Deletes a user or community document.
DocsEditQuery	edit(UserActor actor) Edits a document.
DocsEditQuery	edit(UserActor actor, java.lang.Integer docId, java.lang.String title) Edits a document.
DocsGetQuery	get(UserActor actor) Returns detailed information about user or community documents.
DocsGetByIdQuery	getById(GroupActor actor) Returns information about documents by their IDs.
DocsGetByIdQuery	getById(GroupActor actor, java.util.List<java.lang.String> docs) Returns information about documents by their IDs.
DocsGetByIdQuery	getById(GroupActor actor, java.lang.String... docs) Returns information about documents by their IDs.
DocsGetByIdQuery	getById(UserActor actor) Returns information about documents by their IDs.
DocsGetByIdQuery	getById(UserActor actor, java.util.List<java.lang.String> docs) Returns information about documents by their IDs.
DocsGetByIdQuery	getById(UserActor actor, java.lang.String... docs) Returns information about documents by their IDs.
DocsGetMessagesUploadServerQuery	getMessagesUploadServer(GroupActor actor) Returns the server address for document upload.
DocsGetMessagesUploadServerQuery	getMessagesUploadServer(UserActor actor) Returns the server address for document upload.
DocsGetTypesQuery	getTypes(UserActor actor) Returns documents types available for current user.
DocsGetUploadServerQuery	getUploadServer(UserActor actor) Returns the server address for document upload.
DocsGetWallUploadServerQuery	getWallUploadServer(GroupActor actor) Returns the server address for document upload onto a user's or community's wall.
DocsGetWallUploadServerQuery	getWallUploadServer(UserActor actor) Returns the server address for document upload onto a user's or community's wall.
DocsRestoreQuery	restore(UserActor actor)
DocsRestoreQuery	restore(UserActor actor, java.lang.Long ownerId, java.lang.Integer docId)
DocsSaveQuery	save(GroupActor actor) Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].
DocsSaveQuery	save(GroupActor actor, java.lang.String file) Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].
DocsSaveQuery	save(UserActor actor) Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].
DocsSaveQuery	save(UserActor actor, java.lang.String file) Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].
DocsSearchQuery	search(GroupActor actor) Returns a list of documents matching the search criteria.
DocsSearchQuery	search(UserActor actor) Returns a list of documents matching the search criteria.

Methods inherited from class com.vk.api.sdk.client.AbstractAction

getClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Docs

public Docs(VkApiClient client)

Constructor

Parameters:

client - vk api client

Method Detail

add

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

Copies a document to a user's or community's document list.

Parameters:

actor - vk user actor

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

docId - Document ID.

Returns:

query

add

public DocsAddQuery add(UserActor actor)

Copies a document to a user's or community's document list.

Parameters:

actor - vk user actor

Returns:

only actor query

delete

public DocsDeleteQuery delete(UserActor actor,
                              java.lang.Long ownerId,
                              java.lang.Integer docId)

Deletes a user or community document.

Parameters:

actor - vk user actor

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

docId - Document ID.

Returns:

query

delete

public DocsDeleteQuery delete(UserActor actor)

Deletes a user or community document.

Parameters:

actor - vk user actor

Returns:

only actor query

edit

public DocsEditQuery edit(UserActor actor,
                          java.lang.Integer docId,
                          java.lang.String title)

Edits a document.

Parameters:

actor - vk user actor

docId - Document ID.

title - Document title.

Returns:

query

edit

public DocsEditQuery edit(UserActor actor)

Edits a document.

Parameters:

actor - vk user actor

Returns:

only actor query

get

public DocsGetQuery get(UserActor actor)

Returns detailed information about user or community documents.

Parameters:

actor - vk user actor

Returns:

query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk user actor

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

Returns:

query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk user actor

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

Returns:

query

getById

public DocsGetByIdQuery getById(UserActor actor)

Returns information about documents by their IDs.

Parameters:

actor - vk user actor

Returns:

only actor query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk group actor

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

Returns:

query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk group actor

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

Returns:

query

getById

public DocsGetByIdQuery getById(GroupActor actor)

Returns information about documents by their IDs.

Parameters:

actor - vk group actor

Returns:

only actor query

getMessagesUploadServer

public DocsGetMessagesUploadServerQuery getMessagesUploadServer(UserActor actor)

Returns the server address for document upload.

Parameters:

actor - vk user actor

Returns:

query

getMessagesUploadServer

public DocsGetMessagesUploadServerQuery getMessagesUploadServer(GroupActor actor)

Returns the server address for document upload.

Parameters:

actor - vk group actor

Returns:

query

getTypes

public DocsGetTypesQuery getTypes(UserActor actor)

Returns documents types available for current user.

Parameters:

actor - vk user actor

Returns:

query

getUploadServer

public DocsGetUploadServerQuery getUploadServer(UserActor actor)

Returns the server address for document upload.

Parameters:

actor - vk user actor

Returns:

query

getWallUploadServer

public DocsGetWallUploadServerQuery getWallUploadServer(UserActor actor)

Returns the server address for document upload onto a user's or community's wall.

Parameters:

actor - vk user actor

Returns:

query

getWallUploadServer

public DocsGetWallUploadServerQuery getWallUploadServer(GroupActor actor)

Returns the server address for document upload onto a user's or community's wall.

Parameters:

actor - vk group actor

Returns:

query

restore

public DocsRestoreQuery restore(UserActor actor,
                                java.lang.Long ownerId,
                                java.lang.Integer docId)

Parameters:

actor - vk user actor

ownerId -

docId -

Returns:

query

restore

public DocsRestoreQuery restore(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

save

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

Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].

Parameters:

actor - vk user actor

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

Returns:

query

save

public DocsSaveQuery save(UserActor actor)

Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].

Parameters:

actor - vk user actor

Returns:

only actor query

save

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

Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].

Parameters:

actor - vk group actor

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

Returns:

query

save

public DocsSaveQuery save(GroupActor actor)

Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].

Parameters:

actor - vk group actor

Returns:

only actor query

search

public DocsSearchQuery search(UserActor actor)

Returns a list of documents matching the search criteria.

Parameters:

actor - vk user actor

Returns:

query

search

public DocsSearchQuery search(GroupActor actor)

Returns a list of documents matching the search criteria.

Parameters:

actor - vk group actor

Returns:

query