VKApiDocs Class Reference

Inherits from VKApiBase : VKObject : NSObject
Declared in VKApiDocs.h
VKApiDocs.m

Overview

Builds requests for API.docs part

– get

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

- (VKRequest *)get

Return Value

Request to load

Discussion

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

Declared In

VKApiDocs.h

– get:

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

- (VKRequest *)get:(NSInteger)count

Parameters

count

Number of documents to return.

Return Value

Request to load

Discussion

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

Declared In

VKApiDocs.h

– get:andOffset:

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

- (VKRequest *)get:(NSInteger)count andOffset:(NSInteger)offset

Parameters

count

Number of documents to return. By default, all documents.
offset

Offset needed to return a specific subset of documents.

Return Value

Request to load

Discussion

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

Declared In

VKApiDocs.h

– get:andOffset:andOwnerID:

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

- (VKRequest *)get:(NSInteger)count andOffset:(NSInteger)offset andOwnerID:(NSInteger)ownerID

Parameters

count

Number of documents to return. By default, all documents.
offset

Offset needed to return a specific subset of documents.
ownerID

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

Return Value

Request to load

Discussion

Returns detailed information about user or community documents. https://vk.com/dev/docs.get

Declared In

VKApiDocs.h

– getByID:

Returns information about documents by their IDs. https://vk.com/dev/docs.getById

- (VKRequest *)getByID:(NSArray *)IDs

Parameters

IDs

Document IDs.

Return Value

Request to load

Discussion

Returns information about documents by their IDs. https://vk.com/dev/docs.getById

Declared In

VKApiDocs.h

– getUploadServer

Returns the server address for document upload. https://vk.com/dev/docs.getUploadServer

- (VKRequest *)getUploadServer

Return Value

Request to load

Discussion

Returns the server address for document upload. https://vk.com/dev/docs.getUploadServer

Declared In

VKApiDocs.h

– getUploadServer:

Returns the server address for document upload. https://vk.com/dev/docs.getUploadServer

- (VKRequest *)getUploadServer:(NSInteger)group_id

Parameters

group_id

ID of the community the document will be uploaded to.

Return Value

Request to load

Discussion

Returns the server address for document upload. https://vk.com/dev/docs.getUploadServer

Declared In

VKApiDocs.h

– getWallUploadServer

Returns the server address for document upload onto a user’s or community’s wall. https://vk.com/dev/docs.getWallUploadServer

- (VKRequest *)getWallUploadServer

Return Value

Request to load

Discussion

Returns the server address for document upload onto a user’s or community’s wall. https://vk.com/dev/docs.getWallUploadServer

Declared In

VKApiDocs.h

– getWallUploadServer:

Returns the server address for document upload onto a user’s or community’s wall. https://vk.com/dev/docs.getWallUploadServer

- (VKRequest *)getWallUploadServer:(NSInteger)group_id

Parameters

group_id

ID of the community the document will be uploaded to.

Return Value

Request to load

Discussion

Returns the server address for document upload onto a user’s or community’s wall. https://vk.com/dev/docs.getWallUploadServer

Declared In

VKApiDocs.h

– save:

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

- (VKRequest *)save:(NSString *)file

Parameters

file

This parameter is returned when the file is uploaded to the server.

Return Value

Request to load

Discussion

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

Declared In

VKApiDocs.h

– save:andTitle:

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

- (VKRequest *)save:(NSString *)file andTitle:(NSString *)title

Parameters

file

This parameter is returned when the file is uploaded to the server.
title

Document title.

Return Value

Request to load

Discussion

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

Declared In

VKApiDocs.h

– save:andTitle:andTags:

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

- (VKRequest *)save:(NSString *)file andTitle:(NSString *)title andTags:(NSString *)tags

Parameters

file

This parameter is returned when the file is uploaded to the server.
title

Document title
tags

Document tags

Return Value

Request to load

Discussion

Saves a document after uploading it to a server. https://vk.com/dev/docs.save

Declared In

VKApiDocs.h

– delete:andDocID:

Deletes a user or community document. https://vk.com/dev/docs.delete

- (VKRequest *)delete:(NSInteger)ownerID andDocID:(NSInteger)docID

Parameters

ownerID

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

Document ID.

Return Value

Request to load

Discussion

Deletes a user or community document. https://vk.com/dev/docs.delete

Declared In

VKApiDocs.h

– add:andDocID:

Copies a document to a user’s or community’s document list. https://vk.com/dev/docs.add

- (VKRequest *)add:(NSInteger)ownerID andDocID:(NSInteger)docID

Parameters

ownerID

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

Document ID.

Return Value

Request to load

Discussion

Copies a document to a user’s or community’s document list. https://vk.com/dev/docs.add

Declared In

VKApiDocs.h

– add:andDocID:andAccessKey:

Copies a document to a user’s or community’s document list. https://vk.com/dev/docs.add

- (VKRequest *)add:(NSInteger)ownerID andDocID:(NSInteger)docID andAccessKey:(NSString *)accessKey

Parameters

ownerID

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

Document ID.
accessKey

Access key. This parameter is required if access_key was returned with the document’s data.

Return Value

Request to load

Discussion

Copies a document to a user’s or community’s document list. https://vk.com/dev/docs.add

Declared In

VKApiDocs.h