Class AccessControl

AccessControl service

Example

 const list = await cam.accessControl.getAccessPointInfoList();
 const token = list.accessPointInfo![0].token;
 console.log((await cam.accessControl.getAccessPointState({ token })).enabled);
 await cam.accessControl.disableAccessPoint({ token });

Hierarchy (View Summary)

default
- AccessControl

Constructors

constructor

new AccessControl(onvif: Onvif): AccessControl
Parameters
- onvif: Onvif
Returns AccessControl
Overrides default.constructor
- Defined in accesscontrol.ts:64

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createAccessPoint

createAccessPoint(options: CreateAccessPoint): Promise<string>
Creates a new access point.
Parameters
- options: CreateAccessPoint
Returns Promise<string>
- Defined in accesscontrol.ts:199

createArea

createArea(options: CreateArea): Promise<string>
Creates a new area.
Parameters
- options: CreateArea
Returns Promise<string>
- Defined in accesscontrol.ts:310

deleteAccessPoint

deleteAccessPoint(options: DeleteAccessPoint): Promise<void>
Deletes an access point.
Parameters
- options: DeleteAccessPoint
Returns Promise<void>
- Defined in accesscontrol.ts:226

deleteAccessPointAuthenticationProfile

deleteAccessPointAuthenticationProfile(
options: DeleteAccessPointAuthenticationProfile,
): Promise<void>
Deletes the authentication profile reference from an access point.
Parameters
- options: DeleteAccessPointAuthenticationProfile
Returns Promise<void>
- Defined in accesscontrol.ts:250

deleteArea

deleteArea(options: DeleteArea): Promise<void>
Deletes an area.
Parameters
- options: DeleteArea
Returns Promise<void>
- Defined in accesscontrol.ts:335

disableAccessPoint

disableAccessPoint(options: DisableAccessPoint): Promise<void>
Disables an access point.
Parameters
- options: DisableAccessPoint
Returns Promise<void>
- Defined in accesscontrol.ts:360

enableAccessPoint

enableAccessPoint(options: EnableAccessPoint): Promise<void>
Enables an access point.
Parameters
- options: EnableAccessPoint
Returns Promise<void>
- Defined in accesscontrol.ts:352

externalAuthorization

externalAuthorization(options: ExternalAuthorization): Promise<void>
Informs the device about an external authorization decision.
Parameters
- options: ExternalAuthorization
Returns Promise<void>
- Defined in accesscontrol.ts:368

feedback

feedback(options: Feedback): Promise<void>
Provides feedback for an access point.
Parameters
- options: Feedback
Returns Promise<void>
- Defined in accesscontrol.ts:388

getAccessPointInfo

getAccessPointInfo(
options: GetAccessPointInfo,
): Promise<GetAccessPointInfoResponse>
Returns access point info items for the requested tokens.
Parameters
- options: GetAccessPointInfo
Returns Promise<GetAccessPointInfoResponse>
- Defined in accesscontrol.ts:164

getAccessPointInfoList

getAccessPointInfoList(
options?: GetAccessPointInfoList,
): Promise<GetAccessPointInfoListResponse>
Returns a list of access point info items.
Parameters
- options: GetAccessPointInfoList = {}
Returns Promise<GetAccessPointInfoListResponse>
- Defined in accesscontrol.ts:147

getAccessPointList

getAccessPointList(
options?: GetAccessPointList,
): Promise<GetAccessPointListResponse>
Returns a list of access point items.
Parameters
- options: GetAccessPointList = {}
Returns Promise<GetAccessPointListResponse>
- Defined in accesscontrol.ts:173

getAccessPoints

getAccessPoints(options: GetAccessPoints): Promise<GetAccessPointsResponse>
Returns access point items for the requested tokens.
Parameters
- options: GetAccessPoints
Returns Promise<GetAccessPointsResponse>
- Defined in accesscontrol.ts:190

getAccessPointState

getAccessPointState(options: GetAccessPointState): Promise<AccessPointState>
Returns the current state of an access point.
Parameters
- options: GetAccessPointState
Returns Promise<AccessPointState>
- Defined in accesscontrol.ts:343

getAreaInfo

getAreaInfo(options: GetAreaInfo): Promise<GetAreaInfoResponse>
Returns area info items for the requested tokens.
Parameters
- options: GetAreaInfo
Returns Promise<GetAreaInfoResponse>
- Defined in accesscontrol.ts:275

getAreaInfoList

getAreaInfoList(options?: GetAreaInfoList): Promise<GetAreaInfoListResponse>
Returns a list of area info items.
Parameters
- options: GetAreaInfoList = {}
Returns Promise<GetAreaInfoListResponse>
- Defined in accesscontrol.ts:258

getAreaList

getAreaList(options?: GetAreaList): Promise<GetAreaListResponse>
Returns a list of area items.
Parameters
- options: GetAreaList = {}
Returns Promise<GetAreaListResponse>
- Defined in accesscontrol.ts:284

getAreas

getAreas(options: GetAreas): Promise<GetAreasResponse>
Returns area items for the requested tokens.
Parameters
- options: GetAreas
Returns Promise<GetAreasResponse>
- Defined in accesscontrol.ts:301

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in accesscontrol.ts:138

modifyAccessPoint

modifyAccessPoint(options: ModifyAccessPoint): Promise<void>
Modifies an existing access point.
Parameters
- options: ModifyAccessPoint
Returns Promise<void>
- Defined in accesscontrol.ts:218

modifyArea

modifyArea(options: ModifyArea): Promise<void>
Modifies an existing area.
Parameters
- options: ModifyArea
Returns Promise<void>
- Defined in accesscontrol.ts:327

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from default.request
- Defined in service.ts:49

setAccessPoint

setAccessPoint(options: SetAccessPoint): Promise<void>
Creates or replaces an access point (requires ClientSuppliedTokenSupported).
Parameters
- options: SetAccessPoint
Returns Promise<void>
- Defined in accesscontrol.ts:210

setAccessPointAuthenticationProfile

setAccessPointAuthenticationProfile(
options: SetAccessPointAuthenticationProfile,
): Promise<void>
Sets the authentication profile of an access point.
Parameters
- options: SetAccessPointAuthenticationProfile
Returns Promise<void>
- Defined in accesscontrol.ts:234

setArea

setArea(options: SetArea): Promise<void>
Creates or replaces an area (requires ClientSuppliedTokenSupported).
Parameters
- options: SetArea
Returns Promise<void>
- Defined in accesscontrol.ts:319

Class AccessControl

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AccessControl

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

createAccessPoint

Parameters

Returns Promise<string>

createArea

Parameters

Returns Promise<string>

deleteAccessPoint

Parameters

Returns Promise<void>

deleteAccessPointAuthenticationProfile

Parameters

Returns Promise<void>

deleteArea

Parameters

Returns Promise<void>

disableAccessPoint

Parameters

Returns Promise<void>

enableAccessPoint

Parameters

Returns Promise<void>

externalAuthorization

Parameters

Returns Promise<void>

feedback

Parameters

Returns Promise<void>

getAccessPointInfo

Parameters

Returns Promise<GetAccessPointInfoResponse>

getAccessPointInfoList

Parameters

Returns Promise<GetAccessPointInfoListResponse>

getAccessPointList

Parameters

Returns Promise<GetAccessPointListResponse>

getAccessPoints

Parameters

Returns Promise<GetAccessPointsResponse>

getAccessPointState

Parameters

Returns Promise<AccessPointState>

getAreaInfo

Parameters

Returns Promise<GetAreaInfoResponse>

getAreaInfoList

Parameters

Returns Promise<GetAreaInfoListResponse>

getAreaList

Parameters

Returns Promise<GetAreaListResponse>

getAreas

Parameters

Returns Promise<GetAreasResponse>

getServiceCapabilities

Returns Promise<Capabilities>

modifyAccessPoint

Parameters

Returns Promise<void>

modifyArea

Parameters

Returns Promise<void>

request

Type Parameters

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns