HMError Enum

Definition

Enumerates possible failures in Home Kit operations.

[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public enum HMError
type HMError = 
Inheritance
HMError
Attributes

Fields

Name Value Description
UnexpectedError -1

An unexpected error occurred..

AlreadyExists 1

The container already has the object and another cannot be added.

NotFound 2

The object was not found in the container.

InvalidParameter 3

A parameter was invalid.

AccessoryNotReachable 4

The accessory could not be reached.

ReadOnlyCharacteristic 5

The characteristic cannot be written to.

WriteOnlyCharacteristic 6

The characteristic cannot be read.

NotificationNotSupported 7

The notification could not be enabled because it is not supported.

OperationTimedOut 8

The operation timed out.

AccessoryPoweredOff 9

The accessory was turned off.

AccessDenied 10

Access to a resource was denied.

ObjectAssociatedToAnotherHome 11

The object could not be associated because it was already associated with another home.

ObjectNotAssociatedToAnyHome 12

The operation could not be performed because the object was not associated with any home.

ObjectAlreadyAssociatedToHome 13

The object could not be associated because it was already associated with the home.

AccessoryIsBusy 14

The accessory was busy.

OperationInProgress 15

Another operation was in progress.

AccessoryOutOfResources 16

The accessory was out of resources.

InsufficientPrivileges 17

The user lacked the privilege to perform the operation.

AccessoryPairingFailed 18

The accessory could not be paired.

InvalidDataFormatSpecified 19

An invalid data format was specified.

NilParameter 20

A parameter that must not be null was supplied as null.

UnconfiguredParameter 21

The supplied parameter was not configured.

InvalidClass 22

An invalid abstract base class was used.

OperationCancelled 23

The operation was canceled.

RoomForHomeCannotBeInZone 24

The room that specifies the entire home could not be added to a zone within the home.

NoActionsInActionSet 25

An operation tried to execute an empty action set.

NoRegisteredActionSets 26

An operation tried to activate a trigger that had no action sets.

MissingParameter 27

A required parameter was missing.

FireDateInPast 28

The date the action was to be fired was in the past.

RoomForHomeCannotBeUpdated 29

An attempt was made to update the room for the entire home.

ActionInAnotherActionSet 30

The action was already in another action set and could not be added.

ObjectWithSimilarNameExistsInHome 31

The object could not be associated because another existing object has a similar name.

HomeWithSimilarNameExists 32

A home with a similar name already exists.

RenameWithSimilarName 33

An attempt was made to rename an object, but the new name was too similar to an existing object.

CannotRemoveNonBridgeAccessory 34

The accessory could not be removed because it is bridged.

NameContainsProhibitedCharacters 35

The supplied name contains prohibited characters.

NameDoesNotStartWithValidCharacters 36

The supplied name started with invalid characters.

UserIDNotEmailAddress 37

The supplied user ID was not an email address.

UserDeclinedAddingUser 38

A user declined to add the user.

UserDeclinedRemovingUser 39

The user declined to remove a user.

UserDeclinedInvite 40

A user declined an invitation from the user.

UserManagementFailed 41

An unspecified user management error occurred.

RecurrenceTooSmall 42

The recurrence length was too small.

InvalidValueType 43

Data of an incorrect type were provided.

ValueLowerThanMinimum 44

A value did not meet its required minimum.

ValueHigherThanMaximum 45

A value exceeded its allowed maximum.

StringLongerThanMaximum 46

The maximum string length was exceeded.

HomeAccessNotAuthorized 47

Home access was not authorized.

OperationNotSupported 48

The operation is not supported.

MaximumObjectLimitReached 49

The maximum number of objects have already been created or stored.

AccessorySentInvalidResponse 50

The accessory's response was invalid.

StringShorterThanMinimum 51

The minimum string length was not met.

GenericError 52

An unspecified error occurred.

SecurityFailure 53

There was a security failure.

CommunicationFailure 54

There was a communication error.

MessageAuthenticationFailed 55

The message could not be authenticated.

InvalidMessageSize 56

The message size was invalid.

AccessoryDiscoveryFailed 57

A failure occurred while attempting to discover an accessory.

ClientRequestError 58

The was a client request error.

AccessoryResponseError 59

The accessory response indicated an error.

NameDoesNotEndWithValidCharacters 60

The supplied name ended with invalid characters.

AccessoryIsBlocked 61

The accessory was blocked.

InvalidAssociatedServiceType 62

The associated service type was invalid.

ActionSetExecutionFailed 63

The action set failed to execute.

ActionSetExecutionPartialSuccess 64

The action set partially succeeded.

ActionSetExecutionInProgress 65

The action set was already in progress.

AccessoryOutOfCompliance 66

The accessory was out of compliance.

DataResetFailure 67

Data resetting failed.

NotificationAlreadyEnabled 68

The notification could not be enabled because it already was enabled.

RecurrenceMustBeOnSpecifiedBoundaries 69

The recurrence was required to be within the specified boundaries, and it was not.

DateMustBeOnSpecifiedBoundaries 70

The date was required to be within specified boundaries, and it was not.

CannotActivateTriggerTooFarInFuture 71

The trigger could not be activated because it takes place too far into the future.

RecurrenceTooLarge 72

The recurrence length was too large.

ReadWritePartialSuccess 73

The read or write partially succeeded.

ReadWriteFailure 74

The read or write failed.

NotSignedIntoiCloud 75

The user or application is not signed in to iCloud.

KeychainSyncNotEnabled 76

Keychain synchronization was not enabled.

CloudDataSyncInProgress 77

Data was synchronizing.

NetworkUnavailable 78

The network was unavailable.

AddAccessoryFailed 79

The accessory could not be added.

MissingEntitlement 80

An entitlement was missing.

CannotUnblockNonBridgeAccessory 81

An accessory, accessed via a bridge, cannot be unblocked.

DeviceLocked 82

The device is locked.

CannotRemoveBuiltinActionSet 83

The user attempted to remove a non-deletable HMActionSet.

LocationForHomeDisabled 84

The user has not made their home's location available.

NotAuthorizedForLocationServices 85

The user has not explicitly allowed location services.

ReferToUserManual 86

The error should be diagnosed using the user manual.

InvalidOrMissingAuthorizationData 87

Authorization is required.

BridgedAccessoryNotReachable 88

The accessory, expected to be reachable via a bridge, is not reachable.

NotAuthorizedForMicrophoneAccess 89

The user has not explicitly allowed access to the device microphone.

IncompatibleNetwork 90

The network was not compatible.

NoHomeHub 91

No compatible hub could be found.

IncompatibleHomeHub 92

The hub was not compatible.

IncompatibleAccessory 93

The accessory could not be added because it was not compatible with HomeKit.

Applies to