Class Device

Device methods

Hierarchy (View Summary)

default
- Device

Index

Constructors

Properties

media2Support onvif service xmlns

Accessors

DNS networkInterfaces NTP scopes serviceCapabilities services

Methods

addIPAddressFilter addScopes createCertificate createDot1XConfiguration createStorageConfiguration createUsers deleteCertificates deleteDot1XConfiguration deleteGeoLocation deleteStorageConfiguration deleteUserRole deleteUsers getAccessPolicy getAuthFailureWarningConfiguration getAuthFailureWarningOptions getCACertificates getCapabilities getCertificateInformation getCertificates getCertificatesStatus getClientCertificateMode getDeviceInformation getDiscoveryMode getDNS getDot11Capabilities getDot11Status getDot1XConfiguration getDot1XConfigurations getDPAddresses getDynamicDNS getEndpointReference getGeoLocation getHostname getIPAddressFilter getNetworkDefaultGateway getNetworkInterfaces getNetworkProtocols getNTP getPasswordComplexityConfiguration getPasswordComplexityOptions getPasswordHistoryConfiguration getPkcs10Request getRelayOutputs getRemoteDiscoveryMode getRemoteUser getScopes getServiceCapabilities getServices getStorageConfiguration getStorageConfigurations getSystemBackup getSystemDateAndTime getSystemLog getSystemSupportInformation getSystemUris getUserRoles getUsers getWsdlUrl getZeroConfiguration loadCACertificates loadCertificates loadCertificateWithPrivateKey removeIPAddressFilter removeScopes request restoreSystem scanAvailableDot11Networks sendAuxiliaryCommand setAccessPolicy setAuthFailureWarningConfiguration setCertificatesStatus setClientCertificateMode setDiscoveryMode setDNS setDot1XConfiguration setDPAddresses setDynamicDNS setGeoLocation setHashingAlgorithm setHostname setHostnameFromDHCP setIPAddressFilter setNetworkDefaultGateway setNetworkInterfaces setNetworkProtocols setNTP setPasswordComplexityConfiguration setPasswordHistoryConfiguration setRelayOutputSettings setRelayOutputState setRemoteDiscoveryMode setRemoteUser setScopes setStorageConfiguration setSystemDateAndTime setSystemFactoryDefault setUser setUserRole setZeroConfiguration startFirmwareUpgrade startSystemRestore systemReboot upgradeFirmware upgradeSystemFirmware

Constructors

constructor

new Device(onvif: Onvif, service: keyof OnvifServices): Device
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns Device
Overrides default.constructor
- Defined in device.ts:145

Properties

media2Support

media2Support: boolean = false

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Accessors

DNS

get DNS(): DNSInformation | undefined
Returns DNSInformation | undefined
- Defined in device.ts:137

networkInterfaces

get networkInterfaces(): NetworkInterface[] | undefined
Returns NetworkInterface[] | undefined
- Defined in device.ts:141

NTP

get NTP(): NTPInformation | undefined
Returns NTPInformation | undefined
- Defined in device.ts:133

scopes

get scopes(): Scope[]
Returns Scope[]
- Defined in device.ts:125

serviceCapabilities

get serviceCapabilities(): DeviceServiceCapabilities | undefined
Returns DeviceServiceCapabilities | undefined
- Defined in device.ts:129

services

get services(): Service[]
Returns Service[]
- Defined in device.ts:120

Methods

addIPAddressFilter

addIPAddressFilter(__namedParameters: AddIPAddressFilter): Promise<void>
Parameters
- __namedParameters: AddIPAddressFilter
Returns Promise<void>
- Defined in device.ts:1017

addScopes

addScopes(__namedParameters: AddScopes): Promise<void>
Parameters
- __namedParameters: AddScopes
Returns Promise<void>
- Defined in device.ts:753

createCertificate

createCertificate(options?: CreateCertificate): Promise<any>
Parameters
- options: CreateCertificate = {}
Returns Promise<any>
- Defined in device.ts:1044

createDot1XConfiguration

createDot1XConfiguration(
__namedParameters: CreateDot1XConfiguration,
): Promise<void>
Parameters
- __namedParameters: CreateDot1XConfiguration
Returns Promise<void>
- Defined in device.ts:1136

createStorageConfiguration

createStorageConfiguration(
__namedParameters: CreateStorageConfiguration,
): Promise<string>
Parameters
- __namedParameters: CreateStorageConfiguration
Returns Promise<string>
- Defined in device.ts:1257

createUsers

createUsers(__namedParameters: CreateUsers): Promise<void>
Parameters
- __namedParameters: CreateUsers
Returns Promise<void>
- Defined in device.ts:850

deleteCertificates

deleteCertificates(__namedParameters: DeleteCertificates): Promise<void>
Parameters
- __namedParameters: DeleteCertificates
Returns Promise<void>
- Defined in device.ts:1075

deleteDot1XConfiguration

deleteDot1XConfiguration(
__namedParameters: DeleteDot1XConfiguration,
): Promise<void>
Parameters
- __namedParameters: DeleteDot1XConfiguration
Returns Promise<void>
- Defined in device.ts:1164

deleteGeoLocation

deleteGeoLocation(__namedParameters: DeleteGeoLocation): Promise<void>
Parameters
- __namedParameters: DeleteGeoLocation
Returns Promise<void>
- Defined in device.ts:1298

deleteStorageConfiguration

deleteStorageConfiguration(
__namedParameters: DeleteStorageConfiguration,
): Promise<void>
Parameters
- __namedParameters: DeleteStorageConfiguration
Returns Promise<void>
- Defined in device.ts:1281

deleteUserRole

deleteUserRole(__namedParameters: DeleteUserRole): Promise<void>
Parameters
- __namedParameters: DeleteUserRole
Returns Promise<void>
- Defined in device.ts:826

deleteUsers

deleteUsers(__namedParameters: DeleteUsers): Promise<void>
Parameters
- __namedParameters: DeleteUsers
Returns Promise<void>
- Defined in device.ts:856

getAccessPolicy

getAccessPolicy(): Promise<BinaryData>
Returns Promise<BinaryData>
- Defined in device.ts:1033

getAuthFailureWarningConfiguration

getAuthFailureWarningConfiguration(): Promise<
GetAuthFailureWarningConfigurationResponse,
>
Returns Promise<GetAuthFailureWarningConfigurationResponse>
- Defined in device.ts:919

getAuthFailureWarningOptions

getAuthFailureWarningOptions(): Promise<any>
Returns Promise<any>
- Defined in device.ts:914

getCACertificates

getCACertificates(): Promise<Certificate[]>
Returns Promise<Certificate[]>
- Defined in device.ts:1109

getCapabilities

getCapabilities(options?: GetCapabilities): Promise<Capabilities>
This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods.
Parameters
- Optionaloptions: GetCapabilities
  - Optionalcategory?: CapabilityCategory[]
    
    List of categories to retrieve capability information on.
Returns Promise<Capabilities>
- Defined in device.ts:439

getCertificateInformation

getCertificateInformation(
__namedParameters: GetCertificateInformation,
): Promise<any>
Parameters
- __namedParameters: GetCertificateInformation
Returns Promise<any>
- Defined in device.ts:1123

getCertificates

getCertificates(): Promise<Certificate[]>
Returns Promise<Certificate[]>
- Defined in device.ts:1056

getCertificatesStatus

getCertificatesStatus(): Promise<CertificateStatus[]>
Returns Promise<CertificateStatus[]>
- Defined in device.ts:1061

getClientCertificateMode

getClientCertificateMode(): Promise<boolean>
Returns Promise<boolean>
- Defined in device.ts:1098

getDeviceInformation

getDeviceInformation(): Promise<GetDeviceInformationResponse>
Receive device information

Returns Promise<GetDeviceInformationResponse>
- Defined in device.ts:485

getDiscoveryMode

getDiscoveryMode(): Promise<any>
Returns Promise<any>
- Defined in device.ts:769

getDNS

getDNS(): Promise<DNSInformation>
This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.

Returns Promise<DNSInformation>
- Defined in device.ts:605

getDot11Capabilities

getDot11Capabilities(): Promise<any>
Returns Promise<any>
- Defined in device.ts:1202

getDot11Status

getDot11Status(__namedParameters: GetDot11Status): Promise<any>
Parameters
- __namedParameters: GetDot11Status
Returns Promise<any>
- Defined in device.ts:1207

getDot1XConfiguration

getDot1XConfiguration(__namedParameters: GetDot1XConfiguration): Promise<any>
Parameters
- __namedParameters: GetDot1XConfiguration
Returns Promise<any>
- Defined in device.ts:1152

getDot1XConfigurations

getDot1XConfigurations(): Promise<Dot1XConfiguration[]>
Returns Promise<Dot1XConfiguration[]>
- Defined in device.ts:1159

getDPAddresses

getDPAddresses(): Promise<NetworkHost[] | undefined>
Returns Promise<NetworkHost[] | undefined>
- Defined in device.ts:791

getDynamicDNS

getDynamicDNS(): Promise<DynamicDNSInformation>
Returns Promise<DynamicDNSInformation>
- Defined in device.ts:947

getEndpointReference

getEndpointReference(): Promise<any>
Returns Promise<any>
- Defined in device.ts:803

getGeoLocation

getGeoLocation(): Promise<LocationEntity[]>
Returns Promise<LocationEntity[]>
- Defined in device.ts:1287

getHostname

getHostname(): Promise<HostnameInformation>
Receive hostname information

Returns Promise<HostnameInformation>
- Defined in device.ts:494

getIPAddressFilter

getIPAddressFilter(): Promise<IPAddressFilter>
Returns Promise<IPAddressFilter>
- Defined in device.ts:1004

getNetworkDefaultGateway

getNetworkDefaultGateway(): Promise<NetworkGateway>
Returns Promise<NetworkGateway>
- Defined in device.ts:976

getNetworkInterfaces

getNetworkInterfaces(): Promise<NetworkInterface[]>
This operation gets the network interface configuration from a device. The device shall support return of network interface configuration settings as defined by the NetworkInterface type through the GetNetworkInterfaces command.

Returns Promise<NetworkInterface[]>
- Defined in device.ts:649

getNetworkProtocols

getNetworkProtocols(): Promise<NetworkProtocol[]>
Returns Promise<NetworkProtocol[]>
- Defined in device.ts:962

getNTP

getNTP(): Promise<NTPInformation>
This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the GetNTP command.

Returns Promise<NTPInformation>
- Defined in device.ts:556

getPasswordComplexityConfiguration

getPasswordComplexityConfiguration(): Promise<
GetPasswordComplexityConfigurationResponse,
>
Returns Promise<GetPasswordComplexityConfigurationResponse>
- Defined in device.ts:878

getPasswordComplexityOptions

getPasswordComplexityOptions(): Promise<any>
Returns Promise<any>
- Defined in device.ts:873

getPasswordHistoryConfiguration

getPasswordHistoryConfiguration(): Promise<any>
Returns Promise<any>
- Defined in device.ts:900

getPkcs10Request

getPkcs10Request(options: GetPkcs10Request): Promise<any>
Parameters
- options: GetPkcs10Request
Returns Promise<any>
- Defined in device.ts:1081

getRelayOutputs

getRelayOutputs(): Promise<RelayOutput[]>
Returns Promise<RelayOutput[]>
- Defined in device.ts:1172

getRemoteDiscoveryMode

getRemoteDiscoveryMode(): Promise<any>
Returns Promise<any>
- Defined in device.ts:780

getRemoteUser

getRemoteUser(): Promise<RemoteUser | undefined>
Returns Promise<RemoteUser | undefined>
- Defined in device.ts:832

getScopes

getScopes(): Promise<Scope[]>
Receive the scope parameters of a device

Returns Promise<Scope[]>
- Defined in device.ts:502

getServiceCapabilities

getServiceCapabilities(): Promise<DeviceServiceCapabilities>
Returns the capabilities of the device service. The result is returned in a typed answer

Returns Promise<DeviceServiceCapabilities>
- Defined in device.ts:533

getServices

getServices(__namedParameters?: GetServices): Promise<GetServicesResponse>
Returns information about services of the device.
Parameters
- __namedParameters: GetServices = ...
Returns Promise<GetServicesResponse>
- Defined in device.ts:393

getStorageConfiguration

getStorageConfiguration(
__namedParameters: GetStorageConfiguration,
): Promise<any>
Parameters
- __namedParameters: GetStorageConfiguration
Returns Promise<any>
- Defined in device.ts:1266

getStorageConfigurations

getStorageConfigurations(): Promise<StorageConfiguration[]>
Returns Promise<StorageConfiguration[]>
- Defined in device.ts:1252

getSystemBackup

getSystemBackup(): Promise<BackupFile[]>
Returns Promise<BackupFile[]>
- Defined in device.ts:735

getSystemDateAndTime

getSystemDateAndTime(): Promise<SystemDateTimeExtended>
Returns Promise<SystemDateTimeExtended>
- Defined in device.ts:382

getSystemLog

getSystemLog(__namedParameters: GetSystemLog): Promise<any>
Parameters
- __namedParameters: GetSystemLog
Returns Promise<any>
- Defined in device.ts:741

getSystemSupportInformation

getSystemSupportInformation(): Promise<any>
Returns Promise<any>
- Defined in device.ts:748

getSystemUris

getSystemUris(): Promise<any>
Returns Promise<any>
- Defined in device.ts:1224

getUserRoles

getUserRoles(options?: GetUserRoles): Promise<any>
Parameters
- options: GetUserRoles = {}
Returns Promise<any>
- Defined in device.ts:808

getUsers

getUsers(): Promise<User[]>
Returns Promise<User[]>
- Defined in device.ts:845

getWsdlUrl

getWsdlUrl(): Promise<string>
Returns Promise<string>
- Defined in device.ts:868

getZeroConfiguration

getZeroConfiguration(): Promise<NetworkZeroConfiguration>
Returns Promise<NetworkZeroConfiguration>
- Defined in device.ts:990

loadCACertificates

loadCACertificates(__namedParameters: LoadCACertificates): Promise<void>
Parameters
- __namedParameters: LoadCACertificates
Returns Promise<void>
- Defined in device.ts:1130

loadCertificates

loadCertificates(__namedParameters: LoadCertificates): Promise<void>
Parameters
- __namedParameters: LoadCertificates
Returns Promise<void>
- Defined in device.ts:1092

loadCertificateWithPrivateKey

loadCertificateWithPrivateKey(
__namedParameters: LoadCertificateWithPrivateKey,
): Promise<void>
Parameters
- __namedParameters: LoadCertificateWithPrivateKey
Returns Promise<void>
- Defined in device.ts:1114

removeIPAddressFilter

removeIPAddressFilter(__namedParameters: RemoveIPAddressFilter): Promise<void>
Parameters
- __namedParameters: RemoveIPAddressFilter
Returns Promise<void>
- Defined in device.ts:1025

removeScopes

removeScopes(__namedParameters: RemoveScopes): Promise<string[] | undefined>
Parameters
- __namedParameters: RemoveScopes
Returns Promise<string[] | undefined>
- Defined in device.ts:760

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

restoreSystem

restoreSystem(__namedParameters: RestoreSystem): Promise<void>
Parameters
- __namedParameters: RestoreSystem
Returns Promise<void>
- Defined in device.ts:729

scanAvailableDot11Networks

scanAvailableDot11Networks(
__namedParameters: ScanAvailableDot11Networks,
): Promise<any>
Parameters
- __namedParameters: ScanAvailableDot11Networks
Returns Promise<any>
- Defined in device.ts:1214

sendAuxiliaryCommand

sendAuxiliaryCommand(__namedParameters: SendAuxiliaryCommand): Promise<any>
Parameters
- __namedParameters: SendAuxiliaryCommand
Returns Promise<any>
- Defined in device.ts:1195

setAccessPolicy

setAccessPolicy(__namedParameters: SetAccessPolicy): Promise<void>
Parameters
- __namedParameters: SetAccessPolicy
Returns Promise<void>
- Defined in device.ts:1038

setAuthFailureWarningConfiguration

setAuthFailureWarningConfiguration(
options: SetAuthFailureWarningConfiguration,
): Promise<void>
Parameters
- options: SetAuthFailureWarningConfiguration
Returns Promise<void>
- Defined in device.ts:924

setCertificatesStatus

setCertificatesStatus(__namedParameters: SetCertificatesStatus): Promise<void>
Parameters
- __namedParameters: SetCertificatesStatus
Returns Promise<void>
- Defined in device.ts:1066

setClientCertificateMode

setClientCertificateMode(
__namedParameters: SetClientCertificateMode,
): Promise<void>
Parameters
- __namedParameters: SetClientCertificateMode
Returns Promise<void>
- Defined in device.ts:1103

setDiscoveryMode

setDiscoveryMode(__namedParameters: SetDiscoveryMode): Promise<void>
Parameters
- __namedParameters: SetDiscoveryMode
Returns Promise<void>
- Defined in device.ts:774

setDNS

setDNS(options: SetDNS): Promise<DNSInformation>
Parameters
- options: SetDNS
Returns Promise<DNSInformation>
- Defined in device.ts:617

setDot1XConfiguration

setDot1XConfiguration(__namedParameters: SetDot1XConfiguration): Promise<void>
Parameters
- __namedParameters: SetDot1XConfiguration
Returns Promise<void>
- Defined in device.ts:1144

setDPAddresses

setDPAddresses(__namedParameters: SetDPAddresses): Promise<void>
Parameters
- __namedParameters: SetDPAddresses
Returns Promise<void>
- Defined in device.ts:797

setDynamicDNS

setDynamicDNS(options: SetDynamicDNS): Promise<void>
Parameters
- options: SetDynamicDNS
Returns Promise<void>
- Defined in device.ts:952

setGeoLocation

setGeoLocation(__namedParameters: SetGeoLocation): Promise<void>
Parameters
- __namedParameters: SetGeoLocation
Returns Promise<void>
- Defined in device.ts:1292

setHashingAlgorithm

setHashingAlgorithm(__namedParameters: SetHashingAlgorithm): Promise<void>
Parameters
- __namedParameters: SetHashingAlgorithm
Returns Promise<void>
- Defined in device.ts:1246

setHostname

setHostname(__namedParameters: SetHostname): Promise<void>
Parameters
- __namedParameters: SetHostname
Returns Promise<void>
- Defined in device.ts:934

setHostnameFromDHCP

setHostnameFromDHCP(__namedParameters: SetHostnameFromDHCP): Promise<boolean>
Parameters
- __namedParameters: SetHostnameFromDHCP
Returns Promise<boolean>
- Defined in device.ts:940

setIPAddressFilter

setIPAddressFilter(__namedParameters: SetIPAddressFilter): Promise<void>
Parameters
- __namedParameters: SetIPAddressFilter
Returns Promise<void>
- Defined in device.ts:1009

setNetworkDefaultGateway

setNetworkDefaultGateway(options: SetNetworkDefaultGateway): Promise<void>
Parameters
- options: SetNetworkDefaultGateway
Returns Promise<void>
- Defined in device.ts:981

setNetworkInterfaces

setNetworkInterfaces(
options: SetNetworkInterfaces,
): Promise<SetNetworkInterfacesResponse>
Set network interfaces information
Parameters
- options: SetNetworkInterfaces
Returns Promise<SetNetworkInterfacesResponse>
- Defined in device.ts:659

setNetworkProtocols

setNetworkProtocols(__namedParameters: SetNetworkProtocols): Promise<void>
Parameters
- __namedParameters: SetNetworkProtocols
Returns Promise<void>
- Defined in device.ts:967

setNTP

setNTP(options: SetNTP): Promise<NTPInformation>
Set the NTP settings on a device
Parameters
- options: SetNTP
Returns Promise<NTPInformation>
- Defined in device.ts:571

setPasswordComplexityConfiguration

setPasswordComplexityConfiguration(
options: SetPasswordComplexityConfiguration,
): Promise<void>
Parameters
- options: SetPasswordComplexityConfiguration
Returns Promise<void>
- Defined in device.ts:883

setPasswordHistoryConfiguration

setPasswordHistoryConfiguration(
options: SetPasswordHistoryConfiguration,
): Promise<void>
Parameters
- options: SetPasswordHistoryConfiguration
Returns Promise<void>
- Defined in device.ts:905

setRelayOutputSettings

setRelayOutputSettings(__namedParameters: SetRelayOutputSettings): Promise<void>
Parameters
- __namedParameters: SetRelayOutputSettings
Returns Promise<void>
- Defined in device.ts:1177

setRelayOutputState

setRelayOutputState(__namedParameters: SetRelayOutputState): Promise<void>
Parameters
- __namedParameters: SetRelayOutputState
Returns Promise<void>
- Defined in device.ts:1186

setRemoteDiscoveryMode

setRemoteDiscoveryMode(__namedParameters: SetRemoteDiscoveryMode): Promise<void>
Parameters
- __namedParameters: SetRemoteDiscoveryMode
Returns Promise<void>
- Defined in device.ts:785

setRemoteUser

setRemoteUser(__namedParameters: SetRemoteUser): Promise<void>
Parameters
- __namedParameters: SetRemoteUser
Returns Promise<void>
- Defined in device.ts:837

setScopes

setScopes(scopes: string[]): Promise<Scope[]>
Set the scope parameters of a device
Parameters
- scopes: string[]
  Array of scope's uris
Returns Promise<Scope[]>
- Defined in device.ts:517

setStorageConfiguration

setStorageConfiguration(
__namedParameters: SetStorageConfiguration,
): Promise<void>
Parameters
- __namedParameters: SetStorageConfiguration
Returns Promise<void>
- Defined in device.ts:1273

setSystemDateAndTime

setSystemDateAndTime(
options: SetSystemDateAndTimeExtended,
): Promise<SystemDateTimeExtended>
Parameters
- options: SetSystemDateAndTimeExtended
Returns Promise<SystemDateTimeExtended>
- Defined in device.ts:386

setSystemFactoryDefault

setSystemFactoryDefault(
__namedParameters: SetSystemFactoryDefault,
): Promise<void>
Parameters
- __namedParameters: SetSystemFactoryDefault
Returns Promise<void>
- Defined in device.ts:716

setUser

setUser(__namedParameters: SetUser): Promise<void>
Parameters
- __namedParameters: SetUser
Returns Promise<void>
- Defined in device.ts:862

setUserRole

setUserRole(__namedParameters: SetUserRole): Promise<void>
Parameters
- __namedParameters: SetUserRole
Returns Promise<void>
- Defined in device.ts:820

setZeroConfiguration

setZeroConfiguration(__namedParameters: SetZeroConfiguration): Promise<void>
Parameters
- __namedParameters: SetZeroConfiguration
Returns Promise<void>
- Defined in device.ts:995

startFirmwareUpgrade

startFirmwareUpgrade(): Promise<any>
Returns Promise<any>
- Defined in device.ts:1229

startSystemRestore

startSystemRestore(): Promise<any>
Returns Promise<any>
- Defined in device.ts:1241

systemReboot

systemReboot(): Promise<string>
This operation reboots the device

Returns Promise<string>
- Defined in device.ts:547

upgradeFirmware

upgradeFirmware(__namedParameters: UpgradeFirmware): Promise<any>
Parameters
- __namedParameters: UpgradeFirmware
Returns Promise<any>
- Defined in device.ts:1234

upgradeSystemFirmware

upgradeSystemFirmware(
__namedParameters: UpgradeSystemFirmware,
): Promise<string | undefined>
Parameters
- __namedParameters: UpgradeSystemFirmware
Returns Promise<string | undefined>
- Defined in device.ts:722