View on GitHub
Install in Dash
DataElement Structure Reference
DataElement
public struct DataElement : CodableThe schema for the .data attribute in a message exchange payload
-
Representations of the message body (plain text, html)
Declaration
Swift
public var body: [ForstaPayloadV1.Body]? -
The control-message type (only relevant for messages of type
.control)Declaration
Swift
public var control: ForstaPayloadV1.ControlType? -
The timestamp of the most recently read message by the sender (only relevant for
.controlmessages of type.readMark)Declaration
Swift
public var readMark: Date? -
Information to update regarding this thread (only relevant for
.controlmessages of type.threadUpdate)Declaration
Swift
public var threadUpdate: ForstaPayloadV1.ThreadUpdate? -
Call version (only relevant in call-related
.controlmessages)Declaration
Swift
public var version: Int? -
Call members (only relevant for
.controlof type.callJoin)Declaration
Swift
public var members: [UUID]? -
Call originator (only relevant for
.controlof type.callJoin)Declaration
Swift
public var originator: UUID? -
Call ID (only relevant in call-related
.controlmessages)Declaration
Swift
public var callId: UUID? -
Call peer ID (only relevant in call-related
.controlmessages)Declaration
Swift
public var peerId: UUID? -
Stream types the peer expects to send (only relevant in call-related
.controlmessages)Declaration
Swift
public var sends: [ForstaPayloadV1.StreamType]? -
Stream types the peer expects to receive (only relevant in call-related
.controlmessages)Declaration
Swift
public var receives: [ForstaPayloadV1.StreamType]? -
ICE candidates (only relevant for
.controlmessages of type.callICECandidates)Declaration
Swift
public var icecandidates: [ForstaPayloadV1.IceCandidate]? -
SDP offer details (only relevant for
.controlmessages of type.callOffer)Declaration
Swift
public var offer: ForstaPayloadV1.SDP? -
SDP answer details (only relevant for
.controlmessages of type.callAcceptOffer)Declaration
Swift
public var answer: ForstaPayloadV1.SDP? -
The ephemeral public key provided by a new device for provisioning (only relevant for
.controlmessages of type.provisionRequest)Declaration
Swift
public var key: Data? -
Provisioning UUID, string-encoded in a form we will use as-is (only relevant for
.controlmessages of type.provisionRequest)Declaration
Swift
public var uuid: String? -
Devices for a sync request (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var devices: [UInt32]? -
Known contacts for a sync request (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var knownContacts: [ForstaPayloadV1.KnownContact]? -
Known messages for a sync request (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var knownMessages: [UUID]? -
Known threads for a sync request (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var knownThreads: [ForstaPayloadV1.KnownThread]? -
How long this is valid in milliseconds (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var ttl: UInt64? -
What type of sync request this is (only relevant for
.controlmessages of type.syncRequest)Declaration
Swift
public var type: ForstaPayloadV1.SyncRequestType? -
Undocumented
Declaration
Swift
public var messages: [ForstaPayloadV1.SyncMessage]?