VkApi

Функции

-
call(method, args, callback)
upload(uploadUrl, fileFieldName, fileUri, args, callback)
myId()
getAccounts()
setAccount(account)

Свойства

Имя	Тип
onMessage	function
onMessageEdit	function
onMessageDelete	function
onTyping	function
onStopTyping	function
onReadIn	function
onReadOut	function
onUserOnline	function
onUserOffline	function
onAdminAdded	function
onAdminRemoved	function

Функции

call(method, args, callback)

Вызывает метод VK API method с аргументами args, по получению ответа, возвращает его в callback. Берётся авторизация от текущего аккаунта.
Пример:

var args = {peer_id: Vk.myId(), message: "Привет из SovaScript!", random_id: randomInt()};
Vk.call('messages.send', args, function(response){
    log(response);
});

Аргументы
String method	Метод VK API, который нужно вызвать
Object args	Объект, содержащий поля ключ:значение аргументов, которые нужно передать в запрос
function(VkApiResponse) args	Функция, в которую будет доставлен результат запроса

upload(uploadUrl, fileFieldName, fileUri, args, callback)

Загружает файл с uri fileUri на сервер uploadUrl. Сервер можно получить например из метода VK API photos.getMessagesUploadServer. Подробнее про загрузку файлов в VK можно прочитать здесь.

Аргументы
String uploadUrl	Ссылка, по которой нужно загрузить файл
String fileFieldName	Имя поля с файлом в multipart/form-data
String fileUri	Uri файла, полученный например из pickFile
Object args	Объект, содержащий поля ключ:значение дополнительных аргументов, которые нужно передать в запрос
function(VkApiResponse) args	Функция, в которую будет доставлен результат запроса

myId()

Возвращает ID текущего аккаунта VK

Возвращает
int	ID текущего аккаунта VK

getAccounts()

Возвращает список доступных аккаунтов

Возвращает
Array of VkApiAccount	Массив доступных аккаунтов

setAccount(account)

Устанавливает текущий аккаунт для метода call(method, args, callback), не действует на колбэки от LongPoll.

Аргументы
VkApiAccount или int account	VkApiAccount целового аккаунта, либо его ID как int

Свойства

onMessage

Тип: function(VkApiMessage message)

Функция, которая будет вызвана при получении нового сообщения от LongPoll VK. Обратите внимание, что сюда также попадают отправленные сообщения, а не только входящие.
Пример:

Vk.onMessage = function(message) {
    if(!message.incoming || !message.isPm()){
        return;
    }

    var responseText = "idk, try sending me \"ping\"";
    if(message.text.toLowerCase() === "ping"){
        responseText = "Pong.";
    }

    Vk.call('messages.send', {peer_id: message.fromId, message: responseText, random_id: randomInt()}, function(response){
        log(response);
    });
}

Аргументы
VkApiMessage message	Новое отправленное/полученное сообщение

onMessageEdit

Тип: function(VkApiMessage message)

Функция, которая будет вызвана при редактировании сообщения.

Аргументы
VkApiMessage message	Отредактированное сообщение

onMessageDelete

Тип: function(int messageId)

Функция, которая будет вызвана при удалении сообщения.

Аргументы
int messageId	ID удалённого сообщения

onTyping

Тип: function(VkApiTyping typing)

Функция, которая будет вызвана при наборе сообщения пользователем.

Аргументы
VkApiTyping typing	VkApiTyping с информацией о том, кто и где набирает сообщение

onStopTyping

Тип: function(VkApiTyping typing)

Функция, которая будет вызвана при остановке набора сообщения пользователем.

Аргументы
VkApiTyping typing	VkApiTyping с информацией о том, кто и где перестал набирать сообщение

onReadIn

Тип: function(int peerId, int messageId)

Функция, которая будет вызвана при прочтении вами сообщения с ID messageId в диалоге с ID peerId.

Аргументы
int peerId	ID диалога, в котором было прочитано сообщение
int messageId	ID прочитанного сообщения

onReadOut

Тип: function(int peerId, int messageId)

Функция, которая будет вызвана при прочтении вашего сообщения с ID messageId в диалоге с ID peerId.

Аргументы
int peerId	ID диалога, в котором было прочитано сообщение
int messageId	ID прочитанного сообщения

onUserOnline

Тип: function(int userId, int appId)

Функция, которая будет вызвана при появлении пользователя с ID userId в онлайн.

Аргументы
int userId	ID пользователя, появившегося в онлайн
int appId	ID приложения, которое использует пользователь

onUserOffline

Тип: function(int userId)

Функция, которая будет вызвана при уходе пользователя с ID userId в оффлайн.

Аргументы
int userId	ID пользователя, ушедшего в оффлайн

onAdminAdded

Тип: function(int peerId, int userId)

Функция, которая будет вызвана при становлении пользователя с ID userId администратором в беседе с ID peerId.

Аргументы
int peerId	ID пользователя, ставшего администратором
int userId	ID беседы, в которой пользователь стал администратором

onAdminRemoved

Тип: function(int peerId, int userId)

Функция, которая будет вызвана при снятии пользователя с ID userId с должности администратора в беседе с ID peerId.

Аргументы
int peerId	ID пользователя, переставшего быть администратором
int userId	ID беседы, в которой пользователь перестал быть администратором