CSAPI(Templates) Category Reference
Declared in | CSAPI+Templates.h |
Tasks
-
– getTemplateDetailsWithTemplateID:completionHandler:errorHandler:
Get all basic details for a specific template.
-
– createTemplateWithClientID:name:htmlURLURL:zipFileURL:completionHandler:errorHandler:
Create a new template for a client.
-
– updateTemplateWithTemplateID:name:htmlURLURL:zipFileURL:completionHandler:errorHandler:
Update an existing template for a client.
-
– deleteTemplateWithID:completionHandler:errorHandler:
Delete an existing template based on the template ID.
Instance Methods
createTemplateWithClientID:name:htmlURLURL:zipFileURL:completionHandler:errorHandler:
Create a new template for a client.
- (void)createTemplateWithClientID:(NSString *)clientID name:(NSString *)name htmlURLURL:(NSString *)htmlURLURL zipFileURL:(NSString *)zipFileURL completionHandler:(void ( ^ ) ( NSString *templateID ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler
Parameters
- clientID
The ID of the client for whom the template should be created
- name
Name for the template
- htmlURLURL
URL for the template HTML page
- zipFileURL
URL for the template zip file
- completionHandler
Completion callback, with the ID of the newly created template as the first and only argument
- errorHandler
Error callback
Discussion
http://www.campaignmonitor.com/api/templates/#creating_a_template
Declared In
CSAPI+Templates.h
deleteTemplateWithID:completionHandler:errorHandler:
Delete an existing template based on the template ID.
- (void)deleteTemplateWithID:(NSString *)templateID completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler
Parameters
- templateID
The ID of the template to be deleted
- completionHandler
Completion callback
- errorHandler
Error callback
Discussion
http://www.campaignmonitor.com/api/templates/#deleting_a_template
Declared In
CSAPI+Templates.h
getTemplateDetailsWithTemplateID:completionHandler:errorHandler:
Get all basic details for a specific template.
- (void)getTemplateDetailsWithTemplateID:(NSString *)templateID completionHandler:(void ( ^ ) ( CSTemplate *template ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler
Parameters
- templateID
The ID of the template to be retrieved
- completionHandler
Completion callback, with a
CSTemplate
object as the first and only argument
- errorHandler
Error callback
Discussion
http://www.campaignmonitor.com/api/templates/#getting_a_template
Declared In
CSAPI+Templates.h
updateTemplateWithTemplateID:name:htmlURLURL:zipFileURL:completionHandler:errorHandler:
Update an existing template for a client.
- (void)updateTemplateWithTemplateID:(NSString *)templateID name:(NSString *)name htmlURLURL:(NSString *)htmlURLURL zipFileURL:(NSString *)zipFileURL completionHandler:(void ( ^ ) ( void ))completionHandler errorHandler:(CSAPIErrorHandler)errorHandler
Parameters
- templateID
The ID of the template to be updated
- name
New name for the template
- htmlURLURL
URL for the template HTML page
- zipFileURL
URL for the template zip file
- completionHandler
Completion callback
- errorHandler
Error callback
Discussion
http://www.campaignmonitor.com/api/templates/#updating_a_template
Declared In
CSAPI+Templates.h