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

#import <CampaignScheduleService.h>

Inheritance diagram for CampaignScheduleService:

Class Methods

(HttpResponse *) + addScheduleWithAccesToken:campaignId:andSchedule:
 
(HttpResponse *) + getSchedulesWithAccesToken:andCampaignId:
 
(HttpResponse *) + getScheduleWithAccesToken:campaignId:andScheduleId:
 
(HttpResponse *) + updateScheduleWithAccesToken:campaignId:andSchedule:
 
(BOOL) + deleteScheduleWithAccesToken:campaignId:andScheduleId:errors:
 
(HttpResponse *) + sendTestWithAccesToken:campaignId:andTestSend:
 

Detailed Description

Performs all actions pertaining to scheduling Constant Contact Campaigns

Method Documentation

+ (HttpResponse *) addScheduleWithAccesToken: (NSString *)  accessToken
campaignId: (NSString *)  campaignId
andSchedule: (Schedule *)  schedule 

Create a new schedule for a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - Campaign id to be scheduled
Schedule*schedule - Schedule to be created
Returns
HttpResponse * - response containing either errors or data with the schedule that was created
+ (BOOL) deleteScheduleWithAccesToken: (NSString *)  accessToken
campaignId: (NSString *)  campaignId
andScheduleId: (NSString *)  scheduleId
errors: (NSArray **)  errors 

Delete a specific schedule for a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - id of the Campaign to which we want to see the schedules
NSString*scheudleId - id of the Schedule we want to delete
Returns
bool - if the schedule was deleted or not
+ (HttpResponse *) getSchedulesWithAccesToken: (NSString *)  accessToken
andCampaignId: (NSString *)  campaignId 

Get a list of schedules for a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - id of the Campaign to which we want to see the schedules
Returns
HttpResponse * - response containing either errors or data with a Array with the scheduels of a specific campaign
+ (HttpResponse *) getScheduleWithAccesToken: (NSString *)  accessToken
campaignId: (NSString *)  campaignId
andScheduleId: (NSString *)  scheduleId 

Get a specific schedule for a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - id of the Campaign to which we want to see the schedules
NSString*scheudleId - id of the Schedule we want to see
Returns
HttpResponse * - response containing either errors or data with the specific Schedule we required if it exists
+ (HttpResponse *) sendTestWithAccesToken: (NSString *)  accessToken
campaignId: (NSString *)  campaignId
andTestSend: (TestSend *)  testSend 

Send a test send of a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - id of the Campaign to which we want to see the schedules
TestSend*testSend - Test send details
Returns
HttpResponse * - response containing either errors or data with the TestSend return
+ (HttpResponse *) updateScheduleWithAccesToken: (NSString *)  accessToken
campaignId: (NSString *)  campaignId
andSchedule: (Schedule *)  schedule 

Update a specific schedule for a campaign

Parameters
NSString*accessToken - Constant Contact OAuth2 access token
NSString*campaignId - id of the Campaign to which we want to see the schedules
Schedule*schedule - Schedule to update
Returns
HttpResponse * - response containing either errors or data with the updated Schedule

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