dotMailer.Sdk.Collections.DmCampaignCollection Class Reference

A collection of DmCampaign objects More...

Inheritance diagram for dotMailer.Sdk.Collections.DmCampaignCollection:

Public Member Functions
	DmCampaignCollection ()
	Creates an empty campaign collection
	DmCampaignCollection (DmService api)
	Creates an empty campaign collection
	DmCampaignCollection (IEnumerable< IDmCampaign > campaigns)
	Create a CampaignCollection, adds the specified campaigns
	DmCampaignCollection (DmService api, IEnumerable< IDmCampaign > campaigns)
	Create a CampaignCollection, adds the specified campaigns
void	AddRange (IEnumerable< IDmCampaign > campaigns)
	Adds a range of iDmContacts to the list.
bool	Contains (string name)
	Searches for a campaign with the specified name
bool	Contains (int id)
	Searches for a campaign with the specified Id
DmCampaign	GetCampaignByName (string name)
	Returns the campaign that has the specified name
DmCampaign	GetCampaignById (int id)
	Returns the campaign that has 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 DmCampaign objects

Constructor & Destructor Documentation

dotMailer.Sdk.Collections.DmCampaignCollection.DmCampaignCollection

(

)

Creates an empty campaign collection

dotMailer.Sdk.Collections.DmCampaignCollection.DmCampaignCollection

(

DmService

api

)

Creates an empty campaign collection

Parameters

api	Service API

dotMailer.Sdk.Collections.DmCampaignCollection.DmCampaignCollection

(

IEnumerable< IDmCampaign >

campaigns

)

Create a CampaignCollection, adds the specified campaigns

Parameters

campaigns

list of campaign interfaces

dotMailer.Sdk.Collections.DmCampaignCollection.DmCampaignCollection	(	DmService	api,
		IEnumerable< IDmCampaign >	campaigns
	)

Create a CampaignCollection, adds the specified campaigns

Parameters

api	Service API
campaigns	list of campaign interfaces

Member Function Documentation

void dotMailer.Sdk.Collections.DmCampaignCollection.AddRange

(

IEnumerable< IDmCampaign >

campaigns

)

Adds a range of iDmContacts to the list.

Parameters

campaigns

collection of campaign interfaces

bool dotMailer.Sdk.Collections.DmCampaignCollection.Contains

(

string

name

)

Searches for a campaign with the specified name

Parameters

name

Returns

bool dotMailer.Sdk.Collections.DmCampaignCollection.Contains

(

int

id

)

Searches for a campaign with the specified Id

Parameters

id

Returns

DmCampaign dotMailer.Sdk.Collections.DmCampaignCollection.GetCampaignById

(

int

id

)

Returns the campaign that has the specified Id

Parameters

id	the id of the required Id

Returns

DmCampaign

DmCampaign dotMailer.Sdk.Collections.DmCampaignCollection.GetCampaignByName

(

string

name

)

Returns the campaign that has the specified name

Parameters

name	the name of the required campaign

Returns

DmCampaign

Property Documentation

override string dotMailer.Sdk.Collections.DmCampaignCollection.ObjectType

getset

Returns the type name of the class Used by the serialisation process