Избранное | Русский | Войти

Справочное руководство по API гаджетов Google Wave

Этот документ представляет собой справочное руководство по API гаджетов Google Wave.

Содержание

  1. Библиотека: wave-bundle.js
  2. Конструкторы
  3. Функции

Библиотека: wave-bundle.js

Предоставляет доступ к API волн в гаджетах. Клиенты могут обращаться к API волн с помощью объекта волны.

Пример:

  if (wave && wave.isInWaveContainer()) {
    /* do something */
  }

Конструкторы

wave.Callback (callback, opt_context)

Постоянный вспомогательный класс для обработки обратных вызовов с переменными аргументами и дополнительным контекстом.

Параметры

function (Array.<*>, ?Object=), null callback Функция обратного вызова либо null.
Объект opt_context Если контекст указан, метод будет вызван в контексте этого объекта (не является обязательным).

Методы

wave.Participant()

Класс Participant, описывающий участников в волне.

Методы

wave.State()

Класс State для управления состоянием гаджета.

Методы

  • get (key, opt_default)

Функции

wave.Callback.invoke (var_args)

Инициирует метод обратного вызова с переданными аргументами.

Параметры

var_args

wave.util.printJson (obj, opt_pretty, opt_tabs)

Выводит объекты JSON в текстовом формате. Позволяет обеспечить аккуратную печать.

Параметры

Объект obj Объект, который нужно напечатать.
Логическое значение opt_pretty Если задано значение true, применяется аккуратная печать (не является обязательным).
Число opt_tabs Количество позиций табуляции для отступа.

Возвращает

Строка Форматированный объект в виде текста.

wave.Participant.getId ()

Получает уникальный идентификатор участника.

Возвращает

Строка Идентификатор участника.

wave.Participant.getDisplayName ()

Получает уникальный идентификатор участника.

Возвращает

Строка Идентификатор участника.

wave.Participant.getThumbnailUrl ()

Получает URL уменьшенного изображения для данного участника.

Возвращает

Строка URL уменьшенного изображения для участника.

wave.State.get (key, opt_default)

Получает значение из синхронизированного состояния. В настоящее время метод get всегда возвращает строку. Это изменится в будущем – возвращаться будет заданное значение.

Параметры

Строка key Значение указанного ключа, который нужно получить.
Строка opt_default Дополнительное значение по умолчанию, если ключ не существует (не является обязательным).

Возвращает

Строка, null Объект для указанного ключа или null, если объект не найден.

wave.State.getKeys ()

Получает действительные ключи для синхронизированного состояния.

Возвращает

Массив Набор ключей

wave.State.submitDelta (delta)

Обновляет разницу состояний. Это асинхронный вызов, который обновляет состояние, однако изменение вступает в силу не сразу. При создании ключа со значением null пытается его удалить.

Параметры

Object delta Карта пар ключ-значение, представляющая разницу между ключами, которую нужно обновить.

wave.State.toString ()

Аккуратная печать объекта текущего состояния. Обратите внимание, что этот метод используется только для отладки.

Возвращает

Состояние в виде строки.

wave.isInWaveContainer()

Указывает, выполняется ли гаджет в контейнере волны.

Возвращает

Логическое значение Выполняется ли гаджет в контейнере волны

wave.getViewer()

Получает участника, клиент которого отображает данный гаджет.

Возвращает

wave.Participant Зритель (null, если не известен).

wave.getHost()

Получает хост, т.е. участника, который добавил этот гаджет во всплеск. Обратите внимание, что хост может больше не входить в список участников.

Возвращает

wave.Participant Хост (null, если не известен).

wave.getParticipants()

Возвращает список участников в волне.

Возвращает

Массив Список участников.

wave.getParticipantById (id)

Возвращает объект Participant с заданным идентификатором.

Параметры

Строка id Идентификатор участника, которого нужно получить.

Возвращает

wave.Participant Участник с указанным идентификатором.

wave.getState()

Возвращает объект состояния гаджета.

Возвращает

wave.State Состояние гаджета (null, если не известно).

wave.isPlayback()

Возвращает состояние воспроизведения волны, вейвлета или гаджета.

Возвращает

Логическое значение Должен ли гаджет быть в состоянии воспроизведения.

wave.setStateCallback (callback, opt_context)

Задает функцию обратного вызова для обновления состояния гаджета. Если состояние уже получено из контейнера, функция обратного вызова инициируется незамедлительно, чтобы сообщить текущее состояние гаджета. Можно определить только одну функцию обратного вызова. При последовательных вызовах старая функция обратного вызова будет удалена, а новая – добавлена.

Параметры

Функция callback функция
Объект opt_context Объект, который получает обратный вызов.

wave.setParticipantCallback (callback, opt_context)

Устанавливает функцию обратного вызова для обновления участников. Если информация об участниках уже получена, функция обратного вызова инициируется незамедлительно, чтобы сообщить текущую информацию об участниках. Можно определить только одну функцию обратного вызова. При последовательных вызовах старая функция обратного вызова будет удалена, а новая – добавлена.

Параметры

Функция callback функция
Объект opt_context Объект, который получает обратный вызов.

wave.getTime()

Получает так называемое время гаджета, которое представляет собой либо время воспроизведения в режиме воспроизведения, либо текущее время в противном случае.

Возвращает

Число Время гаджета.