Class GlobalConfigItems

Namespace

SWConfigDataClientLib.Proxies.GlobalConfig

Assembly

IpPbxCDSClientLib.dll

Proxy wrapper for GlobalConfigItems. (Set generic of global settings.)

public class GlobalConfigItems : SWCFProxy<GlobalConfigEnumClient, IGlobalConfigEnum>

Inheritance

object

SWCFProxy<GlobalConfigEnumClient, IGlobalConfigEnum>

GlobalConfigItems

Constructors

GlobalConfigItems()

Constructor

public GlobalConfigItems()

Fields

ClassTrace

protected static STraceInfo ClassTrace

Field Value

STraceInfo

Properties

DefaultAdminProfileID

The ID of default AdminProfile

public int DefaultAdminProfileID { get; set; }

Property Value

int

DefaultCallAccessProfileID

The ID of default RightsProfile

public int DefaultCallAccessProfileID { get; set; }

Property Value

int

DefaultEmptyFeatureProfileID

The ID of default FeatureProfile

public int DefaultEmptyFeatureProfileID { get; set; }

Property Value

int

DefaultFeatureProfileID

The ID of default FeatureProfile

public int DefaultFeatureProfileID { get; set; }

Property Value

int

DefautLocationID

The ID of default Location

public int DefautLocationID { get; set; }

Property Value

int

HSWClientID

The ID of the HSWClient

public Guid HSWClientID { get; }

Property Value

Guid

HSWLastRegistrationUTC

Time of the last successfull reguistration

public DateTime HSWLastRegistrationUTC { get; }

Property Value

DateTime

HSWResellerID

The ID of the Reseller

public Guid HSWResellerID { get; }

Property Value

Guid

IpPbxServerLocationID

Server Location

public int IpPbxServerLocationID { get; set; }

Property Value

int

LastRegisteredFaxServer

The host of the last registered fax server. The value will used by the CDS to connect the FaxServer

public string LastRegisteredFaxServer { get; set; }

Property Value

string

LicenseAndReportingServer

The host of the License and Reporting Service. Use key word Local to indicate that the Reporting Service is on the same machine.

public string LicenseAndReportingServer { get; set; }

Property Value

string

LicenseAndReportingServerPort

The port to be used at the License and Reporting Service

public int LicenseAndReportingServerPort { get; set; }

Property Value

int

MaximumNumbersOfConferenceRooms

Get or sets the maximum numbers of conference rooms, this value is used by Admin only

public int MaximumNumbersOfConferenceRooms { get; set; }

Property Value

int

PublicServerIPAddress

Gets ot sets the public server address for mediastreaming

public IPAddress PublicServerIPAddress { get; set; }

Property Value

IPAddress

PublicServerIPAddressString

Gets ot sets the public server address as string for mediastreaming.

public string PublicServerIPAddressString { get; set; }

Property Value

string

Remarks

The address string must be parsable by System.Net.IpAddress. Empty string represents empty address.

ServerType

public ServerType ServerType { get; set; }

Property Value

ServerType

m_BaseUrl

protected override string m_BaseUrl { get; }

Property Value

string

Methods

CreateClient(Binding, EndpointAddress)

protected override GlobalConfigEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

GlobalConfigEnumClient

DeleteGlobalConfigItem(string, string, string)

Deletes a single item from the GlobalConfig table.

public void DeleteGlobalConfigItem(string section, string subsection, string key)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

Dispose()

Added for CDS API backward compatibility

public void Dispose()

FreeForReuse()

public override void FreeForReuse()

GetFallbackEnabledStatus()

return true if the fallback is enabled

public bool GetFallbackEnabledStatus()

Returns

bool

GetIsLocal()

public bool GetIsLocal()

Returns

bool

GetServerRequestTimeout(GlobalConfigEnumClient)

protected override TimeSpan GetServerRequestTimeout(GlobalConfigEnumClient client)

Parameters

client GlobalConfigEnumClient

Returns

TimeSpan

PingService(GlobalConfigEnumClient)

protected override void PingService(GlobalConfigEnumClient client)

Parameters

client GlobalConfigEnumClient

ReadGlobalConfigBinaryItem(string, string, string, byte[])

Retrieves an item value form the GlobalConfigItems table.

public byte[] ReadGlobalConfigBinaryItem(string section, string subsection, string key, byte[] defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue byte[]

This value will be returned if the item does not exist

Returns

byte[]

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigDateTimeItem(string, string, string, DateTime)

Retrieves an item value form the GlobalConfigItems table.

public DateTime ReadGlobalConfigDateTimeItem(string section, string subsection, string key, DateTime defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue DateTime

This value will be returned if the item does not exist

Returns

DateTime

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigDecimalItem(string, string, string, decimal)

Retrieves an item value form the GlobalConfigItems table.

public decimal ReadGlobalConfigDecimalItem(string section, string subsection, string key, decimal defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue decimal

This value will be returned if the item does not exist

Returns

decimal

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigGuidItem(string, string, string, Guid)

Retrieves an item value form the GlobalConfigItems table.

public Guid ReadGlobalConfigGuidItem(string section, string subsection, string key, Guid defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue Guid

This value will be returned if the item does not exist

Returns

Guid

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigIntItem(string, string, string, int)

Retrieves an item value form the GlobalConfigItems table.

public int ReadGlobalConfigIntItem(string section, string subsection, string key, int defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue int

This value will be returned if the item does not exist

Returns

int

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigLongItem(string, string, string, long)

Retrieves an item value form the GlobalConfigItems table.

public long ReadGlobalConfigLongItem(string section, string subsection, string key, long defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue long

This value will be returned if the item does not exist

Returns

long

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

ReadGlobalConfigStringItem(string, string, string, string)

Retrieves an item value form the GlobalConfigItems table.

public string ReadGlobalConfigStringItem(string section, string subsection, string key, string defaultValue)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

defaultValue string

This value will be returned if the item does not exist

Returns

string

Value of the item

Exceptions

SSystemException

Will be thrown when data type of item in database does not match with the ReadGlobalConfigItem method.

SetFallbackEnabledStatus(bool)

set the global fallback enabled status

public void SetFallbackEnabledStatus(bool enabled)

Parameters

enabled bool

WriteGlobalConfigItem(string, string, string, byte[])

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, byte[] value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value byte[]

The value of the configuration item

WriteGlobalConfigItem(string, string, string, DateTime)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, DateTime value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value DateTime

The value of the configuration item

WriteGlobalConfigItem(string, string, string, decimal)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, decimal value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value decimal

The value of the configuration item

WriteGlobalConfigItem(string, string, string, Guid)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, Guid value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value Guid

The value of the configuration item

WriteGlobalConfigItem(string, string, string, int)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, int value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value int

The value of the configuration item

WriteGlobalConfigItem(string, string, string, long)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, long value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value long

The value of the configuration item

WriteGlobalConfigItem(string, string, string, string)

Writes a custom configuration item to the database (GlobalConfigItems). If the an item with section, subsection and key already exists, it will be replaced by the value.

public void WriteGlobalConfigItem(string section, string subsection, string key, string value)

Parameters

section string

Section name

subsection string

Subsection name

key string

The name of the configuration item value

value string

The value of the configuration item