Interface Customisations

Interface customisations is a new concept that's available to our Partner Portal users. It allows for configuration of the app in version 8.3.0 and above.

Each Customisation is able to be targeted to the app, hub or both platforms. Some options are only applicable to one target, all configuration options below specify where they apply to.

Available Configuration Options

Key	Type	Default Value	Support (min ver)
enableCampaignDeleteBtn	bool	true	app - 8.4.0
addressBookConnectButtonIcon	String	null	app - 8.4.0
hideAddressBookConnectionButtons	bool	false	app - 8.4.0
enableProfileShareQRCode	bool	true	app - 8.4.0
integrationReportsTitle	String	null	app - 8.4.0
useDarkTintColorForToasts	bool	false	app - 8.4.0
limitPBBroadcastToOwn	bool	true	app - 8.4.0
customDashboardAppBar	Custom Object	null	app - 8.4.0
showIntegrationReportsAsGridOnDashboard	bool	false	app - 8.4.0
enforcedDashboardComponents	Array of Custom Objects	null	app - 8.4.0
material3Overrides	Custom Object	null	app - 8.4.0
fontFamily	String	null	app - 8.4.0
fontUrl	String	null	app - 8.4.0
overrideCommentReplyMap	Custom Object	null	app - 8.4.0
tabBarLabelBehaviourPreference	Enum	null	app - 8.4.0
integrationReportListHeight	int	null	app - 8.4.0
instanceTranslationOverrides	Custom Object	null	app - 8.4.0
localAuthConfiguration	Enum	null	app - 8.4.0
enableFirebaseAnalytics	bool	false	app - 8.4.0
allowBackgroundBase64FileDownloads	bool	false	app - 8.4.0
cacheDataForOffline	bool	false	app - 8.4.0
faviconUrl	String	null	app - 8.4.0
allowFileDowloads	bool	true	app - 8.4.0
minimumIosVersion	String	0.0.0	app - 8.5.0
minimumAndroidVersion	String	0.0.0	app - 8.5.0
lightThemeOverrides	Custom Object	null	app - 8.5.0
darkThemeOverrides	Custom Object	null	app - 8.5.0
integrationReportsWithExemptAjaxHandling	Array of Strings	null	app - 8.5.0
supportedSearchTypes	Array of Enum Strings	all, campaign, broadcast, addressbook	app - 8.5.0
requireAllApplicationConfig	bool	false	app - 8.8.0
useAndroidWebViewBrowserForLaunchInternallyBusinessApps	bool	false	app - 8.9.0
cacheExpiryTime	int	7200000	app - 8.9.0
messagingListPollingInterval	int	10	app - 8.10.0
messagingDetailPollingInterval	int	6	app - 8.10.0
messagingListPollWhileNotVisible	bool	false	app - 8.10.0
useAlternativeBusinessAppLaunchLogic	bool	false	app - 8.10.0
enableChannelFile	bool	false	app - 8.11.0
enableSSE	bool	false	app - 8.12.0
enableReadReciepts	bool	false	app - 8.13.0
enableChatLinkPreviews	bool	false	app - 8.13.0
linkPreviewsWhitelist	Array	null	app - 8.13.0
linkPreviewsBlacklist	Array	null	app - 8.13.0
dashboardCollectionsHiddenTitles	Array	null	app - 8.13.1
decolourizeThemeSurfaces	bool	false	app - 8.13.2
commonEmojis	Array	null	app - 8.14.0
customLinkPreviewRules	Array	null	app - 8.14.0
commonEmojis	Array	null	app - 8.14.0
enableAnyLinkPreviewFallback	bool	false	app - 8.14.0
anyLinkPreviewCacheSeconds	bool	604800	app - 8.14.0

Custom Object Definitions

Custom Dashboard App Bar

{
    "leading": [],
    "trailing": [
        {
            "key": "notifications",
            "preferBottomNavigation": false,
            "type": "named",
            "target": "mobile"
        },
        {
            "key": "profile",
            "preferBottomNavigation": false,
            "type": "named",
            "target": "mobile"
        }
    ],
    "title": null,
    "overrideLogoURL": null,
    "overrideIconColor": null,
    "overrideTextColor": null,
    "shadow": false,
    "noTitleOrLogo": false,
    "forceCenterLeft": true
}

Enforced Dashboard Components

[
    "Banner",
    "UnreadBroadcasts",
    "BusinessApps",
    "CategoryCollections",
    "Reports"
]

In Version 8.2, instead of an Array of Strings, these can now be specified as an array of objects:

[
    {"identifier": "Banner"},
    {"identifier": "UnreadBroadcasts"},
    {"identifier": "Apps", "type":"business"},
    {"identifier": "CategoryCollections"},
    {"identifier": "Reports"}
]

Material 3 Colour Scheme Overrides

{
    "dark_onSecondaryContainer": "#86BC25",
    "light_onSecondaryContainer": "#86BC25",
    "dark_secondaryContainer": "#00000000",
    "light_secondaryContainer": "#00000000",
    "light_background": "#FFFFFF",
    "dark_background": "#1e1e1e"
}

Possible keys here are prefixed with either light_ or dark_ (for which theme), and then with the following key:

• primary
• onPrimary
• primaryContainer
• onPrimaryContainer
• primaryFixed
• primaryFixedDim
• onPrimaryFixed
• onPrimaryFixedVariant
• secondary
• onSecondary
• secondaryContainer
• onSecondaryContainer
• secondaryFixed
• secondaryFixedDim
• onSecondaryFixed
• onSecondaryFixedVariant
• tertiary
• onTertiary
• tertiaryContainer
• onTertiaryContainer
• tertiaryFixed
• tertiaryFixedDim
• onTertiaryFixed
• onTertiaryFixedVariant
• error
• onError
• errorContainer
• onErrorContainer
• surface
• onSurface
• surfaceDim
• surfaceBright
• surfaceContainerLowest
• surfaceContainerLow
• surfaceContainer
• surfaceContainerHigh
• surfaceContainerHighest
• onSurfaceVariant
• outline
• outlineVariant
• shadow
• scrim
• inverseSurface
• onInverseSurface
• inversePrimary
• surfaceTint

overrideCommentReplyMap

{
    "<channel id>": "<int report id>"
}