Payload

struct Payload

Payload for the LockOperationErrorEvent.

  • The type of the lock operation that failed.

    Declaration

    Swift

    let lockOperationType: Matter.DoorLockTrait.LockOperationTypeEnum?
  • The source of the lock operation.

    Declaration

    Swift

    let operationSource: Matter.DoorLockTrait.OperationSourceEnum?
  • The lock operation error triggered when the operation failed.

    Declaration

    Swift

    let operationError: Matter.DoorLockTrait.OperationErrorEnum?
  • The user who attempted the lock operation.

    Declaration

    Swift

    let userIndex: UInt16?
  • The fabric on which the lock operation was attempted.

    Declaration

    Swift

    let fabricIndex: UInt8?
  • The node that attempted the lock operation.

    Declaration

    Swift

    let sourceNode: UInt64?
  • The credentials used in attempting the lock operation.

    Declaration

    Swift

    let credentials: [Matter.DoorLockTrait.CredentialStruct]?
  • 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 }