Inheritance diagram for ListsCollection:

Class Methods
(HttpResponse *)	+ listsWithAccessToken:andModificationDate:

(HttpResponse *)	+ addList:withAccessToken:

(HttpResponse *)	+ listWithAccessToken:andListId:

(HttpResponse *)	+ getContactListMembershipWithAccessToken:fromList:withModificationDate:withAlimitOf:

(HttpResponse *)	+ updateListWithAccessToken:andListId:andList:

(BOOL)	+ deleteListWithAccessToken:andListId:errors:

Method Documentation

Function that adds a contact list to a user identified by a token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
ContactList*	list - the list to be added to the users list collection;

Returns: HttpResponse * - response containing either errors or data with the added ContactList in case of succes;

+ (BOOL) deleteListWithAccessToken:	(NSString*)	accessToken
andListId:	(NSString*)	listId
errors:	(NSArray**)	errors

Function that delete a contact list

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	listID - the id of the list that will be deleted;

Returns: HttpResponse * - response containing either errors or data with the updated ContactList;

+ (HttpResponse *) getContactListMembershipWithAccessToken:	(NSString*)	accessToken
fromList:	(NSString*)	listId
withModificationDate:	(NSDate *)	date
withAlimitOf:	(int)	limit

Function that gets contacts from the list specified by the user;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	listID - the id of the list you wish to obtain contacts from;
NSDate*	date - (otional) results will be filtered by the date if it is provided, adding a date will invalidate the limit parameter
int	limit - (optional) the number of elements to be returned, default 50;

Returns: HttpResponse * - response containing either errors or data with a array of Contacts from the list;

+ (HttpResponse *) listsWithAccessToken:	(NSString*)	accessToken
andModificationDate:	(NSDate *)	date

Function that gets a array of lists of a user identified by a token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSDate*	date = optional parameter used for filtering lists by modification date

Returns: HttpResponse * - response containing either errors or data with the array of contact lists belonging to the user authenthicated by the token;

+ (HttpResponse *) listWithAccessToken:	(NSString*)	accessToken
andListId:	(NSString*)	listId

Function that gets a specific contact list from the user identified by a token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	listID - the id of the list you wish to obtain;

Returns: HttpResponse * - response containing either errors or data with the ContactList who is identified by listID;

+ (HttpResponse *) updateListWithAccessToken:	(NSString*)	accessToken
andListId:	(NSString*)	listId
andList:	(ContactList *)	list

Function that updates a contact list

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	listID - the id of the list that will be updated;
ContactList	*list - the list to be updated;

Returns: HttpResponse * - response containing either errors or data with the updated ContactList;

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

/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Collections/ListsCollection.h
/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Collections/ListsCollection.m

Class Methods