Ctct\Services\ListService
Performs all actions pertaining to Constant Contact Lists
- Author: Constant Contact
Synopsis
class ListService
extends BaseService
{
- // Inherited members from BaseService
- public $restClient $restClient;
- protected $apiKey;
- // methods
- public Array getLists()
- public ContactList addList()
- public ContactList updateList()
- public ContactList deleteList()
- public ContactList getList()
- public ResultSet getContactsFromList()
- // 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
- addList() — Create a new Contact List
- deleteList() — Delete a Contact List
- getContactsFromList() — Get all contacts from an individual list
- getList() — Get an individual contact list
- getLists() — Get lists within an account
- updateList() — Update a Contact List
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()