Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISafetyPasswordManager

SafetyPasswordManager for managing safety password in the system.

api-version

1

user

Hierarchy

  • ISafetyPasswordManager

Index

Properties

Methods

Properties

Readonly safetyPasswordLocked

safetyPasswordLocked: Monitorable<boolean>

Monitorable safety password lock state.

api-version

1

user

Methods

authenticateSafetyPassword

  • authenticateSafetyPassword(customTitle: null | string, customMessage: null | string, force?: boolean): Promise<boolean>
  • authenticateSafetyPassword(options?: SafetyPasswordPopupOptions): Promise<boolean>

  • Confirm Safety password.

    api-version

    1

    user

    Parameters

    • customTitle: null | string

      A custom title. If it is not set, then default title will be displayed.

    • customMessage: null | string

      A custom message. If it is not set, then default message will be displayed.

    • Optional force: boolean

      If the authentication procedure is required even if the password lock is unlocked, set force to true

    Returns Promise<boolean>

    Return Fulfills with true if user authenticated safety password successfully, otherwise false.

  • Confirm Safety password.

    api-version

    3

    user

    Parameters

    Returns Promise<boolean>

    Return Fulfills with true if user authenticated safety password successfully, otherwise false.

changeSafetyPassword

  • changeSafetyPassword(newPwd: string): Promise<boolean>

  • Change Safety password

    api-version

    1

    system

    Parameters

    • newPwd: string

      A new password

    Returns Promise<boolean>

    Return settings table update result

safetyPasswordAuthentication

  • safetyPasswordAuthentication(context: Context, force?: boolean): Promise<boolean>

  • Confirm Safety password

    api-version

    1

    user

    Parameters

    • context: Context

      A caller's context

    • Optional force: boolean

      If the authentication procedure is required even if the password lock is unlocked, set force to true

    Returns Promise<boolean>

    Return password confirmation

setSafetyPasswordLock

  • setSafetyPasswordLock(): Promise<void>
  • setSafetyPasswordLock(locked: boolean): Promise<void>

  • Change Safety password lock state

    api-version

    1

    system

    Returns Promise<void>

  • Change Safety password lock state

    api-version

    3

    system

    Parameters

    • locked: boolean

      A lock state

    Returns Promise<void>

verifySafetyPassword

  • verifySafetyPassword(confirmPassword: string): Promise<boolean>

  • Verify Safety password

    api-version

    3

    system

    Parameters

    • confirmPassword: string

      A confirm password

    Returns Promise<boolean>

    Return verified or not

Generated using TypeDoc