HMHome Class

Definition

An object representing a single residence. The highest level "container" in Home Kit.

[Foundation.Register("HMHome", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.TV(10, 0)]
public class HMHome : Foundation.NSObject
type HMHome = class
    inherit NSObject
Inheritance
HMHome
Attributes

Constructors

HMHome(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

HMHome(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Accessories

Gets an array that contains all of the accessories that have been added to the home.

ActionSets

Gets an array that contains all of the action sets that are in the home.

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

CurrentUser

The active HMUser.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate

An instance of the HomeKit.IHMHomeDelegate model class which acts as the class delegate.

Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HomeHubState

Gets a value that tells whether the hub is connected, disconnected, or unavailable.

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
Name

Gets the name of the home.

Primary

Gets a value that tells whether the receiver is the primary home for its manager.

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Rooms

Gets an array that contains all the rooms in the home.

Self (Inherited from NSObject)
ServiceGroups

Gets an array that contains all the service groups in the home.

Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Triggers

Gets an array that contains all the triggers in the home.

UniqueIdentifier

Identifies this HMHome.

UserFailedAccessoriesKey

Represents the value associated with the constant HMUserFailedAccessoriesKey

Users

Gets an array that contains all the users in the home.

WeakDelegate

An object that can respond to the delegate protocol for this type

Zone (Inherited from NSObject)
Zones

Gets an array that contains all the zones in the home.

Methods

AddAccessory(HMAccessory, Action<NSError>)

Adds accessory to the home and runs completion after it has been added.

AddAccessoryAsync(HMAccessory)

Adds accessory to the home and runs completion after it has been added.

AddActionSet(String, Action<HMActionSet,NSError>)

Adds an action set named actionSetName to the home and runs completion after it has been added.

AddActionSetAsync(String)

Adds an action set named actionSetName to the home and runs completion after it has been added.

AddAndSetupAccessories(Action<NSError>)

Displays a device selection user interface that allows the user to choose which devices to add and set up, and then runs a handler when the user exits the UI.

AddAndSetupAccessories(HMAccessorySetupPayload, Action<HMAccessory[],NSError>)

Scans for nearby accessories so the user can add them to the HomeKit object.

AddAndSetupAccessoriesAsync()

Displays a device selection user interface that allows the user to choose which devices to add and set up, and returning a task that represents the asynchronous AddAndSetupAccessories operation.

AddAndSetupAccessoriesAsync(HMAccessorySetupPayload)

Displays a device selection user interface that allows the user to choose which devices to add and set up, and returning a task that represents the asynchronous AddAndSetupAccessories operation.

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddRoom(String, Action<HMRoom,NSError>)

Adds a room named roomName to the home and runs completion after it has been added.

AddRoomAsync(String)

Adds a room named roomName to the home and runs completion after it has been added.

AddServiceGroup(String, Action<HMServiceGroup,NSError>)

Adds a service group named serviceGroupName to the home and runs completion after it has been added.

AddServiceGroupAsync(String)

Adds a service group named serviceGroupName to the home and runs completion after it has been added.

AddTrigger(HMTrigger, Action<NSError>)

Adds trigger to the home and runs completion after it has been added.

AddTriggerAsync(HMTrigger)

Adds trigger to the home and runs completion after it has been added.

AddUser(Action<HMUser,NSError>)

Developers should not use this deprecated method.

AddUserAsync()

Developers should not use this deprecated method.

AddZone(String, Action<HMZone,NSError>)

Adds a none that is named zoneName to the home and runs completionHandler after it has been added.

AddZoneAsync(String)

Adds a none that is named zoneName to the home and runs completionHandler after it has been added.

AssignAccessory(HMAccessory, HMRoom, Action<NSError>)

Assigns accessory to room and runs completion afer it has been assigned.

AssignAccessoryAsync(HMAccessory, HMRoom)

Assigns accessory to room and runs completion afer it has been assigned.

AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the HMHome object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExecuteActionSet(HMActionSet, Action<NSError>)

Runs the specified actionSet and runs completion afer it has finished.

ExecuteActionSetAsync(HMActionSet)

Runs the specified actionSet and runs completion afer it has finished.

ExposedBindings() (Inherited from NSObject)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetBuiltinActionSet(String)

Retrieve the built-in HMActionSet of the specified actionSeType.

GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetHomeAccessControl(HMUser)

Gets the HMHomeAccessControl for the specified user.

GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetRoomForEntireHome()

Returns the room object that represents the entire home.

GetServices(HMServiceType)

Returns services that accessories in the home provide that are of type serviceTypes.

GetServices(NSString[])
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
ManageUsers(Action<NSError>)

Displays a device selection user interface that allows the user manage users and their privileges, and then runs a handler when the user exits the UI.

ManageUsersAsync()

Displays a device selection user interface that allows the user manage users and their privileges, and then runs a handler when the user exits the UI.

MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveAccessory(HMAccessory, Action<NSError>)

Removes accessory from the home and runs completion afer it has finished.

RemoveAccessoryAsync(HMAccessory)

Removes accessory from the home and runs completion afer it has finished.

RemoveActionSet(HMActionSet, Action<NSError>)

Removes actionSet from the home and runs completion after it has finished.

RemoveActionSetAsync(HMActionSet)

Removes actionSet from the home and runs completion after it has finished.

RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveRoom(HMRoom, Action<NSError>)

Removes room from the home and runs completion after it has finished..

RemoveRoomAsync(HMRoom)

Removes room from the home and runs completion after it has finished..

RemoveServiceGroup(HMServiceGroup, Action<NSError>)

Removes group from the home and runs completion after it has finished.

RemoveServiceGroupAsync(HMServiceGroup)

Removes group from the home and runs completion after it has finished.

RemoveTrigger(HMTrigger, Action<NSError>)

Removes trigger from the home and runs completion after it has finished.

RemoveTriggerAsync(HMTrigger)

Removes trigger from the home and runs completion after it has finished.

RemoveUser(HMUser, Action<NSError>)

Removes the user who is specified by userID from the home and runs completion after it has finished.

RemoveUserAsync(HMUser)

Removes the user who is specified by userID from the home and runs completion after it has finished.

RemoveZone(HMZone, Action<NSError>)

Removes zone from the home and runs completion after it has finished.

RemoveZoneAsync(HMZone)

Removes zone from the home and runs completion after it has finished.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
UnblockAccessory(HMAccessory, Action<NSError>)

Unblocks accessory from the home and runs completion after it has finished.

UnblockAccessoryAsync(HMAccessory)

Unblocks accessory from the home and runs completion after it has finished.

UpdateName(String, Action<NSError>)

Changes the home name to name and runs completion after it has finished..

UpdateNameAsync(String)

Changes the home name to name and runs completion after it has finished..

ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Events

DidAddAccessory

Event raised by the object.

DidAddActionSet

Event raised by the object.

DidAddRoom

Event raised by the object.

DidAddRoomToZone

Event raised by the object.

DidAddService

Event raised by the object.

DidAddServiceGroup

Event raised by the object.

DidAddTrigger

Event raised by the object.

DidAddUser

Event raised by the object.

DidAddZone

Event raised by the object.

DidEncounterError

Event raised by the object.

DidRemoveAccessory

Event raised by the object.

DidRemoveActionSet

Event raised by the object.

DidRemoveRoom

Event raised by the object.

DidRemoveRoomFromZone

Event raised by the object.

DidRemoveService

Event raised by the object.

DidRemoveServiceGroup

Event raised by the object.

DidRemoveTrigger

Event raised by the object.

DidRemoveUser

Event raised by the object.

DidRemoveZone

Event raised by the object.

DidUnblockAccessory

Event raised by the object.

DidUpdateAccessControlForCurrentUser

Event raised by the object.

DidUpdateActionsForActionSet

Event raised by the object.

DidUpdateHomeHubState

Event raised by the object.

DidUpdateNameForActionSet

Event raised by the object.

DidUpdateNameForHome

Event raised by the object.

DidUpdateNameForRoom

Event raised by the object.

DidUpdateNameForServiceGroup

Event raised by the object.

DidUpdateNameForTrigger

Event raised by the object.

DidUpdateNameForZone

Event raised by the object.

DidUpdateRoom

Event raised by the object.

DidUpdateTrigger

Event raised by the object.

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also