Class Credential

Credential service

Example

 const list = await cam.credential.getCredentialInfoList();
 const token = list.credentialInfo![0].token;
 console.log((await cam.credential.getCredentialState({ token })).enabled);
 await cam.credential.enableCredential({ token });

Hierarchy (View Summary)

default
- Credential

Constructors

constructor

new Credential(onvif: Onvif): Credential
Parameters
- onvif: Onvif
Returns Credential
Overrides default.constructor
- Defined in credential.ts:67

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

addToBlacklist

addToBlacklist(options: AddToBlacklist): Promise<void>
Adds credential identifiers to the blacklist.
Parameters
- options: AddToBlacklist
Returns Promise<void>
- Defined in credential.ts:479

addToWhitelist

addToWhitelist(options: AddToWhitelist): Promise<void>
Adds credential identifiers to the whitelist.
Parameters
- options: AddToWhitelist
Returns Promise<void>
- Defined in credential.ts:424

createCredential

createCredential(options: CreateCredential): Promise<string>
Creates a new credential.
Parameters
- options: CreateCredential
Returns Promise<string>
- Defined in credential.ts:236

deleteBlacklist

deleteBlacklist(): Promise<void>
Deletes all blacklisted credential identifiers.

Returns Promise<void>
- Defined in credential.ts:506

deleteCredential

deleteCredential(options: DeleteCredential): Promise<void>
Deletes a credential.
Parameters
- options: DeleteCredential
Returns Promise<void>
- Defined in credential.ts:266

deleteCredentialAccessProfiles

deleteCredentialAccessProfiles(
options: DeleteCredentialAccessProfiles,
): Promise<void>
Deletes access profiles associated with a credential.
Parameters
- options: DeleteCredentialAccessProfiles
Returns Promise<void>
- Defined in credential.ts:388

deleteCredentialIdentifier

deleteCredentialIdentifier(options: DeleteCredentialIdentifier): Promise<void>
Deletes a credential identifier by type name.
Parameters
- options: DeleteCredentialIdentifier
Returns Promise<void>
- Defined in credential.ts:338

deleteWhitelist

deleteWhitelist(): Promise<void>
Deletes all whitelisted credential identifiers.

Returns Promise<void>
- Defined in credential.ts:451

disableCredential

disableCredential(options: DisableCredential): Promise<void>
Disables a credential.
Parameters
- options: DisableCredential
Returns Promise<void>
- Defined in credential.ts:291

enableCredential

enableCredential(options: EnableCredential): Promise<void>
Enables a credential.
Parameters
- options: EnableCredential
Returns Promise<void>
- Defined in credential.ts:283

getBlacklist

getBlacklist(options?: GetBlacklist): Promise<GetBlacklistResponse>
Returns blacklisted credential identifiers.
Parameters
- options: GetBlacklist = {}
Returns Promise<GetBlacklistResponse>
- Defined in credential.ts:459

getCredentialAccessProfiles

getCredentialAccessProfiles(
options: GetCredentialAccessProfiles,
): Promise<CredentialAccessProfile[] | undefined>
Returns access profiles associated with a credential.
Parameters
- options: GetCredentialAccessProfiles
Returns Promise<CredentialAccessProfile[] | undefined>
- Defined in credential.ts:354

getCredentialIdentifiers

getCredentialIdentifiers(
options: GetCredentialIdentifiers,
): Promise<CredentialIdentifier[] | undefined>
Returns identifiers of a credential.
Parameters
- options: GetCredentialIdentifiers
Returns Promise<CredentialIdentifier[] | undefined>
- Defined in credential.ts:307

getCredentialInfo

getCredentialInfo(
options: GetCredentialInfo,
): Promise<GetCredentialInfoResponse>
Returns credential info items for the requested tokens.
Parameters
- options: GetCredentialInfo
Returns Promise<GetCredentialInfoResponse>
- Defined in credential.ts:181

getCredentialInfoList

getCredentialInfoList(
options?: GetCredentialInfoList,
): Promise<GetCredentialInfoListResponse>
Returns a list of credential info items.
Parameters
- options: GetCredentialInfoList = {}
Returns Promise<GetCredentialInfoListResponse>
- Defined in credential.ts:190

getCredentialList

getCredentialList(
options?: GetCredentialList,
): Promise<GetCredentialListResponse>
Returns a list of credential items.
Parameters
- options: GetCredentialList = {}
Returns Promise<GetCredentialListResponse>
- Defined in credential.ts:219

getCredentials

getCredentials(options: GetCredentials): Promise<GetCredentialsResponse>
Returns credential items for the requested tokens.
Parameters
- options: GetCredentials
Returns Promise<GetCredentialsResponse>
- Defined in credential.ts:207

getCredentialState

getCredentialState(options: GetCredentialState): Promise<CredentialState>
Returns the current state of a credential.
Parameters
- options: GetCredentialState
Returns Promise<CredentialState>
- Defined in credential.ts:274

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in credential.ts:158

getSupportedFormatTypes

getSupportedFormatTypes(
options: GetSupportedFormatTypes,
): Promise<CredentialIdentifierFormatTypeInfo[]>
Returns supported format types for a credential identifier type.
Parameters
- options: GetSupportedFormatTypes
Returns Promise<CredentialIdentifierFormatTypeInfo[]>
- Defined in credential.ts:167

getWhitelist

getWhitelist(options?: GetWhitelist): Promise<GetWhitelistResponse>
Returns whitelisted credential identifiers.
Parameters
- options: GetWhitelist = {}
Returns Promise<GetWhitelistResponse>
- Defined in credential.ts:404

modifyCredential

modifyCredential(options: ModifyCredential): Promise<void>
Modifies an existing credential.
Parameters
- options: ModifyCredential
Returns Promise<void>
- Defined in credential.ts:258

removeFromBlacklist

removeFromBlacklist(options: RemoveFromBlacklist): Promise<void>
Removes credential identifiers from the blacklist.
Parameters
- options: RemoveFromBlacklist
Returns Promise<void>
- Defined in credential.ts:493

removeFromWhitelist

removeFromWhitelist(options: RemoveFromWhitelist): Promise<void>
Removes credential identifiers from the whitelist.
Parameters
- options: RemoveFromWhitelist
Returns Promise<void>
- Defined in credential.ts:438

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

resetAntipassbackViolation

resetAntipassbackViolation(options: ResetAntipassbackViolation): Promise<void>
Resets an anti-passback violation for a credential.
Parameters
- options: ResetAntipassbackViolation
Returns Promise<void>
- Defined in credential.ts:299

setCredential

setCredential(options: SetCredential): Promise<void>
Creates or replaces a credential (requires ClientSuppliedTokenSupported).
Parameters
- options: SetCredential
Returns Promise<void>
- Defined in credential.ts:250

setCredentialAccessProfiles

setCredentialAccessProfiles(options: SetCredentialAccessProfiles): Promise<void>
Sets access profiles associated with a credential.
Parameters
- options: SetCredentialAccessProfiles
Returns Promise<void>
- Defined in credential.ts:372

setCredentialIdentifier

setCredentialIdentifier(options: SetCredentialIdentifier): Promise<void>
Sets a credential identifier.
Parameters
- options: SetCredentialIdentifier
Returns Promise<void>
- Defined in credential.ts:325

Class Credential

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Credential

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

addToBlacklist

Parameters

Returns Promise<void>

addToWhitelist

Parameters

Returns Promise<void>

createCredential

Parameters

Returns Promise<string>

deleteBlacklist

Returns Promise<void>

deleteCredential

Parameters

Returns Promise<void>

deleteCredentialAccessProfiles

Parameters

Returns Promise<void>

deleteCredentialIdentifier

Parameters

Returns Promise<void>

deleteWhitelist

Returns Promise<void>

disableCredential

Parameters

Returns Promise<void>

enableCredential

Parameters

Returns Promise<void>

getBlacklist

Parameters

Returns Promise<GetBlacklistResponse>

getCredentialAccessProfiles

Parameters

Returns Promise<CredentialAccessProfile[] | undefined>

getCredentialIdentifiers

Parameters

Returns Promise<CredentialIdentifier[] | undefined>

getCredentialInfo

Parameters

Returns Promise<GetCredentialInfoResponse>

getCredentialInfoList

Parameters

Returns Promise<GetCredentialInfoListResponse>

getCredentialList

Parameters

Returns Promise<GetCredentialListResponse>

getCredentials

Parameters

Returns Promise<GetCredentialsResponse>

getCredentialState

Parameters

Returns Promise<CredentialState>

getServiceCapabilities

Returns Promise<Capabilities>

getSupportedFormatTypes

Parameters

Returns Promise<CredentialIdentifierFormatTypeInfo[]>

getWhitelist

Parameters

Returns Promise<GetWhitelistResponse>

modifyCredential

Parameters

Returns Promise<void>

removeFromBlacklist

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns