Skip to content

feature_configuration.md

Latest commit

 

History

History
223 lines (188 loc) · 5.27 KB

feature_configuration.md

File metadata and controls

223 lines (188 loc) · 5.27 KB

Setup App Features Scheme

Table of Contents

Login Screen Configuration

Configuration Key: mode-select-actions

For more details, refer to the Embedded Resources section.

Settings for selecting the login mode, between native and custom login.

Fields:

  • enabled: Determines if the button is active.
  • embeddedResourceId: ID of the resource for the embedded page (if applicable).
  • type: Action type (login, embedded).
  • titleL10n: Localized button title.

If embeddedResourceId is provided, the section is enabled, and the type is embedded, it will display a custom login page for this button on the welcome screen.

Example Configuration for Custom Login:

{
  "loginConfig": {
    "greetingL10n": "WebTrit",
    "modeSelectActions": [
      {
        "enabled": false,
        "embeddedResourceId": 1,
        "type": "embedded",
        "titleL10n": "login_Button_signIn"
      }
    ]
  },
  "embeddedResources": [
    {
      "id": 1,
      "uri": "asset://assets/themes/custom_signup.html",
      "toolbar": {
        "showToolbar": true,
        "titleL10n": "login_requestCredentials_title"
      }
    }
  ]
}

Setup Main Configuration

The main configuration defines the navigation structure.

Bottom Menu Configuration

{
  "bottomMenu": {
    "cacheSelectedTab": true,
    "tabs": [
      {
        "enabled": true,
        "type": "favorites",
        "titleL10n": "main_BottomNavigationBarItemLabel_favorites",
        "icon": "0xe5fd"
      },
      {
        "enabled": true,
        "type": "recents",
        "titleL10n": "main_BottomNavigationBarItemLabel_recents",
        "icon": "0xe03a"
      },
      {
        "enabled": true,
        "type": "contacts",
        "titleL10n": "main_BottomNavigationBarItemLabel_contacts",
        "icon": "0xee35",
        "contactSourceTypes": [
          "local",
          "external"
        ]
      },
      {
        "enabled": true,
        "initial": true,
        "type": "keypad",
        "titleL10n": "main_BottomNavigationBarItemLabel_keypad",
        "icon": "0xe1ce"
      },
      {
        "enabled": true,
        "type": "messaging",
        "titleL10n": "main_BottomNavigationBarItemLabel_chats",
        "icon": "0xe155"
      },
      {
        "enabled": false,
        "type": "embedded1",
        "titleL10n": "embaded1TitleL10n",
        "icon": "0xe2ce",
        "embeddedResourceId": 2
      }
    ]
  }
}
  • cacheSelectedTab: Saves the last selected tab
  • tabs: List of bottom menu tabs

Setup Call Configuration

{
  "callConfig": {
    "videoEnabled": true,
    "transfer": {
      "enableBlindTransfer": true,
      "enableAttendedTransfer": true
    }
  }
}
  • videoEnabled: Enables video calls
  • transfer: Call forwarding settings

Transfer Configuration

  • enableBlindTransfer: Enables blind call transfer
  • enableAttendedTransfer: Enables attended call transfer

Setup Settings Configuration

Settings Sections

{
  "sections": [
    {
      "titleL10n": "settings_ListViewTileTitle_settings",
      "enabled": true,
      "items": [
        {
          "type": "network",
          "titleL10n": "settings_ListViewTileTitle_network",
          "icon": "0xe424"
        },
        {
          "type": "mediaSettings",
          "titleL10n": "settings_ListViewTileTitle_mediaSettings",
          "icon": "0xf1cf"
        },
        {
          "type": "embedded",
          "titleL10n": "settings_ListViewTileTitle_termsConditions",
          "icon": "0xeedf",
          "embeddedResourceId": 4
        }
      ]
    }
  ]
}
  • titleL10n: Localized section title
  • enabled: Whether the section is active
  • items: List of settings in the section

Settings Items

Each settings item includes:

  • type: Setting type (network, encoding, embedded)
  • titleL10n: Localized name
  • icon: Item icon

Embedded Resources

The embeddedResources section defines the resources that can be embedded within the application. Each resource can either be a local file or a URL to an external page. If using a local file, ensure it is placed in the assets directory and provide the correct path.

{
  "embeddedResources": [
    {
      "id": 1,
      "uri": "asset://assets/themes/custom_signup.html",
      "toolbar": {
        "showToolbar": true,
        "titleL10n": "login_requestCredentials_title"
      }
    },
    {
      "id": 4,
      "uri": "https://webtrit.com/legal/privacy-policy-for-webtrit-app/",
      "toolbar": {
        "showToolbar": true,
        "titleL10n": "settings_ListViewTileTitle_termsConditions"
      }
    }
  ]
}
  • id: Unique resource identifier.
  • uri: URL or resource path.
  • toolbar: Toolbar settings for the embedded page.
    • showToolbar: Boolean to show or hide the toolbar.
    • titleL10n: Localized title for the toolbar.