 |
dotmailer SDK
Tools to access and manage an account in the dotMailer system
|
dotMailer.Sdk.Collections.DmAddressBookCollection Class Reference
A collection of DmAddressBooks More...
Inheritance diagram for dotMailer.Sdk.Collections.DmAddressBookCollection:
Public Member Functions | |
| DmAddressBookCollection () | |
| Creates an empty address book collection | |
| DmAddressBookCollection (IEnumerable< IDmAddressBook > addressBooks) | |
| Creates a new address book collection, and adds the specified address books | |
| DmAddressBookCollection (DmService api) | |
| Creates an empty address book collection | |
| DmAddressBookCollection (DmService api, IEnumerable< IDmAddressBook > addressBooks) | |
| Creates a new address book collection, and adds the specified address books | |
| void | AddRange (IEnumerable< IDmAddressBook > addressBooks) |
| Adds a range of IDmAddressBook to the list. | |
| DmAddressBook | GetAddressBook (string name) |
| Searches for the address book that has the specified name and returns it if found | |
| DmAddressBook | GetAddressBook (int id) |
| Searches for the address book that has the specified Id and returns it if found | |
| SendResult | SendCampaign (SplitTestSendOptions splitTestSendOptions, int campaignId, DateTime dateTimeToSend) |
| Sends the collection of address book to the specified campaign | |
| SendResult | SendCampaign (SplitTestSendOptions splitTestSendOptions, IDmCampaign campaign, DateTime dateTimeToSend) |
| Sends the collection of address book to the specified campaign | |
| bool | Contains (string name) |
| Does the collection contain an address book with the specified name | |
| void | Remove (string addressBookName) |
| Removes the addressbook that is specified by the name | |
| bool | Contains (int id) |
| Checks to see if the collection contains an address book with the specified Id | |
Properties | |
| override string | ObjectType [get, set] |
| Returns the type name of the class Used by the serialisation process | |
Detailed Description
A collection of DmAddressBooks
Constructor & Destructor Documentation
| dotMailer.Sdk.Collections.DmAddressBookCollection.DmAddressBookCollection | ( | ) |
Creates an empty address book collection
| dotMailer.Sdk.Collections.DmAddressBookCollection.DmAddressBookCollection | ( | IEnumerable< IDmAddressBook > | addressBooks | ) |
Creates a new address book collection, and adds the specified address books
- Parameters
-
addressBooks List of address book interfaces
| dotMailer.Sdk.Collections.DmAddressBookCollection.DmAddressBookCollection | ( | DmService | api | ) |
Creates an empty address book collection
- Parameters
-
api DmService
| dotMailer.Sdk.Collections.DmAddressBookCollection.DmAddressBookCollection | ( | DmService | api, |
| IEnumerable< IDmAddressBook > | addressBooks | ||
| ) |
Creates a new address book collection, and adds the specified address books
- Parameters
-
addressBooks List of address book interfaces api DmService
Member Function Documentation
| void dotMailer.Sdk.Collections.DmAddressBookCollection.AddRange | ( | IEnumerable< IDmAddressBook > | addressBooks | ) |
Adds a range of IDmAddressBook to the list.
Converts to DmAddressBooks, and therefore needs a collection that is linked to the api
- Parameters
-
addressBooks collection of contact interfaces
| bool dotMailer.Sdk.Collections.DmAddressBookCollection.Contains | ( | string | name | ) |
Does the collection contain an address book with the specified name
- Parameters
-
name the name of the address book
- Returns
- true if the name is found
| bool dotMailer.Sdk.Collections.DmAddressBookCollection.Contains | ( | int | id | ) |
Checks to see if the collection contains an address book with the specified Id
- Parameters
-
id the id to search for
- Returns
- true if the Id is found
| DmAddressBook dotMailer.Sdk.Collections.DmAddressBookCollection.GetAddressBook | ( | string | name | ) |
Searches for the address book that has the specified name and returns it if found
- Parameters
-
name the name of the address book
- Returns
- DmAddressBook
- Exceptions
-
DmException If address book is not found
| DmAddressBook dotMailer.Sdk.Collections.DmAddressBookCollection.GetAddressBook | ( | int | id | ) |
Searches for the address book that has the specified Id and returns it if found
- Parameters
-
id the Id of the address book
- Returns
- DmAddressBook
- Exceptions
-
DmException If address book is not found
| void dotMailer.Sdk.Collections.DmAddressBookCollection.Remove | ( | string | addressBookName | ) |
Removes the addressbook that is specified by the name
- Parameters
-
addressBookName Name of the address book to remove
| SendResult dotMailer.Sdk.Collections.DmAddressBookCollection.SendCampaign | ( | SplitTestSendOptions | splitTestSendOptions, |
| int | campaignId, | ||
| DateTime | dateTimeToSend | ||
| ) |
Sends the collection of address book to the specified campaign
- Parameters
-
splitTestSendOptions Send Options campaignId the id of the campaign to send dateTimeToSend DateTime to send the campaign
- Returns
- SendResult
| SendResult dotMailer.Sdk.Collections.DmAddressBookCollection.SendCampaign | ( | SplitTestSendOptions | splitTestSendOptions, |
| IDmCampaign | campaign, | ||
| DateTime | dateTimeToSend | ||
| ) |
Sends the collection of address book to the specified campaign
- Parameters
-
splitTestSendOptions Send Options campaign IDmCampaign Interface dateTimeToSend DateTime to send the campaign
- Returns
- SendResult
Property Documentation
|
getset |
Returns the type name of the class Used by the serialisation process
Generated by
1.8.3