Interface IGetStateServiceConfig

Extend common IServiceConfig with special parameters that only apply to the polling characteristics of this service.

interface IGetStateServiceConfig {
    basicAuth: boolean;
    controllerUrl: string;
    errorTolerance: number;
    password?: string;
    requestHeaders?: {
        [key: string]: string;
    };
    timeout: number;
    updateInterval: number;
    username?: string;
}

Hierarchy (view full)

Properties

basicAuth controllerUrl errorTolerance password? requestHeaders? timeout updateInterval username?

Properties

basicAuth

basicAuth: boolean

Enable HTTP basic auth.

controllerUrl

controllerUrl: string

Controller URL must be a valid URL string with leading protocol scheme (e.g. 'http://') and should point to the ProCon.IP HTTP root. This address will be combined with the endpoint (e.g. "/GetState.csv") to build the request address. A trailing slash will be added automatically if needed.

errorTolerance

errorTolerance: number

Define how many HTTP request errors to tolerate before raising an error.

Optionalpassword

password?: string

HTTP basic auth pass. Optional.

OptionalrequestHeaders

requestHeaders?: {
    [key: string]: string;
}

timeout

timeout: number

Define request timeout.

updateInterval

updateInterval: number

Interval [ms] between two webservice polling requests.

Optionalusername

username?: string

HTTP basic auth username. Optional.

Settings

Member Visibility

On This Page

Properties