ProtoOAErrorRes
* Generic response when an ERROR occurred.
Implements: IMessage<ProtoOAErrorRes>, IMessage, IEquatable<ProtoOAErrorRes>, IDeepCloneable<ProtoOAErrorRes>, IBufferMessage
Properties
public long CtidTraderAccountId { get; set; }
value = protoOAErrorRes.CtidTraderAccountId
protoOAErrorRes.CtidTraderAccountId = value
The unique identifier of the trader's account in cTrader platform.
public string Description { get; set; }
value = protoOAErrorRes.Description
protoOAErrorRes.Description = value
The error description.
public string ErrorCode { get; set; }
value = protoOAErrorRes.ErrorCode
protoOAErrorRes.ErrorCode = value
The name of the ProtoErrorCode or the other custom ErrorCodes (e.g. ProtoCHErrorCode).
public bool HasCtidTraderAccountId { get; }
value = protoOAErrorRes.HasCtidTraderAccountId
Gets whether the "ctidTraderAccountId" field is set
public bool HasDescription { get; }
value = protoOAErrorRes.HasDescription
Gets whether the "description" field is set
public bool HasErrorCode { get; }
value = protoOAErrorRes.HasErrorCode
Gets whether the "errorCode" field is set
public bool HasMaintenanceEndTimestamp { get; }
value = protoOAErrorRes.HasMaintenanceEndTimestamp
Gets whether the "maintenanceEndTimestamp" field is set
public bool HasPayloadType { get; }
value = protoOAErrorRes.HasPayloadType
Gets whether the "payloadType" field is set
public bool HasRetryAfter { get; }
value = protoOAErrorRes.HasRetryAfter
Gets whether the "retryAfter" field is set
public long MaintenanceEndTimestamp { get; set; }
value = protoOAErrorRes.MaintenanceEndTimestamp
protoOAErrorRes.MaintenanceEndTimestamp = value
The Unix time in seconds when the current maintenance session will be ended.
public ulong RetryAfter { get; set; }
value = protoOAErrorRes.RetryAfter
protoOAErrorRes.RetryAfter = value
When you hit rate limit with errorCode=BLOCKED_PAYLOAD_TYPE, this field will contain amount of seconds until related payload type will be unlocked.
Methods
public void ClearCtidTraderAccountId()
protoOAErrorRes.ClearCtidTraderAccountId()
Clears the value of the "ctidTraderAccountId" field
public void ClearDescription()
protoOAErrorRes.ClearDescription()
Clears the value of the "description" field
public void ClearErrorCode()
protoOAErrorRes.ClearErrorCode()
Clears the value of the "errorCode" field
public void ClearMaintenanceEndTimestamp()
protoOAErrorRes.ClearMaintenanceEndTimestamp()
Clears the value of the "maintenanceEndTimestamp" field
public void ClearPayloadType()
protoOAErrorRes.ClearPayloadType()
Clears the value of the "payloadType" field
public void ClearRetryAfter()
protoOAErrorRes.ClearRetryAfter()
Clears the value of the "retryAfter" field
Fields
public const int CtidTraderAccountIdFieldNumber
value = ProtoOAErrorRes.CtidTraderAccountIdFieldNumber
Field number for the "ctidTraderAccountId" field.
public const int DescriptionFieldNumber
value = ProtoOAErrorRes.DescriptionFieldNumber
Field number for the "description" field.
public const int ErrorCodeFieldNumber
value = ProtoOAErrorRes.ErrorCodeFieldNumber
Field number for the "errorCode" field.
public const int MaintenanceEndTimestampFieldNumber
value = ProtoOAErrorRes.MaintenanceEndTimestampFieldNumber
Field number for the "maintenanceEndTimestamp" field.
public const int PayloadTypeFieldNumber
value = ProtoOAErrorRes.PayloadTypeFieldNumber
Field number for the "payloadType" field.
public const int RetryAfterFieldNumber
value = ProtoOAErrorRes.RetryAfterFieldNumber
Field number for the "retryAfter" field.