Ctct\Services\ContactService
Performs all actions pertaining to Constant Contact Contacts
- Author: Constant Contact
Synopsis
class ContactService
extends BaseService
{
- // Inherited members from BaseService
- public $restClient $restClient;
- protected $apiKey;
- // methods
- public ResultSet getContacts()
- public Contact getContact()
- public Contact addContact()
- public boolean deleteContact()
- public boolean deleteContactFromLists()
- public boolean deleteContactFromList()
- public Contact updateContact()
- // Inherited methods from BaseService
- public void __construct()
- public string buildUrl()
- public RestClientInterface getRestClient()
- public void setRestClient()
- protected static array getHeaders()
Hierarchy
Extends
Members
protected
- $apiKey
—
string
ApiKey for the application
public
- $restClient
—
Ctct\Services\$restClient
RestClient Implementation to use for HTTP requests
Methods
public
- addContact() — Add a new contact to the Constant Contact account
- deleteContact() — Delete contact details for a specific contact
- deleteContactFromList() — Delete a contact from a specific contact list
- deleteContactFromLists() — Delete a contact from all contact lists
- getContact() — Get contact details for a specific contact
- getContacts() — Get a ResultSet of contacts
- updateContact() — Update contact details for a specific contact
Inherited from Ctct\Services\BaseService
protected
- getHeaders() — Helper function to return required headers for making an http request with constant contact
public
- buildUrl() — Build a url from the base url and query parameters array
- getRestClient() — Get the rest client being used by the service
- setRestClient()