ActivityService Class Reference

#import <ActivityService.h>

Inheritance diagram for ActivityService:

Class Methods
(HttpResponse *)	+ getActivitesWithToken:
(HttpResponse *)	+ getActivityWithToken:andActivityId:
(HttpResponse *)	+ createAddContactsActivityWithToken:andContacts:
(HttpResponse *)	+ addClearListActivityWithToken:andLists:
(HttpResponse *)	+ addExportContactsActivityWithToken:andExportContacts:
(HttpResponse *)	+ addRemoveContactsFromListsActivityWithToken:emailAddresses:andLists:
(HttpResponse *)	+ addContactsMultipartWithToken:withFile:toLists:
(HttpResponse *)	+ removeContactsMultipartWithToken:withFile:fromLists:
(HttpResponse *)	+ getStatusReportForLast50Activites:
(HttpResponse *)	+ getActivityWithToken:status:andType:

Detailed Description

Performs all actions pertaining to scheduling Constant Contact Activities

Method Documentation

+ (HttpResponse *) addClearListActivityWithToken:		(NSString *)	accessToken
andLists:		(NSArray *)	lists

Create a Clear Lists Activity

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSArray	*clearLists - Array of list id's to be cleared

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) addContactsMultipartWithToken:		(NSString *)	accessToken
withFile:		(NSString *)	file
toLists:		(NSString *)	lists

Create a add Contacts Activity using file information

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*fileName - the file path that will be looked up for the file
NSString	*lists - the list in which the contacts will be added,list elements must be separated by commas

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) addExportContactsActivityWithToken:		(NSString *)	accessToken
andExportContacts:		(ExportContacts *)	exportContacts

Create an Export Contacts Activity

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
ExportContacts	*exportContacts - the contacts that need exported

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) addRemoveContactsFromListsActivityWithToken:		(NSString *)	accessToken
emailAddresses:		(NSArray *)	emailAddresses
andLists:		(NSArray *)	lists

Create a Remove Contacts From Lists Activity

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSArray	*emailAddressed - the array of email addresses to specify which contacts will be removed
NSArray	*lists - the list from which to remove the contacts

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) createAddContactsActivityWithToken:		(NSString *)	accessToken
andContacts:		(AddContacts *)	addContacts

Create an Add Contacts Activity

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
AddContacts	*addContact - the contacts that will be added with the activity

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) getActivitesWithToken:

(NSString *)

accessToken

Get an array of activities

Parameters

NSString

*accessToken - Constant Contact OAuth2 access token

Returns

HttpResponse * - response containing either errors or data with a Array of all ActivitySummaryReports

+ (HttpResponse *) getActivityWithToken:		(NSString *)	accessToken
andActivityId:		(NSString *)	activityId

Get an specific activity

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*activityId - Activity id

Returns

HttpResponse * - response containing either errors or data with the specific Activity referenced by the parameter id

+ (HttpResponse *) getActivityWithToken:		(NSString *)	accessToken
status:		(NSString *)	status
andType:		(NSString *)	type

Retrieves a detailed activity based on the parameters sent

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*status - the status filter of the activity
NSString	*type - the type filter of the activity

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) getStatusReportForLast50Activites:

(NSString *)

accessToken

Retrieves the last 50 activites reports

Parameters

NSString

*accessToken - Constant Contact OAuth2 access token

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

+ (HttpResponse *) removeContactsMultipartWithToken:		(NSString *)	accessToken
withFile:		(NSString *)	file
fromLists:		(NSString *)	lists

Create a remove Contacts Activity using file information

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*fileName - the file path that will be looked up for the file
NSString	*lists - the list in which the contacts will be removed, list elements must be separated by commas

Returns

HttpResponse * - response containing either errors or data with the specific Activity created

---

The documentation for this class was generated from the following files:

• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/ActivityService.h
• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/ActivityService.m