Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IUserManager

IUserManager have APIs for managing users.

api-version

1

user

Hierarchy

Index

Properties

Methods

Properties

Readonly user

user: Monitorable<User>

Monitorable User.

api-version

1

user

Methods

authenticateUserPassword

changeUser

  • changeUser(user: User, customTitle?: string, customMessage?: string): Promise<boolean>
  • changeUser(user: User, options?: UserPasswordPopupOptions): Promise<boolean>

  • Change user User.

    api-version

    1

    system

    Parameters

    • user: User

      An user to change.

    • Optional customTitle: string

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

    • Optional customMessage: string

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

    Returns Promise<boolean>

    Return Fulfills with true if the user has been changed successfully, otherwise false.

  • Change user User. Request user password.

    api-version

    3

    system

    Parameters

    Returns Promise<boolean>

    Return Fulfills with true if the user has been changed successfully, otherwise false.

changeUserPassword

  • changeUserPassword(user: User, newPwd: string): Promise<boolean>

  • Change User password

    api-version

    3

    system

    Parameters

    • user: User

      An user to change password.

    • newPwd: string

      A new password

    Returns Promise<boolean>

    Return settings table update result

verifyUserPassword

  • verifyUserPassword(user: User, confirmPassword: string): Promise<boolean>

  • Verify User password

    api-version

    3

    system

    Parameters

    • user: User

      A user

    • confirmPassword: string

      A confirm password

    Returns Promise<boolean>

    Return Fulfills with true if the confirmPassword is correct, otherwise false.

Generated using TypeDoc