Class MTRErrorCode


  • public final class MTRErrorCode
    extends java.lang.Object
    MTRErrorDomain contains errors caused by data processing the framework itself is performing. These can be caused by invalid values provided to a framework API, failure to decode an incoming message, and so forth. This error domain also contains errors that are communicated via success responses from a server but mapped to an error on the client. Errors reported by the server side of a Matter interaction via the normal Matter error-reporting mechanisms use MTRInteractionErrorDomain instead. clang-format off
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static long BufferTooSmall
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long DNSSDUnauthorized
      MTRErrorCodeDNSSDUnauthorized means that the application is not authorized to perform DNS_SD lookups.
      static long FabricExists
      MTRErrorCodeFabricExists is returned when trying to commission a device into a fabric when it's already part of that fabric.
      static long GeneralError
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long IntegrityCheckFailed
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long InvalidArgument
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long InvalidIntegerValue
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long InvalidMessageLength
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long InvalidState
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long InvalidStringLength
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long SchemaMismatch
      MTRErrorCodeSchemaMismatch means that provided data did not match the expected schema.
      static long Timeout
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
      static long TLVDecodeFailed
      MTRErrorCodeTLVDecodeFailed means that the TLV being decoded was malformed in some way.
      static long UnknownSchema
      MTRErrorCodeUnknownSchema means the schema for the given cluster/attribute, cluster/event, or cluster/command combination is not known.
      static long WrongAddressType
      MTRErrorCodeGeneralError represents a generic Matter error with no further categorization.
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • GeneralError

        public static final long GeneralError
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • InvalidStringLength

        public static final long InvalidStringLength
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • InvalidIntegerValue

        public static final long InvalidIntegerValue
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • InvalidArgument

        public static final long InvalidArgument
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • InvalidMessageLength

        public static final long InvalidMessageLength
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • InvalidState

        public static final long InvalidState
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • WrongAddressType

        public static final long WrongAddressType
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • IntegrityCheckFailed

        public static final long IntegrityCheckFailed
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • Timeout

        public static final long Timeout
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • BufferTooSmall

        public static final long BufferTooSmall
        MTRErrorCodeGeneralError represents a generic Matter error with no further categorization. The userInfo will have a key named @"errorCode" whose value will be an integer representing the underlying Matter error code. These integer values should not be assumed to be stable across releases, but may be useful in logging and debugging.
        See Also:
        Constant Field Values
      • FabricExists

        public static final long FabricExists
        MTRErrorCodeFabricExists is returned when trying to commission a device into a fabric when it's already part of that fabric.
        See Also:
        Constant Field Values
      • UnknownSchema

        public static final long UnknownSchema
        MTRErrorCodeUnknownSchema means the schema for the given cluster/attribute, cluster/event, or cluster/command combination is not known. API-Since: 17.0
        See Also:
        Constant Field Values
      • SchemaMismatch

        public static final long SchemaMismatch
        MTRErrorCodeSchemaMismatch means that provided data did not match the expected schema. API-Since: 17.0
        See Also:
        Constant Field Values
      • TLVDecodeFailed

        public static final long TLVDecodeFailed
        MTRErrorCodeTLVDecodeFailed means that the TLV being decoded was malformed in some way. This can include things like lengths running past the end of the buffer, strings that are not actually UTF-8, and various other TLV-level failures. API-Since: 17.0
        See Also:
        Constant Field Values
      • DNSSDUnauthorized

        public static final long DNSSDUnauthorized
        MTRErrorCodeDNSSDUnauthorized means that the application is not authorized to perform DNS_SD lookups. This typically means missing entries for "_matter._tcp" (for operational lookup) and "_matterc._udp" (for commissionable lookup) under the NSBonjourServices key in the application's Info.plist. API-Since: 17.2
        See Also:
        Constant Field Values