File

src/device/device-property-command-response.ts

Description

This is the server's response from having issued either a configure, allocate, or deallocate command. The response indicates the command that was received and whether or not it succeeeded. For configure, there is no response in the server if the configure fails, so the status is always true unless an exception is thrown.

Index

Properties

Properties

message
message: string
Type : string

Any extra messsages that wre returned

method
method: DevicePropertyCommandType
Type : DevicePropertyCommandType

The method attempted: configure, allocate, or deallocate

status
status: boolean
Type : boolean

The return status of the command

import { DevicePropertyCommandType } from './device-property-command-type';
/**
 * This is the server's response from having issued either a configure, allocate,
 * or deallocate command.  The response indicates the command that was received
 * and whether or not it succeeeded.  For configure, there is no response in the
 * server if the configure fails, so the status is always true unless an 
 * exception is thrown.
 */
export interface IDevicePropertyCommandResponse {
    /** The method attempted: configure, allocate, or deallocate */
    method: DevicePropertyCommandType;
    /** The return status of the command */
    status: boolean;
    /** Any extra messsages that wre returned */
    message: string;
}

results matching ""

    No results matching ""