ConstantContact iOS SDK
Class Methods | List of all members
EmailCampaignService Class Reference

#import <EmailCampaignService.h>

Inheritance diagram for EmailCampaignService:

Class Methods

(HttpResponse *) + addCampaignWithToken:andCampaign:
 
(HttpResponse *) + getCampaignsWithToken:withALimitOf:
 
(HttpResponse *) + getCampaignsWithToken:status:withALimitOf:
 
(HttpResponse *) + getCampaignsWithToken:modificationDate:
 
(HttpResponse *) + getCampaignWithToken:andCampaignId:
 
(BOOL) + deleteCamapaignWithToken:andCamapaignId:errors:
 
(HttpResponse *) + updateCampaignWithToken:andEmailCampaign:
 

Detailed Description

Performs all actions pertaining to Constant Contact Campaigns

Method Documentation

+ (HttpResponse *) addCampaignWithToken: (NSString *)  accessToken
andCampaign: (EmailCampaign *)  campaign 

Create a new campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
Campaign*campaign - Campign to be created
Returns
HttpResponse * - response containing either errors or data with the Campaign that was created
+ (BOOL) deleteCamapaignWithToken: (NSString *)  accessToken
andCamapaignId: (NSString *)  campaignId
errors: (NSArray **)  errors 

Delete an email campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - Valid campaign id
Returns
boolean - if the deletion action was succcesful or not
+ (HttpResponse *) getCampaignsWithToken: (NSString *)  accessToken
modificationDate: (NSDate *)  date 

Get a set of campaigns

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSDate*date - the returned values are filtered by the sent modification date
Returns
HttpResponse * - response containing either errors or data with all the campaigns with the modification date
+ (HttpResponse *) getCampaignsWithToken: (NSString *)  accessToken
status: (NSString *)  status
withALimitOf: (int)  limit 

Get a set of campaigns

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*status - the returned values are filtered by the sent status value
intlimit - (optional) limits the number of results returned
Returns
HttpResponse * - response containing either errors or data with all the campaigns with the given status
+ (HttpResponse *) getCampaignsWithToken: (NSString *)  accessToken
withALimitOf: (int)  limit 

Get a set of campaigns

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
intlimit - (optional) limits the number of results returned
Returns
HttpResponse * - response containing either errors or data with all the campaigns of the user
+ (HttpResponse *) getCampaignWithToken: (NSString *)  accessToken
andCampaignId: (NSString *)  campaignId 

Get campaign details for a specific campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - Valid campaign id
Returns
HttpResponse * - response containing either errors or data with the specific Campaign required.
+ (HttpResponse *) updateCampaignWithToken: (NSString *)  accessToken
andEmailCampaign: (EmailCampaign *)  emailCampaign 

Update a specific email campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
Campaign*emailCampaign - Campaign to be updated
Returns
HttpResponse * - response containing either errors or data with the Campaign that was updated

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