ApplicationAPI

Description

Interface for Application API. Register with "cnApplicationAPI".

Since

1.0, 2025

Functions
ApiJsonResponse	getAccessToken ()
ApiJsonResponse	getInfo ()
ApiJsonResponse	getUser ()

SETTINGS
ApiJsonResponse	setSettings (QVariant &v)
ApiJsonResponse	getSettingsValue (QString key)
ApiJsonResponse	getSettingsDefaultValue (QString key)
ApiJsonResponse	setSettingsValue (QString key, QVariant &v)
ApiJsonResponse	getSettingsSupportedKeys ()
ApiJsonResponse	resetSettings ()
ApiJsonResponse	getSettings ()

Function Documentation

getAccessToken

ApiJsonResponse getAccessToken ( )

slot

Get Access Token of logged in user. The user must confirm access to the access token.

Since

1.0, Apr 2025

getInfo

ApiJsonResponse getInfo ( )

slotinherited

Get application information.

Returns

data : {
    name        : "colneopro",
    displayName : "COLNEO pro", // not available for COLNEO console
    version     : "1.0.0",
    build       : "123",
    builddate   : "2024-11-01",
    organization: "COLNEO GmbH",
    domain      : "www.colneo.com",
    dirPath     : "C:/Software/Colneo"
}

Since

1.0, Dec 2024

getSettings

ApiJsonResponse getSettings ( )

slot

Note

Usable with script properties

Get application setting.

Returns

data : {
    "key" : value,
    ...
}

Since

1.0, May 2025

getSettingsDefaultValue()

ApiJsonResponse getSettingsDefaultValue

(

QString

key

)

Note

Usable with script properties

Get application settings default value.

Returns

data : value

Since

1.0, May 2025

getSettingsSupportedKeys()

ApiJsonResponse getSettingsSupportedKeys

(

)

Note

Usable with script properties

Get list of application setting supported keys.

Returns

data : [ ... ]  // list of strings

Since

1.0, 07.2025

getSettingsValue()

ApiJsonResponse getSettingsValue

(

QString

key

)

Note

Usable with script properties

Get application settings value.

Returns

data : value

Since

1.0, May 2025

getUser

ApiJsonResponse getUser ( )

slotinherited

Get data of the user currently logged in.

Returns

data :
{
}

Since

1.0, Apr 2025

resetSettings()

ApiJsonResponse resetSettings

(

)

Note

Usable with script properties

Reset settings to default values. Values of settings without defaiult value are not changed.

Returns

data : 

Since

1.0, 07.2025, jh

setSettings()

ApiJsonResponse setSettings

(

QVariant &

v

)

Note

Usable with script properties

set application settings.

Returns

data : {
    "key" : value,
    ...
}

Since

1.0, May 2025

setSettingsValue()

ApiJsonResponse setSettingsValue	(	QString	key,
		QVariant &	v )

Note

Usable with script properties

Set application settings value for given key.

Returns

data : {
    "key" : value       
}

Since

1.0, May 2025