Class DoorControl

DoorControl service

Example

 const doorsList = await cam.doorControl.getDoorList();
 const token = doorsList.door![0].token;
 console.log((await cam.doorControl.getDoorState({ token })).doorMode);
 await cam.doorControl.unlockDoor({ token });
 console.log((await cam.doorControl.getDoorState({ token })).doorMode);

Hierarchy (View Summary)

default
- DoorControl

Index

Constructors

constructor

new DoorControl(onvif: Onvif, service: keyof OnvifServices): DoorControl
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns DoorControl
Overrides default.constructor
- Defined in doorcontrol.ts:54

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

accessDoor

accessDoor(options: AccessDoor): Promise<void>
Grants momentary access to a door.
Parameters
- options: AccessDoor
Returns Promise<void>
- Defined in doorcontrol.ts:266

blockDoor

blockDoor(options: BlockDoor): Promise<void>
Blocks a door.
Parameters
- options: BlockDoor
Returns Promise<void>
- Defined in doorcontrol.ts:307

createDoor

createDoor(options: CreateDoor): Promise<string>
Creates a new door.
Parameters
- options: CreateDoor
Returns Promise<string>
- Defined in doorcontrol.ts:204

deleteDoor

deleteDoor(options: DeleteDoor): Promise<void>
Deletes a door.
Parameters
- options: DeleteDoor
Returns Promise<void>
- Defined in doorcontrol.ts:241

doubleLockDoor

doubleLockDoor(options: DoubleLockDoor): Promise<void>
Activates double-lock on a door.
Parameters
- options: DoubleLockDoor
Returns Promise<void>
- Defined in doorcontrol.ts:367

getDoorInfo

getDoorInfo(options: GetDoorInfo): Promise<GetDoorInfoResponse>
Returns door info items for the requested tokens.
Parameters
- options: GetDoorInfo
Returns Promise<GetDoorInfoResponse>
- Defined in doorcontrol.ts:155

getDoorInfoList

getDoorInfoList(options?: GetDoorInfoList): Promise<GetDoorInfoListResponse>
Returns a list of door info items.
Parameters
- options: GetDoorInfoList = {}
Returns Promise<GetDoorInfoListResponse>
- Defined in doorcontrol.ts:138

getDoorList

getDoorList(options?: GetDoorList): Promise<GetDoorListResponse>
Returns a list of door items.
Parameters
- options: GetDoorList = {}
Returns Promise<GetDoorListResponse>
- Defined in doorcontrol.ts:171

getDoors

getDoors(options: GetDoors): Promise<GetDoorsResponse>
Returns door items for the requested tokens.
Parameters
- options: GetDoors
Returns Promise<GetDoorsResponse>
- Defined in doorcontrol.ts:188

getDoorState

getDoorState(options: GetDoorState): Promise<DoorState>
Returns the current state of a door.
Parameters
- options: GetDoorState
Returns Promise<DoorState>
- Defined in doorcontrol.ts:253

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the door control service.

Returns Promise<Capabilities>
- Defined in doorcontrol.ts:127

lockDoor

lockDoor(options: LockDoor): Promise<void>
Locks a door.
Parameters
- options: LockDoor
Returns Promise<void>
- Defined in doorcontrol.ts:283

lockDownDoor

lockDownDoor(options: LockDownDoor): Promise<void>
Puts a door in lock-down mode.
Parameters
- options: LockDownDoor
Returns Promise<void>
- Defined in doorcontrol.ts:319

lockDownReleaseDoor

lockDownReleaseDoor(options: LockDownReleaseDoor): Promise<void>
Releases lock-down mode on a door.
Parameters
- options: LockDownReleaseDoor
Returns Promise<void>
- Defined in doorcontrol.ts:331

lockOpenDoor

lockOpenDoor(options: LockOpenDoor): Promise<void>
Puts a door in lock-open mode.
Parameters
- options: LockOpenDoor
Returns Promise<void>
- Defined in doorcontrol.ts:343

lockOpenReleaseDoor

lockOpenReleaseDoor(options: LockOpenReleaseDoor): Promise<void>
Releases lock-open mode on a door.
Parameters
- options: LockOpenReleaseDoor
Returns Promise<void>
- Defined in doorcontrol.ts:355

modifyDoor

modifyDoor(options: ModifyDoor): Promise<void>
Modifies an existing door.
Parameters
- options: ModifyDoor
Returns Promise<void>
- Defined in doorcontrol.ts:229

request

request(query: Record<string, any>, options?: LineraseOptions): Promise<any>
Parameters
- query: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<any>
Inherited from default.request
- Defined in service.ts:37

setDoor

setDoor(options: SetDoor): Promise<void>
Creates or replaces a door (requires ClientSuppliedTokenSupported).
Parameters
- options: SetDoor
Returns Promise<void>
- Defined in doorcontrol.ts:217

unlockDoor

unlockDoor(options: UnlockDoor): Promise<void>
Unlocks a door.
Parameters
- options: UnlockDoor
Returns Promise<void>
- Defined in doorcontrol.ts:295

Class DoorControl

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DoorControl

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

accessDoor

Parameters

Returns Promise<void>

blockDoor

Parameters

Returns Promise<void>

createDoor

Parameters

Returns Promise<string>

deleteDoor

Parameters

Returns Promise<void>

doubleLockDoor

Parameters

Returns Promise<void>

getDoorInfo

Parameters

Returns Promise<GetDoorInfoResponse>

getDoorInfoList

Parameters

Returns Promise<GetDoorInfoListResponse>

getDoorList

Parameters

Returns Promise<GetDoorListResponse>

getDoors

Parameters

Returns Promise<GetDoorsResponse>

getDoorState

Parameters

Returns Promise<DoorState>

getServiceCapabilities

Returns Promise<Capabilities>

lockDoor

Parameters

Returns Promise<void>

lockDownDoor

Parameters

Returns Promise<void>

lockDownReleaseDoor

Parameters

Returns Promise<void>

lockOpenDoor

Parameters

Returns Promise<void>

lockOpenReleaseDoor

Parameters

Returns Promise<void>

modifyDoor

Parameters

Returns Promise<void>

request

Parameters

Returns Promise<any>

setDoor

Parameters

Returns Promise<void>

unlockDoor

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns