PsApplicationAPI

Detailed Description

Interface for Application API for Property Scripts. Register with "cnPsApplicationAPI".

Since

1.0, 2025.01

Public Slots
virtual ApiJsonResponse	getInfo ()
virtual ApiJsonResponse	getUser ()
virtual ApiJsonResponse	getSettings ()=0

Member Function Documentation

getInfo

virtual ApiJsonResponse getInfo ( )

virtualslot

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, 2024.11

getSettings

virtual ApiJsonResponse getSettings ( )

pure virtualslot

Get Application settings. Override in derived classes.

getUser

virtual ApiJsonResponse getUser ( )

virtualslot

Get data of currently logged in user.

Returns

data : {                
}

Since

1.0, 2025.04