Struct ApiCommandResponse
Represents an API command response.
Inherited Members
Namespace: SI.PIXL.Client.Structs.CommandResponse
Assembly: SI.PIXL.Client.dll
Syntax
public struct ApiCommandResponseConstructors
ApiCommandResponse(string, string, bool)
Initialises a new instance of the ApiCommandResponse struct.
Declaration
public ApiCommandResponse(string message, string code, bool isSuccess)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | A message detailing the response. |
| string | code | A code detailing the response. |
| bool | isSuccess | If this command resulted in success. |
Properties
Code
Get the code detailing the response.
Declaration
public string Code { get; }Property Value
| Type | Description |
|---|---|
| string |
IsSuccess
Get if this command resulted in success.
Declaration
public bool IsSuccess { get; }Property Value
| Type | Description |
|---|---|
| bool |
Message
Get a message detailing the response.
Declaration
public string Message { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ToString()
Returns the fully qualified type name of this instance.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | A string containing a fully qualified type name. |