logout

[ Function ]

public static logout(
    callback?: null | (
        (data: TcHmi.IResultObject) => void
    ) = null
): boolean;

Logs out the current user.

Parameter

Name

Type

Description

callback [ optional ]

(data: TcHmi.IResultObject) => void

Asynchronous callback function that is triggered when the operation was terminated.

Return value

Type

Description

boolean

Returns confirmation as to whether the operation was successfully sent.

logout 1:

Available from 1.8

Sample - JavaScript

TcHmi.Server.logout(function(data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Success
    } else {
        // Error
    }
});