Spec-Zone.ru › Cordova 6

Config.xml

Config.xml — это глобальный файл конфигурации, который управляет многими аспектами поведения приложения cordova. Этот независимый от платформы XML-файл организован на основе спецификации W3C Packaged Web Apps (Widgets) и расширен для указания основных функций API Cordova, плагинов и платформозависимых настроек.

Для проектов, созданных с помощью Cordova CLI (описанного в Разделе по интерфейсу командной строки), этот файл можно найти в корневой директории:

app/config.xml

Обратите внимание, что до версии 3.3.1-0.2.0 файл располагался в app/www/config.xml, и его расположение здесь также поддерживается.

При использовании CLI для сборки проекта, версии этого файла пассивно копируются в различные platforms/ подкаталоги. Например:

app/platforms/ios/AppName/config.xml
app/platforms/blackberry10/www/config.xml
app/platforms/android/res/xml/config.xml

Помимо различных параметров конфигурации, описанных ниже, вы также можете настроить основной набор изображений приложения для каждой целевой платформы. Для получения дополнительной информации см. Раздел по настройке значков.

widget

Корневой элемент документа config.xml.

Атрибуты(тип)
Только для платформы:
Описание
id(строка) Обязательно
Указывает идентификатор приложения в обратном доменном формате и version полную версию, выраженную в формате мажор/минор/патч.
version(строка) Обязательно
Полный номер версии, выраженный в формате мажор/минор/патч.
android-versionCode(строка)
Android
Альтернативный номер версии для Android. Устанавливает номер версии приложения. Для получения информации о том, как можно изменить этот атрибут, см. руководство по Android.
defaultlocale
iOS
Указывает язык по умолчанию приложения в виде кода языка IANA.
ios-CFBundleVersion(строка)
iOS
Альтернативный номер версии для iOS. Для получения дополнительной информации см. версионирование iOS.
osx-CFBundleVersion(строка)
OS X
Альтернативный номер версии для OS X. Для получения дополнительной информации см. версионирование OS X.
windows-packageVersion(строка)
Windows
Альтернативный номер версии для Windows. Для получения дополнительной информации см. версионирование Windows
packageName(строка)
Windows
По умолчанию: Cordova.Example
Имя пакета для Windows.
xmlns(строка) Обязательно
Пространство имен для документа config.xml.
xmlns:cdv(строка) Обязательно
Префикс пространства имен.

Примеры:

<!-- Android -->
<widget id="io.cordova.hellocordova" version="0.0.1" android-versionCode="13" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- iOS -->
<widget id="io.cordova.hellocordova" version="0.0.1" ios-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- Windows -->
<widget id="io.cordova.hellocordova" version="0.0.1" windows-packageVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- OS X -->
<widget id="io.cordova.hellocordova" version="0.0.1" osx-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

name

Указывает официальное имя приложения, которое отображается на главном экране устройства и в интерфейсах магазинов приложений.

Примеры:

<widget ...>
   <name>HelloCordova</name>
</widget>

description

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

Примеры:

<widget ...>
   <description>A sample Apache Cordova application</description>
</widget>

author

Указывает контактную информацию, которая может отображаться в списках приложений в магазинах.

Атрибуты(тип)
Только для платформы:
Описание
email(строка) Обязательно
Электронный адрес автора.
href(строка) Обязательно
Веб-сайт автора.

Примеры:

<widget ...>
   <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
</widget>

content

Определяет начальную страницу приложения в корневом каталоге веб-активов. Значение по умолчанию — index.html, который обычно находится в корневом www каталоге проекта.

Атрибуты(тип)
Только для платформы:
Описание
src(строка) Обязательно
Определяет начальную страницу приложения в корневом каталоге веб-активов. Значение по умолчанию — index.html, который обычно

находится в корневом www каталоге проекта.

Примеры:

<widget ...>
   <content src="startPage.html"></content>
</widget>

access

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

Атрибуты(тип)
Только для платформы:
Описание
origin(строка) Обязательно
Определяет набор внешних доменов, с которыми приложение разрешено взаимодействовать.

По умолчанию показанное значение разрешает доступ к любому серверу. Подробности см. в Руководстве по белому списку доменов.

Примеры:

<widget ...>
   <access origin="*"></access>
</widget>

<widget ...>
   <access origin="http://google.com"></access>
</widget>

allow-navigation

Управляет URL-адресами, к которым может переходить сам WebView. Применяется только к переходам верхнего уровня.

Атрибуты(тип)
Только для платформы:
Описание
href(строка) Обязательно
Определяет набор внешних доменов, к которым WebView разрешено переходить.

Для получения подробностей см. cordova-plugin-whitelist.

Примеры:

<!-- Allow links to example.com -->
<allow-navigation href="http://example.com/*" />

<!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
<allow-navigation href="*://*.example.com/*" />

allow-intent

Управляет URL-адресами, которые приложение разрешено открывать в системе. По умолчанию внешние URL-адреса запрещены.

Атрибуты(тип)
Только для платформы:
Описание
href(строка) Обязательно
Определяет URL-адреса, которые приложение разрешено открывать в системе.

Для получения подробностей см. cordova-plugin-whitelist.

Примеры:

<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
<allow-intent href="tel:*" />
<allow-intent href="sms:*" />

edit-config

См. документацию по для plugin.xml.

config-file

См. документацию по для plugin.xml.

engine

Указывает подробности о платформе, которую необходимо восстановить во время prepare.

Атрибуты(тип)
Только для платформы:
Описание
name(строка) Обязательно
Имя платформы, которую нужно восстановить
spec(строка) Обязательно
Сведения о платформе, которую нужно восстановить. Это может быть major.minor.patch номер версии, каталог с платформой или URL, указывающий на репозиторий Git. Эта информация будет использована для получения кода платформы для восстановления из NPM, локального каталога или репозитория Git. Подробнее см. Спецификацию платформы.

Примеры:

<engine name="android" spec="https://github.com/apache/cordova-android.git#5.1.1" />
<engine name="ios" spec="^4.0.0" />

plugin

Указывает подробности о плагине, который необходимо восстановить во время prepare. Этот элемент автоматически добавляется в проект config.xml при добавлении плагина с помощью --save флага. Подробнее см. справочник CLI по добавлению плагинов.

Атрибуты(тип)
Только для платформы:
Описание
name(строка) Обязательно
Имя плагина, который нужно восстановить
spec(строка) Обязательно
Сведения о плагине, который нужно восстановить. Это может быть major.minor.patch номер версии, каталог с плагином или URL, указывающий на репозиторий Git. Эта информация будет использована для извлечения кода плагина из NPM, локального каталога или репозитория Git. Подробнее см. Спецификацию плагина.

Примеры:

<plugin name="cordova-plugin-device" spec="^1.1.0" />
<plugin name="cordova-plugin-device" spec="https://github.com/apache/cordova-plugin-device.git#1.0.0" />

variable

Сохраняет значение переменной CLI, используемой при восстановлении плагина во время prepare. Этот элемент добавляется в config.xml при добавлении плагина, использующего переменные CLI, с помощью --save флага. См. справочник CLI по добавлению плагинов.

Обратите внимание, что это значение используется только при восстановлении плагина в проект во время prepare. Изменение этого значения не изменит значение, используемое плагином в текущем проекте. Для того, чтобы изменения этого значения вступили в силу, необходимо удалить плагин из проекта и восстановить его, выполнив cordova prepare. См. элемент preference в plugin.xml для получения дополнительной информации о переменных CLI.

Атрибуты(тип)
Только для платформы:
Описание
name(строка) Обязательно
Имя переменной CLI. Может содержать только заглавные буквы, цифры и символы подчеркивания.
value(строка) Обязательно
Значение переменной CLI, которое должно использоваться при восстановлении родительского плагина во время prepare.

Примеры:

<plugin name="cordova-plugin-device" spec="^1.1.0">
    <variable name="MY_VARIABLE" value="my_variable_value" />
</plugin>

preference

Устанавливает различные параметры как пары имя/значение. Имя каждого параметра нечувствительно к регистру. Многие параметры уникальны для определенных платформ и будут отмечены как таковые.

Атрибуты(тип)
Только для платформы:
Описание
AllowInlineMediaPlayback(boolean)
iOS
По умолчанию: false
Установите в значение true, чтобы разрешить воспроизведение HTML5 медиа встраиваемым способом в макете экрана, используя встроенные браузерные средства управления вместо системных. Для этого добавьте атрибут webkit-playsinline к элементам <video>.
AndroidLaunchMode(string)
Android
По умолчанию: singleTop
Допустимые значения: standard, singleTop, singleTask, singleInstance
Устанавливает атрибут Activity android:launchMode. Это изменяет поведение при запуске приложения с иконки или намерения (intent), когда приложение уже запущено.
android-maxSdkVersion(integer)
Android
По умолчанию: Не указано
Устанавливает атрибут maxSdkVersion тега <uses-sdk> в манифесте проекта AndroidManifest.xml (см. здесь).
android-minSdkVersion(integer)
Android
По умолчанию: Зависит от версии cordova-android
Устанавливает атрибут minSdkVersion тега <uses-sdk> в манифесте проекта AndroidManifest.xml (см. здесь).
android-targetSdkVersion(integer)
Android
По умолчанию: Зависит от версии cordova-android
Устанавливает атрибут targetSdkVersion тега <uses-sdk> в манифесте проекта AndroidManifest.xml (см. здесь).
AppendUserAgent(string)
Android iOS
Если задано, значение будет добавлено в конец старого UserAgent веб-вью. При использовании с OverrideUserAgent это значение будет проигнорировано.
BackgroundColor(string)
Android BlackBerry Windows
Устанавливает цвет фона приложения. Поддерживает четырёхбайтовое шестнадцатеричное значение, где первый байт представляет альфа-канал, а следующие три — стандартные значения RGB.
Для Windows альфа-канал игнорируется.
Примечание: значение transparent установит цвет фона плитки приложения на акцентный цвет в Windows.
BackupWebStorage(string)
iOS
По умолчанию: cloud
Допустимые значения: none, local, cloud.
Установите в значение cloud, чтобы разрешить резервное копирование данных веб-хранилища с помощью iCloud. Установите в значение local, чтобы разрешить только локальные резервные копии с помощью синхронизации iTunes. Установите в значение none, чтобы предотвратить резервное копирование веб-хранилища.
ChildBrowser(string)
BlackBerry
По умолчанию: enable
Отключает окна дочернего браузера. По умолчанию приложения запускают окно второго браузера для отображения ресурсов, доступных через window.open() или указание целевого атрибута _blank. Укажите disable, чтобы переопределить это поведение.
CordovaWebViewEngine(string)
iOS
По умолчанию: CDVUIWebViewEngine
Это задаёт используемый плагин WebView для отрисовки приложения. Плагин должен соответствовать протоколу CDVWebViewEngineProtocol. Значение здесь должно соответствовать имени "feature" плагина WebView, установленного в приложении. Обычно этот параметр устанавливается плагином WebView автоматически.
DefaultVolumeStream(string)
Android
По умолчанию: default
Добавлено в cordova-android 3.7.0. Этот параметр задаёт, к какому потоку звука привязаны аппаратные кнопки громкости. По умолчанию это "call" для телефонов и "media" для планшетов. Установите это значение в "media", чтобы кнопки громкости всегда меняли громкость медиа. Обратите внимание, что при использовании плагина Cordova для медиа, кнопки громкости динамически изменяют управление громкостью медиа, когда активны какие-либо объекты Media.
DisallowOverscroll(boolean)
iOS Android
По умолчанию: false
Установите в значение true, если не хотите, чтобы интерфейс отображал обратную связь при прокрутке за начало или конец содержимого. В iOS жесты перепрокрутки вызывают отскок содержимого в исходное положение. В Android они производят более тонкий эффект свечения по верхнему или нижнему краю содержимого.
EnableViewportScale(boolean)
iOS
По умолчанию: false
Установите в значение true, чтобы разрешить тегу viewport метатег либо отключить, либо ограничить диапазон масштабирования, которое включено по умолчанию. Поместите тег viewport, такой как следующий, в HTML, чтобы отключить масштабирование и гибко подгонять содержимое в веб-вью:
<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />
EnableWebGL(boolean)
OS X
По умолчанию: false
(OS X 4.0.0+) Установите в значение true, чтобы включить WebGL в веб-вью.
ErrorUrl(URL)
Android
По умолчанию: null
При установке отобразит указанную страницу при ошибке в приложении вместо диалогового окна с заголовком "Ошибка приложения".
ErrorUrl(string)
iOS
При установке отобразит указанную локальную страницу при ошибке в приложении.
ForegroundText(string)
Windows
По умолчанию: "light"
Действует только для проектов Windows 8.1. Допустимые значения: "light", "dark". Установите в "dark", если используете BackgroundColor="white" или другой светлый цвет, чтобы избежать ошибок при подаче в Windows Store.
FullScreen(boolean)
Android
По умолчанию: false
Разрешает скрытие строки состояния в верхней части экрана.
Примечание: Рекомендуемый платформонезависимый способ достижения этого — использование плагина StatusBar.
GapBetweenPages(float)
iOS
По умолчанию: 0
Размер промежутка в пунктах между страницами.
HideKeyboardFormAccessoryBar(boolean)
BlackBerry
По умолчанию: false
Установите в значение true, чтобы скрыть дополнительную панель инструментов, которая появляется над клавиатурой, помогая пользователям переходить от одного поля ввода к другому.
HideMousePointer(integer)
OS X
По умолчанию: -1
(OS X 4.0.0+) Устанавливает тайм-аут для скрытия указателя мыши. Установите в 0 для мгновенного скрытия, в -1 для никогда.
InAppBrowserStorageEnabled (boolean)
Android
По умолчанию: true
Управляет возможностью страниц, открытых в InAppBrowser, получать доступ к хранилищу localStorage и WebSQL так же, как страницы, открытые в стандартном браузере.
KeepRunning(boolean)
Android
По умолчанию: true
Определяет, останется ли приложение активным в фоновом режиме даже после срабатывания события pause. Установка значения false не закрывает приложение после срабатывания события pause, а просто останавливает выполнение кода в веб-вью cordova, пока приложение находится в фоновом режиме.
KeyboardDisplayRequiresUserAction(boolean)
iOS
По умолчанию: true
Установите в значение false, чтобы разрешить появлению клавиатуры при вызове focus() для элементов формы.
LoadUrlTimeoutValue(number in milliseconds)
Android
По умолчанию: 20000, 20 секунд
Время ожидания при загрузке страницы перед выбросом ошибки таймаута.
LoadingDialog(string)
Android
По умолчанию: null
При установке отображает диалоговое окно с указанным заголовком и сообщением, а также спиннер при загрузке первой страницы приложения. Заголовок и сообщение разделены запятой в строке значения, и эта запятая удаляется перед отображением диалогового окна.
LogLevel(string)
Android
По умолчанию: ERROR
Допустимые значения: ERROR, WARN, INFO, DEBUG, VERBOSE
Устанавливает минимальный уровень логов, через которые будут отфильтрованы сообщения логов из вашего приложения.
MediaPlaybackAllowsAirPlay(boolean)
iOS
По умолчанию: true
Установите в значение false, чтобы предотвратить использование AirPlay в этом представлении. Доступно в стандартном UIWebView и WKWebView.
MediaPlaybackRequiresUserAction(boolean)
iOS
По умолчанию: false
Установите в значение true, чтобы предотвратить автоматическое воспроизведение HTML5 видео или аудио с атрибутом autoplay или через JavaScript.
Min/Max Version(Regex)
Windows
Допустимые значения: /(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i
Идентифицирует экосистемы и их минимальные/максимальные версии, с которыми совместимо приложение. Каждое значение состоит из трёх частей: SDK, ограничение версии и значение версии. Эти параметры обнаруживаются, начиная с Windows или Microsoft и заканчивая -MinVersion или -MaxVersionTested:
  • SDK определяет, какую специализированную платформу вы хотите нацелить. По умолчанию — Windows.Universal. Действительные значения для этих параметров определены в схеме AppxManifest в элементах Package/Depednencies/TargetPlatform.
  • ограничение версии определяет правила совместимости приложения. Например, если -MinVersion установлено в значение 10.1.0.0, то версии ОС, которые не поддерживают по крайней мере 10.1.0.0 соответствующего SDK, не смогут его загрузить. Аналогично можно использовать -MaxVersionTested, которое определяет максимальную протестированную версию SDK. Если выпущена новая версия соответствующего SDK, она будет запускаться в режиме совместимости для указанной версии.
  • значение версии — четырёхэлементный кортеж в формате major.minor.build.qfe.
Если в вашем файле config.xml не указаны параметры этих типов, по умолчанию будет выбран Windows.Universal версии 10.0.0.0.
Примечание: Эти параметры устанавливаются только в файлах appxmanifest целевых платформ, а не в файлах jsproj.
Orientation(string) По умолчанию: default
Допустимые значения: default, landscape, portrait
Разрешает блокировку ориентации и предотвращает поворот интерфейса в ответ на изменения ориентации.
ПРИМЕЧАНИЕ: Значение по умолчанию означает, что Cordova удалит запись о параметре ориентации из файла манифеста/конфигурации платформы, позволяя платформе вернуться к своему поведению по умолчанию. Для iOS, чтобы указать режимы как портрет, так и ландшафт, вы должны использовать значение 'all'.
OSXLocalStoragePath(string)
OS X
По умолчанию: ~/Library/Application Support/{bundle.id}
(OS X 4.0.0+) Устанавливает каталог для пути локального хранилища.
OverrideUserAgent(string)
Android
Если установлено, значение заменит старый UserAgent веб-вью. Это полезно для идентификации запроса из приложения/браузера при запросе удалённых страниц. Используйте с осторожностью, это может привести к проблемам совместимости с веб-серверами. В большинстве случаев используйте AppendUserAgent.
PageLength(float)
iOS
Значение по умолчанию: 0
Размер каждой страницы в пунктах в направлении потока страниц. Когда PaginationMode задан как справа налево или слева направо, это свойство представляет ширину каждой страницы. Когда PaginationMode задан как сверху вниз или снизу вверх, это свойство представляет высоту каждой страницы. Значение по умолчанию равно 0, что означает, что макет использует размер области просмотра для определения размеров страницы.
PaginationBreakingMode(string)
iOS
Значение по умолчанию: page
Допустимые значения: page, column
Допустимые значения — page и column. Способ, которым происходит разбиение колонок или страниц. Это свойство определяет, будут ли соблюдаться или игнорироваться определённые свойства CSS, касающиеся разбиения колонок и страниц. Если это свойство установлено в column, содержимое учитывает свойства CSS, относящиеся к разбиению колонок вместо разбиения страниц.
PaginationMode(string)
iOS
Значение по умолчанию: unpaginated
Допустимые значения: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft
Это свойство определяет, будет ли содержимое в веб-вью разбиваться на страницы, которые заполняют экран по одной за раз, или отображаться как одна длинная прокручиваемая область. Если установлено значение в форме paginated, это свойство включает в содержимое paginated макет, заставляя веб-вью использовать значения PageLength и GapBetweenPages для повторного расположения содержимого.
PopupBlocker(string)
BlackBerry
Значение по умолчанию: enable
Включает блокировщик всплывающих окон, который предотвращает вызовы window.open(). По умолчанию всплывающие окна отображаются в окне дочернего браузера. Установка значения preferences в enable предотвращает их отображение вообще.
SetFullscreen(boolean)
Android
Значение по умолчанию: false
То же самое, что и параметр Fullscreen в глобальной конфигурации этого файла xml. Этот Android-специфичный элемент устарел в пользу глобального элемента Fullscreen и будет удалён в будущей версии.
ShowTitle(boolean)
Android
Значение по умолчанию: false
Отобразить заголовок в верхней части экрана.
SplashScreenBackgroundColor
Windows
Значение по умолчанию: #464646
Устанавливает цвет фона экрана запуска. Поддерживает имя цвета CSS или четырёхбайтовое шестнадцатеричное значение, где первый байт представляет альфа-канал, а следующие три байта — стандартные значения RGB.
Альфа-канал игнорируется, хотя значение transparent вызовет чёрный/белый цвет фона в зависимости от тёмной/светлой темы соответственно.
Suppresses3DTouchGesture(boolean)
iOS
Значение по умолчанию: false
Установите в значение true, чтобы избежать отображения инструмента увеличения на устройствах iOS, поддерживающих 3D Touch, когда пользователь применяет силу во время долгого нажатия на веб-вью. Тщательно протестируйте ваше приложение, так как это отключает обработчики onclick, но нормально работает с ontouchend. Если это значение установлено в true, SuppressesLongPressGesture фактически будет равно true.
SuppressesIncrementalRendering(boolean)
iOS
Значение по умолчанию: false
Установите в значение true, чтобы подождать, пока всё содержимое не будет получено, прежде чем оно будет отображено на экране.
SuppressesLongPressGesture(boolean)
iOS
Значение по умолчанию: false
Установите в значение true, чтобы избежать отображения инструмента увеличения на iOS 9+ при длинном нажатии на веб-вью. Тщательно протестируйте своё приложение, так как это может повлиять на возможности выбора текста.
TopActivityIndicator(string)
iOS
Значение по умолчанию: gray
Допустимые значения: whiteLarge, white, gray.

Управляет отображением маленького вращающегося значка в строке состояния, который указывает на значительную активность процессора.
uap-target-min-version(string)
Windows
Это свойство устанавливает MinTargetVersion для Windows UAP. Если не указано, оно устанавливается в начальную версию выпуска 10.0.10240.0
Примечание: Эта настройка задаётся в файле jsproj, а не в файле appxmanifest. Поэтому пользователи с версией ОС ниже этой не смогут запустить приложение.
UIWebViewDecelerationSpeed(string)
iOS
Значение по умолчанию: normal
Допустимые значения: normal, fast
Это свойство управляет скоростью замедления импульсной прокрутки. normal — это стандартная скорость для большинства собственных приложений, а fast — для Mobile Safari.
WebSecurity(string)
BlackBerry
Значение по умолчанию: enable
Установите в disable, чтобы переопределить настройки безопасности веб-сайта, разрешив доступ к удалённому контенту из неизвестных источников. Это настройка предназначена только для удобства разработки, поэтому удалите её перед упаковкой приложения для распространения. В выпущенном приложении все URI должны быть известны и внесены в белый список с помощью элемента , описанного в руководстве по белому списку доменов.
WindowSize(string)
OS X
Значение по умолчанию: auto
(OS X 4.0.0+) Устанавливает размер окна приложения.
Принимает формат WxH для определённой ширины и высоты или специальные значения auto и fullscreen. Последнее откроет окно без рамок, занимающее всю область рабочего стола. Обратите внимание, что это отличается от обычного режима полноэкранного отображения OS X, который никогда не охватывает несколько дисплеев.
Примечание: глобальная настройка cordova fullscreen не имеет эффекта в OS X.
WindowsDefaultUriPrefix(string)
Windows
Допустимые значения: ms-appx://, ms-appx-web://
Определяет, хотите ли вы, чтобы ваше приложение нацеливалось на локальный контекст или удалённый контекст в качестве URI запуска. При построении для Windows 10 по умолчанию используется удалённый контекст (ms-appx-web://).
Чтобы иметь приложение в локальном режиме, которое не подвержено ограничениям функциональности удалённого режима, вы должны установить это свойство в значение ms-appx:// и не объявлять никаких элементов <access> с удалёнными URI. Режим локального доступа по умолчанию для Windows 8.1.
WindowsStoreDisplayName(string)
Windows
Дружественное имя издателя, которое может отображаться пользователям.
WindowsStoreIdentityName(string)
Windows
Имя идентификатора, используемое для магазина Windows. Идентификатор определяет глобально уникальный идентификатор для пакета. Идентификатор пакета представлен в виде набора атрибутов пакета. Подробнее см. страницу идентификатора в справочнике по схеме пакета manifest.
WindowsStorePublisherName(string)
Windows
Имя издателя для отображения.
WindowsToastCapable(boolean)
Windows
Значение по умолчанию: false
Значение true указывает, что приложение разрешено предоставлять уведомления «тост».
deployment-target(string)
iOS
Это задаёт IPHONEOSDEPLOYMENTTARGET в сборке, что в конечном итоге приводит к MinimumOSVersion в ipa. Для получения дополнительной информации см. документацию Apple по настройкам целевой версии развертывания.
target-device(string)
iOS
Значение по умолчанию: universal
Допустимые значения: handset, tablet, universal
Это свойство напрямую соответствует TARGETEDDEVICEFAMILY в проекте xcode. Обратите внимание, что если вы выбираете универсальную (что является значением по умолчанию), вам нужно предоставить снимки экрана как для iPhone, так и для iPad, иначе ваше приложение может быть отклонено.
windows-phone-target-version(string)
Windows
Устанавливает версию Windows Phone, для которой пакет (полученный из cordova build) будет нацелен. Если не указано, будет установлена та же версия, что и windows-target-version (если найдена).
windows-target-version(string)
Windows
Устанавливает версию Windows, для которой пакет (полученный из cordova build) будет нацелен. Если не указано, будет установлено значение «8.1».

Примеры:

<preference name="DisallowOverscroll" value="true"/>
<preference name="Fullscreen" value="true" />
<preference name="BackgroundColor" value="0xff0000ff"/>
<preference name="HideKeyboardFormAccessoryBar" value="true"/>
<preference name="Orientation" value="landscape" />

<!-- iOS only preferences -->
<preference name="EnableViewportScale" value="true"/>
<preference name="MediaPlaybackAllowsAirPlay" value="false"/>
<preference name="MediaPlaybackRequiresUserAction" value="true"/>
<preference name="AllowInlineMediaPlayback" value="true"/>
<preference name="BackupWebStorage" value="local"/>
<preference name="TopActivityIndicator" value="white"/>
<preference name="SuppressesIncrementalRendering" value="true"/>
<preference name="GapBetweenPages" value="0"/>
<preference name="PageLength" value="0"/>
<preference name="PaginationBreakingMode" value="page"/>
<preference name="PaginationMode" value="unpaginated"/>
<preference name="UIWebViewDecelerationSpeed" value="fast" />
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />
<preference name="target-device" value="universal" />
<preference name="deployment-target" value="7.0" />
<preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
<preference name="SuppressesLongPressGesture" value="true" />
<preference name="Suppresses3DTouchGesture" value="true" />

<!-- Android only preferences -->
<preference name="KeepRunning" value="false"/>
<preference name="LoadUrlTimeoutValue" value="10000"/>
<preference name="InAppBrowserStorageEnabled" value="true"/>
<preference name="LoadingDialog" value="My Title,My Message"/>
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="ShowTitle" value="true"/>
<preference name="LogLevel" value="VERBOSE"/>
<preference name="AndroidLaunchMode" value="singleTop"/>
<preference name="DefaultVolumeStream" value="call" />
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />

<!-- Windows only preferences -->
<preference name="windows-phone-target-version" value="8.1" />
<preference name="windows-target-version" value="8.1" />
<preference name="Windows.Universal" value="10.0.10240.0" />
<preference name="WindowsDefaultUriPrefix" value="ms-appx://" />
<preference name="Windows.Mobile-MaxVersionTested" value="10.0.10031.0" />
<preference name="Windows.Universal-MinVersion" value="10.0.0.0" />
<preference name="WindowsStoreIdentityName" value="Cordova.Example.ApplicationDataSample" />
<preference name="WindowsStorePublisherName" value="CN=Contoso Corp, O=Contoso Corp, L=Redmond, S=Washington, C=US" />
<preference name="WindowsToastCapable" value="true" />
<preference name="uap-target-min-version" value="10.0.10586.0" />

<!-- BlackBerry only preferences -->
<preference name="ChildBrowser" value="disable"/>
<preference name="PopupBlocker" value="enable"/>
<preference name="WebSecurity" value="disable"/>

<!-- OS X only preferences -->
<preference name="HideMousePointer" value="5"/>
<preference name="OSXLocalStoragePath" value="~/.myapp/database"/>
<preference name="WindowSize" value="800x400"/>
<preference name="EnableWebGL" value="true"/>

функция

Если вы используете командную строку для сборки приложений, вы используете команду плагина для включения API устройств. Это не изменяет файл конфигурации верхнего уровня config.xml, поэтому элемент не применяется к вашему рабочему процессу. Если вы работаете непосредственно в SDK и используете файл конфигурации платформы config.xml в качестве источника, вы используете тег для включения API уровня устройства и внешних плагинов. Они часто появляются со значениями в файлах конфигурации платформы, специфичных для платформы. Подробнее о том, как указать каждый элемент, см. в справочнике по API. См. Руководство по разработке плагинов для получения дополнительной информации о плагинах. ПРИМЕЧАНИЕ: в большинстве случаев вы НЕ хотите устанавливать это значение напрямую.

Атрибуты(тип)
Только для платформы:
Описание
name(string) Обязательный
Имя плагина для включения.

параметр

Используется для указания определённых параметров плагина, таких как: пакет для извлечения кода плагина и инициализируется ли код плагина во время инициализации Webview.

Атрибуты(тип)
Только для платформы:
Описание
name(string)
iOS OS X Android
Обязательный
Допустимые значения: android-package, ios-package, osx-package, onload.
'ios-package', 'osx-package' и 'android-package' используются для указания имени пакета (как указано атрибутом 'value') для инициализации кода плагина, в то время как 'onload' используется для указания того, следует ли инициализировать соответствующий плагин (как указано в атрибуте 'value') при инициализации контроллера.
value(string or boolean)
iOS OS X Android
Обязательный
Указывает имя пакета, который будет использоваться для инициализации кода плагина (когда атрибут 'name' равен android-package, ios-package или osx-package), указывает имя плагина, который должен загружаться во время инициализации контроллера (когда атрибут 'name' установлен в 'onload').

Примеры:

<!-- Here is how to specify the Device API for Android projects -->
<feature name="Device">
   <param name="android-package" value="org.apache.cordova.device.Device" />
</feature>

<!-- Here's how the element appears for iOS projects -->
<feature name="Device">
   <param name="ios-package" value="CDVDevice" />
   <param name="onload" value="true" />
</feature>

<!-- Here's how the element appears for OS X projects -->
<feature name="Device">
   <param name="osx-package" value="CDVDevice" />
   <param name="onload" value="true" />
</feature>

платформа

При использовании командной строки для сборки приложений иногда необходимо указать настройки или другие элементы, специфичные для конкретной платформы. Используйте элемент для указания конфигурации, которая должна отображаться только в файле config.xml, специфичном для каждой платформы.

Атрибуты(тип)
Только для платформы:
Описание
name(string) Обязательный
Платформа, настройки которой определяются.

Примеры:

<platform name="android">
   <preference name="Fullscreen" value="true" />
</platform>

крючок

Представляет ваш пользовательский скрипт, который будет вызываться Cordova при возникновении определённого действия (например, после добавления плагина или вызова логики подготовки платформы). Это полезно, когда вам нужно расширить стандартную функциональность Cordova. См. Руководство по крючкам для получения дополнительной информации.

Атрибуты(тип)
Только для платформы:
Описание
type(строка) Обязательно
Указывает действие, во время которого должен вызываться пользовательский скрипт.
src(строка) Обязательно
Указывает расположение скрипта, который будет вызван при определённом действии.

Примеры:

<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />

Файл ресурсов

Этот тег устанавливает файлы ресурсов в вашу платформу и аналогичен такому же тегу в plugin.xml. Этот тег в настоящее время поддерживается только на версиях cordova-ios@4.4.0 и выше, и cordova-android@6.2.1 и выше.

Атрибуты(тип)
Только для платформы:
Описание
src(строка)
iOS Android
Обязательно
Путь к файлу относительно config.xml.
target(строка) Путь, куда файл будет скопирован в вашем каталоге.

Примеры:

Для Android:

<resource-file src="FooPluginStrings.xml" target="res/values/FooPluginStrings.xml" />

Пример config.xml

Ниже приведен пример файла config.xml:

<?xml version='1.0' encoding='utf-8'?>
<widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
  <name>HelloCordova</name>
  <description>
      A sample Apache Cordova application that responds to the deviceready event.
  </description>
  <author email="dev@cordova.apache.org" href="http://cordova.io">
      Apache Cordova Team
  </author>
  <content src="index.html" />
  <plugin name="cordova-plugin-whitelist" spec="1" />
  <access origin="*" />
  <allow-intent href="http://*/*" />
  <allow-intent href="https://*/*" />
  <allow-intent href="tel:*" />
  <allow-intent href="sms:*" />
  <allow-intent href="mailto:*" />
  <allow-intent href="geo:*" />
  <platform name="android">
      <allow-intent href="market:*" />
  </platform>
  <platform name="ios">
      <allow-intent href="itms:*" />
      <allow-intent href="itms-apps:*" />
  </platform>
</widget>

© 2012, 2013, 2015 The Apache Software Foundation
Licensed under the Apache License 2.0.
https://cordova.apache.org/docs/en/6.x/config_ref/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API