Class AdminFacade

Namespace

SWConfigDataClientLib.Proxies.Admin

Assembly

IpPbxCDSClientLib.dll

Facade class for administration applications.

public class AdminFacade : AdminFacadeBase

Inheritance

object

SWCFProxy<AdminFacadeClient, IAdminFacade>

AdminFacadeBase

AdminFacade

Inherited Members

AdminFacadeBase.ClassTrace

Constructors

AdminFacade()

Creates instance of PortManagerFacade. (For use by Unmanaged Wrapper only)

public AdminFacade()

Remarks

Use the LibManager to create an instance of this class.

Properties

IsLocal

public bool IsLocal { get; }

Property Value

bool

PoolMaxSize

depcreated

public static int PoolMaxSize { get; set; }

Property Value

int

PoolMinSize

depcreated

public static int PoolMinSize { get; set; }

Property Value

int

m_BaseUrl

protected override string m_BaseUrl { get; }

Property Value

string

Methods

AccountName2SID(SStringList)

Retrieves the SIDs matching to given list of windows usernames.

public SStringList AccountName2SID(SStringList names)

Parameters

names SStringList

list of windows usernames

Returns

SStringList

List of SID strings

ActivatePortLed(string, int, int)

Activates the LED at the Port on the card

public void ActivatePortLed(string strHostname, int iCardID, int iCardPortID)

Parameters

strHostname string

iCardID int

iCardPortID int

AddAdminUser(string, int)

Adds an administrative user to the pbx. If the user already exists the profile of the user will be changed. The user must have a sufficient scurity level to assign or disassing an administrative profile.

public int AddAdminUser(string WindowsIdentitiy, int ProfileID)

Parameters

WindowsIdentitiy string

id to the windows user ( DOMAIN|COMPUTER\Name)

ProfileID int

id of the administrative profile.

Returns

int

AdminUserID

AddAdminUser(string, string)

Adds an administrative user to the pbx. If the user already exists the profile of the user will be changed. The user must have a sufficient scurity level to assign or disassing an administrative profile.

public int AddAdminUser(string WindowsIdentitiy, string profileName)

Parameters

WindowsIdentitiy string

id to the windows user ( DOMAIN|COMPUTER\Name)

profileName string

name of the administrative profile.

Returns

int

AdminUserID

AddEditablePhoneBookEntry(string, string, string, string, bool)

Adds a new PhoneBookEntry (Global editable phonebook) directly into database.

public int AddEditablePhoneBookEntry(string Name, string Number, string SearchNumber, string Description, bool Hide)

Parameters

Name string

The name of the phone entry

Number string

The number

SearchNumber string

The searchnumber is the canonical representation of the number. It will be generated by the CDS.

Description string

Mandantory description

Hide bool

When set to true the entry will not be shown in phonebook. It will be used to resolve the name for displaying current call informations.

Returns

int

The EntryID of the entry

AddLicenses(byte[], out SUIntList, out int)

public SCl4LicenseInfoList AddLicenses(byte[] KeyBuffer, out SUIntList Results, out int hr)

Parameters

KeyBuffer byte[]

Results SUIntList

hr int

Returns

SCl4LicenseInfoList

AddOrReplaceGroupByID(GroupAdminView1PrimaryCollection, int)

Adds or replaces a Port with a given PortID from database

public GroupAdminView1Entry AddOrReplaceGroupByID(GroupAdminView1PrimaryCollection collection, int GroupID)

Parameters

collection GroupAdminView1PrimaryCollection

GroupID int

Returns

GroupAdminView1Entry

AddOrReplaceUserByID(UserAdminView1PrimaryCollection, int, bool, out UserDeviceSmallMap)

Adds or replaces a Port with a given PortID from database

public UserAdminView1Entry AddOrReplaceUserByID(UserAdminView1PrimaryCollection collection, int UserID, bool showUserFileSize, out UserDeviceSmallMap deviceMap)

Parameters

collection UserAdminView1PrimaryCollection

UserID int

showUserFileSize bool

deviceMap UserDeviceSmallMap

Returns

UserAdminView1Entry

AddPhoneControllerAddressRange(int, string, string, string, int, string)

Adds a new AddressRange to a PhoneControllerConfiguration

public void AddPhoneControllerAddressRange(int PhoneControllerID, string BeginAddress, string EndAddress, string FallBackPhoneMgr, int Id, string PhoneMgr)

Parameters

PhoneControllerID int

Id of the PhoneControllerConfiguration

BeginAddress string

EndAddress string

FallBackPhoneMgr string

Id int

PhoneMgr string

AddPhoneControllerConfiguration(int, int, SDateTime)

Adds a new PhoneControllerConfiguration. Also a the CDS suppots more than one Phonecontroller there will always be only one.

public int AddPhoneControllerConfiguration(int Period, int RescanInterval, SDateTime StartTime)

Parameters

Period int

RescanInterval int

StartTime SDateTime

Returns

int

AddSignalRelation(SignalRelationEntry)

Adds a new SignalRelation to database

public SignalRelationEntry AddSignalRelation(SignalRelationEntry entry)

Parameters

entry SignalRelationEntry

The new Entry

Returns

SignalRelationEntry

The added entry, including all fields modified by database. (EntryID)

AdjustHoldMusicVolume(int, bool)

Sets the current holdmusic volume in the IpPbxServer. Can be used to modify volume while listening holdmusic.

public int AdjustHoldMusicVolume(int iVolume, bool bCommit)

Parameters

iVolume int

Volume

bCommit bool

True to make changes persitent.

Returns

int

HRESULT

CallsLoginsEnabled(out bool, out bool, out int)

returns if calls/logins are enabled.

public void CallsLoginsEnabled(out bool bCallsEnabled, out bool bLoginsAllowed, out int hr)

Parameters

bCallsEnabled bool

if true SwyxServer will allow calls to be established, otherwise all call attempts will fail

bLoginsAllowed bool

if true, SwyxServer will allow clients to login, otherwise all login attempts will fail

hr int

HRESULT

CancelCall(uint, out int)

Cancels a specified call.

public void CancelCall(uint CallID, out int hr)

Parameters

CallID uint

ID of call to be cancelled.

hr int

HRESULT

CheckCDRFilePath(string)

Check CDR file accesibility

public int CheckCDRFilePath(string sPath)

Parameters

sPath string

Path to be checked.

Returns

int

return S_OK given file can be accessed by SwyxServer for writing

CheckClientVersion()

Checks if the client version is supported by the server.

public void CheckClientVersion()

CheckFeatureList(int, FeatureList)

Checks the Features for the given user. All features in the given list will be checked the flags Enabled and Licensed will be set.

public void CheckFeatureList(int UserID, FeatureList featureList)

Parameters

UserID int

The UserID of the User. The UserID will be used to retrieve the Enabled information. Set UserID to 0 to retrieve license information only

featureList FeatureList

The list of feature to be checked

CheckLinkAddress(string, ref int)

check link address tries a DNS name resolution on the given name first. If this succeeds, tries to connect to the well known H.323 port on the given address and returns the result.

public int CheckLinkAddress(string LinkRemoteAddress, ref int iResult)

Parameters

LinkRemoteAddress string

DNS name or IP-address in dot-notation to check. Examples: lothlorien.middle-earth.com, 3.1.189.2

iResult int

result of link address check, one of SCl5CheckLinkAddressResult values

Returns

int

HRESULT

CheckPublicNumberForOverlappedDialingIntegrity(string)

Checks if the number for overlapped dialing integrity.

public bool CheckPublicNumberForOverlappedDialingIntegrity(string PublicNumber)

Parameters

PublicNumber string

The number

Returns

bool

true or false

CheckVersion()

public void CheckVersion()

ClearInstanceId()

public void ClearInstanceId()

CreateActivationKey()

public string CreateActivationKey()

Returns

string

CreateClient(Binding, EndpointAddress)

protected override AdminFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

AdminFacadeClient

CreateClientCertificate(int, string)

public bool CreateClientCertificate(int UserID, string Password)

Parameters

UserID int

Password string

Returns

bool

CreateRootAndServerCertificate(string, bool)

public void CreateRootAndServerCertificate(string Password, bool systemManagedCertificateSecuirty)

Parameters

Password string

systemManagedCertificateSecuirty bool

CreateRootAndServerCertificateAsync(string, bool)

public void CreateRootAndServerCertificateAsync(string Password, bool systemManagedCertificateSecuirty)

Parameters

Password string

systemManagedCertificateSecuirty bool

CreateRootCertificate(string, out string)

public bool CreateRootCertificate(string Password, out string Thumbprint)

Parameters

Password string

Thumbprint string

Returns

bool

CreateServerCertificate(string, out string)

public bool CreateServerCertificate(string Password, out string Thumbprint)

Parameters

Password string

Thumbprint string

Returns

bool

DecodeLicenses(byte[], out int)

public SCl4LicenseInfoList DecodeLicenses(byte[] KeyBuffer, out int hr)

Parameters

KeyBuffer byte[]

hr int

Returns

SCl4LicenseInfoList

DeleteAdminUser(int)

Deletes an administrative windows user from pbx.

public bool DeleteAdminUser(int AdminUserID)

Parameters

AdminUserID int

id of user to be deleted

Returns

bool

true if succeeded

DeleteClientCertificate()

public bool DeleteClientCertificate()

Returns

bool

DeleteConnectedSite(int)

Removes connected site with all its data

public bool DeleteConnectedSite(int iSiteID)

Parameters

iSiteID int

Teh local id of the site.

Returns

bool

DeleteEditablePhoneBookEntry(int)

Deletes an new PhoneBookEntry directly

public void DeleteEditablePhoneBookEntry(int EntryID)

Parameters

EntryID int

The EntryID of the entry to be deleted.

DeleteFederatedIdentity(int)

public bool DeleteFederatedIdentity(int userId)

Parameters

userId int

Returns

bool

DeleteFromFreeNumbersList(string)

Deletes a number from free public number list

public int DeleteFromFreeNumbersList(string number)

Parameters

number string

public number

Returns

int

id of portnumberrange or 0

DeleteIdentityFederationEndpointConfiguration(FederationEndpointType)

public bool DeleteIdentityFederationEndpointConfiguration(FederationEndpointType type)

Parameters

type FederationEndpointType

Returns

bool

DeleteOutboundHttpProxyCredentials()

public void DeleteOutboundHttpProxyCredentials()

DeletePhoneControllerAddressRange(int, int)

Deletes specific address range

public void DeletePhoneControllerAddressRange(int PhoneControllerID, int AddressRangeID)

Parameters

PhoneControllerID int

Id of the PhoneControllerConfiguration

AddressRangeID int

Id of the Address range

DeletePhoneControllerAddressRanges(int)

Deletes all AddressRanges from a PhoneControllerConfiguration

public void DeletePhoneControllerAddressRanges(int PhoneControllerID)

Parameters

PhoneControllerID int

Id of the PhoneControllerConfiguration

DeletePhoneControllerConfiguration(int)

Deletes a PhoneControllerConfiguration

public void DeletePhoneControllerConfiguration(int PhoneControllerID)

Parameters

PhoneControllerID int

DeleteRootCertificate()

public bool DeleteRootCertificate()

Returns

bool

DeleteS3Configuration()

public void DeleteS3Configuration()

DeleteServerCertificate()

public bool DeleteServerCertificate()

Returns

bool

DeleteSignalRelation(int)

Deletes a single SignalRelationEntry

public bool DeleteSignalRelation(int SignalRelationID)

Parameters

SignalRelationID int

ID of entry to be deleted.

Returns

bool

True if delete was successfull.

DeleteTrunkRecording(int)

public bool DeleteTrunkRecording(int trunkRecordingId)

Parameters

trunkRecordingId int

Returns

bool

DeleteTrunkRecordings(List<int>)

public bool DeleteTrunkRecordings(List<int> trunkRecordingIds)

Parameters

trunkRecordingIds List<int>

Returns

bool

Dispose()

public virtual void Dispose()

EnableCallsLogins(bool, bool, out int)

Enable/disable all calls/logins Requires role ServerDisableCallsLogins

public void EnableCallsLogins(bool bEnableCalls, bool bEnableLogins, out int hr)

Parameters

bEnableCalls bool

bEnableLogins bool

hr int

HRESULT

FindAndPersistFreeNumbers(int, bool)

Find free public numbers and store them into database for fast access if list of free numbers is exceeded

public void FindAndPersistFreeNumbers(int rangeId, bool reset)

Parameters

rangeId int

id of number range

reset bool

If true the number will be cleared before

FirmwareUpdateAvaiable(out int)

Retrieves if firmware update is avaiable (L420)

public bool FirmwareUpdateAvaiable(out int hr)

Parameters

hr int

Returns

bool

ForceLogoffTrunk(int)

The specified trunk will be logged of from the pbx. This operation is not synchron.

public int ForceLogoffTrunk(int TrunkID)

Parameters

TrunkID int

Trunk

Returns

int

HRESULT

ForceLogoffUser(int)

The specified user will be logged of from the pbx.

public int ForceLogoffUser(int UserID)

Parameters

UserID int

Returns

int

HRESULT

FreeForReuse()

public override void FreeForReuse()

GenerateLicenseRequest(SUIntList, SCl6LicenseCustomer, bool, bool, out SUIntList, out int)

public string GenerateLicenseRequest(SUIntList LicenseIds, SCl6LicenseCustomer Customer, bool bSentViaMail, bool bCopyToSender, out SUIntList Results, out int hr)

Parameters

LicenseIds SUIntList

Customer SCl6LicenseCustomer

bSentViaMail bool

bCopyToSender bool

Results SUIntList

hr int

Returns

string

GetAbandonedPublicNumbers(ICollection<int>)

Gets a list of public numbers that are not configured on trunk range other than the excluded ones

public ICollection<string> GetAbandonedPublicNumbers(ICollection<int> excludedRanges)

Parameters

excludedRanges ICollection<int>

Returns

ICollection<string>

List of public nuumbers

GetAbandonedPublicNumbersByNumberRangeList(NumberRangeAdminViewPrimaryCollection)

Returns a list of ids of all public numbers which does not fit to any of the given number ranges. The method is intended to be used before updating or deleting port number ranges to identify all numbers which will no longer be valid after the planned operation. The list of all number ranges can be retrieved by GetNumberRangeAdminView1.

public SIntList GetAbandonedPublicNumbersByNumberRangeList(NumberRangeAdminViewPrimaryCollection NumberRanges)

Parameters

NumberRanges NumberRangeAdminViewPrimaryCollection

List of all number ranges with planned chnages

Returns

SIntList

List of PublicNumberIDs

Remarks

The recommanded way of changing NumberRanges:

1. Call GetNumberRangeAdminView1 to retrieve all existing PortNumberRanges
2. Modify the list with the planned chnages. (add, remove, change entries ). (PortBundleName and PortName can be empty but not null)
3. Call GetAbandonedPublicNumbersByNumberRangeList with the modified list.
4. If returned list of abandoned public numbers is not empty. Remove the public numbers or abort your operation. (PublicNumberEnum)
5. Use PublicNumberEnum to apply the planned changes. It is highly recommanded that add operations will be seperately exceuted before delete operations. Otherwise it is possible to cause an contraint excpetion.

GetActivationKey()

public string GetActivationKey()

Returns

string

GetActivationStatus()

public LicenseActivationStatus GetActivationStatus()

Returns

LicenseActivationStatus

GetActiveCallsView()

Retrieves a collection conataining all active calls

public ActiveCallPrimaryCollection GetActiveCallsView()

Returns

ActiveCallPrimaryCollection

ActiveCallPrimaryCollection

GetActiveTrunkDevices()

Gets list of registered GetPossibleMappingFromRange devices

public ICollection<TrunkDeviceInfo> GetActiveTrunkDevices()

Returns

ICollection<TrunkDeviceInfo>

list

GetActiveUserDevices(int?)

Gets list of registered user devices

public ICollection<UserDeviceInfo> GetActiveUserDevices(int? userId)

Parameters

userId int?

id of the user

Returns

ICollection<UserDeviceInfo>

list

GetAdminProfilesView()

Retrieves list of all administrative profiles

public AdminProfilePrimaryCollection GetAdminProfilesView()

Returns

AdminProfilePrimaryCollection

Returns collection

GetAdminUsersView()

Retrieves list of all administrative windows accounts

public AdminUserPrimaryCollection GetAdminUsersView()

Returns

AdminUserPrimaryCollection

GetAllKindsOfChangeInfos()

Retrieves a translated list of all possible changelog entries

public ICollection<KindOfChangeInfo> GetAllKindsOfChangeInfos()

Returns

ICollection<KindOfChangeInfo>

GetAllSignalRelations()

Retieves a list of all SignaRelationEntries

public SignalRelationPrimaryCollection GetAllSignalRelations()

Returns

SignalRelationPrimaryCollection

Collection of SignaRelationEntries

GetAllSignalRelationsWithAggregatedType()

Retieves a list of all SignaRelationEntries

public SignalRelationsAggregatedTypePrimaryCollection GetAllSignalRelationsWithAggregatedType()

Returns

SignalRelationsAggregatedTypePrimaryCollection

Collection of SignaRelationEntries

GetCardPortList(string, bool)

Retrieves a list of all Isdn Ports of the host

public BoardConfigList GetCardPortList(string strHostName, bool bOnlyFree)

Parameters

strHostName string

bOnlyFree bool

Returns

BoardConfigList

List of sites.

GetChangeLog(SDateTime, SDateTime)

Retreives all change log entries from the given period

public ChangeLogPrimaryCollection GetChangeLog(SDateTime StartPeriod, SDateTime EndPeriod)

Parameters

StartPeriod SDateTime

Start point of the period. (Will be included)

EndPeriod SDateTime

End point of the period. (Will be excluded)

Returns

ChangeLogPrimaryCollection

Collection of ChangeLog Entries

Remarks

Use GetChangeLogPeriods() to get list of valid periods.

GetChangeLog(SDateTime, SDateTime, bool, string)

Retrieves all change log entries from the given period export its to a file and delete the log in database

public ChangeLogPrimaryCollection GetChangeLog(SDateTime StartPeriod, SDateTime EndPeriod, bool deleteLog, string exportFile)

Parameters

StartPeriod SDateTime

Start point of the period. (Will be included)

EndPeriod SDateTime

End point of the period. (Will be excluded)

deleteLog bool

If true the data will be deleted in database. (Only if export path is not empty or null)

exportFile string

Returns

ChangeLogPrimaryCollection

Collection of ChangeLog Entries

Remarks

Use GetChangeLogPeriods() to get list of valid periods.

GetChangeLogPeriods()

Retrieves a list of periods that can be used with the method GetChangeLog(). The retreived list can contain monthly periods or the reporting periods in case of a hosted installation.

public ChangeLogPeriodList GetChangeLogPeriods()

Returns

ChangeLogPeriodList

List of valid periods.

Remarks

If the Reporting and Licensing Server in a hosted installation is not avaible the period list will contain monthly periods.

GetChangeLogWebView(DateTime, DateTime, int?, int?, out int)

Retrieves all change log entries from the given period export its to a file and delete the log in database

public ICollection<ChangeLogEntry> GetChangeLogWebView(DateTime start, DateTime end, int? page, int? pageSize, out int totalCount)

Parameters

start DateTime

end DateTime

page int?

pageSize int?

totalCount int

Returns

ICollection<ChangeLogEntry>

Collection of ChangeLog Entries

Remarks

Use GetChangeLogPeriods() to get list of valid periods.

GetChangeLogWebViewEntry(int)

Retrieves all change log entries from the given period export its to a file and delete the log in database

public ChangeLogEntry GetChangeLogWebViewEntry(int changeLogEntryId)

Parameters

changeLogEntryId int

id of the log entry

Returns

ChangeLogEntry

GetClientCertificate(int, out string)

public bool GetClientCertificate(int UserID, out string Certificate)

Parameters

UserID int

Certificate string

Returns

bool

GetClientSettings(int)

Gets client settings for a user

public ClientSettingParameters GetClientSettings(int userId)

Parameters

userId int

user id

Returns

ClientSettingParameters

Result object with detailed information

GetConnectedSites()

Retrieves a list of al connected stes

public ConnectedSitePrimaryCollection GetConnectedSites()

Returns

ConnectedSitePrimaryCollection

List of sites.

GetControlCenterConfiguration()

public ControlCenterConfigurationInfo GetControlCenterConfiguration()

Returns

ControlCenterConfigurationInfo

GetCurrentUserDevices(int)

public UserDeviceList GetCurrentUserDevices(int iUserID)

Parameters

iUserID int

Returns

UserDeviceList

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetCurrentUserName(ref string)

public int GetCurrentUserName(ref string UserName)

Parameters

UserName string

Returns

int

GetCurrentUserRoles(out string, out bool, out bool, out bool, out bool)

public ICollection<BuildInRoles> GetCurrentUserRoles(out string administrativeProfile, out bool isServerAdmin, out bool isProviderAdmin, out bool isResellerAdmin, out bool isTenantAdmin)

Parameters

administrativeProfile string

isServerAdmin bool

isProviderAdmin bool

isResellerAdmin bool

isTenantAdmin bool

Returns

ICollection<BuildInRoles>

GetCustomerInformation(out int)

Retreives the Customer Information Class

public SCl6LicenseCustomer GetCustomerInformation(out int hr)

Parameters

hr int

COM Result in RCW.

Returns

SCl6LicenseCustomer

TSCl6LicenseCustomer

GetDCFLocalWebAccessPassword()

public string GetDCFLocalWebAccessPassword()

Returns

string

GetDatabaseUsageInformations(out long, out long, out long, out long, out long, out long)

Retrieves the current usage information from the database.

public string GetDatabaseUsageInformations(out long UsedSpaceKB, out long MaxSizeKB, out long TotalUserFileSizeKB, out long TotalSystemFileSizeKB, out long TotalUserUncompressedFileSizeKB, out long TotalSystemUncompressedFileSizeKB)

Parameters

UsedSpaceKB long

The currently used space of the database in kb. The size is of the database file is commonly geater.

MaxSizeKB long

The allowed maximum size of the database in kb. -1 if there is no limitation.

TotalUserFileSizeKB long

The total size of all user files in the database.

TotalSystemFileSizeKB long

The total size of all system files in the database.

TotalUserUncompressedFileSizeKB long

TotalSystemUncompressedFileSizeKB long

Returns

string

String containing the product name of the database server.

GetDependantPublicNumbersByNumberRange(PortNumberRangeType, string, string, string, string, string, string)

Retrieves the depandant public numbers of this PortNumberRange.

public SStringList GetDependantPublicNumbersByNumberRange(PortNumberRangeType RangeType, string CountryCode, string AreaCode, string HeadNumber, string TailNumberStart, string TailNumberEnd, string Realm)

Parameters

RangeType PortNumberRangeType

Type of the range (Number, Sip Uri)

CountryCode string

The CountryCode. Empty in case of SipUri

AreaCode string

The AreaCode. Empty in case of SipUri

HeadNumber string

Subscriber number, or sip uri

TailNumberStart string

First extension, or MSN

TailNumberEnd string

Last extension od MSN

Realm string

realm of a sip uiri

Returns

SStringList

List of public numbers

GetDependantPublicNumbersByNumberRange(int)

Retrieves the exclusivly depandant public numbers of this PortNumberRange.

public SStringList GetDependantPublicNumbersByNumberRange(int PortNumberRangeID)

Parameters

PortNumberRangeID int

Id of the number range

Returns

SStringList

List of public numbers

GetDependantPublicNumbersByPort(int)

Retrieves the exclusivly depandant public numbers of this port.

public SStringList GetDependantPublicNumbersByPort(int PortID)

Parameters

PortID int

Id of the port

Returns

SStringList

List of public numbers

GetDnsRegistration(string)

public DnsRegistration GetDnsRegistration(string configName = "IpPbxServer")

Parameters

configName string

Returns

DnsRegistration

GetEnabledFeaturesList(out int)

public SCLLicensedFeatureList GetEnabledFeaturesList(out int hr)

Parameters

hr int

Hresult value, all HRESULT failures will cause an SCOMException including the value.

Returns

SCLLicensedFeatureList

Remarks

Do not use this method to retrieve license information at runtime. Use CheckFeatureList instead.

GetEntitiesCountInfo()

public EntitiesCountInfo GetEntitiesCountInfo()

Returns

EntitiesCountInfo

GetFederationConfig()

public FederationConfig GetFederationConfig()

Returns

FederationConfig

GetFederationIdentities()

public UserListFromFederationIdProvider GetFederationIdentities()

Returns

UserListFromFederationIdProvider

GetFederationLog(FederationLogQuery, out int)

public ICollection<FederationLogEntry> GetFederationLog(FederationLogQuery queryParameter, out int totalCount)

Parameters

queryParameter FederationLogQuery

totalCount int

Returns

ICollection<FederationLogEntry>

GetFileSystemConfiguration()

public FileSystemConfigurationInfo GetFileSystemConfiguration()

Returns

FileSystemConfigurationInfo

GetFirstAdminUserWebViewEntry()

public UserWebInfo GetFirstAdminUserWebViewEntry()

Returns

UserWebInfo

GetFisConnectionInfo()

public FisConnectionInfo GetFisConnectionInfo()

Returns

FisConnectionInfo

GetFreePublicNumberFromRange(int)

Get first unused number from number range

public string GetFreePublicNumberFromRange(int rangeId)

Parameters

rangeId int

Returns

string

GetGroupAdminView1()

Retrieves a collection with all groups including data displayed in an admin client view.

public GroupAdminView1PrimaryCollection GetGroupAdminView1()

Returns

GroupAdminView1PrimaryCollection

Collection of GroupAdminView1Entries

GetGroupMemberWebAdminView(int, out int, int?, int?)

public ICollection<GroupMemberWebInfo> GetGroupMemberWebAdminView(int groupId, out int toatalCount, int? page = null, int? pageSize = null)

Parameters

groupId int

toatalCount int

page int?

pageSize int?

Returns

ICollection<GroupMemberWebInfo>

GetGroupSignalRelations(int, bool)

Retrieves a list of all SignalRelationEntries assigned to the given group

public SignalRelationPrimaryCollection GetGroupSignalRelations(int GroupID, bool bBothDirections)

Parameters

GroupID int

The ID of the group.

bBothDirections bool

Returns

SignalRelationPrimaryCollection

Collection of SignaRelationEntries

GetHoldMusicVolume(out int)

Retrieves the current hold music volume from the IpPbxServer

public int GetHoldMusicVolume(out int iVolume)

Parameters

iVolume int

volumne

Returns

int

HRESULT

GetIFBServerStateAndType(out bool, out bool, out int)

get state and type of server

public StandbyServerType GetIFBServerStateAndType(out bool bActive, out bool bConnected, out int hr)

Parameters

bActive bool

true if server is active

bConnected bool

true is keep alive connection is established

hr int

HRESULT from COM

Returns

StandbyServerType

Type of server

GetIFBStates(out int)

Get states and further data of server and connected clients

public SClKeepAliveStates GetIFBStates(out int hr)

Parameters

hr int

HRESULT value from COM call.

Returns

SClKeepAliveStates

GetIdentityFederationEndpointAuthenticationCertificate(FederationEndpointType, out byte[])

public bool GetIdentityFederationEndpointAuthenticationCertificate(FederationEndpointType type, out byte[] certData)

Parameters

type FederationEndpointType

certData byte[]

Returns

bool

GetIdentityFederationEndpointConfiguration(FederationEndpointType)

public FederationEndpointConfiguration GetIdentityFederationEndpointConfiguration(FederationEndpointType type)

Parameters

type FederationEndpointType

Returns

FederationEndpointConfiguration

GetInstanceId()

public string GetInstanceId()

Returns

string

GetInternalAndExternalNumbersView()

Retrieves a list of all internal and external numbers for configuration of undeliverable calls number on locations

public InternalAndExternalNumbersViewPrimaryCollection GetInternalAndExternalNumbersView()

Returns

InternalAndExternalNumbersViewPrimaryCollection

List of numbers with additional information.

GetInternalNumberInfos()

Gets the internal numbers infos coresponding to a specified tenant.

public IEnumerable<InternalNumberInfo> GetInternalNumberInfos()

Returns

IEnumerable<InternalNumberInfo>

The user's internal numbers.

GetLdapConfigurationInfo()

public LdapConfigurationInfo GetLdapConfigurationInfo()

Returns

LdapConfigurationInfo

GetLicenseAlerts()

public List<LicenseAlertInfo> GetLicenseAlerts()

Returns

List<LicenseAlertInfo>

GetLicenseInfo()

public LicenseInfoCollections GetLicenseInfo()

Returns

LicenseInfoCollections

GetLicenseInfoForUnmanaged()

public LicenseInfoCollection GetLicenseInfoForUnmanaged()

Returns

LicenseInfoCollection

GetLicenseInfoList(out int)

Retrieves a collection conataining all liscense infos

public SCl4LicenseInfoList GetLicenseInfoList(out int hr)

Parameters

hr int

Returns

SCl4LicenseInfoList

TSCl4LicenseInfoList

Remarks

Do not use this method to retrieve license information at runtime. Use CheckFeatureList instead.

GetLicenseParameter(uint, out int)

Retrieves the TSCl4LicenseInfo of a specific License.

public SCl4LicenseInfo GetLicenseParameter(uint LicenseId, out int hr)

Parameters

LicenseId uint

Id of the License

hr int

COM Result in RCW.

Returns

SCl4LicenseInfo

TSCl4LicenseInfo

Remarks

Do not use this method to retrieve license information at runtime. Use CheckFeatureList instead.

GetLicenseSystemChangeLog()

Retrieves all change log entries written by the license system. Licnese System us writing chagelog entries while changing tge configuration because of missing licenses

public ChangeLogPrimaryCollection GetLicenseSystemChangeLog()

Returns

ChangeLogPrimaryCollection

Collection of ChangeLog Entries

GetLicenseSystemChangeLogWebView(DateTime, DateTime, int?, int?, out int)

Retrieves all change log entries created by the license system from the given period export its to a file and delete the log in database

public ICollection<ChangeLogEntry> GetLicenseSystemChangeLogWebView(DateTime start, DateTime end, int? page, int? pageSize, out int totalCount)

Parameters

start DateTime

end DateTime

page int?

pageSize int?

totalCount int

Returns

ICollection<ChangeLogEntry>

Collection of ChangeLog Entries

Remarks

Use GetChangeLogPeriods() to get list of valid periods.

GetLicenseUsageList()

public LicenseUsageList GetLicenseUsageList()

Returns

LicenseUsageList

GetLicensingServerBaseAddress()

public string GetLicensingServerBaseAddress()

Returns

string

GetLooseConnectedSiteIDs()

Retrieves a list of al connected stes

public SIntList GetLooseConnectedSiteIDs()

Returns

SIntList

List of sites.

GetNetPromoterScoreConfiguration()

public ProductNetPromoterScoreConfiguration GetNetPromoterScoreConfiguration()

Returns

ProductNetPromoterScoreConfiguration

GetNextExpirationDate(out int)

Returns date when the next license expires. If you've any non-permanent license this function returns the earliest date when one of them expires.

public SDateTime GetNextExpirationDate(out int hr)

Parameters

hr int

HRESULT

Returns

SDateTime

Expirationdate date when the next license expires.

GetNumberMappingsAdminView1()

Retrieves a collection with all numbermappings including data displayed in an admin client view.

public NumberMappingAdminViewPrimaryCollection GetNumberMappingsAdminView1()

Returns

NumberMappingAdminViewPrimaryCollection

Collection of NumberMappingAdminViewEntries

GetNumberOfConferenceRooms()

Returns the number of configured conferecne rooms. (Number of internal numbers of all conference users.)

public int GetNumberOfConferenceRooms()

Returns

int

GetNumberRangeAdminView1()

Retrieves a collection (view) with all trunk number ranges.

public NumberRangeAdminViewPrimaryCollection GetNumberRangeAdminView1()

Returns

NumberRangeAdminViewPrimaryCollection

Collection of NumberRangeAdminViewEntry

GetOSVersion()

Retrieves the OSVersion from the server. The returning class is similar to System.OperatingSystem.

public TOperatingSystem GetOSVersion()

Returns

TOperatingSystem

GetOutboundHttpProxyAddress()

public string GetOutboundHttpProxyAddress()

Returns

string

GetOutboundHttpProxyCredentials()

public string GetOutboundHttpProxyCredentials()

Returns

string

GetPbxServiceIpAddress()

public string GetPbxServiceIpAddress()

Returns

string

GetPhoneControllerConfiguration(int)

Retrieves the Phonecontroller Configuration. Also a the CDS suppots more than one Phonecontroller there will always be only one.

public PhoneControllerPrimaryCollection GetPhoneControllerConfiguration(int PhoneControllerID)

Parameters

PhoneControllerID int

0 for all PhoneControllers

Returns

PhoneControllerPrimaryCollection

Collection of PhoneController configuration inluding address ranges.

GetPhoneControllerState()

Retrieves scanning state of the PhoneController

public int GetPhoneControllerState()

Returns

int

The state value

GetPhoneControllerState(out int)

Retrieves scanning state of the PhoneController

[Obsolete("Replaced by GetPhoneControllerState()")]
public int GetPhoneControllerState(out int hr)

Parameters

hr int

Returns

int

GetPossibleIpPbxUserNames()

Returns all possible IpPbx User Names of the current user. Can be more than one if the current user is a windows user and multiple IppPbxUser are assigned to his windows account.

public SStringList GetPossibleIpPbxUserNames()

Returns

SStringList

StringList

GetProductInfo(out int)

Retrieves product info about IpPbxServer

public TIpPbxProductInformation3 GetProductInfo(out int hr)

Parameters

hr int

HRESULT

Returns

TIpPbxProductInformation3

TIpPbxProductInformation3

GetPublicNumberOwner(string, out bool, out bool, out int, out string)

Searches for the owner of a public number.

public void GetPublicNumberOwner(string PublicNumber, out bool UserFound, out bool GroupFound, out int FoundEntryID, out string FoundName)

Parameters

PublicNumber string

Public number in canocical form.

UserFound bool

Returns true if a user was found.

GroupFound bool

Returns true if a group was found.

FoundEntryID int

The id (user or group) of the owner.

FoundName string

The name of the owner.

GetRecordingCodecs()

Retreives the list of known recording codecs. The list contains the builtin codes and custom codec, defined in file CustomCodecs.xml

public RecordingCodecList GetRecordingCodecs()

Returns

RecordingCodecList

List of recording codecs

GetRemoteConnectorCertificateInfo()

public RemoteConnectorCertificateInfo GetRemoteConnectorCertificateInfo()

Returns

RemoteConnectorCertificateInfo

GetRequiredUpdateLicenses(out int)

public SCl4LicenseInfoList GetRequiredUpdateLicenses(out int hr)

Parameters

hr int

Returns

SCl4LicenseInfoList

GetResellerInfo()

public TenantPbxInstanceResellerInfo GetResellerInfo()

Returns

TenantPbxInstanceResellerInfo

GetRootAndServerCertificate(out string)

public bool GetRootAndServerCertificate(out string Certificates)

Parameters

Certificates string

Returns

bool

GetRoutingTableAdminView1()

Retrieves a collection with all rounting entries including data displayed in an admin client view.

public RoutingTableAdminView1PrimaryCollection GetRoutingTableAdminView1()

Returns

RoutingTableAdminView1PrimaryCollection

Collection of RoutingTableAdminView1Entries

GetRoutingTableAdminView2(out AutomaticRoutingTableAdminViewPrimaryCollection)

Retrieves a collection with all rounting entries including data displayed in an admin client view.

public RoutingTableAdminView1PrimaryCollection GetRoutingTableAdminView2(out AutomaticRoutingTableAdminViewPrimaryCollection cAutomaticRoutingTable)

Parameters

cAutomaticRoutingTable AutomaticRoutingTableAdminViewPrimaryCollection

Returns

RoutingTableAdminView1PrimaryCollection

Collection of RoutingTableAdminView1Entries

GetS3Configuration()

public S3ConfigurationInfo GetS3Configuration()

Returns

S3ConfigurationInfo

GetScstCertificateInfo(string)

public ScstCertificateInfo GetScstCertificateInfo(string name = "IpPbxServer")

Parameters

name string

Returns

ScstCertificateInfo

GetScstConfiguration(string)

public ScstConfiguration GetScstConfiguration(string name = "IpPbxServer")

Parameters

name string

Returns

ScstConfiguration

GetServerDateTimeNow()

public SDateTime GetServerDateTimeNow()

Returns

SDateTime

GetServerRequestTimeout(AdminFacadeClient)

protected override TimeSpan GetServerRequestTimeout(AdminFacadeClient client)

Parameters

client AdminFacadeClient

Returns

TimeSpan

GetServerSerialNumber(out uint, out int)

returns the server serial number which is the serial number of the server license

public string GetServerSerialNumber(out uint Result, out int hr)

Parameters

Result uint

result of the query. Will be one of the SCl4LicenseResult values

hr int

HRESULT

Returns

string

server serial number

GetServerSerialNumberFromLicenseManager()

returns the server serial number which is the serial number of the server license. The source of the information is the LicenseManager. In an HSW installations the serial number is originated in the license of the License and Reporting server.

public string GetServerSerialNumberFromLicenseManager()

Returns

string

server serial number

GetServiceSettings()

public List<ServiceSetting> GetServiceSettings()

Returns

List<ServiceSetting>

GetSidNTAccountList()

returns all SIDs assigned to users with a AccountName

public SIDNTAccountPrimaryCollection GetSidNTAccountList()

Returns

SIDNTAccountPrimaryCollection

List of SID, AccountName tupels.

GetSignalDestination(int, SignalType)

Retrieves an array of UserIDs containing the Ids of all Users which are configured for signalization.

public TUserID[] GetSignalDestination(int UserID, SignalType signalType)

Parameters

UserID int

The source user.

signalType SignalType

The type of signalization

Returns

TUserID[]

Array of UserIDs to be signaled

GetSignalRelationsView(int?, int?, string, out int, int?, int?)

public ICollection<SignalRelationWebInfo> GetSignalRelationsView(int? userId, int? groupId, string filter, out int count, int? page, int? pageSize)

Parameters

userId int?

groupId int?

filter string

count int

page int?

pageSize int?

Returns

ICollection<SignalRelationWebInfo>

GetSignalSenders(int, SignalType)

Retrieves an array of UserIDs containing the Ids of all Users which are possible signalization senders of the given user.

public TUserID[] GetSignalSenders(int UserID, SignalType signalType)

Parameters

UserID int

The destination user.

signalType SignalType

The type of signalization

Returns

TUserID[]

Array of UserIDs

GetSslCertificateInfoForPort9100()

public SslCertificateInfo GetSslCertificateInfoForPort9100()

Returns

SslCertificateInfo

GetSslCertificateInfoForPort9101()

public SslCertificateInfo GetSslCertificateInfoForPort9101()

Returns

SslCertificateInfo

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetTechnicalContact()

public TechnicalContact GetTechnicalContact()

Returns

TechnicalContact

GetTechnicalContactConfiguration()

public TechnicalContactConfiguration GetTechnicalContactConfiguration()

Returns

TechnicalContactConfiguration

GetTenantFileQuotaInfo()

public TenantFileQuotaInfo GetTenantFileQuotaInfo()

Returns

TenantFileQuotaInfo

GetThumbprint(int, out string, out bool)

public bool GetThumbprint(int UserID, out string Thumbprint, out bool CertificateAvailable)

Parameters

UserID int

Thumbprint string

CertificateAvailable bool

Returns

bool

GetThumbprint2(int, out bool, out bool)

public string GetThumbprint2(int UserID, out bool CertificateAvailable, out bool result)

Parameters

UserID int

CertificateAvailable bool

result bool

Returns

string

GetTotalLicenseSummary(out int)

public SCl9TotalLicenseSummary GetTotalLicenseSummary(out int hr)

Parameters

hr int

Returns

SCl9TotalLicenseSummary

GetTotalLicenseSummary14(out int)

public SCl14TotalLicenseSummary GetTotalLicenseSummary14(out int hr)

Parameters

hr int

Returns

SCl14TotalLicenseSummary

GetTotalLicenseSummary15(out int)

public SCl15TotalLicenseSummary GetTotalLicenseSummary15(out int hr)

Parameters

hr int

Returns

SCl15TotalLicenseSummary

GetTotalLicenseSummary16(out int)

public SCl16TotalLicenseSummary GetTotalLicenseSummary16(out int hr)

Parameters

hr int

Returns

SCl16TotalLicenseSummary

GetTotalLicenses(out uint, out uint, out uint, out uint, out int)

public void GetTotalLicenses(out uint EffectiveTotalUsers, out uint EffectiveTotalChannels, out uint UserResult, out uint ChannelResult, out int hr)

Parameters

EffectiveTotalUsers uint

EffectiveTotalChannels uint

UserResult uint

ChannelResult uint

hr int

GetTranscriptionServiceInfo()

public TranscriptionServiceInfo GetTranscriptionServiceInfo()

Returns

TranscriptionServiceInfo

GetTrunkAdminView1()

Retrieves a collection with all trunks including data displayed in an admin client view.

public TrunkAdminView1PrimaryCollection GetTrunkAdminView1()

Returns

TrunkAdminView1PrimaryCollection

Collection of TrunkAdminView1Entries

GetTrunkAdminView1ByMatchingPublicNumber(string)

Retrieves a collection with all trunks including data displayed in an admin client view. Only trunks with matching number range will be returned.

public TrunkAdminView1PrimaryCollection GetTrunkAdminView1ByMatchingPublicNumber(string PublicNumber)

Parameters

PublicNumber string

The given public number in canonical form.

Returns

TrunkAdminView1PrimaryCollection

Collection of TrunkAdminView1Entries

GetTrunkGroupAdminView1()

Retrieves a collection with all trunk groups including data displayed in an admin client view.

public TrunkGroupAdminView1PrimaryCollection GetTrunkGroupAdminView1()

Returns

TrunkGroupAdminView1PrimaryCollection

Collection of GroupAdminView1Entries

GetTrunkRecording(int)

public TrunkRecordingViewEntry GetTrunkRecording(int trunkRecordingId)

Parameters

trunkRecordingId int

Returns

TrunkRecordingViewEntry

GetTrunkRecordingLog(TrunkRecordingLogQueryParameters, out int)

public ICollection<TrunkRecordingLogEntry> GetTrunkRecordingLog(TrunkRecordingLogQueryParameters parameters, out int totalCount)

Parameters

parameters TrunkRecordingLogQueryParameters

totalCount int

Returns

ICollection<TrunkRecordingLogEntry>

GetTrunkRecordingView(TrunkRecordingQueryParameters, out int)

public List<TrunkRecordingViewEntry> GetTrunkRecordingView(TrunkRecordingQueryParameters parameters, out int totalCount)

Parameters

parameters TrunkRecordingQueryParameters

totalCount int

Returns

List<TrunkRecordingViewEntry>

GetTwoFactorAuthenticationRequiredForAllAdminProfiles()

public bool GetTwoFactorAuthenticationRequiredForAllAdminProfiles()

Returns

bool

GetUniqueServerID()

public Guid GetUniqueServerID()

Returns

Guid

GetUnusedPin(byte)

Retreives an unsed LanPhonePin

public string GetUnusedPin(byte PinLength)

Parameters

PinLength byte

Lenght of genereated pin

Returns

string

The generated pin.

GetUsedSubstitutionNumbersByGroup(int)

Returns a list of public numbers of the given group, that are used as substituted numbers by other users or groups. The retrieved list contains the Number, the UserID of the other users, and optionally the GroupID.

public UsedSubstitutionNumberPrimaryCollection GetUsedSubstitutionNumbersByGroup(int GroupID)

Parameters

GroupID int

ID of the given group

Returns

UsedSubstitutionNumberPrimaryCollection

List of containing the numbers, and IDs of the Groups and Users which are using the number

GetUsedSubstitutionNumbersByInternalNumber(int)

Returns a list of users or groups that are using this internal number as substituted number. The retrieved list contains the Number, the UserID of the other users, and optionally the GroupID.

public UsedSubstitutionNumberPrimaryCollection GetUsedSubstitutionNumbersByInternalNumber(int InternalNumberID)

Parameters

InternalNumberID int

Returns

UsedSubstitutionNumberPrimaryCollection

List of containing the numbers, and IDs of the Groups and Users which are using the number

GetUsedSubstitutionNumbersByUser(int)

Returns a list of public numbers of the given user, that are used as substituted numbers by other users or groups. The retrieved list contains the Number, the UserID of the other users, and optionally the GroupID.

public UsedSubstitutionNumberPrimaryCollection GetUsedSubstitutionNumbersByUser(int UserID)

Parameters

UserID int

ID of the given user

Returns

UsedSubstitutionNumberPrimaryCollection

List of containing the numbers, and IDs of the Groups and Users which are using the number

GetUserAdminView1(bool, out UserDeviceSmallMap)

Retrieves a collection with all users including data displayed in an admin client view.

public UserAdminView1PrimaryCollection GetUserAdminView1(bool showUserFileSize, out UserDeviceSmallMap userDeviceMap)

Parameters

showUserFileSize bool

If true the UserFile Size will be filled.

userDeviceMap UserDeviceSmallMap

Returns

UserAdminView1PrimaryCollection

Collection of UserAdminView1Entries

GetUserAdminView1(int, bool, out UserDeviceSmallMap)

Retrieves a collection with all users of a group including data displayed in an admin client view.

public UserAdminView1PrimaryCollection GetUserAdminView1(int GroupID, bool ShowUserFileSize, out UserDeviceSmallMap deviceMap)

Parameters

GroupID int

Show only you users of this group

ShowUserFileSize bool

deviceMap UserDeviceSmallMap

Returns

UserAdminView1PrimaryCollection

Collection of UserAdminView1Entries

GetUserAdminView1ByLocation(int, bool, out UserDeviceSmallMap)

Retrieves a collection with all users of a group including data displayed in an admin client view.

public UserAdminView1PrimaryCollection GetUserAdminView1ByLocation(int LocationID, bool ShowUserFileSize, out UserDeviceSmallMap deviceMap)

Parameters

LocationID int

ShowUserFileSize bool

deviceMap UserDeviceSmallMap

Returns

UserAdminView1PrimaryCollection

Collection of UserAdminView1Entries

GetUserAdminView1ForOneUser(int, bool, out UserDeviceSmallMap)

Retrieves a collection with on user including data displayed in an admin client view.

public UserAdminView1PrimaryCollection GetUserAdminView1ForOneUser(int UserID, bool ShowUserFileSize, out UserDeviceSmallMap deviceMap)

Parameters

UserID int

Show only this user

ShowUserFileSize bool

deviceMap UserDeviceSmallMap

Returns

UserAdminView1PrimaryCollection

Collection of UserAdminView1Entries

GetUserApiRoles(int)

public UserApiRoles GetUserApiRoles(int userId)

Parameters

userId int

Returns

UserApiRoles

GetUserIdByLogin(string)

return the UserId of the user with the given login

public int GetUserIdByLogin(string login)

Parameters

login string

Login. Front part of the unique principal name

Returns

int

UserdId or 0 if no user exists with the given login

GetUserInternalNumbers()

Gets the internal numbers assigned to the users coresponding to a specified tenant.

public IEnumerable<InternalNumberInfo> GetUserInternalNumbers()

Returns

IEnumerable<InternalNumberInfo>

The user's internal numbers.

GetUserWebAdminView(UserViewParameters, out int)

public ICollection<UserWebInfo> GetUserWebAdminView(UserViewParameters parameters, out int totalCount)

Parameters

parameters UserViewParameters

totalCount int

Returns

ICollection<UserWebInfo>

GetUserWebAdminView(int)

public UserWebInfo GetUserWebAdminView(int userId)

Parameters

userId int

Returns

UserWebInfo

GetUserWebAdminViewCount(bool, string)

public int GetUserWebAdminViewCount(bool onlyAdmins = false, string name = null)

Parameters

onlyAdmins bool

name string

Returns

int

GetUsersSignalRelations(int, bool)

Retieves a list of all SignaRelationEntries assigned to the given user

public SignalRelationPrimaryCollection GetUsersSignalRelations(int UserID, bool bBothDirections)

Parameters

UserID int

The ID of the user.

bBothDirections bool

Returns

SignalRelationPrimaryCollection

Collection of SignaRelationEntries

HasMailbox(string, string, string, out SMailBoxInfo)

Verify exchange mailbox. Returns S_OK if the given name can be resolved to an exchange mailbox

public int HasMailbox(string Name, string DisplayName, string MailBoxID, out SMailBoxInfo cMailBoxInfo)

Parameters

Name string

name to verify

DisplayName string

display name of the exchange mailbox

MailBoxID string

unique identifier of the mailbox (Use this parameter in Users.UserEntry)

cMailBoxInfo SMailBoxInfo

Returns

int

S_OK when name could be resolved to an exchange mailbox

HasMailbox(string, ref string, ref string)

Verify exchange mailbox. Returns S_OK if the given name can be resolved to an exchange mailbox

public int HasMailbox(string Name, ref string DisplayName, ref string MailBoxID)

Parameters

Name string

name to verify

DisplayName string

display name of the exchange mailbox

MailBoxID string

unique identifier of the mailbox (Use this parameter in Users.UserEntry)

Returns

int

S_OK when name could be resolved to an exchange mailbox

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

InitLicensing()

(Re)Inits the licensing mananger in the CDSService. In case of HSW the CDS will reregister at the License and Report Service

public void InitLicensing()

IsClientCertificateAvailable()

public bool IsClientCertificateAvailable()

Returns

bool

IsConnectionToSwyxONEstablished()

public bool IsConnectionToSwyxONEstablished()

Returns

bool

IsFeatureInstalled(Guid, out int)

Checks if a license for this feature is installed and valid.

public bool IsFeatureInstalled(Guid FeatureGUID, out int hr)

Parameters

FeatureGUID Guid

hr int

Hresult value, all HRESULT failures will cause an SCOMException including the value.

Returns

bool

Remarks

Do not use this method to retrieve license information at runtime. Use CheckFeatureList instead.

IsNameUniqueWithinSwyxWare(string, EntityIdentifierType, int)

public bool IsNameUniqueWithinSwyxWare(string name, EntityIdentifierType entityType, int id = 0)

Parameters

name string

entityType EntityIdentifierType

id int

Returns

bool

IsPinUnused(string)

Checks if the given LanPhonePin in unused. (LanPhonePin must be uniuqe)

public bool IsPinUnused(string LanPhonePin)

Parameters

LanPhonePin string

Pin to be checked.

Returns

bool

True or False

IsPublicNumberConfiguredOnTrunk(string)

Checks if the given number is configured on a trunk.

public bool IsPublicNumberConfiguredOnTrunk(string PublicNumber)

Parameters

PublicNumber string

The number

Returns

bool

True or False

IsPublicNumberInUse(string)

Checks if given public number is already in use.

public bool IsPublicNumberInUse(string PublicNumber)

Parameters

PublicNumber string

Public number in canocical form.

Returns

bool

true, if public number in use

IsRootCertificateAvailable()

public bool IsRootCertificateAvailable()

Returns

bool

IsServerCertificateAvailable()

public bool IsServerCertificateAvailable()

Returns

bool

IsSipUserIdFree(string)

public bool IsSipUserIdFree(string sipUserId)

Parameters

sipUserId string

Returns

bool

IsUserEmialAddressFree(string)

public bool IsUserEmialAddressFree(string userEmailAdress)

Parameters

userEmailAdress string

Returns

bool

IsUserPinUnused(int, string)

Checks if the given lanPhonePin is used only by the current user.

public bool IsUserPinUnused(int userId, string lanPhonePin)

Parameters

userId int

User id.

lanPhonePin string

Pin to be checked.

Returns

bool

True or False

MakeNumberCanonical(string, int)

Converts any number into a canonical format.

public string MakeNumberCanonical(string Number, int LocationID)

Parameters

Number string

The number to be converted.

LocationID int

The ID of the location.

Returns

string

Canonical number

ModifyAdminUserProfile(int, int)

Modifies the administrative profile of an existing administrative window user.

public bool ModifyAdminUserProfile(int AdminUserID, int ProfileID)

Parameters

AdminUserID int

ID of administrative user

ProfileID int

new ProfileID

Returns

bool

true if succeeded

ModifyEditablePhoneBookEntry(int, string, string, string, string, bool)

Modifeis a PhoneBookEntry directly

public void ModifyEditablePhoneBookEntry(int EntryID, string Name, string Number, string SearchNumber, string Description, bool Hide)

Parameters

EntryID int

The EntryID of the entry to be modified.

Name string

The name of the entry

Number string

The number

SearchNumber string

The searchnumber is the canonical representation of the number. It will be generated by the CDS.

Description string

Mandantory description

Hide bool

When set to true the entry will not be shown in phonebook. It will be used to resolve the name for displaying current call informations.

ModifyPhoneControllerAddressRange(int, int, string, string, string, int, string)

public void ModifyPhoneControllerAddressRange(int phoneControllerAddressRangeID, int phoneControllerID, string beginAddress, string endAddress, string fallBackPhoneMgr, int id, string phoneMgr)

Parameters

phoneControllerAddressRangeID int

phoneControllerID int

beginAddress string

endAddress string

fallBackPhoneMgr string

id int

phoneMgr string

ModifyPhoneControllerConfiguration(int, int, int, SDateTime)

Modififies an existing PhoneControllerConfiguration. Also a the CDS suppots more than one Phonecontroller there will always be only one.

public void ModifyPhoneControllerConfiguration(int PhoneControllerID, int Period, int RescanInterval, SDateTime StartTime)

Parameters

PhoneControllerID int

Period int

RescanInterval int

StartTime SDateTime

PingService(AdminFacadeClient)

protected override void PingService(AdminFacadeClient cProxy)

Parameters

cProxy AdminFacadeClient

PushDnsChallenge(string)

public DnsRegistration PushDnsChallenge(string token)

Parameters

token string

Returns

DnsRegistration

PushDnsChallenge(string, string)

public DnsRegistration PushDnsChallenge(string configName, string token)

Parameters

configName string

token string

Returns

DnsRegistration

PushDnsRegistration(string)

public DnsRegistration PushDnsRegistration(string ipAddress)

Parameters

ipAddress string

Returns

DnsRegistration

PushDnsRegistration(string, string)

public DnsRegistration PushDnsRegistration(string configName, string ipAddress)

Parameters

configName string

ipAddress string

Returns

DnsRegistration

PutActivationKey(string)

public void PutActivationKey(string key)

Parameters

key string

PutControlCenterConfiguration(ControlCenterConfiguration)

public void PutControlCenterConfiguration(ControlCenterConfiguration configuration)

Parameters

configuration ControlCenterConfiguration

PutFederationConfig(FederationConfig)

public FederationConfig PutFederationConfig(FederationConfig config)

Parameters

config FederationConfig

Returns

FederationConfig

PutFileSystemConfiguration(FileSystemConfiguration)

public FileSystemConfigurationInfo PutFileSystemConfiguration(FileSystemConfiguration configuration)

Parameters

configuration FileSystemConfiguration

Returns

FileSystemConfigurationInfo

PutIdentityFederationEndpointConfiguration(FederationEndpointConfiguration)

public void PutIdentityFederationEndpointConfiguration(FederationEndpointConfiguration config)

Parameters

config FederationEndpointConfiguration

PutNetPromoterScoreConfiguration(ProductNetPromoterScoreConfiguration)

public void PutNetPromoterScoreConfiguration(ProductNetPromoterScoreConfiguration config)

Parameters

config ProductNetPromoterScoreConfiguration

PutS3Configuration(S3Configuration)

public S3ConfigurationInfo PutS3Configuration(S3Configuration configuration)

Parameters

configuration S3Configuration

Returns

S3ConfigurationInfo

PutScstCertificateInfo(ScstCertificateInfo)

public void PutScstCertificateInfo(ScstCertificateInfo certificateInfo)

Parameters

certificateInfo ScstCertificateInfo

PutScstConfiguration(ScstConfiguration)

public void PutScstConfiguration(ScstConfiguration configuration)

Parameters

configuration ScstConfiguration

PutServiceSetting(ServiceSetting, bool)

public ServiceSetting PutServiceSetting(ServiceSetting setting, bool resetToDefault)

Parameters

setting ServiceSetting

resetToDefault bool

Returns

ServiceSetting

PutTechnicalContactConfiguration(TechnicalContactConfiguration)

public void PutTechnicalContactConfiguration(TechnicalContactConfiguration configuration)

Parameters

configuration TechnicalContactConfiguration

ReloadLicenseDocument()

public DateTimeOffset? ReloadLicenseDocument()

Returns

DateTimeOffset?

ReloadLicenseDocumentForUnmanaged()

public string ReloadLicenseDocumentForUnmanaged()

Returns

string

RemoveDnsChallenge(string)

public void RemoveDnsChallenge(string configName = "IpPbxServer")

Parameters

configName string

RemoveDnsRegistration(string)

public void RemoveDnsRegistration(string configName = "IpPbxServer")

Parameters

configName string

RemoveLicense(uint, out int)

public void RemoveLicense(uint LicenseId, out int hr)

Parameters

LicenseId uint

hr int

RemoveScstCertificateInfo(string)

public void RemoveScstCertificateInfo(string name = "IpPbxServer")

Parameters

name string

RemoveScstConfiguration(string)

public void RemoveScstConfiguration(string name = "IpPbxServer")

Parameters

name string

ReplaceCallrouting(int, SIntList)

Replaces the call routing of the users in destination list by the callrouting of the source user. The callroutings will replaced the existing call routings will be removed and can not be restored. The source user id cannot be part of the listof destination user Ids

public BulkAdminResult ReplaceCallrouting(int sourceUserId, SIntList destinationUserIds)

Parameters

sourceUserId int

destinationUserIds SIntList

Returns

BulkAdminResult

Result object with detailed information

Remarks

This method can partly succeed. In the result object contains result for each user.

ReplaceCallrouting(int, int)

Replaces the call routing of the users in destination group by the callrouting of the source user. The callroutings will replaced the existing call routings will be removed and can not be restored. The source user id cannot be part of the listof destination user Ids

public BulkAdminResult ReplaceCallrouting(int sourceUserId, int groupId)

Parameters

sourceUserId int

groupId int

Returns

BulkAdminResult

Result object with detailed information

Remarks

This method can partly succeed. In the result object contains result for each user.

ReplaceSpeedDials(int, SIntList, int, int)

Replaces the speed dials (aka name keys, aka favorites) of the users in destination list by the callrouting of the source user. The spped dials will be replaced and can not be restored. The source user id cannot be part of the listof destination user Ids

public BulkAdminResult ReplaceSpeedDials(int sourceUserId, SIntList destinationUserIds, int startNumber, int stopNumber)

Parameters

sourceUserId int

destinationUserIds SIntList

startNumber int

The number of the first speed dial. (Number = Position of speed dial in skin. The first is 1.)

stopNumber int

The number of the last speed dial.(Number = Position of speed dial in skin. The first is 1.)

Returns

BulkAdminResult

Result object with detailed information

Remarks

This method can partly succeed. In the result object contains result for each user.

ReplaceSpeedDials(int, int, int, int)

Replaces the speed dials (aka name keys, aka favorites) of all users of a group by the callrouting of the source user. The spped dials will be replaced and can not be restored. The source user id cannot be part of the listof destination user Ids

public BulkAdminResult ReplaceSpeedDials(int sourceUserId, int groupId, int startNumber, int stopNumber)

Parameters

sourceUserId int

groupId int

group id

startNumber int

The number of the first speed dial. (Number = Position of speed dial in skin. The first is 1.)

stopNumber int

The number of the last speed dial.(Number = Position of speed dial in skin. The first is 1.)

Returns

BulkAdminResult

Result object with detailed information

Remarks

This method can partly succeed. In the result object contains result for each user.

ResetLicensing()

Resets the licensing mananger in the CDSService. In case of HSW the CDS will reregister at the License and Report Service This method hat to be invoked when changing the Reporting and Licensing Service

public void ResetLicensing()

SID2AccountName(SStringList)

Retrieves the windows usernames matching to given list of SIDs.

public SStringList SID2AccountName(SStringList names)

Parameters

names SStringList

list of windows sids

Returns

SStringList

List of user names strings

SendActivationRequest(ActivationType)

public bool SendActivationRequest(ActivationType type)

Parameters

type ActivationType

Returns

bool

SendActivationRequestWithDetailedResult(ActivationType)

public ActivationResultInfo SendActivationRequestWithDetailedResult(ActivationType type)

Parameters

type ActivationType

Returns

ActivationResultInfo

SendIpPbxMail(string, string, string, bool)

public void SendIpPbxMail(string recipient, string subject, string body, bool isBodyHtml)

Parameters

recipient string

subject string

body string

isBodyHtml bool

SendReloadNotifyToServices()

public void SendReloadNotifyToServices()

SendTestEMail(string, string, string, string, int, bool)

The SwyxServer sends a test EMail

public int SendTestEMail(string MailServer, string TestMailSenderAndRecipient, string Username, string Password, int iServerSmtpPort, bool bUseSecureConnection)

Parameters

MailServer string

Mail Server

TestMailSenderAndRecipient string

sending and receiving mail account

Username string

user name for authentication (may be "")

Password string

password for authentication (may be "")

iServerSmtpPort int

server's SMTP port (may be 0 in which case the default SMTP port is used)

bUseSecureConnection bool

if true the connection will be encrypted

Returns

int

SendWelcomeMail(SIntList)

Sends a welcome email to one or multiple users

public void SendWelcomeMail(SIntList userIds)

Parameters

userIds SIntList

Ids of the users who should receive a welcome email

SendWelcomeMail(int)

Sends a welcome email to a user

public void SendWelcomeMail(int userId)

Parameters

userId int

Id of the user who should receive a welcome email

SetClientSettings(ClientSettingParameters, SIntList)

Sets client settings for a set uo users

public BulkAdminResult SetClientSettings(ClientSettingParameters parameters, SIntList destinationUserIds)

Parameters

parameters ClientSettingParameters

ParamterClass with nullable values for each settting. Only not null values will be set

destinationUserIds SIntList

Returns

BulkAdminResult

Result object with detailed information

SetClientSettings(ClientSettingParameters, int)

Sets client settings for all users of a group

public BulkAdminResult SetClientSettings(ClientSettingParameters parameters, int groupId)

Parameters

parameters ClientSettingParameters

ParamterClass with nullable values for each settting. Only not null values will be set

groupId int

id of group

Returns

BulkAdminResult

Result object with detailed information

SetForwardings(ForwardingParameterList, SIntList)

Sets the forwarding configuration (Unconditional|OnBusy|OnNoAnswer) for a set of users

public BulkAdminResult SetForwardings(ForwardingParameterList forwardingParameters, SIntList destinationUserIds)

Parameters

forwardingParameters ForwardingParameterList

A list contains the new formwardings. For each forwarding type there can none or one entry in the list.

destinationUserIds SIntList

Returns

BulkAdminResult

Result object with detailed information

SetForwardings(ForwardingParameterList, int)

Sets the forwarding configuration (Unconditional|OnBusy|OnNoAnswer) to all users of a group

public BulkAdminResult SetForwardings(ForwardingParameterList forwardingParameters, int groupId)

Parameters

forwardingParameters ForwardingParameterList

A list contains the new formwardings. For each forwarding type there can none or one entry in the list.

groupId int

group id

Returns

BulkAdminResult

Result object with detailed information

SetIFBServerState(bool, out int)

Changes the active state of the master server.

public void SetIFBServerState(bool bActive, out int hr)

Parameters

bActive bool

true or false

hr int

HRESULT from COM

Remarks

The method can only be used on the master server.

SetOutboundHttpProxyAddress(string)

public void SetOutboundHttpProxyAddress(string uri)

Parameters

uri string

SetOutboundHttpProxyCredentials(string, string)

public void SetOutboundHttpProxyCredentials(string username, string password)

Parameters

username string

password string

SetOutboundHttpProxyUsername(string)

public void SetOutboundHttpProxyUsername(string username)

Parameters

username string

SetPhoneControllerState(int)

Sets the scanning state of the PhoneController. This method should be used by the PhoneManager only.

public void SetPhoneControllerState(int State)

Parameters

State int

The state value

SetScstDnsInfo(string, string)

public void SetScstDnsInfo(string serverName, string ipAddress)

Parameters

serverName string

ipAddress string

SetScstLetsEncryptEmail(string)

public void SetScstLetsEncryptEmail(string email)

Parameters

email string

SetScstServerNameMode(ScstServerNameMode)

public void SetScstServerNameMode(ScstServerNameMode mode)

Parameters

mode ScstServerNameMode

SetScstTlsCertificateMode(ScstCertificateMode)

public void SetScstTlsCertificateMode(ScstCertificateMode certificateMode)

Parameters

certificateMode ScstCertificateMode

SetThumbprint(int, string)

public bool SetThumbprint(int UserID, string Thumbprint)

Parameters

UserID int

Thumbprint string

Returns

bool

SetTwoFactorAuthenticationRequiredForAllAdminProfiles(bool)

public void SetTwoFactorAuthenticationRequiredForAllAdminProfiles(bool value)

Parameters

value bool

SignalRelationViewForGroup(int)

Returns all existing relations for specified group. The returning relation collection contains one or more entries for each user having a relation to the specified user, including informations about direction and type of signaling, the related group and the id of the originating SignalRelationEntry.

public SignalRelationViewPrimaryCollection SignalRelationViewForGroup(int GroupID)

Parameters

GroupID int

Returns

SignalRelationViewPrimaryCollection

Collection of SignalRelationViewEntry

SignalRelationViewForUser(int)

Returns all existing relations for specified user. The returning relation collection contains one or more entries for each user having a relation to the specified group, including informations about direction and type of signaling, the related group and the id of the originating SignalRelationEntry.

public SignalRelationViewPrimaryCollection SignalRelationViewForUser(int UserID)

Parameters

UserID int

Specified User

Returns

SignalRelationViewPrimaryCollection

Collection of SignalRelationViewEntry

StartFullSync(bool)

Synchronizes this site with all connected sites.

public void StartFullSync(bool bRequestReply)

Parameters

bRequestReply bool

If true all receiving sites will send a full sync message by their own.

StartLookUpUserForMatchingIdentity(int)

public bool StartLookUpUserForMatchingIdentity(int userId)

Parameters

userId int

Returns

bool

TestCDRDBConnection(string, out int)

Retrieves if firmware update is avaiable (L420)

public string TestCDRDBConnection(string ConnectionString, out int hr)

Parameters

ConnectionString string

hr int

Returns

string

TestLicenseServerConnection()

public bool TestLicenseServerConnection()

Returns

bool

ValidateActivationKey(string)

public bool ValidateActivationKey(string key)

Parameters

key string

Returns

bool

ValidateIdentityFederationEndpointConfiguration(FederationEndpointConfiguration)

public void ValidateIdentityFederationEndpointConfiguration(FederationEndpointConfiguration config)

Parameters

config FederationEndpointConfiguration

VerifyCanCreateConferenceRoom(int, string)

public void VerifyCanCreateConferenceRoom(int userId, string internalNumber)

Parameters

userId int

internalNumber string

VerifyCanCreateConferenceRooms(int, SStringList)

public void VerifyCanCreateConferenceRooms(int userId, SStringList internalNumbers)

Parameters

userId int

internalNumbers SStringList