ABRecord.xml

<Type Name="ABRecord" FullName="AddressBook.ABRecord">
  <TypeSignature Language="C#" Value="public abstract class ABRecord : IDisposable, ObjCRuntime.INativeObject" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ABRecord extends System.Object implements class ObjCRuntime.INativeObject, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:AddressBook.ABRecord" />
  <TypeSignature Language="F#" Value="type ABRecord = class&#xA;    interface INativeObject&#xA;    interface IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.iOS</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>ObjCRuntime.INativeObject</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 9, 0, ObjCRuntime.PlatformArchitecture.None, "Use the 'Contacts' API instead.")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
      Base type for
      <see cref="T:AddressBook.ABGroup" /> and
      <see cref="T:AddressBook.ABPerson" />.
    </summary>
    <remarks>
      <para>
        Supported operations:
      </para>
      <list type="bullet">
        <item>
          <term>
            Getting record information:
            <see cref="P:AddressBook.ABRecord.Id" />,
            <see cref="P:AddressBook.ABRecord.Type" />.
          </term>
        </item>
      </list>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:AddressBook.ABRecord.Dispose" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="aBRecord.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Releases the resources used by the ABRecord object.</summary>
        <remarks>
          <para>The Dispose method releases the resources used by the ABRecord class.</para>
          <para>Calling the Dispose method when the application is finished using the ABRecord ensures that all external resources used by this managed object are released as soon as possible.  Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at https://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:AddressBook.ABRecord.Dispose(System.Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="aBRecord.Dispose disposing" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
        </param>
        <summary>Releases the resources used by the ABRecord object.</summary>
        <remarks>
          <para>This Dispose method releases the resources used by the ABRecord class.</para>
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposing <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
          <para>Calling the Dispose method when the application is finished using the ABRecord ensures that all external resources used by this managed object are released as soon as possible.  Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.</para>
          <para>  For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at https://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="~ABRecord ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
      <MemberSignature Language="DocId" Value="M:AddressBook.ABRecord.Finalize" />
      <MemberSignature Language="F#" Value="override this.Finalize : unit -&gt; unit" Usage="aBRecord.Finalize " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Finalizer for the ABRecord object</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FromHandle">
      <MemberSignature Language="C#" Value="public static AddressBook.ABRecord FromHandle (IntPtr handle);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class AddressBook.ABRecord FromHandle(native int handle) cil managed" />
      <MemberSignature Language="DocId" Value="M:AddressBook.ABRecord.FromHandle(System.IntPtr)" />
      <MemberSignature Language="F#" Value="static member FromHandle : nativeint -&gt; AddressBook.ABRecord" Usage="AddressBook.ABRecord.FromHandle handle" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>AddressBook.ABRecord</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="handle" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="handle">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Handle">
      <MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
      <MemberSignature Language="DocId" Value="P:AddressBook.ABRecord.Handle" />
      <MemberSignature Language="F#" Value="member this.Handle : nativeint" Usage="AddressBook.ABRecord.Handle" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Handle (pointer) to the unmanaged object representation.</summary>
        <value>A pointer</value>
        <remarks>This IntPtr is a handle to the underlying unmanaged representation for this object.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Id">
      <MemberSignature Language="C#" Value="public int Id { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Id" />
      <MemberSignature Language="DocId" Value="P:AddressBook.ABRecord.Id" />
      <MemberSignature Language="F#" Value="member this.Id : int" Usage="AddressBook.ABRecord.Id" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the unique ID of the record.</summary>
        <value>
          A <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=System%20Int%2032&amp;scope=Xamarin" title="T:System.Int32">T:System.Int32</a></format> which is the unique ID of the record.
        </value>
        <remarks>
          <para>
            If the record hasn't been saved into the database, this is
            <see cref="F:AddressBook.ABRecord.InvalidRecordId" />.
          </para>
        </remarks>
        <altmember cref="M:AddressBook.ABAddressBook.Save" />
      </Docs>
    </Member>
    <Member MemberName="InvalidPropertyId">
      <MemberSignature Language="C#" Value="public const int InvalidPropertyId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidPropertyId = (-1)" />
      <MemberSignature Language="DocId" Value="F:AddressBook.ABRecord.InvalidPropertyId" />
      <MemberSignature Language="F#" Value="val mutable InvalidPropertyId : int" Usage="AddressBook.ABRecord.InvalidPropertyId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>
          An invalid value for a property id.
        </summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="InvalidRecordId">
      <MemberSignature Language="C#" Value="public const int InvalidRecordId = -1;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal int32 InvalidRecordId = (-1)" />
      <MemberSignature Language="DocId" Value="F:AddressBook.ABRecord.InvalidRecordId" />
      <MemberSignature Language="F#" Value="val mutable InvalidRecordId : int" Usage="AddressBook.ABRecord.InvalidRecordId" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>
          An invalid value for a record id.
        </summary>
        <remarks>
          <para>
            <see cref="P:AddressBook.ABRecord.Id" /> returns this
            value when the record hasn't been saved to the database.
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:AddressBook.ABRecord.ToString" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="aBRecord.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          Returns the composite name of the <see cref="T:AddressBook.ABRecord" />.
        </summary>
        <returns>
          A <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=System%20String&amp;scope=Xamarin" title="T:System.String">T:System.String</a></format> containing
          the composite name of the <see cref="T:AddressBook.ABRecord" />.
        </returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public AddressBook.ABRecordType Type { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype AddressBook.ABRecordType Type" />
      <MemberSignature Language="DocId" Value="P:AddressBook.ABRecord.Type" />
      <MemberSignature Language="F#" Value="member this.Type : AddressBook.ABRecordType" Usage="AddressBook.ABRecord.Type" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>AddressBook.ABRecordType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the type of the record.</summary>
        <value>
          A <see cref="T:AddressBook.ABRecordType" /> containing
          the type of the record.
        </value>
        <remarks>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>