ПродуктыДокументацияSDKПоддержкаПравила платформыСписок методов
Главная » Mobile SDK
Mobile SDK
1. Подключение в приложении
2. Методы Mobile Client API
    2.1. showInviteBox
    2.2. showRequestBox
    2.3. showShareBox
    2.4. showSettingsBox
    2.5. showOrderBox
    2.6. showLeaderboardBox
3. Обработка событий
    3.1. VK.addCallback
    3.2. VK.removeCallback
4. Вызов методов API

Обратите внимание! Мы завершаем поддержку Mobile SDK.
С 1 ноября 2019 года мы прекратили принимать в каталог игры, которые интегрированы с Direct Games через Mobile SDK. В каталоге будут опубликованы только игры с интеграцией через VK Connect.

Подобнее в Roadmap.


Mobile SDK позволяет работать с нативным интерфейсом в мобильном приложении ВКонтакте и предназначен для HTML5-игр на нашей платформе.
1. Подключение в приложении
Чтобы использовать Mobile SDK, добавьте подключение скрипта в <head> страницы: 

<script src="https://vk.com/js/api/mobile_sdk.js"  type="text/javascript"></script>


А затем инициализируйте объект VK:

<script type="text/javascript">
  VK.init(function() {
      // API initialization succeeded
      // Your code here
  }, function() {
     // API initialization failed
     // Can reload page here
}, '5.60');
</script>
2. Методы Mobile Client API
Эти методы используются для взаимодействия с нативным интерфейсом мобильного приложения. Обратите внимание, список методов Mobile Client API отличается от списка методов Client API для Javascript и Flash SDK. Чтобы вызвать метод Mobile Client API, используйте VK.callMethod().

2.1. showInviteBox
Параметры: —

Открывает окно для приглашения друзей пользователя в приложение. После закрытия окна вызывается событие onInviteBoxDone, в которое передаются значения:
  • status (string) — статус действия: cancel — отмена пользователем, success — успешно, fail — с ошибками;
  • [data (array) — массив идентификатор пользователей, для которых приглашение не было отправлено (status = fail).]

2.2. showRequestBox
Параметры: user_id (integer), message (string), request_key (string)

Открывает окно для отправки запроса пользователю user_id с текстом message. request_key — произвольная строка для отслеживания конверсии (request_key передается в параметрах запуска приложения, если оно запущено из запроса). После закрытия окна вызывается событие onRequestBoxDone, в которое передаются значения:
  • status (string) — статус действия: cancel — отмена пользователем, success — успешно, fail — с ошибками;

Перед вызовом showRequestBox необходимо получить список пользователей, которым можно отправлять запросы, с помощью API метода friends.getAppUsers.

2.3. showShareBox
Параметры: message (string), attachments (array), target (string)

Открывает окно для шаринга с текстом message и вложениями attachments. target = wall — шаринг на стену, target = im — шаринг в личные сообщения. У записи может быть максимум 2 вложения — фотография и ссылка (при target = im ссылку следует указать в тексте сообщения message). После закрытия окна вызывается событие onShareBoxDone, в которое передаются значения:
  • status (string) — статус действия: cancel — отмена пользователем, success — успешно, fail — с ошибками;

2.4. showSettingsBox
Параметры: settings (integer)

Открывает окно с запросом прав доступа для приложения. Параметр settings — это битовая маска запрашиваемых прав доступа. Если settings = 0, то пользователю будет предложено разрешить все возможные права доступа. После закрытия окна вызывается событие onSettingsBoxDone, в которое передаются значения:
  • status (string) — статус действия: cancel — отмена пользователем, success — успешно, fail — с ошибками;
  • [data (string) — новый access_token].

2.5. showOrderBox
Параметры: order (object)

Объект order содержит поля:
  • type (string) — содержит строку item.
  • item (string) — содержит наименование товара, которое будет отправлено в платежном уведомлении.

Открывает окно для покупки товара в приложении. После закрытия окна вызывается событие onOrderBoxDone, в которое передаются значения:
  • status (string) — статус действия: cancel — отмена пользователем, success — успешно, fail — с ошибками;

Добавьте тестировщиков платежей в настройках приложения в разделе «Платежи». На счету тестеров должен быть как минимум 1 голос. При оплате голоса не списываются со счета тестеров в пользу приложения.

Пример:
VK.callMethod("showOrderBox", {"type":"item","item":"MyOrderTitle"});


2.6. showLeaderboardBox
Параметры: user_result (integer)

Отображает окно с турнирной таблицей приложения. Турнирная таблица может отображать прогресс пользователей по очкам или уровням (тип турнирной таблицы выбирается в Управлении приложением). user_result — результат текущего пользователя. Для добавления уровня или очков пользователям используйте метод secure.addAppEvent.
3. Обработка событий
3.1. VK.addCallback
Параметры: string eventName, function callback.

Добавляет функцию callback в качестве обработчика события eventName.

3.2. VK.removeCallback
Параметры: string eventName, function callback.

Удаляет функцию callback из обработчика события eventName.
4. Вызов методов API
Методы API ВКонтакте позволяют работать с данными пользователей и сообществ ВКонтакте. Для обращения к методам API в Mobile SDK используется функция VK.api. Она принимает следующие параметры:
  • methodName (string) — название метода API;
  • params (object) — объект, содержащий параметры метода;
  • callback (function) — функция, в которую будет передан полученный результат после выполнения метода.

Параметры метода API передаются в виде пар «ключ»: «значение».