<doc>
	<legacy_id></legacy_id>
	<name>mobileGetContactData</name>
	<type>function</type>

	<syntax>
		<example>mobileGetContactData <i>contactId</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Allows the user to read contact information from the contacts list.</summary>

	<examples>
<example>put mobileGetContactData (21) into tContactData</example>
<example>put mobileGetContactData (field &quot;InputData ID&quot;) into tResultData</example>
	</examples>

	<history>
		<changed version="6.0.0"></changed>
		<introduced version="5.5.1">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<command tag="mobilePick">mobilePick Command</command>
		<command tag="mobilePickDate">mobilePickDate Command</command>
		<command tag="mobilePickMedia">mobilePickMedia Command</command>
		<command tag="mobilePickContact">mobilePickContact Command</command>
		<command tag="mobileShowContact">mobileShowContact Command</command>
		<command tag="mobileCreateContact">mobileCreateContact Command</command>
		<command tag="mobileRemoveContact">mobileRemoveContact Command</command>
		<command tag="mobileAddContact">mobileAddContact Command</command>
		<command tag="mobileFindContact">mobileFindContact Command</command>
	</references>

	<description>
	<overview>Allows the user to extract contact data information from the contact list, based on a contact ID. The information returned is stored in a nested array repressentation with the following format:</overview>

		<parameters>

 <parameter>
     <name/>
    <description/>
    <options title="Person Information - The personal information of the contact is stored at the top level of the array and has the following keys:">
      <option>
        <item>firstname</item>
        <description>The first name.</description>
      </option>
      <option>
        <item>middlename</item>
        <description>The middle name.</description>
      </option>
      <option>
        <item>lastname</item>
        <description>The last name.</description>
      </option>
      <option>
        <item>alternatename</item>
        <description>The alternative name.</description>
      </option>
      <option>
        <item>nickname</item>
        <description>The nick name (iOS only).</description>
      </option>
      <option>
        <item>firstnamephonetic</item>
        <description>The phonetic transcription of the first name.</description>
      </option>
      <option>
        <item>middlenamephonetic</item>
        <description>The phonetic transcription of the middle name.</description>
      </option>
      <option>
        <item>lastnamephonetic</item>
        <description>The phonetic transcription of the last name.</description>
      </option>
      <option>
        <item>prefix</item>
        <description>The name prefix.</description>
      </option>
      <option>
        <item>suffix</item>
        <description>The name suffix.</description>
      </option>
      <option>
        <item>organization</item>
        <description>The name of the organization.</description>
      </option>
      <option>
        <item>jobtitle</item>
        <description>The job title (iOS only).</description>
      </option>
      <option>
        <item>department</item>
        <description>The name of the department (iOS only).</description>
      </option>
      <option>
        <item>message</item>
        <description>A person message (iOS only).</description>
      </option>
      <option>
        <item>note</item>
        <description>A person note.</description>
      </option>
    </options>
  </parameter>
  
  <parameter>
    <options title="E-Mail Addresses - The e-mail addresses of the contact are stored in integer indexed arrays starting at one under the key <b>email</b>. This allows any number of e-mail addresses to be stored against a particular category. There are three categories of e-mail address:">
      <option>
        <item>home</item>
        <description>The home e-mail address.</description>
      </option>
      <option>
        <item>work</item>
        <description>The work e-mail address.</description>
      </option>
      <option>
        <item>other</item>
        <description>An alternative e-mail address.</description>
      </option>
    </options>
  </parameter>

  <parameter>
    <options title="Telephone Numbers - The telephone numbers of the contact are stored in integer indexed arrays starting at one under the key <b>phone</b>. This allows any number of telephone numbers to be stored against a particular category. There are ten categories of phone numbers:">
      <option>
        <item>mobile</item>
        <description>The mobile telephone number.</description>
      </option>
      <option>
        <item>iphone</item>
        <description>The iPhone telephone number (iOS only).</description>
      </option>
      <option>
        <item>main</item>
        <description>The main telephone number (iOS only).</description>
      </option>
      <option>
        <item>home</item>
        <description>The home telephone number.</description>
      </option>
      <option>
        <item>work</item>
        <description>The work telephone number.</description>
      </option>
      <option>
        <item>homefax</item>
        <description>The home FAX number (iOS only).</description>
      </option>
      <option>
        <item>workfax</item>
        <description>The work FAX number (iOS only).</description>
      </option>
      <option>
        <item>otherfax</item>
        <description>The other FAX number (iOS >= 5.0 only).</description>
      </option>
      <option>
        <item>pager</item>
        <description>The pager number (iOS only).</description>
      </option>
      <option>
        <item>other</item>
        <description>An alternative telephone number.</description>
      </option>
    </options>
  </parameter>

  <parameter>
    <options title="Address - Addresses of the contact are stored as sub arrays under the key <b>address</b>. There are three categories of address:">
      <option>
        <item>home</item>
        <description>The home address.</description>
      </option>
      <option>
        <item>work</item>
        <description>The work address.</description>
      </option>
      <option>
        <item>other</item>
        <description>The other address.</description>
      </option>
    </options>
  </parameter>

  <parameter>
    <options title="Address Subkey - Each address category is an integer indexed array, starting at one under the key <b>address</b>. This allows any number of a addresses to be stored against a particular category:">
      <option>
        <item>street</item>
        <description>The address street.</description>
      </option>
      <option>
        <item>city</item>
        <description>The address city.</description>
      </option>
      <option>
        <item>state</item>
        <description>The address state.</description>
      </option>
      <option>
        <item>zip</item>
        <description>The address ZIP code.</description>
      </option>
      <option>
        <item>country</item>
        <description>The address country.</description>
      </option>
      <option>
        <item>countrycode</item>
        <description>The address country code (iOS only).</description>
      </option>
    </options>
  </parameter>

		</parameters>

	<value>A nested array of data entries for the specified user ID.<p></p><p>If no contact could be found, then no array is returned.</p><p>Use a test like: "if the result is an array" to determine if contact information was returned. "if the result is empty" will always be empty, even if data is returned in an array.</p></value>
	<comments>Use the <b>mobileGetContactData</b> function to read contact data from the contact list.</comments>
	</description>
</doc>