Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
336 lines (335 sloc) 19 KB
<Type Name="HMPresenceEvent" FullName="HomeKit.HMPresenceEvent">
<TypeSignature Language="C#" Value="public class HMPresenceEvent : HomeKit.HMEvent, Foundation.INSMutableCopying, IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HMPresenceEvent extends HomeKit.HMEvent implements class Foundation.INSCopying, class Foundation.INSMutableCopying, class ObjCRuntime.INativeObject, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:HomeKit.HMPresenceEvent" />
<TypeSignature Language="F#" Value="type HMPresenceEvent = class&#xA; inherit HMEvent&#xA; interface INSCopying&#xA; interface INativeObject&#xA; interface IDisposable&#xA; interface INSMutableCopying" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>HomeKit.HMEvent</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Foundation.INSCopying</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Foundation.INSMutableCopying</InterfaceName>
</Interface>
<Interface>
<InterfaceName>ObjCRuntime.INativeObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>Foundation.Register("HMPresenceEvent", true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 4, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=T:HMKit.HMEvent&amp;scope=Xamarin" title="T:HMKit.HMEvent">T:HMKit.HMEvent</a></format> that represents a change in the physical presence or absence of users.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected HMPresenceEvent (Foundation.NSObjectFlag t);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Foundation.NSObjectFlag t) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMPresenceEvent.#ctor(Foundation.NSObjectFlag)" />
<MemberSignature Language="F#" Value="new HomeKit.HMPresenceEvent : Foundation.NSObjectFlag -&gt; HomeKit.HMPresenceEvent" Usage="new HomeKit.HMPresenceEvent t" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="t" Type="Foundation.NSObjectFlag" />
</Parameters>
<Docs>
<param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
<summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
<remarks>
<para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke the constructor that takes the NSObjectFlag.Empty they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.</para>
<para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
<para>It is the developer's responsibility to completely initialize the object if they chain up using the NSObjectFlag.Empty path.</para>
<para>In general, if the developer's constructor invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class. </para>
<para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// The NSObjectFlag merely allocates the object and registers the
// C# class with the Objective-C runtime if necessary, but no actual
// initXxx method is invoked, that is done later in the constructor
//
// This is taken from Xamarin.iOS's source code:
//
[Export ("initWithFrame:")]
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
{
// Invoke the init method now.
var initWithFrame = new Selector ("initWithFrame:").Handle;
if (IsDirectBinding)
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
else
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
}
]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal HMPresenceEvent (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMPresenceEvent.#ctor(System.IntPtr)" />
<MemberSignature Language="F#" Value="new HomeKit.HMPresenceEvent : nativeint -&gt; HomeKit.HMPresenceEvent" Usage="new HomeKit.HMPresenceEvent handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">Pointer (handle) to the unmanaged object.</param>
<summary>A constructor used when creating managed representations of unmanaged objects; Called by the runtime.</summary>
<remarks>
<para>This constructor is invoked by the runtime infrastructure (<see cref="M:ObjCRuntime.Runtime.GetNSObject(System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HMPresenceEvent (HomeKit.HMPresenceEventType presenceEventType, HomeKit.HMPresenceEventUserType presenceUserType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype HomeKit.HMPresenceEventType presenceEventType, valuetype HomeKit.HMPresenceEventUserType presenceUserType) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMPresenceEvent.#ctor(HomeKit.HMPresenceEventType,HomeKit.HMPresenceEventUserType)" />
<MemberSignature Language="F#" Value="new HomeKit.HMPresenceEvent : HomeKit.HMPresenceEventType * HomeKit.HMPresenceEventUserType -&gt; HomeKit.HMPresenceEvent" Usage="new HomeKit.HMPresenceEvent (presenceEventType, presenceUserType)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("initWithPresenceEventType:presenceUserType:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="presenceEventType" Type="HomeKit.HMPresenceEventType" />
<Parameter Name="presenceUserType" Type="HomeKit.HMPresenceEventUserType" />
</Parameters>
<Docs>
<param name="presenceEventType">To be added.</param>
<param name="presenceUserType">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassHandle">
<MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMPresenceEvent.ClassHandle" />
<MemberSignature Language="F#" Value="member this.ClassHandle : nativeint" Usage="HomeKit.HMPresenceEvent.ClassHandle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>The handle for this class.</summary>
<value>The pointer to the Objective-C class.</value>
<remarks>Each Xamarin.iOS class mirrors an unmanaged Objective-C class. This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public virtual Foundation.NSObject Copy (Foundation.NSZone zone);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Foundation.NSObject Copy(class Foundation.NSZone zone) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMPresenceEvent.Copy(Foundation.NSZone)" />
<MemberSignature Language="F#" Value="override this.Copy : Foundation.NSZone -&gt; Foundation.NSObject" Usage="hMPresenceEvent.Copy zone" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Foundation.INSCopying.Copy(Foundation.NSZone)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("copyWithZone:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Foundation.NSObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="zone" Type="Foundation.NSZone" />
</Parameters>
<Docs>
<param name="zone">Zone to use to allocate this object, or null to use the default zone.</param>
<summary>Performs a copy of the underlying Objective-C object.</summary>
<returns>This method performs a copy of the underlying Objective-C object state and returns a new instance of it. It does not actually try to replicate any managed state.</returns>
<remarks>Implementation of the INSCopyable interface.</remarks>
</Docs>
</Member>
<Member MemberName="KeyPath">
<MemberSignature Language="C#" Value="public static Foundation.NSString KeyPath { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Foundation.NSString KeyPath" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMPresenceEvent.KeyPath" />
<MemberSignature Language="F#" Value="member this.KeyPath : Foundation.NSString" Usage="HomeKit.HMPresenceEvent.KeyPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Field("HMPresenceKeyPath", "HomeKit")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Foundation.NSString</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MutableCopy">
<MemberSignature Language="C#" Value="public virtual Foundation.NSObject MutableCopy (Foundation.NSZone zone);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Foundation.NSObject MutableCopy(class Foundation.NSZone zone) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMPresenceEvent.MutableCopy(Foundation.NSZone)" />
<MemberSignature Language="F#" Value="override this.MutableCopy : Foundation.NSZone -&gt; Foundation.NSObject" Usage="hMPresenceEvent.MutableCopy zone" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Foundation.INSMutableCopying.MutableCopy(Foundation.NSZone)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("mutableCopyWithZone:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Foundation.NSObject</ReturnType>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.Release</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="zone" Type="Foundation.NSZone" />
</Parameters>
<Docs>
<param name="zone">Zone to use to allocate this object, or null to use the default zone.</param>
<summary>Performs a copy of the underlying Objective-C object.</summary>
<returns>This method performs a copy of the underlying Objective-C object state and returns a new instance of it. It does not actually try to replicate any managed state.</returns>
<remarks>Implementation of the INSCopyable interface.</remarks>
</Docs>
</Member>
<Member MemberName="PresenceEventType">
<MemberSignature Language="C#" Value="public virtual HomeKit.HMPresenceEventType PresenceEventType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype HomeKit.HMPresenceEventType PresenceEventType" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMPresenceEvent.PresenceEventType" />
<MemberSignature Language="F#" Value="member this.PresenceEventType : HomeKit.HMPresenceEventType with get, set" Usage="HomeKit.HMPresenceEvent.PresenceEventType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("presenceEventType")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: Foundation.NotImplemented</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>HomeKit.HMPresenceEventType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PresenceUserType">
<MemberSignature Language="C#" Value="public virtual HomeKit.HMPresenceEventUserType PresenceUserType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype HomeKit.HMPresenceEventUserType PresenceUserType" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMPresenceEvent.PresenceUserType" />
<MemberSignature Language="F#" Value="member this.PresenceUserType : HomeKit.HMPresenceEventUserType with get, set" Usage="HomeKit.HMPresenceEvent.PresenceUserType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("presenceUserType")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: Foundation.NotImplemented</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>HomeKit.HMPresenceEventUserType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.