Interface DeviceAPI

Device API methods

See

Device API Docs

interface DeviceAPI {
    add(dme: CreateDMERequest): Promise<any>;
    delete(deviceId: string): Promise<void>;
    healthStatus(deviceId: string): Promise<DmeHealthStatus>;
    listDMEs(): Promise<DmeDetails[]>;
    listPresentationProfiles(): Promise<PresentationProfile[]>;
    listZoneDevices(): Promise<ZoneDevice[]>;
    rebootDME(deviceId: string): Promise<any>;
}

Hierarchy

API
- DeviceAPI

Index

Methods

add delete healthStatus listDMEs listPresentationProfiles listZoneDevices rebootDME

Methods

add

add(dme: CreateDMERequest): Promise<any>
Create a new DME in Rev
Parameters
- dme: CreateDMERequest
Returns Promise<any>
Inherited from API.add
- Defined in src/api/device.ts:46

delete

delete(deviceId: string): Promise<void>
Remove a DME from Rev
Parameters
- deviceId: string
Returns Promise<void>
Inherited from API.delete
- Defined in src/api/device.ts:62

healthStatus

healthStatus(deviceId: string): Promise<DmeHealthStatus>
Get details about the specified DME's health
Parameters
- deviceId: string
Returns Promise<DmeHealthStatus>
Inherited from API.healthStatus
- Defined in src/api/device.ts:54

listDMEs

listDMEs(): Promise<DmeDetails[]>
Get a list of all DMEs

Returns Promise<DmeDetails[]>
Inherited from API.listDMEs
- Defined in src/api/device.ts:22

listPresentationProfiles

listPresentationProfiles(): Promise<PresentationProfile[]>
Get a list of the Presentation Profiles defined in Rev

Returns Promise<PresentationProfile[]>
Inherited from API.listPresentationProfiles
- Defined in src/api/device.ts:38

listZoneDevices

listZoneDevices(): Promise<ZoneDevice[]>
Get a list of devices that can be used for Zoning configuration

Returns Promise<ZoneDevice[]>
Inherited from API.listZoneDevices
- Defined in src/api/device.ts:30

rebootDME

rebootDME(deviceId: string): Promise<any>
Have Rev send a reboot request to the specified DME
Parameters
- deviceId: string
Returns Promise<any>
Inherited from API.rebootDME
- Defined in src/api/device.ts:70