Inheritance diagram for MyLibraryFilesService:

Class Methods
(HttpResponse *)	+ getFileCollectionWithAccessToken:type:source:withALimitOf:

(HttpResponse *)	+ getFileCollectionWithAccessToken:folderId:withaAimitOf:

(HttpResponse *)	+ getFileWithAccessToken:andFileId:

(HttpResponse *)	+ updateFileWithAccessToken:fileId:includePayload:andFile:

(BOOL)	+ deleteFileWithAccessToken:andFileId:errors:

(HttpResponse *)	+ addFileMultipartWithToken:withFile:toFolder:withDescription:fromSource:errors:

(HttpResponse *)	+ getUploadStatusWithAccessToken:forFilesInArray:

(HttpResponse *)	+ moveFilesWithAccessToken:toFolderWithId:withMoveFilesArray:

Method Documentation

+ (HttpResponse *) addFileMultipartWithToken:	(NSString *)	accessToken
withFile:	(NSString *)	file
toFolder:	(NSString *)	folderId
withDescription:	(NSString *)	description
fromSource:	(NSString *)	source
errors:	(NSArray**)	errors

Function is used to add a file to a folder.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*file - the file path for the file sent to the server.
NSString	*folderId - the folder destination for the file sent to the server.
NSString	*description - user description for the file sent to the server.
NSString	*fromSource - the source of the original file: MyComputer, StockImage, Facebook, Instagram, Shutterstock, Mobile . Accessible by the keyword FILE_TYPE_
NSString*	data - the data from the selected file in string format.

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (BOOL) deleteFileWithAccessToken:	(NSString*)	accessToken
andFileId:	(NSString *)	fileId
errors:	(NSArray**)	errors

DELETE an individual MyLibrary file.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*fileId - an individual MyLibrary file that you want to delete

+ (HttpResponse *) getFileCollectionWithAccessToken:	(NSString*)	accessToken
folderId:	(NSString *)	folderId
withaAimitOf:	(int)	limit

Retrieve MyLibrary files from a specific folder.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*folderId - the id of the folder that containes the desired files.
int	limit - (optional) the number of elements to be returned, default 50;

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (HttpResponse *) getFileCollectionWithAccessToken:	(NSString*)	accessToken
type:	(NSString *)	type
source:	(NSString *)	source
withALimitOf:	(int)	limit

Returns a collection of MyLibrary files.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*type - (optional) Specifies the type of files to retrieve, ALL, IMAGES, or DOCUMENTS. Default All. Accessible by the keyword FILE_TYPE_
NSString	*source - (optional) Specifies to retrieve files from a particular source: ALL , MyComputer, StockImage, Facebook, Instagram, Shutterstock, Mobile. Default All. Accessible by the keyword FILE_SOURCE_
int	limit - (optional) the number of elements to be returned, default 50;

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (HttpResponse *) getFileWithAccessToken:	(NSString*)	accessToken
andFileId:	(NSString *)	fileId

Retrieve information for a specific MyLibrary file

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*fileId - the id of the desired file.

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (HttpResponse *) getUploadStatusWithAccessToken:	(NSString*)	accessToken
forFilesInArray:	(NSArray *)	fileIds

Retrieve the status of one or more files uploaded to MyLibrary.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSArray	*fileIds - a array containing file id's, in string format;

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (HttpResponse *) moveFilesWithAccessToken:	(NSString*)	accessToken
toFolderWithId:	(NSString *)	folderId
withMoveFilesArray:	(NSArray *)	arr

Moves files in the array to the desiganted folder.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*folderId - an individual MyLibrary folder that you want to move the files to
NSArray	*arr - a array containing file id's, in string format;

Returns: HttpResponse * - response containing data and errors (if there are some)

+ (HttpResponse *) updateFileWithAccessToken:	(NSString*)	accessToken
fileId:	(NSString *)	fileId
includePayload:	(BOOL)	includePayload
andFile:	(LibraryFile *)	file

Update information for a specific MyLibrary file

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*fileId - an individual MyLibrary file that you want to update
File	*file - the file that is about to be updated;
BOOL	includePayload - (optional) Determines if updated files JSON payload is returned : YES , NO. Default YES.

Returns: HttpResponse * - response containing data and errors (if there are some)

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

/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/MyLibraryFilesService.h
/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/MyLibraryFilesService.m

Class Methods