| Server IP : 67.43.7.42 / Your IP : 216.73.216.61 Web Server : Apache System : Linux host.isabellascookies.com 2.6.32-754.35.1.el6.x86_64 #1 SMP Sat Nov 7 12:42:14 UTC 2020 x86_64 User : isabella ( 503) PHP Version : 5.5.38 Disable Function : exec,passthru,shell_exec,system MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/isabella/public_html/constant/docs/ |
Upload File : |
<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="ApiGen 2.8.0" /> <title>Class Ctct\Components\Contacts\Contact | Appconnect PHP SDK</title> <script type="text/javascript" src="resources/combined.js?554516056"></script> <script type="text/javascript" src="elementlist.js?1423846706"></script> <link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" /> </head> <body> <div id="left"> <div id="menu"> <a href="index.html" title="Overview"><span>Overview</span></a> <div id="groups"> <h3>Namespaces</h3> <ul> <li class="active"><a href="namespace-Ctct.html">Ctct<span></span></a> <ul> <li><a href="namespace-Ctct.Auth.html">Auth</a> </li> <li class="active"><a href="namespace-Ctct.Components.html">Components<span></span></a> <ul> <li><a href="namespace-Ctct.Components.Account.html">Account</a> </li> <li><a href="namespace-Ctct.Components.Activities.html">Activities</a> </li> <li class="active"><a href="namespace-Ctct.Components.Contacts.html">Contacts</a> </li> <li><a href="namespace-Ctct.Components.EmailMarketing.html">EmailMarketing</a> </li> <li><a href="namespace-Ctct.Components.Tracking.html">Tracking</a> </li> </ul></li> <li><a href="namespace-Ctct.Exceptions.html">Exceptions</a> </li> <li><a href="namespace-Ctct.Services.html">Services</a> </li> </ul></li> <li><a href="namespace-PHP.html">PHP</a> </li> </ul> </div> <hr /> <div id="elements"> <h3>Classes</h3> <ul> <li><a href="class-Ctct.Components.Contacts.Address.html">Address</a></li> <li class="active"><a href="class-Ctct.Components.Contacts.Contact.html">Contact</a></li> <li><a href="class-Ctct.Components.Contacts.ContactList.html">ContactList</a></li> <li><a href="class-Ctct.Components.Contacts.CustomField.html">CustomField</a></li> <li><a href="class-Ctct.Components.Contacts.EmailAddress.html">EmailAddress</a></li> <li><a href="class-Ctct.Components.Contacts.Note.html">Note</a></li> </ul> </div> </div> </div> <div id="splitter"></div> <div id="right"> <div id="rightInner"> <form id="search"> <input type="hidden" name="cx" value="" /> <input type="hidden" name="ie" value="UTF-8" /> <input type="text" name="q" class="text" /> <input type="submit" value="Search" /> </form> <div id="navigation"> <ul> <li> <a href="index.html" title="Overview"><span>Overview</span></a> </li> <li> <a href="namespace-Ctct.Components.Contacts.html" title="Summary of Ctct\Components\Contacts"><span>Namespace</span></a> </li> <li class="active"> <span>Class</span> </li> </ul> <ul> <li> <a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a> </li> </ul> <ul> </ul> </div> <div id="content" class="class"> <h1>Class Contact</h1> <div class="description"> <p>Represents a single Contact in Constant Contact</p> </div> <dl class="tree"> <dd style="padding-left:0px"> <a href="class-Ctct.Components.Component.html"><span>Ctct\Components\Component</span></a> </dd> <dd style="padding-left:30px"> <img src="resources/inherit.png" alt="Extended by" /> <b><span>Ctct\Components\Contacts\Contact</span></b> </dd> </dl> <div class="info"> <b>Namespace:</b> <a href="namespace-Ctct.html">Ctct</a>\<a href="namespace-Ctct.Components.html">Components</a>\<a href="namespace-Ctct.Components.Contacts.html">Contacts</a><br /> <b>Package:</b> Components\Contacts<br /> <b>Author:</b> Constant Contact<br /> <b>Located at</b> <a href="source-class-Ctct.Components.Contacts.Contact.html#7-236" title="Go to source code">Ctct/Components/Contacts/Contact.php</a><br /> </div> <table class="summary" id="methods"> <caption>Methods summary</caption> <tr data-order="create" id="_create"> <td class="attributes"><code> public static <code><a href="class-Ctct.Components.Contacts.Contact.html">Ctct\Components\Contacts\Contact</a></code> </code> </td> <td class="name"><div> <a class="anchor" href="#_create">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#137-185" title="Go to source code">create</a>( <span>array <var>$props</var></span> )</code> <div class="description short"> <p>Factory method to create a Contact object from an array</p> </div> <div class="description detailed hidden"> <p>Factory method to create a Contact object from an array</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$props</var></dt> <dd><code>array</code><br>$props - Associative array of initial properties to set</dd> </dl></div> <h4>Returns</h4> <div class="list"> <code><code><a href="class-Ctct.Components.Contacts.Contact.html">Ctct\Components\Contacts\Contact</a></code></code><br /> </div> </div> </div></td> </tr> <tr data-order="addList" id="_addList"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_addList">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#187-198" title="Go to source code">addList</a>( <span>mixed <var>$contactList</var></span> )</code> <div class="description short"> <p>Add a ContactList</p> </div> <div class="description detailed hidden"> <p>Add a ContactList</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$contactList</var></dt> <dd><code>mixed</code><br>$contactList - ContactList object or contact list id</dd> </dl></div> </div> </div></td> </tr> <tr data-order="addEmail" id="_addEmail"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_addEmail">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#200-211" title="Go to source code">addEmail</a>( <span>mixed <var>$emailAddress</var></span> )</code> <div class="description short"> <p>Add an EmailAddress</p> </div> <div class="description detailed hidden"> <p>Add an EmailAddress</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$emailAddress</var></dt> <dd><code>mixed</code><br>$emailAddress - EmailAddress object or email address</dd> </dl></div> </div> </div></td> </tr> <tr data-order="addCustomField" id="_addCustomField"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_addCustomField">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#213-220" title="Go to source code">addCustomField</a>( <span><code><a href="class-Ctct.Components.Contacts.CustomField.html">Ctct\Components\Contacts\CustomField</a></code> <var>$customField</var></span> )</code> <div class="description short"> <p>Add a custom field to the contact object</p> </div> <div class="description detailed hidden"> <p>Add a custom field to the contact object</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$customField</var></dt> <dd><code><code><a href="class-Ctct.Components.Contacts.CustomField.html">Ctct\Components\Contacts\CustomField</a></code></code><br>$customField - custom field to add to the contact</dd> </dl></div> </div> </div></td> </tr> <tr data-order="addAddress" id="_addAddress"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_addAddress">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#222-229" title="Go to source code">addAddress</a>( <span><code><a href="class-Ctct.Components.Contacts.Address.html">Ctct\Components\Contacts\Address</a></code> <var>$address</var></span> )</code> <div class="description short"> <p>Add an address</p> </div> <div class="description detailed hidden"> <p>Add an address</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$address</var></dt> <dd><code><code><a href="class-Ctct.Components.Contacts.Address.html">Ctct\Components\Contacts\Address</a></code></code><br>$address - Address to add</dd> </dl></div> </div> </div></td> </tr> <tr data-order="toJson" id="_toJson"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_toJson">#</a> <code><a href="source-class-Ctct.Components.Contacts.Contact.html#231-235" title="Go to source code">toJson</a>( )</code> <div class="description short"> </div> <div class="description detailed hidden"> </div> </div></td> </tr> </table> <table class="summary inherited"> <caption>Methods inherited from <a href="class-Ctct.Components.Component.html#methods">Ctct\Components\Component</a></caption> <tr> <td><code> <a href="class-Ctct.Components.Component.html#_getValue">getValue()</a> </code></td> </tr> </table> <table class="summary" id="properties"> <caption>Properties summary</caption> <tr data-order="id" id="$id"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#17-21" title="Go to source code"><var>$id</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$id" class="anchor">#</a> <div class="description short"> <p>Unique identifier for the contact</p> </div> <div class="description detailed hidden"> <p>Unique identifier for the contact</p> </div> </div></td> </tr> <tr data-order="status" id="$status"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#23-27" title="Go to source code"><var>$status</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$status" class="anchor">#</a> <div class="description short"> <p>Status of the contact, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"</p> </div> <div class="description detailed hidden"> <p>Status of the contact, must be one of "ACTIVE", "UNCONFIRMED", "OPTOUT", "REMOVED", "NON_SUBSCRIBER", "VISITOR"</p> </div> </div></td> </tr> <tr data-order="first_name" id="$first_name"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#29-33" title="Go to source code"><var>$first_name</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$first_name" class="anchor">#</a> <div class="description short"> <p>First name of the contact</p> </div> <div class="description detailed hidden"> <p>First name of the contact</p> </div> </div></td> </tr> <tr data-order="middle_name" id="$middle_name"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#35-39" title="Go to source code"><var>$middle_name</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$middle_name" class="anchor">#</a> <div class="description short"> <p>Middle name of the contact</p> </div> <div class="description detailed hidden"> <p>Middle name of the contact</p> </div> </div></td> </tr> <tr data-order="last_name" id="$last_name"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#41-45" title="Go to source code"><var>$last_name</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$last_name" class="anchor">#</a> <div class="description short"> <p>Last name of the contact</p> </div> <div class="description detailed hidden"> <p>Last name of the contact</p> </div> </div></td> </tr> <tr data-order="confirmed" id="$confirmed"> <td class="attributes"><code> public boolean </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#47-51" title="Go to source code"><var>$confirmed</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$confirmed" class="anchor">#</a> <div class="description short"> <p>Whether or not the contact is confirmed</p> </div> <div class="description detailed hidden"> <p>Whether or not the contact is confirmed</p> </div> </div></td> </tr> <tr data-order="source" id="$source"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#53-57" title="Go to source code"><var>$source</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$source" class="anchor">#</a> <div class="description short"> <p>Contact source information</p> </div> <div class="description detailed hidden"> <p>Contact source information</p> </div> </div></td> </tr> <tr data-order="email_addresses" id="$email_addresses"> <td class="attributes"><code> public array </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#59-63" title="Go to source code"><var>$email_addresses</var></a> </td> <td class="value"><code><span class="php-keyword1">array</span>()</code></td> <td class="description"><div> <a href="#$email_addresses" class="anchor">#</a> <div class="description short"> <p>Array of email addresses associated with this contact</p> </div> <div class="description detailed hidden"> <p>Array of email addresses associated with this contact</p> </div> </div></td> </tr> <tr data-order="prefix_name" id="$prefix_name"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#65-69" title="Go to source code"><var>$prefix_name</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$prefix_name" class="anchor">#</a> <div class="description short"> <p>The prefix name of the contact</p> </div> <div class="description detailed hidden"> <p>The prefix name of the contact</p> </div> </div></td> </tr> <tr data-order="job_title" id="$job_title"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#71-75" title="Go to source code"><var>$job_title</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$job_title" class="anchor">#</a> <div class="description short"> <p>The job title of the contact</p> </div> <div class="description detailed hidden"> <p>The job title of the contact</p> </div> </div></td> </tr> <tr data-order="addresses" id="$addresses"> <td class="attributes"><code> public array </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#77-81" title="Go to source code"><var>$addresses</var></a> </td> <td class="value"><code><span class="php-keyword1">array</span>()</code></td> <td class="description"><div> <a href="#$addresses" class="anchor">#</a> <div class="description short"> <p>Array of addresses associated with this contact</p> </div> <div class="description detailed hidden"> <p>Array of addresses associated with this contact</p> </div> </div></td> </tr> <tr data-order="notes" id="$notes"> <td class="attributes"><code> public array </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#83-87" title="Go to source code"><var>$notes</var></a> </td> <td class="value"><code><span class="php-keyword1">array</span>()</code></td> <td class="description"><div> <a href="#$notes" class="anchor">#</a> <div class="description short"> <p>Array of notes associated with this contact</p> </div> <div class="description detailed hidden"> <p>Array of notes associated with this contact</p> </div> </div></td> </tr> <tr data-order="company_name" id="$company_name"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#89-93" title="Go to source code"><var>$company_name</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$company_name" class="anchor">#</a> <div class="description short"> <p>Company name this contact works for</p> </div> <div class="description detailed hidden"> <p>Company name this contact works for</p> </div> </div></td> </tr> <tr data-order="home_phone" id="$home_phone"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#95-99" title="Go to source code"><var>$home_phone</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$home_phone" class="anchor">#</a> <div class="description short"> <p>Contact's home phone number</p> </div> <div class="description detailed hidden"> <p>Contact's home phone number</p> </div> </div></td> </tr> <tr data-order="work_phone" id="$work_phone"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#101-105" title="Go to source code"><var>$work_phone</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$work_phone" class="anchor">#</a> <div class="description short"> <p>Contact's work phone number</p> </div> <div class="description detailed hidden"> <p>Contact's work phone number</p> </div> </div></td> </tr> <tr data-order="cell_phone" id="$cell_phone"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#107-111" title="Go to source code"><var>$cell_phone</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$cell_phone" class="anchor">#</a> <div class="description short"> <p>Contact's cell phone number</p> </div> <div class="description detailed hidden"> <p>Contact's cell phone number</p> </div> </div></td> </tr> <tr data-order="fax" id="$fax"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#113-117" title="Go to source code"><var>$fax</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$fax" class="anchor">#</a> <div class="description short"> <p>Contact's fax number</p> </div> <div class="description detailed hidden"> <p>Contact's fax number</p> </div> </div></td> </tr> <tr data-order="custom_fields" id="$custom_fields"> <td class="attributes"><code> public array </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#119-123" title="Go to source code"><var>$custom_fields</var></a> </td> <td class="value"><code><span class="php-keyword1">array</span>()</code></td> <td class="description"><div> <a href="#$custom_fields" class="anchor">#</a> <div class="description short"> <p>Array of custom fields associated with this contact</p> </div> <div class="description detailed hidden"> <p>Array of custom fields associated with this contact</p> </div> </div></td> </tr> <tr data-order="lists" id="$lists"> <td class="attributes"><code> public array </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#125-129" title="Go to source code"><var>$lists</var></a> </td> <td class="value"><code><span class="php-keyword1">array</span>()</code></td> <td class="description"><div> <a href="#$lists" class="anchor">#</a> <div class="description short"> <p>Array of contact lists this contact belongs to</p> </div> <div class="description detailed hidden"> <p>Array of contact lists this contact belongs to</p> </div> </div></td> </tr> <tr data-order="source_details" id="$source_details"> <td class="attributes"><code> public string </code></td> <td class="name"> <a href="source-class-Ctct.Components.Contacts.Contact.html#131-135" title="Go to source code"><var>$source_details</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$source_details" class="anchor">#</a> <div class="description short"> <p>Contact source details</p> </div> <div class="description detailed hidden"> <p>Contact source details</p> </div> </div></td> </tr> </table> </div> <div id="footer"> Appconnect PHP SDK API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a> </div> </div> </div> </body> </html>