listUsersEx

[ Function ]

public static listUsersEx(
    options?: TcHmi.Server.UserManagement.IUserManagementOptions | null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.Server.UserManagement. IUserResultObject) => void) = null
): TcHmi.IErrorDetails;

Supplies a list of all existing system users as object with all metadata.

Parameter

Name	Type	Description
options	TcHmi.Server.UserManagement.IUserManagementOptions, null	User management options
requestOptions	TcHmi.Server.IRequestOptions, null	Server request options
callback [ optional ]	(data: TcHmi.Server.UserManagement. IUserResultObject) => void, null	Asynchronous callback function that is triggered once the action is completed.

Return value

Type	Description
TcHmi.IErrorDetails	Returns confirmation as to whether the operation was successfully sent.

	Available from version 1.10.1018.48

Sample - JavaScript

TcHmi.Server.UserManagement.listUsersEx(
    null,
    {timeout: 2000},
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
                console.log(data.userDetails);
/*
{
    "__SystemAdministrator": {
        "domain": "TcHmiUserManagement",
        "enabled": false,
        "autoLogout": "P30D",
        "locale": "en",
        "groups": [
            "__SystemAdministrators"
        ]
    },
    "__SystemGuest": {
        "domain": "TcHmiUserManagement",
        "enabled": true,
        "autoLogout": "P30D",
        "locale": "en",
        "groups": [
         "__SystemGuests"
        ]
    }
}
*/
            } else {
                // Error
            }
        }
);