Package 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	Description
Docs(VkApiClient client)	Constructor

Method Summary

Modifier and Type	Method	Description
DocsAddQuery	add(UserActor actor, int ownerId, int docId)	Copies a document to a user's or community's document list.
DocsDeleteQuery	delete(UserActor actor, int ownerId, int docId)	Deletes a user or community document.
DocsEditQuery	edit(UserActor actor, int ownerId, int docId, java.lang.String title)	Edits a document.
DocsGetQuery	get(UserActor actor)	Returns detailed information about user or community documents.
DocsGetByIdQuery	getById(GroupActor actor, java.lang.String... docs)	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(UserActor actor, java.lang.String... docs)	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.
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, int ownerId)	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.
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, java.lang.String file)	Saves a document after [vk.com/dev/upload_files_2|uploading it to a server].
DocsSearchQuery	search(GroupActor actor, java.lang.String q)	Returns a list of documents matching the search criteria.
DocsSearchQuery	search(UserActor actor, java.lang.String q)	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,
                        int ownerId,
                        int docId)

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

Parameters:

actor - vk 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,
                              int ownerId,
                              int docId)

Deletes a user or community document.

Parameters:

actor - vk 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

edit

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

Edits a document.

Parameters:

actor - vk actor

ownerId - User ID or community ID. Use a negative value to designate a community ID.

docId - Document ID.

title - Document title.

Returns:

query

get

public DocsGetQuery get(UserActor actor)

Returns detailed information about user or community documents.

Parameters:

actor - vk actor

Returns:

query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk 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 actor

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

Returns:

query

getById

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

Returns information about documents by their IDs.

Parameters:

actor - vk 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 actor

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

Returns:

query

getMessagesUploadServer

public DocsGetMessagesUploadServerQuery getMessagesUploadServer(UserActor actor)

Returns the server address for document upload.

Parameters:

actor - vk actor

Returns:

query

getMessagesUploadServer

public DocsGetMessagesUploadServerQuery getMessagesUploadServer(GroupActor actor)

Returns the server address for document upload.

Parameters:

actor - vk actor

Returns:

query

getTypes

public DocsGetTypesQuery getTypes(UserActor actor,
                                  int ownerId)

Returns documents types available for current user.

Parameters:

actor - vk actor

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

Returns:

query

getUploadServer

public DocsGetUploadServerQuery getUploadServer(UserActor actor)

Returns the server address for document upload.

Parameters:

actor - vk 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 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 actor

Returns:

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 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,
                          java.lang.String file)

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

Parameters:

actor - vk actor

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

Returns:

query

search

public DocsSearchQuery search(UserActor actor,
                              java.lang.String q)

Returns a list of documents matching the search criteria.

Parameters:

actor - vk actor

q - Search query string.

Returns:

query

search

public DocsSearchQuery search(GroupActor actor,
                              java.lang.String q)

Returns a list of documents matching the search criteria.

Parameters:

actor - vk actor

q - Search query string.

Returns:

query