ProtoMessage
* Base message that is used for all messages that are sent to/from Open API proxy of cTrader platform.
Implements: IMessage<ProtoMessage>, IMessage, IEquatable<ProtoMessage>, IDeepCloneable<ProtoMessage>, IBufferMessage
Properties
public string ClientMsgId { get; set; }
value = protoMessage.ClientMsgId
protoMessage.ClientMsgId = value
Request message id, assigned by the client that will be returned in the response.
public bool HasClientMsgId { get; }
value = protoMessage.HasClientMsgId
Gets whether the "clientMsgId" field is set
public bool HasPayload { get; }
value = protoMessage.HasPayload
Gets whether the "payload" field is set
public bool HasPayloadType { get; }
value = protoMessage.HasPayloadType
Gets whether the "payloadType" field is set
public ByteString Payload { get; set; }
value = protoMessage.Payload
protoMessage.Payload = value
Serialized protobuf message that corresponds to payloadType.
public uint PayloadType { get; set; }
value = protoMessage.PayloadType
protoMessage.PayloadType = value
Contains id of ProtoPayloadType or other custom PayloadTypes (e.g. ProtoOAPayloadType).
Methods
public void ClearClientMsgId()
protoMessage.ClearClientMsgId()
Clears the value of the "clientMsgId" field
public void ClearPayload()
protoMessage.ClearPayload()
Clears the value of the "payload" field
public void ClearPayloadType()
protoMessage.ClearPayloadType()
Clears the value of the "payloadType" field
Fields
public const int ClientMsgIdFieldNumber
value = ProtoMessage.ClientMsgIdFieldNumber
Field number for the "clientMsgId" field.
public const int PayloadFieldNumber
value = ProtoMessage.PayloadFieldNumber
Field number for the "payload" field.
public const int PayloadTypeFieldNumber
value = ProtoMessage.PayloadTypeFieldNumber
Field number for the "payloadType" field.