Руководство по разработке расширений

Мосты плагин Cordova a bit of функциональность между WebView питания Cordova-приложение и родной платформе Cordova-приложение работает на. Плагины состоят из единого интерфейса JavaScript, используемых на всех платформах и встроенных реализаций после платформа специфического плагин интерфейсы, которые вызывает JavaScript. Все основные Cordova API реализованы с помощью этой архитектуры.

Этом руководстве шаги процесса написания простой плагин эхо передает строку из JavaScript и отправляет его в родной среде для поддерживаемых платформ. Машинный код затем возвращает ту же строку обратно на обратные вызовы внутри плагина JavaScript.

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

JavaScript

Точка входа для любого плагина является JavaScript. Причина разработчиков использовать Cordova, поэтому они могут использовать и писать JavaScript, не Objective-C, не Java, C#. Интерфейс JavaScript для вашего плагина является передней и возможно наиболее важной частью Cordova плагин.

Можно структурировать ваш плагин JavaScript, как вам нравится. Одна вещь, вы должны использовать для связи между Cordova JavaScript и родной среды cordova.exec функции. Вот пример:

    cordova.exec(function(winParam) {}, function(error) {}, "service",
                 "action", ["firstArgument", "secondArgument", 42,
                 false]);

Параметры описаны ниже:

• function(winParam) {}: Успех функции обратного вызова. Если ваш exec вызов завершается успешно, эта функция вызывается (при необходимости с любыми параметрами, вы проходите к нему).

• function(error) {}: Ошибка функции обратного вызова. Если операция не завершена успешно, эта функция вызывается (при необходимости с параметром ошибка).

• "service": Имя службы, для вызова на родной стороне. Это сопоставляется собственный класс, о котором более подробная информация доступна в родной гидов, перечисленных ниже.

• "action": Имя действия для вызова. Это взял на получение собственного класса exec вызов и, в зависимости от платформы, по существу карты к методу класса. Перечисленные ниже родной руководствах детали.

• [/* arguments */]: Аргументы для передачи в родной среде.

Пример JavaScript плагин эхо

    window.echo = function(str, callback) {
        cordova.exec(callback, function(err) {
            callback('Nothing to echo.');
        }, "Echo", "echo", [str]);
    };

Обсудим это. Плагин прикрепляется к window , специально для echo функции. Плагин пользователей будет затем использовать его следующим образом:

    window.echo("echome", function(echoValue) {
        alert(echoValue == "echome"); // should alert true.
    });

Во-первых Давайте рассмотрим три последние аргументы для exec функции. Мы будет вызывать Echo «услуг», с просьбой echo «action» и пройдя массив аргументов, содержащих строку эхо, который является первым параметром в window.echo функции.

Успех обратного вызова передается в exec это просто ссылка на обратный вызов функцию, window.echo принимает. Мы делаем немного больше для обратного вызова ошибки: Если родной стороне запускает обратный вызов для ошибки, мы просто успех обратного вызова и передайте в него строку «по умолчанию».

Модуль Спецификация

Cordova имеет плагин спецификации доступны для включения автоматической установки плагина для Android, iOS, платформы BlackBerry 10 и Windows Phone. Структурирование ваш плагин определенным образом и добавив plugin.xml файл манифеста, можно разрешить пользователям устанавливать ваш плагин через командной строки инструмента.

• Модуль Спецификация

Родной

После того, как вы определяете JavaScript для вашего плагина, вы должны дополнить его по крайней мере один собственной реализации. Ниже перечислены детали, чтобы сделать это для каждой платформы. Эти руководства по-прежнему опираться на простой пример эхо плагин, рассмотренных выше.

• Андроид плагины
• Ежевика плагины
• Ежевика 10 плагинов
• iOS, плагины
• Windows Phone плагины

В настоящее время Tizen платформа не поддерживает плагины.

Публикации плагины

После того как вы разработали ваш плагин, вы можете опубликовать его и поделиться им с сообществом. Вы можете опубликовать ваш плагин в cordova реестр (на npmjs) или для любых других npmjs на основе реестра. Пользователи смогут установить его автоматически с помощью plugman или Кордова cli.

Чтобы опубликовать плагин необходимо использовать средство plugman и пройти через следующие шаги:

$ plugman adduser # that is if you don't have an account yet
$ plugman publish /path/to/your/plugin

Вот оно что!

Другие на основе реестра команды доступны и plugman --help даст вам список какие команды доступны и как их использовать.