dotMailer.Sdk.DmServiceFactory Class Reference

Service Factory More...

Static Public Member Functions
static DmService	Create (string userName, string password)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, TimeoutOptions timeoutOptions)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, IDmCacheProvider cacheProvider)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, int pageSize, TimeoutOptions timeoutOptions)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, bool httpConnection)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, bool httpConnection, int pageSize, TimeoutOptions timeoutOptions, IDmCacheProvider cacheProvider)
	Creates a DmServiceApi instance
static DmService	Create (string userName, string password, bool httpConnection, int pageSize, TimeoutOptions timeoutOptions, IDmCacheProvider cacheProvider, string appName)
	Creates a DmServiceApi instance

Properties
static string	LogConfigFile [get, set]
	Set the log configuration file for the SDK
bool	LogEnabled [get, set]
	Enable/Disable logging output
static DmServiceFactory	Instance [get]
	The singleton instance
static bool	Logging [get, set]
	Enables or disables logging

Events
ProcessUpdateHandler	OnProcessUpdate
	Event for receiving progress updates

Detailed Description

Service Factory

Member Function Documentation

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, TimeoutOptions  timeoutOptions  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password
timeoutOptions	timeout options

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, IDmCacheProvider  cacheProvider  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password
cacheProvider	dotMailer cache provider interface

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, int  pageSize, TimeoutOptions  timeoutOptions  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password
pageSize	The number of dotMailer objects to read from paged web service api calls
timeoutOptions

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, bool  httpConnection  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password
httpConnection	set this to true to use HTTP instead of HTTPS for connection

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, bool  httpConnection, int  pageSize, TimeoutOptions  timeoutOptions, IDmCacheProvider  cacheProvider  )

static

Creates a DmServiceApi instance

Parameters

userName	dotMailer api account username
password	dotMailer api account password
pageSize	The number of dotMailer objects to read from paged web service api calls
httpConnection	set this to true to use HTTP instead of HTTPS for connection
timeoutOptions
cacheProvider

Returns

If the username and password are valid, returns instance of DmServiceApi

Exceptions

DmServiceNotValidException

Invalid Login exception, if username/password incorrect

static DmService dotMailer.Sdk.DmServiceFactory.Create ( string  userName, string  password, bool  httpConnection, int  pageSize, TimeoutOptions  timeoutOptions, IDmCacheProvider  cacheProvider, string  appName  )

static

Creates a DmServiceApi instance

Property Documentation

DmServiceFactory dotMailer.Sdk.DmServiceFactory.Instance

staticget

The singleton instance

string dotMailer.Sdk.DmServiceFactory.LogConfigFile

staticgetset

Set the log configuration file for the SDK

bool dotMailer.Sdk.DmServiceFactory.LogEnabled

getset

Enable/Disable logging output

bool dotMailer.Sdk.DmServiceFactory.Logging

staticgetset

Enables or disables logging

Event Documentation

ProcessUpdateHandler dotMailer.Sdk.DmServiceFactory.OnProcessUpdate

Event for receiving progress updates