Skip to main content
Version: 8.0.3

security

The sos.management.security API groups together methods for management of a security PIN code of the device.

Methods

generateRandomPinCode()

The getPinCode() method sets the PIN code to a randomly generated one.

generateRandomPinCode(): Promise<void>;

getPinCode()

The getPinCode() method returns the currently set PIN code.

getPinCode(): Promise<string>;

Possible errors

The method throws an error 41703: Get PIN code failed because the PIN code has not been set yet.

setPinCode()

The setPinCode() method sets the pin code.

setPinCode(pinCode: string): Promise<void>;

Params

NameTypeDescription
pinCodestringThe PIN code to be set.

Possible errors

The method throws an error 41701: Invalid PIN code format (has to be 4-digits string).