Class AccessRules

AccessRules service

Example

 const list = await cam.accessRules.getAccessProfileInfoList();
 const token = list.accessProfileInfo![0].token;
 console.log((await cam.accessRules.getAccessProfiles({ token: [token] })).accessProfile);

Hierarchy (View Summary)

default
- AccessRules

Index

Constructors

constructor

new AccessRules(onvif: Onvif): AccessRules
Parameters
- onvif: Onvif
Returns AccessRules
Overrides default.constructor
- Defined in accessrules.ts:39

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createAccessProfile

createAccessProfile(options: CreateAccessProfile): Promise<string>
Creates a new access profile.
Parameters
- options: CreateAccessProfile
Returns Promise<string>
- Defined in accessrules.ts:137

deleteAccessProfile

deleteAccessProfile(options: DeleteAccessProfile): Promise<void>
Deletes an access profile.
Parameters
- options: DeleteAccessProfile
Returns Promise<void>
- Defined in accessrules.ts:164

getAccessProfileInfo

getAccessProfileInfo(
options: GetAccessProfileInfo,
): Promise<GetAccessProfileInfoResponse>
Returns access profile info items for the requested tokens.
Parameters
- options: GetAccessProfileInfo
Returns Promise<GetAccessProfileInfoResponse>
- Defined in accessrules.ts:82

getAccessProfileInfoList

getAccessProfileInfoList(
options?: GetAccessProfileInfoList,
): Promise<GetAccessProfileInfoListResponse>
Returns a list of access profile info items.
Parameters
- options: GetAccessProfileInfoList = {}
Returns Promise<GetAccessProfileInfoListResponse>
- Defined in accessrules.ts:91

getAccessProfileList

getAccessProfileList(
options?: GetAccessProfileList,
): Promise<GetAccessProfileListResponse>
Returns a list of access profile items.
Parameters
- options: GetAccessProfileList = {}
Returns Promise<GetAccessProfileListResponse>
- Defined in accessrules.ts:120

getAccessProfiles

getAccessProfiles(
options: GetAccessProfiles,
): Promise<GetAccessProfilesResponse>
Returns access profile items for the requested tokens.
Parameters
- options: GetAccessProfiles
Returns Promise<GetAccessProfilesResponse>
- Defined in accessrules.ts:108

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in accessrules.ts:73

modifyAccessProfile

modifyAccessProfile(options: ModifyAccessProfile): Promise<void>
Modifies an existing access profile.
Parameters
- options: ModifyAccessProfile
Returns Promise<void>
- Defined in accessrules.ts:156

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

setAccessProfile

setAccessProfile(options: SetAccessProfile): Promise<void>
Creates or replaces an access profile (requires ClientSuppliedTokenSupported).
Parameters
- options: SetAccessProfile
Returns Promise<void>
- Defined in accessrules.ts:148

Class AccessRules

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AccessRules

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

createAccessProfile

Parameters

Returns Promise<string>

deleteAccessProfile

Parameters

Returns Promise<void>

getAccessProfileInfo

Parameters

Returns Promise<GetAccessProfileInfoResponse>

getAccessProfileInfoList

Parameters

Returns Promise<GetAccessProfileInfoListResponse>

getAccessProfileList

Parameters

Returns Promise<GetAccessProfileListResponse>

getAccessProfiles

Parameters

Returns Promise<GetAccessProfilesResponse>

getServiceCapabilities

Returns Promise<Capabilities>

modifyAccessProfile

Parameters

Returns Promise<void>

request

Type Parameters

Parameters

Returns Promise<T>

setAccessProfile

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns