Payload

struct Payload

Payload for the MessageCompleteEvent.

  • The messageID for the message being confirmed.

    Declaration

    Swift

    let messageID: Data?
  • The messageResponseId selected by the user. If there is no response before the duration of the message elapses, this field is null.

    Declaration

    Swift

    let responseID: UInt32?
  • A user-provided reply to a message. If there is no reply or the message did not have the responseRequired bit set, this field is null.

    Declaration

    Swift

    let reply: String?
  • A user-provided preference for the delivery of similar messages in the future. A null value indicates there is no change in user preference.

    Declaration

    Swift

    let futureMessagesPreference: Matter.MessagesTrait.FutureMessagePreferenceEnum?
  • A textual representation of this instance, suitable for debugging.

    Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

    struct Point: CustomDebugStringConvertible {
        let x: Int, y: Int
    
        var debugDescription: String {
            return "(\(x), \(y))"
        }
    }
    
    let p = Point(x: 21, y: 30)
    let s = String(reflecting: p)
    print(s)
    // Prints "(21, 30)"
    

    The conversion of p to a string in the assignment to s uses the Point type’s debugDescription property.

    Declaration

    Swift

    var debugDescription: String { get }