Документация

Creatio development guide
Это документация Creatio версии 7.9.0. Мы рекомендуем использовать новую версию документации.

Манифест. Свойства интерфейса приложения

Glossary Item Box

Общие положения

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

Свойство ModuleGroups

Группы модулей приложения. Описывает верхнеуровневую настройку групп главного меню мобильного приложения. Для каждой группы меню задается списком именованных конфигурационных объектов с единственным возможным свойством Position (см. табл. 1).

Табл. 1. Свойство конфигурационного объекта для настройки группы меню.

Свойство Значение
Position Позиция группы в главном меню. Начинается с 0.

Пример

Настройка меню мобильного приложения, состоящего из двух групп — основной группы и группы [Продажи].

// Групы модулей мобильного приложения.
"ModuleGroups": {
    // Настройка группы основного меню.
    "main": {
        // Позиция группы в главном меню.
        "Position": 0
    },
    // Настройка группы меню [Продажи]. 
    "sales": {
        // Позиция группы в главном меню.
        "Position": 1
    }
}

Свойство Modules

Модули мобильного приложения. Модуль представляет собой раздел приложения. Каждый модуль в свойстве [Modules] конфигурационного объекта манифеста описывается конфигурационным объектом со свойствами, приведенными в таблице 2. Имя конфигурационного объекта раздела должно совпадать с названием модели, которая предоставляет данные раздела.

Табл. 2. Свойства конфигурационного объекта раздела.

Свойство Значение
Group Группа меню приложения, в которой размещается раздел. Задается строкой с названием соответствующего раздела меню из свойства ModuleGroups конфигурационного объекта манифеста.
Model Название модели, которая предоставляет данные раздела. Задается строкой с названием одной из моделей, объявленных в свойстве Models конфигурационного объекта манифеста.
Position Позиция раздела в группе главного меню. Задается числовым значением, начиная с 0.
isStartPage Признак, является ли страница данного раздела стартовой страницей приложения (true — стартовая страница, иначе — false). Необязательное свойство. По умолчанию — false.
Title Заголовок раздела. Строка с названием локализованного значения заголовка раздела. Локализованное значение заголовка раздела должно быть добавлено в блок [LocalizableStrings] схемы манифеста.
Icon Свойство, предназначенное для подключения пользовательского изображение к разделу в меню пользовательского интерфейса версии 1.
IconV2 Свойство, предназначенное для подключения пользовательского изображение к разделу в меню пользовательского интерфейса версии 2.
Hidden Признак, отображается ли данный раздел в меню (true — скрыт, false — отображается). Необязательное свойство. По умолчанию — false.

Пример

Настроить разделы приложения следующим образом:

  1. Разделы основного меню: [Контакты], [Контрагенты].
  2. Стартовая страница приложения: раздел [Контакты].

В блоке [LocalizableStrings] схемы манифеста должны быть созданы строки содержащие заголовки разделов:

  • ContactSectionTitle со значением "Контакты".
  • AccountSectionTitle со значением "Контрагенты".
// Модули мобильного приложения.
"Modules": {
    // Раздел "Контакт".
    "Contact": {
        // Группа меню приложения, в которой размещается раздел.
        "Group": "main",
        // Название модели, которая предоставляет данные раздела.
        "Model": "Contact",
        // Позиция раздела в группе меню.
        "Position": 0,
        // Признак начальной страницы приложения.
        "isStartPage": true,
        // Заголовок раздела.
        "Title": "ContactSectionTitle",
        // Подключение пользовательского изображения к разделу.
        "Icon": {
            // Уникальный идентификатор изображения.
            "ImageId": "4c1944db-e686-4a45-8262-df0c7d080658"
        },
        // Подключение пользовательского изображения к разделу.
        "IconV2": {
            // Уникальный идентификатор изображения.
            "ImageId": "9672301c-e937-4f01-9b0a-0d17e7a2855c"
        },
        // Признак отображения в меню.
        "Hidden": false
    },
    // Раздел "Контрагент".
    "Account": {
        // Группа меню приложения, в которой размещается раздел.
        "Group": "main",
        // Название модели, которая предоставляет данные раздела.
        "Model": "Account",
        // Позиция раздела в группе меню.
        "Position": 1,
        // Признак начальной страницы приложения.
        "isStartPage": false,
        // Заголовок раздела.
        "Title": "AccountSectionTitle",
        // Подключение пользовательского изображения к разделу.
        "Icon": {
            // Уникальный идентификатор изображения.
            "ImageId": "c046aa1a-d618-4a65-a226-d53968d9cb3d"
        },
        // Подключение пользовательского изображения к разделу.
        "IconV2": {
            // Уникальный идентификатор изображения.
            "ImageId": "876320ef-c6ac-44ff-9415-953de17225e0"
        },
        // Признак отображения в меню.
        "Hidden": false
    }
}

Свойство Icons

Свойство предназначено для подключения к мобильному приложению пользовательских изображений.

Задается массивом конфигурационных объектов, каждый из которых имеет свойства, приведенные в таблице 3.

Табл. 3. Свойства конфигурационного объекта для подключения пользовательского изображения.

Свойство Значение
ImageListId Идентификатор списка изображений.
ImageId Идентификатор подключаемого изображения из списка ImageListId.

Пример

// Подключение пользовательских изображений.
"Icons": [
    {
        // Идентификатор списка изображений.
        "ImageListId": "69c7829d-37c2-449b-a24b-bcd7bf38a8be",
        // Идентификатор подключаемого изображения.
        "ImageId": "4c1944db-e686-4a45-8262-df0c7d080658"
    }
]

Свойства DefaultModuleImageId и DefaultModuleImageIdV2

Свойства предназначены для установки уникальных идентификаторов изображений по умолчанию для вновь создаваемых разделов или для разделов, у которых не указаны идентификаторы изображений в свойствах Icon или IconV2 свойства Modules конфигурационного объекта манифеста.

Пример

//Идентификатор изображения по умолчанию для пользовательского интерфейса V1.
"DefaultModuleImageId": "423d3be8-de6b-4f15-a81b-ed454b6d03e3",
//Идентификатор изображения по умолчанию для пользовательского интерфейса V2.
"DefaultModuleImageIdV2": "1c92d522-965f-43e0-97ab-2a7b101c03d4"

Смотрите также

© Terrasoft 2002-2017.

Был ли данный материал полезен?

Как можно улучшить эту статью?