FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | FIELD | ACTION | DETAIL: IMPORT | CONSTANT | FIELD | ACTION |
Constant summary | |
---|---|
string | CHANNEL := "StatusReport" The channel to subscribe to for receiving this event. |
Field summary | |
---|---|
string | serviceID Service ID to subscribe to - blank will target all services. |
string | object Object to request status of. |
string | subServiceID SubService ID to subscribe to. |
string | connection Connection to subscribe to. |
string | description Status description. |
sequence<string> | summaries A sequence of summary strings specifying information about the status of the specified object. |
boolean | available True if the object is "available" - the exact meaning is adapter specific; for example, connected, open for general orders, etc. |
dictionary<string, string> | extraParams Extra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "Username", "CloseTime", etc. |
Constant detail |
---|
string CHANNEL := "StatusReport"The channel to subscribe to for receiving this event.
Field detail |
---|
boolean availableTrue if the object is "available" - the exact meaning is adapter specific; for example, connected, open for general orders, etc.
string connectionConnection to subscribe to.
string descriptionStatus description.
dictionary<string, string> extraParamsExtra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "Username", "CloseTime", etc.
string objectObject to request status of.
string serviceIDService ID to subscribe to - blank will target all services.
string subServiceIDSubService ID to subscribe to.
sequence<string> summariesA sequence of summary strings specifying information about the status of the specified object.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | FIELD | ACTION | DETAIL: IMPORT | CONSTANT | FIELD | ACTION |