MethodResponse Class

JSON response for a method that doesn't return a value.

Definition

Namespace: ASCOM.Common.Alpaca
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class MethodResponse : Response
Inheritance
Object    ErrorResponse    Response    MethodResponse

Constructors

MethodResponse Create a new uninitialised instance
MethodResponse(UInt32, UInt32) Create a new instance initialised with client transaction ID and server transaction ID

Properties

ClientTransactionID Client's transaction ID (0 to 4294967295), as supplied by the client in the command request.
(Inherited from Response)
DriverException Optional field for Windows drivers to return an exception to the client application.
(Inherited from ErrorResponse)
ErrorMessage Empty string for a successful transaction, or a message describing the issue that was encountered. If an error message is returned, a non zero ErrorNumber must also be returned.
(Inherited from ErrorResponse)
ErrorNumber Zero for a successful transaction, or a non-zero integer(-2147483648 to 2147483647) if the device encountered an issue.Devices must use ASCOM reserved error numbers whenever appropriate so that clients can take informed actions. E.g.returning 0x401 (1025) to indicate that an invalid value was received.
(Inherited from ErrorResponse)
ServerTransactionID Server's transaction ID (0 to 4294967295), should be unique for each client transaction so that log messages on the client can be associated with logs on the device.
(Inherited from Response)

Version Information

.NET Standard

Supported in: 2.0

See Also