Method | Description | |
---|---|---|
CompareContactListsBySortOrder ( ConstantContactBO.ContactList x, ConstantContactBO.ContactList y ) : int |
Defines the compare criteria for two Contact List instances
|
|
CreateNewContact ( |
Create a New Contact The POST data presents only values for EmailAddress, FirstName, LastName, OptInSource and ContactLists elements |
|
CreateNewEmailCampaign ( |
Create a New EmailCampaign
|
|
DeleteEmailCampaign ( |
Sends a Http DELETE request at the specified Uri address to delete an Email Campaign
|
|
GetContactCollection ( |
Retrieves the first chunk collection of Contacts that the server provides Constant Contact server provides paged collections |
|
GetContactCollection ( |
Retrieves the collection of Contacts returned by server at the current chunk Id Constant Contact server provides paged collections |
|
GetContactDetailsById ( |
Retrieve an individual Contact by its Id
|
|
GetEmailCampaignById ( |
Get EmailCampaign By Id
|
|
GetEmailCampaignCollection ( |
Gets a list of email campaigns
|
|
GetEmailCampaignCollection ( |
Gets a list of email campaigns filtered by status
|
|
GetEmailCollection ( |
Retrieves the collection of Emails returned by server
|
|
GetUserContactListCollection ( |
Retrieves the first chunk collection of user Contact Lists that the server provides for current Contact Account Owner. The collection is sorted by the Sort Order and it will not include the system predefined lists ("Active", "Removed", "DoNotEmail") Constant Contact server provides paged collections |
|
GetUserContactListCollection ( |
Retrieves the collection of user Contact Lists returned by the server at current chunk Id. The collection is sorted by the Sort Order and it will not include the system predefined lists ("Active", "Removed", "DoNotEmail")
|
|
IsEmail ( string email ) : bool |
Check if e-mail is valid
|
|
IsValidUserAuthentication ( |
Verify user authentication
|
|
RemoveContactFromAllLists ( AuthenticationData authenticationData, string contactId ) : void |
Remove Contact from all Contact Lists
|
|
ScheduleEmailCampaign ( AuthenticationData authenticationData, ConstantContactBO.Entities.EmailCampaign campaign ) : ConstantContactBO.Entities.EmailCampaign |
Schedule an EmailCampaign
|
|
SearchContactByEmail ( AuthenticationData authenticationData, IEnumerable |
Retrieves the first chunk collection of Contacts that match specified Email Addresses Constant Contact server provides paged collections |
|
SearchContactByEmail ( AuthenticationData authenticationData, IEnumerable |
Retrieves the collection of Contacts that match specified Email Addresses, returned by the server at current chunk Id. Entire collection of Contacts will be returned if no Email Address is specified Constant Contact server provides paged collections |
|
UnsubscribeContact ( AuthenticationData authenticationData, string contactId ) : void |
Opting-out ("Unsubscribe") a Contact Opted-out Contacts become members of the Do-Not-Mail special list |
|
UpdateContactFullForm ( AuthenticationData authenticationData, ConstantContactBO.Contact contact ) : void |
Update a Contact using the full form. All Contact fields will be updated
|
|
UpdateEmailCampaign ( AuthenticationData authenticationData, ConstantContactBO.Entities.EmailCampaign campaign ) : ConstantContactBO.Entities.EmailCampaign |
Update a New EmailCampaign
|
|
UpdateList ( ConstantContactBO.ContactList list, AuthenticationData authdata ) : void |
Update an existing ContactList
|
|
addFolder ( AuthenticationData authdata, string folderName ) : string |
Creates a new folder
|
|
addList ( string name, bool optindefault, AuthenticationData authdata ) : void |
Create a new Contact List
|
|
addList ( string name, bool optindefault, int sortOrder, AuthenticationData authdata ) : void |
Create a new Contact List
|
|
bulkUrlEncoded ( AuthenticationData authdata, string data, IList |
Uploads text/csv file dumped to string to specified lists
|
|
clearContacts ( AuthenticationData authdata, IList |
Removes all contacts from selected lists
|
|
clearFolder ( AuthenticationData authdata, int folderId ) : void |
Deletes all images in target folder
|
|
deleteImage ( AuthenticationData authdata, string link ) : void |
Deletes target image
|
|
deleteList ( AuthenticationData authdata, string listID ) : void |
Delete a Contact List specified by list ID
|
|
exportContacts ( AuthenticationData authdata, int listId, string fileType, bool exportOptDate, bool exportOptSource, bool exportListName, string sortBy, IList |
Creates export all contacts activity for targeded list.
|
|
getActivities ( AuthenticationData Authdata, string &nextChunk ) : IList |
Gets first chunk of all activities
|
|
getActivities ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
Gets chunk of activites at specified link
|
|
getActivityDetails ( AuthenticationData Authdata, string id ) : ConstantContactBO.Activity |
Get details of activity with specified ID
|
|
getImageDetails ( string link, AuthenticationData Authdata ) : ConstantContactBO.Image |
Gets Details of a single image
|
|
getListMembers ( string link, AuthenticationData Authdata, string &nextChunk ) : IList |
Retrieves all list members of selected node. Constant Contact server provides paged collections |
|
httpDelete ( AuthenticationData Authdata, string URI ) : string |
Sends HTTP Delete to specified URI
|
|
httpGet ( AuthenticationData Authdata, string URI ) : string |
Performs HTTP GET to specified URI
|
|
httpPost ( AuthenticationData Authdata, string URI, string data, string contentType ) : string |
Posts XML data to specified URI
|
|
httpPut ( AuthenticationData Authdata, string URI, string data, string contentType ) : string |
Posts XML data to specified URI
|
|
listFolders ( AuthenticationData Authdata, string &nextChunk ) : IList |
Retrieves list of first 50 folders
|
|
listFolders ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
Retrieves list of all folders in chunks of 50
|
|
listImages ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
Get chunk of 50 images at specified link
|
|
listImages ( string folderId, AuthenticationData Authdata, string &nextChunk ) : IList |
Get chunk of first 50 images in specified folder
|
|
urlEncodedPost ( AuthenticationData Authdata, string URI, string content ) : string |
HTTP POST using URLEncoded Content Type
|
Method | Description | |
---|---|---|
CreateCredentialCache ( |
Create credentials for network transport
|
|
DeleteInformation ( |
Sends a Http DELETE request at the specified Uri address
|
|
GetContactListCollection ( |
Retrieves the collection of Contact Lists returned by the server at current chunk Id. The collection is sorted by the Sort Order and it will include the system predefined lists ("Active", "Removed", "DoNotEmail") Constant Contact server provides paged collections |
|
ScheduleEmailCampaign ( AuthenticationData authenticationData, Uri address, string data ) : void | ||
SetCredentials ( AuthenticationData Authdata, HttpWebRequest &request ) : void | ||
UpdateContact ( AuthenticationData authenticationData, ConstantContactBO.Contact contact ) : void |
Update a Contact
|
|
ValidateAuthenticationData ( AuthenticationData authenticationData ) : void |
Check if API Key, Username and Password are not null or empty
|
public static CompareContactListsBySortOrder ( ConstantContactBO.ContactList x, ConstantContactBO.ContactList y ) : int | ||
x | ConstantContactBO.ContactList | Contact List to be compared |
y | ConstantContactBO.ContactList | Contact List to be compared |
return | int |
public static CreateNewContact ( |
||
authenticationData | Authentication data (username, password and API Key) | |
contact | ConstantContactBO.Contact | Contact to be created |
return | ConstantContactBO.Contact |
public static CreateNewEmailCampaign ( |
||
authenticationData | Authentication data (username, password and API Key) | |
campaign | ConstantContactBO.Entities.EmailCampaign | Email Campaign to be created |
return | ConstantContactBO.Entities.EmailCampaign |
public static DeleteEmailCampaign ( |
||
authenticationData | Authentication data (username, password and API Key) | |
id | string | campaign id |
return | void |
public static GetContactCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
nextChunkId | string | Link to the next chunk of data |
return | IList |
public static GetContactCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
currentChunkId | string | Link to the current chunk data |
nextChunkId | string | Link to the next chunk of data |
return | IList |
public static GetContactDetailsById ( |
||
authenticationData | Authentication data (username, password and API Key) | |
id | string | Contact Id |
return | ConstantContactBO.Contact |
public static GetEmailCampaignById ( |
||
authenticationData | Authentication data (username, password and API Key) | |
id | string | campaign id |
return | ConstantContactBO.Entities.EmailCampaign |
public static GetEmailCampaignCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
return | List |
public static GetEmailCampaignCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
status | string | campaign status |
return | List |
public static GetEmailCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
currentChunkId | string | |
nextChunkId | string | |
return | IList |
public static GetUserContactListCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
nextChunkId | string | Link to the next chunk data |
return | IList |
public static GetUserContactListCollection ( |
||
authenticationData | Authentication data (username, password and API Key) | |
currentChunkId | string | Link to the current chunk data |
nextChunkId | string | Link to the next chunk of data |
return | IList |
public static IsEmail ( string email ) : bool | ||
string | ||
return | bool |
public static IsValidUserAuthentication ( |
||
authenticationData | Authentication data (username, password and API Key) | |
return | void |
public static RemoveContactFromAllLists ( AuthenticationData authenticationData, string contactId ) : void | ||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
contactId | string | Contact Id |
return | void |
public static ScheduleEmailCampaign ( AuthenticationData authenticationData, ConstantContactBO.Entities.EmailCampaign campaign ) : ConstantContactBO.Entities.EmailCampaign | ||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
campaign | ConstantContactBO.Entities.EmailCampaign | Email Campaign to be updated |
return | ConstantContactBO.Entities.EmailCampaign |
public static SearchContactByEmail ( AuthenticationData authenticationData, IEnumerable |
||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
emailAddresses | IEnumerable |
One or more Email Addresses |
nextChunkId | string | Link to the next chunk of data |
return | IList |
public static SearchContactByEmail ( AuthenticationData authenticationData, IEnumerable |
||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
emailAddresses | IEnumerable |
One or more Email Addresses |
currentChunkId | string | Link to the current chunk data |
nextChunkId | string | Link to the next chunk of data |
return | List |
public static UnsubscribeContact ( AuthenticationData authenticationData, string contactId ) : void | ||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
contactId | string | Contact Id |
return | void |
public static UpdateContactFullForm ( AuthenticationData authenticationData, ConstantContactBO.Contact contact ) : void | ||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
contact | ConstantContactBO.Contact | Contact to be updated |
return | void |
public static UpdateEmailCampaign ( AuthenticationData authenticationData, ConstantContactBO.Entities.EmailCampaign campaign ) : ConstantContactBO.Entities.EmailCampaign | ||
authenticationData | AuthenticationData | Authentication data (username, password and API Key) |
campaign | ConstantContactBO.Entities.EmailCampaign | Email Campaign to be updated |
return | ConstantContactBO.Entities.EmailCampaign |
public static UpdateList ( ConstantContactBO.ContactList list, AuthenticationData authdata ) : void | ||
list | ConstantContactBO.ContactList | ContactList object to be updated |
authdata | AuthenticationData | Authentication Data for the Constant Contact account |
return | void |
public static addFolder ( AuthenticationData authdata, string folderName ) : string | ||
authdata | AuthenticationData | Authentication Data |
folderName | string | Name of folder to be created |
return | string |
public static addList ( string name, bool optindefault, AuthenticationData authdata ) : void | ||
name | string | Name of list to be created |
optindefault | bool | determines if list is the default opt in list |
authdata | AuthenticationData | Authentication data (username, password and API Key) |
return | void |
public static addList ( string name, bool optindefault, int sortOrder, AuthenticationData authdata ) : void | ||
name | string | Name of list to be created |
optindefault | bool | determines if list is the default opt in list |
sortOrder | int | Order that the list will show in the Constant Contact UI |
authdata | AuthenticationData | Authentication data (username, password and API Key) |
return | void |
public static bulkUrlEncoded ( AuthenticationData authdata, string data, IList |
||
authdata | AuthenticationData | Authentication Data |
data | string | CSV or text, dumped to string |
listIds | IList |
ID(s) of target lists to upload to |
return | string |
public static clearContacts ( AuthenticationData authdata, IList |
||
authdata | AuthenticationData | Authentication Data |
listIds | IList |
ID(s) of target lists to upload to |
return | string |
public static clearFolder ( AuthenticationData authdata, int folderId ) : void | ||
authdata | AuthenticationData | Authentication Data |
folderId | int | ID of desired folder to empty |
return | void |
public static deleteImage ( AuthenticationData authdata, string link ) : void | ||
authdata | AuthenticationData | Authentication Data |
link | string | Link to desired image to delete (EX: /ws/customers/{username}/library/folders/{folderID}/images/{imageID}) |
return | void |
public static deleteList ( AuthenticationData authdata, string listID ) : void | ||
authdata | AuthenticationData | Authentication data (username, password and API Key) |
listID | string | ID of target list to delete |
return | void |
public static exportContacts ( AuthenticationData authdata, int listId, string fileType, bool exportOptDate, bool exportOptSource, bool exportListName, string sortBy, IList |
||
authdata | AuthenticationData | Authenticatoin Data |
listId | int | ID of target list |
fileType | string | Export File Type (TXT or CSV) |
exportOptDate | bool | if add/remove date is included in file |
exportOptSource | bool | if add/removed by (contact or site owner) is included |
exportListName | bool | if name of list is included in file |
sortBy | string | sort by Email Address in Ascending Order (EMAIL_ADDRESS) or Date in Descending Order (DATE_DESC) |
columns | IList |
List of what columns to include in exported file |
return | string |
public static getActivities ( AuthenticationData Authdata, string &nextChunk ) : IList |
||
Authdata | AuthenticationData | Authentication Data |
nextChunk | string | Out Link to next chunk of data if |
return | IList |
public static getActivities ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
||
Authdata | AuthenticationData | Authentication Data |
link | string | Link to target chunk of data |
nextChunk | string | out link to next chunk of data |
return | IList |
public static getActivityDetails ( AuthenticationData Authdata, string id ) : ConstantContactBO.Activity | ||
Authdata | AuthenticationData | Authentication Data |
id | string | ID of target activity |
return | ConstantContactBO.Activity |
public static getImageDetails ( string link, AuthenticationData Authdata ) : ConstantContactBO.Image | ||
link | string | link to target image |
Authdata | AuthenticationData | Authentication Data |
return | ConstantContactBO.Image |
public static getListMembers ( string link, AuthenticationData Authdata, string &nextChunk ) : IList |
||
link | string | Link to target list |
Authdata | AuthenticationData | Authentication data (username, password and API Key) |
nextChunk | string | Link to the next chunk data |
return | IList |
public static httpDelete ( AuthenticationData Authdata, string URI ) : string | ||
Authdata | AuthenticationData | Authentication Data |
URI | string | Target URI to send DELETE to |
return | string |
public static httpGet ( AuthenticationData Authdata, string URI ) : string | ||
Authdata | AuthenticationData | Authentication Data |
URI | string | Target URI to send request to |
return | string |
public static httpPost ( AuthenticationData Authdata, string URI, string data, string contentType ) : string | ||
Authdata | AuthenticationData | Authentication Data |
URI | string | Target URI to POST XML data to |
data | string | XML Data |
contentType | string | |
return | string |
public static httpPut ( AuthenticationData Authdata, string URI, string data, string contentType ) : string | ||
Authdata | AuthenticationData | Authentication Data |
URI | string | Target URI to POST XML data to |
data | string | XML Data |
contentType | string | Type of content for the POST data |
return | string |
public static listFolders ( AuthenticationData Authdata, string &nextChunk ) : IList |
||
Authdata | AuthenticationData | Authentication Data |
nextChunk | string | Out; if more than 50 folders, will out link to next chunk of data |
return | IList |
public static listFolders ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
||
Authdata | AuthenticationData | Authentication Data |
link | string | link to chunk of data desired |
nextChunk | string | link to next chunk of 50 if needed, otherwise returns blank string |
return | IList |
public static listImages ( AuthenticationData Authdata, string link, string &nextChunk ) : IList |
||
Authdata | AuthenticationData | Authentication Data |
link | string | Link to desired chunk of data |
nextChunk | string | out link to next chunk of data |
return | IList |
public static listImages ( string folderId, AuthenticationData Authdata, string &nextChunk ) : IList |
||
folderId | string | ID of target folder |
Authdata | AuthenticationData | Authentication Data |
nextChunk | string | out link to next chunk of data |
return | IList |
public static urlEncodedPost ( AuthenticationData Authdata, string URI, string content ) : string | ||
Authdata | AuthenticationData | Authentication Data |
URI | string | URI to POST URLEncoded data to |
content | string | URLencoded data to POST |
return | string |