DecryptedMessage

public enum DecryptedMessage
extension DecryptedMessage: Sendable

Represents the items a consumer might require after decrypting a message.

  • The decrypted message is a text message.

    Declaration

    Swift

    case text(
    /**
     * Decrypted text message.
     */plaintext: Data, 
    /**
     * The sender's `ClientId`.
     */senderClientId: ClientId, 
    /**
     * Identity claims present in the sender credential.
     */identity: WireIdentity
)

  • The decrypted message is a commit.

    Declaration

    Swift

    case commit(
    /**
     * False if processing this message caused the client to be removed from the group, i.e. due to a Remove
     * commit.
     */isActive: Bool, 
    /**
     * Contains buffered messages for next epoch which were received before the commit creating the epoch
     * because the DS did not fan them out in order.
     */bufferedMessages: [BufferedDecryptedMessage]?, 
    /**
     * Identity claims present in the sender credential.
     */identity: WireIdentity
)

  • The decrypted message is a proposal.

    Declaration

    Swift

    case proposal(
    /**
     * Commit delay in seconds.
     *
     * When set, clients must delay by this time interval before processing a commit. This reduces load on the
     * backend, which otherwise would receive epoch change notifications from all clients simultaneously.
     */delay: UInt64?, 
    /**
     * Identity claims present in the sender credential.
     */identity: WireIdentity
)