#import <ContactsCollection.h>

Inheritance diagram for ContactsCollection:

Class Methods
(HttpResponse *)	+ contactsWithAccessToken:withLimitOf:

(HttpResponse *)	+ contactWithAccessToken:andId:

(HttpResponse *)	+ contactsWithAccessToken:andEmail:withALimitOf:

(HttpResponse *)	+ contactsWithAccessToken:andStatus:withAlimitOf:

(HttpResponse *)	+ contactsWithAccessToken:andModifiedSince:

(HttpResponse *)	+ addContact:withAccessToken:actionByVisitor:

(BOOL)	+ deleteContactWithAccessToken:andContactId:errors:

(BOOL)	+ deleteContactFromListsWithAccessToken:andContactId:errors:

(BOOL)	+ deleteContactFromListWithAccessToken:andContactId:andListId:errors:

(HttpResponse *)	+ updateContact:withAccessToken:actionByVisitor:

Method Documentation

+ (HttpResponse *) addContact:	(Contact*)	contact
withAccessToken:	(NSString*)	accessToken
actionByVisitor:	(BOOL)	action

Function adds a new contact to the Constant Contact account belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
Contact*	contact - The contact that we want to add;

Returns: HttpResponse * - response containing either errors or data with Contact with the information related to the added contact if action was successful;

+ (HttpResponse *) contactsWithAccessToken:	(NSString*)	accessToken
andEmail:	(NSString*)	email
withALimitOf:	(int)	limit

Function gets the contacts with a specified email address, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	email - The e-mail address of the contacts that we want to get;
int	limit - positive value that specifyes the maximum number of contacts returned;

Returns: HttpResponse * - response containing either errors or data with a array containing all the Contacts that have the given e-mail address;

+ (HttpResponse *) contactsWithAccessToken:	(NSString*)	accessToken
andModifiedSince:	(NSDate *)	date

Function gets the contacts with a specified modification date, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSDate*	date - The modification date of the contacts that we want to get;

Returns: HttpResponse * - response containing either errors or data with a array containing all the Contacts that have the given date;

+ (HttpResponse *) contactsWithAccessToken:	(NSString*)	accessToken
andStatus:	(NSString *)	status
withAlimitOf:	(int)	limit

Function gets the contacts with a specified status, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
NSString*	status - The status of the contacts that we want to get;
int	limit - positive value that specifyes the maximum number of contacts returned;

Returns: HttpResponse * - response containing either errors or data with a array containing all the Contacts that have the given status;

+ (HttpResponse *) contactsWithAccessToken:	(NSString*)	accessToken
withLimitOf:	(int)	limit

Function gets all contacts belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
int	limit - Number of results to get

Returns: HttpResponse * - response containing either errors or data with a array of all contacts belonging to the user identified by the token;

+ (HttpResponse *) contactWithAccessToken:	(NSString*)	accessToken
andId:	(NSString*)	contactId

Function gets the contact details for a specific contact, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
int	contactId - The id of the contact that we want to get;
NSString*	limit - positive value that specifyes the maximum number of contacts returned;

Returns: HttpResponse * - response containing either errors or data with a Contact that has the information related to the contact with the given id;

+ (BOOL) deleteContactFromListsWithAccessToken:	(NSString*)	accessToken
andContactId:	(NSString*)	contactId
errors:	(NSArray**)	errors

Function deletes a contact from all contact lists belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
int	contactId - The id of the contact that we want to delete;

Returns: BOOL* - The function returns 1 or 0 depending on the success or failure of the delete action;

+ (BOOL) deleteContactFromListWithAccessToken:	(NSString*)	accessToken
andContactId:	(NSString*)	contactId
andListId:	(NSString*)	listId
errors:	(NSArray**)	errors

Function deletes the contact details for a specific contact, from a specific contact list, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
Contact*	contact - The contact that we want to add;
int	contactId - The id of the contact that we want to delete;
NSString*	listId - The id of the list from which we want to delete the contact;

Returns: BOOL* - The function returns 1 or 0 depending on the success or failure of the delete action;

+ (BOOL) deleteContactWithAccessToken:	(NSString*)	accessToken
andContactId:	(NSString*)	contactId
errors:	(NSArray**)	errors

Function deletes the contact details for a specific contact belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
Contact*	contact - The contact that we want to add;
int	contactId - The id of the contact that we want to delete;

Returns: BOOL* - The function returns 1 or 0 depending on the success or failure of the delete action;

+ (HttpResponse *) updateContact:	(Contact*)	contact
withAccessToken:	(NSString*)	accessToken
actionByVisitor:	(BOOL)	action

Function updates the contact details for a specific contact, belonging to the user identified by the token;

Parameters

NSString*	accessToken - Constant Contact OAuth2 access token, obtained after login;
Contact*	contact - The contact information that we want to update;

Returns: HttpResponse * - response containing either errors or data with a Contact with the information related to the updated contact if update is successful;

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

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

Class Methods

Method Documentation