Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YaleDoorman<Test>

SDK class that expose the Yale doorman SDK.

Note that login() does not need to be called explicitly. The SDK will lazily call login() to (re)authenticate when necessary.

Type parameters

  • Test: boolean = false

Hierarchy

  • YaleDoorman

Index

Constructors

Methods

Constructors

constructor

  • The generic type parameter should be either omitted or false in production.

    Type parameters

    • Test: boolean = false

    Parameters

    • email: string
    • password: string
    • Optional configuration: Configuration<Test>

    Returns YaleDoorman<Test>

Methods

getDevices

getDoors

  • Convenience method to filter the set of Yale devices down the only doors. Only returns the metadata required for changing door states.

    Returns Promise<{ address: RfAddress; area: Area; name: string; state?: LockState; zone: Zone }[]>

getEventHistory

lockDoor

  • Locks a specific door. This request tends to take ~10 sec. The Zone, Area and RfAddress arguments may be retrieved using the getDevices() method.

    Parameters

    Returns Promise<void>

login

  • login(): Promise<void>

  • Authenticate using the credentials specified in the constructor.

    This function is used internally and does not need to be called directly.

    Returns Promise<void>

unlockDoor

  • unlockDoor(zone: Zone, area: Area, pincode: string): Promise<void>

  • Unlocks a specific door. This request tends to take ~10 sec. The Zone and Area arguments may be retrieved using the getDevices() method.

    Parameters

    Returns Promise<void>