Interface Returns

Hierarchy

  • Returns

Properties

agedigitalconsentverification authinstructions authloginviaemail authnoneenabled autolang compactlogourl country enablemobilewebservice enablewebservices forgottenpasswordurl guestlogin httpswwwroot identityproviders lang langlist langmenu launchurl locale logourl maintenanceenabled maintenancemessage mobilecssurl registerauth rememberusername sitename supportavailability supportemail supportname supportpage tool_mobile_androidappid tool_mobile_disabledfeatures tool_mobile_iosappid tool_mobile_minimumversion tool_mobile_qrcodetype tool_mobile_setuplink typeoflogin warnings wwwroot

Properties

agedigitalconsentverification

agedigitalconsentverification: null | boolean

Whether age digital consent verification is enabled.

authinstructions

authinstructions: null | string

Authentication instructions.

authloginviaemail

authloginviaemail: null | number

Whether log in via email is enabled.

authnoneenabled

authnoneenabled: null | number

Whether auth none is enabled.

autolang

autolang: null | number

Whether to detect default language from browser setting.

compactlogourl

compactlogourl: null | string

The site compact logo URL

country

country: null | string

Default site country

enablemobilewebservice

enablemobilewebservice: null | number

Whether the Mobile service is enabled.

enablewebservices

enablewebservices: null | number

Whether Web Services are enabled.

forgottenpasswordurl

forgottenpasswordurl: null | string

Forgotten password URL.

guestlogin

guestlogin: null | number

Whether guest login is enabled.

httpswwwroot

httpswwwroot: null | string

Site https URL (if httpslogin is enabled).

identityproviders

identityproviders: ReturnsIdentityproviders

Identity providers

lang

lang: null | string

Default language for the site.

langlist

langlist: null | string

Languages on language menu.

langmenu

langmenu: null | number

Whether the language menu should be displayed.

launchurl

launchurl: null | string

SSO login launch URL.

locale

locale: null | string

Sitewide locale.

logourl

logourl: null | string

The site logo URL

maintenanceenabled

maintenanceenabled: null | number

Whether site maintenance is enabled.

maintenancemessage

maintenancemessage: null | string

Maintenance message.

mobilecssurl

mobilecssurl: null | string

Mobile custom CSS theme

registerauth

registerauth: null | string

Authentication method for user registration.

rememberusername

rememberusername: null | number

Values: 0 for No, 1 for Yes, 2 for optional.

sitename

sitename: null | string

Site name.

supportavailability

supportavailability: null | number

Determines who has access to contact site support.

supportemail

supportemail: null | string

Site support contact email (only if age verification is enabled).

supportname

supportname: null | string

Site support contact name (only if age verification is enabled).

supportpage

supportpage: null | string

Site support page link.

tool_mobile_androidappid

tool_mobile_androidappid: null | string

Android app's unique identifier.

tool_mobile_disabledfeatures

tool_mobile_disabledfeatures: null | string

Disabled features in the app

tool_mobile_iosappid

tool_mobile_iosappid: null | string

iOS app's unique identifier.

tool_mobile_minimumversion

tool_mobile_minimumversion: null | string

Minimum required version to access.

tool_mobile_qrcodetype

tool_mobile_qrcodetype: null | number

QR login configuration.

tool_mobile_setuplink

tool_mobile_setuplink: null | string

App download page.

typeoflogin

typeoflogin: null | number

The type of login. 1 for app, 2 for browser, 3 for embedded.

warnings

warnings: api.tool.mobile.get_public_config.ReturnsWarnings

list of warnings

wwwroot

wwwroot: null | string

Site URL.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc