TKMCommandResult

public class TKMCommandResult : NSObject

The result of a command, returned by a Tapkey lock. Contains a result code and additional response data.

  • Represents a command’s result code. The result codes in this enum are sorted by priority.

    See more

    Declaration

    Swift

    @objc(TKMCommandResultCode)
public enum TKMCommandResultCode : Int

  • Undocumented

    See more

    Declaration

    Swift

    @objc(TKMUserCommandResult)
public class TKMUserCommandResult : NSObject

  • The result code of this command. The result code must be inspected in order to retrieve information on whether the command ran successfully or not.

    Declaration

    Swift

    public let code: TKMCommandResultCode

  • Reserved for internal use.

    Declaration

    Swift

    public let responseData: Any?

  • Reserved for internal use.

    Declaration

    Swift

    public let userCommandResults: [TKMUserCommandResult]

  • Whether the lock is bound or not.

    Declaration

    Swift

    public let isBound: Bool?

  • The time on the lock when the command was executed.

    Declaration

    Swift

    public let lockTime: Date?

  • The time on the Tapkey Trust Service when the command was executed.

    Declaration

    Swift

    public let serverTime: TKMServerClockTime?

  • The lock’s battery warning level. Interpretation of this value is specific to the type of lock. Consult the lock manufacturer for more information. Zero-values will usually indicate a good battery.

    Declaration

    Swift

    public let batteryWarnLevel: Int32?

  • Undocumented

    Declaration

    Swift

    public init(commandResultCode: TKMCommandResultCode, responseData: Any?, userCommandResults: [TKMUserCommandResult], isBound: Bool?, lockTime: Date?, serverTime: TKMServerClockTime?, batteryWarnLevel: Int32?)