My favorites | Sign in
Project Home Wiki Issues Source
Search
for
Documentation  
Документация по использованию библиотеки.
Featured
Updated Feb 2, 2010 by alexande...@gmail.com

Свойства и методы не являются статическими! Необходимо создать объект при помощи конструктора vk_api() и работать с созданным объектом.

Константы объекта

Имя константы Описание
SETT_NOTIFY Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил отправлять ему уведомления
SETT_FRIENDS Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к друзьям
SETT_PHOTOS Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к фотографиям
SETT_AUDIO Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к аудиозаписям
SETT_OFFER Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к предложениям
SETT_QUESTIONS Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к вопросам
SETT_WIKI Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к wiki-страницам
SETT_MENU Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил доступ к меню слева
SETT_WALL Используется в методах makeSettings() и external.showSettingsBox() для указания на то, что пользователь разрешил публикацию на стене

Свойства объекта

Название свойства Описание
params Параметры, переданные приложению после запуска. Аналог flashVars в случае с Flash-приложениями. Представляет собой объект типа {key: value}
external Содержит методы для доступа к внешним вызовам. Описан ниже

Методы

Название метода Параметры Описание
call String method,
[Object parameters,]
Function onData
Вызывает метод API method, передавая серверу параметры parameters, если указаны. Когда сервер вернет результат, будет вызван обработчик onData с полученным от сервера JSON-объектом в качестве единственного параметра
addCallback String name,
Function callback
Добавляет функцию callback в качестве обработчика события name. Обработчики описаны в официальной документации Вконактев разделе Обработка событий. Функция возвращает ID установленного обработчика.
removeCallback String name,
Number callback_id
Удаляет обработчик события name, ID которого callback_id (возвращается методом addCallback()).
makeInstall Function isInstalled Заставляет пользователя установить приложение. При вызове открывает окно установки приложения. Если пользователь отказывается от установки, вместо приложения будет отображаться сообщение о том, что необходимо установить приложение и ссылка для установки.
makeSettings Number settings Заставляет пользователя установить приложению настройки settings. Отображает окно установки настроек с выбранными опциями. Если пользователь не согласится с установкой параметров settings, то вместо приложения будет отображаться сообщение о том, что необходимо произвести настройку и ссылка, активирующая окно настроек.

Методы внешних вызовов

Имейте ввиду, что данные методы могут меняться разработчиками контакта. Актуальный список методов внешних вызовов доступен в официальной документации Вконтакте.

Название метода Параметры Описание
showPaymentBox Number votes Открывает окно для ввода голосов на счет в приложении. Если параметр votes равен 0, то пользователю будет предложено указать количество голосов вручную. По умолчанию votes равен 0
showSettingsBox Number settings Открывает окно с пользовательскими настройками приложения. Параметр settings — это битовая маска запрашиваемых настроек. Если параметр settings равен 0, то пользователю будет предложено разрешить все действия приложению. Подробнее о настройках приложения можно прочитать в описании метода getUserSettings официальной документации Вконтакте
showInstallBox Открывает окно с предложением установить приложение
showInviteBox Открывает окно для приглашения друзей пользователя в приложение
resizeWindow Number width,
Number height
Инициирует изменение ширины и высоты элемента iframe. Максимальное значение ширины окна соответствует 807 или 827 точек в зависимости от того включены отступы и элементы управления или нет
scrollWindow Number top,
Number speed
Инициирует скроллинг окна браузера по вертикали. Параметр top задает смещение скролла относительно нулевой координаты окна. Например, для того, чтобы прокрутить окно на самый верх страницы, необходимо передать значение 0. Второй параметр speed задает скорость анимации в миллисекундах и по умолчанию равен 0


Sign in to add a comment
Powered by Google Project Hosting