Failure message

Table of Contents

State

Failed message id

Declaration

getFailedMessageID()

Discussion

Capability identifier of the failed message

Example

val state:FailureMessage.State
assertTrue(state.failedMessageID.value == 0x0021)
// Failed message is the 'Trunk' capability

Failed message type

Declaration

getFailedMessageType()

Discussion

Message type of the failed message

Example

val state:FailureMessage.State
assertTrue(state.failedMessageType.value == 0x01)
// Failed message type is 'set'

Failure reason

Declaration

getFailureReason()

Example

val state:FailureMessage.State
assertTrue(state.failureReason.value == FailureMessage.FailureReason.UNAUTHORISED)
// Failure occured because of unauthorised state

Failure description

Declaration

getFailureDescription()

Discussion

Failure description

Example

val state:FailureMessage.State
assertTrue(state.failureDescription.value == "Try again")
// Failure description informs to 'Try again'

Failed property ids

Declaration

getFailedPropertyIDs()

Discussion

Array of failed property identifiers

Example

val state:FailureMessage.State
assertTrue(state.failedPropertyIDs.value == Bytes(byteArrayOf(0x01, 0x02)))
// Trunk's lock and position properties failed