Infohub JS API
Loading...
Searching...
No Matches
Licence Class Reference

Description

COLNEO infohub Licence.

Information about an infohub user licence. Contains licencee information as well as modules and information about permissions.

Example:

{
"contract": "",
"created": "2025-01-01T00:00:00Z",
"createdby": "user@example.com",
"expirated": null,
"id": "00000000-0000-0000-0000-000000000000",
"licenced_userids": ["user@example.com"],
"licencee": {
"address": "{\"street\":\"...\", \"city\":\"...\", \"zip\":\"...\"}",
"email": "info@example.com",
"name": "ACME"
},
"maxpermissions": 50,
"maxseats": 0,
"module": "objecttypes",
"scope": "cn_dv",
"startdate": "2025-01-01T00:00:00Z",
"updated": "2025-01-01T00:00:00Z",
"updatedby": "user@example.com"
}

Public Member Functions

 constructor (data=({}))
 getData ()
 getLicencedUserIds ()
 getLicencee ()
 setData (data=({}))

Function Documentation

◆ constructor()

constructor ( data = ({}))

Create a licence from a JSON object.

Parameters
{object}data - The licence data

◆ getData()

getData ( )

Get the licence data.

Returns
{object}

◆ getLicencedUserIds()

getLicencedUserIds ( )

Get licenced user IDs.

Returns
{string[]}

◆ getLicencee()

getLicencee ( )

Get licencee.

Returns
{any}

◆ setData()

setData ( data = ({}))

Set the licence data.

Parameters
{object}data - The licence data
Returns
{void}