Class PhoneClientFacade

Namespace
SWConfigDataClientLib.Proxies.PhoneClient
Assembly
IpPbxCDSClientLib.dll

Facade class for phone client applications.

public class PhoneClientFacade : PhoneClientFacadeBase
Inheritance
SWCFProxy<PhoneClientFacadeClient, IPhoneClientFacade>
PhoneClientFacade
Inherited Members

Constructors

PhoneClientFacade()

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

public PhoneClientFacade()

Remarks

Use the LibManager to create an instance of this class.

Properties

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

ChangePassword(string, string)

Changes the SIPPassword which is also the password used for authentication at the CDS.

public void ChangePassword(string OldPassword, string NewPassword)

Parameters

OldPassword string

The old password

NewPassword string

The new password

Remarks

If the current user context is a SwyxWare user, who is logged in with the old password (Default), the LibManager class will be reset. (ProxyPool cleared, etc) The password used by the current webservice proxy will changed implicitly. Also the password property of the LibManager object will be updated. All other instances of any web service client proxies will become inoperable!

CheckClientVersion()

Checks if the client version is supported by teh server.

public void CheckClientVersion()

CheckFeatureList(FeatureList)

Checks the Features for the current user. All features in the given list will be checked and the Enbaled flag ist set.

public void CheckFeatureList(FeatureList featureList)

Parameters

featureList FeatureList

CheckFeatureList(int, FeatureList)

Checks the Features for the given user. All features in the given list will be checked and the Enbaled flag ist set. If the given user is not the current user, the APIRole UserAminRO is required.

public void CheckFeatureList(int UserID, FeatureList featureList)

Parameters

UserID int

The ID of the given user.

featureList FeatureList

The list of features to be checked.

CheckVersion() 

public void CheckVersion()

CloseConnection()

This method is closing a connection to the server

public void CloseConnection()

CreateClient(Binding, EndpointAddress) 

protected override PhoneClientFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

PhoneClientFacadeClient

DeleteCtiSettings()

Delete all CTI settings of the current user

public bool DeleteCtiSettings()

Returns

bool

True if succeeds

DeleteCtiSettings(int)

Delete all CTI settings of the given user

public bool DeleteCtiSettings(int iUserID)

Parameters

iUserID int

The id of the user

Returns

bool

True if succeeds

DeleteGroupVoiceMessages(int) 

public void DeleteGroupVoiceMessages(int groupId)

Parameters

groupId int

DeleteRedialItem(int)

delete phone call from user's phone call list

public void DeleteRedialItem(int RedialItemID)

Parameters

RedialItemID int

ID of RedialItem to be deleted.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteRedialItem(int, int)

delete phone call from user's phone call list

public void DeleteRedialItem(int UserID, int RedialItemID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

RedialItemID int

ID of RedialItem to be deleted.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteRedialItemList(int, SIntList) 

public void DeleteRedialItemList(int UserID, SIntList redialItemIds)

Parameters

UserID int
redialItemIds SIntList

DeleteRedialItems()

Deletes the users items in the database.

public void DeleteRedialItems()

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteRedialItems(int)

Deletes the users items in the database.

public void DeleteRedialItems(int UserID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteUserPhoneCall(int)

Delete a single UserPhoneCall. The current user must be owner of the entry.

public void DeleteUserPhoneCall(int IpPbxPhoneCallID)

Parameters

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

DeleteUserPhoneCall(int, int)

Deletes a single UserPhoneCall. The current user must be owner of the entry.

public void DeleteUserPhoneCall(int UserID, int IpPbxPhoneCallID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

DeleteUserPhoneCallList(int, SIntList)

Deletes a list of UserPhoneCalls. The current user must be owner of the entries.

public void DeleteUserPhoneCallList(int userid, SIntList callIds)

Parameters

userid int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

callIds SIntList

The phonecall Ids. Same as the CDR CallID.

DeleteUserPhoneCallbackRequest(int)

Deletes a single UserPhoneCallbackRequest.

public void DeleteUserPhoneCallbackRequest(int IpPbxPhoneCallID)

Parameters

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

DeleteUserPhoneCallbackRequest(int, int)

Deletes a single UserPhoneCallbackRequest.

public void DeleteUserPhoneCallbackRequest(int UserID, int IpPbxPhoneCallID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

DeleteUserPhoneCallbackRequestList(int, SIntList) 

public void DeleteUserPhoneCallbackRequestList(int UserID, SIntList callIds)

Parameters

UserID int
callIds SIntList

DeleteUserPhoneCallbackRequests()

Deletes all PhoneCallbackRequests of the current user.

public void DeleteUserPhoneCallbackRequests()

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteUserPhoneCallbackRequests(int)

Deletes all PhoneCallbackRequests of the given user.

public void DeleteUserPhoneCallbackRequests(int UserID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteUserPhoneCalls()

Deletes the users phonecalls list in database. All existing phonecalls entries will be removed.

public void DeleteUserPhoneCalls()

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteUserPhoneCalls(int)

Deletes the users phonecalls list in database. All existing phonecalls entries will be removed.

public void DeleteUserPhoneCalls(int UserID)

Parameters

UserID int

The UserId of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

DeleteUserVoiceMessages(int) 

public void DeleteUserVoiceMessages(int userId)

Parameters

userId int

DeleteVoiceMessage(int) 

public void DeleteVoiceMessage(int callId)

Parameters

callId int

DeleteVoiceMessages(SIntList) 

public void DeleteVoiceMessages(SIntList callIds)

Parameters

callIds SIntList

Dispose() 

public virtual void Dispose()

FreeForReuse() 

public override void FreeForReuse()

GetAccessTokens() 

public AccessTokens GetAccessTokens()

Returns

AccessTokens

GetAllKeys(int)

Gets all keys (key vlaue pairs) of a user.

public SStringList GetAllKeys(int userId)

Parameters

userId int

UserID

Returns

SStringList

List of keys

GetAppMode(int) 

public UserAppMode GetAppMode(int userId)

Parameters

userId int

Returns

UserAppMode

GetCallListStatistics(int, out int, out int, out int, out int, out int, out int)

Sets the viewed state to the given UserPhoneCalls of the given user.

public void GetCallListStatistics(int iUserID, out int iNewSimpleCalls, out int iTotalSimpleCalls, out int iNewCallbackRequests, out int iTotalCallbackRequests, out int iVoiceMails, out int iRedialEntries)

Parameters

iUserID int
iNewSimpleCalls int
iTotalSimpleCalls int
iNewCallbackRequests int
iTotalCallbackRequests int
iVoiceMails int
iRedialEntries int

GetClientCertificate(out string) 

public bool GetClientCertificate(out string Certificate)

Parameters

Certificate string

Returns

bool

GetCtiSettings()

Gets the CTI settings of the current user

public TCtiSettings GetCtiSettings()

Returns

TCtiSettings

CTI settings

GetCtiSettings(int)

Gets the CTI settings of the given user from database.

public TCtiSettings GetCtiSettings(int iUserID)

Parameters

iUserID int

The userID

Returns

TCtiSettings

CTI settings

GetCurrentUserDevices()

Retrieves all registered devices of the current user.

public SStringList GetCurrentUserDevices()

Returns

SStringList

List of version strings.

GetCurrentUserDevicesEx()

Retrieves all registered devices of the current user.

public UserDeviceList GetCurrentUserDevicesEx()

Returns

UserDeviceList

A list of all user devices

GetCurrentUserDevicesEx(int)

Retrieves all registered devices from the requested user.

public UserDeviceList GetCurrentUserDevicesEx(int UserID)

Parameters

UserID int

Id of the User

Returns

UserDeviceList

A list of all user devices

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

GetDefaultMediaEncryptionType(int) 

public int GetDefaultMediaEncryptionType(int userId)

Parameters

userId int

Returns

int

GetEnabledCRMRules()

Retrieves the list of enabled CRM rules for the current user.

public SStringList GetEnabledCRMRules()

Returns

SStringList

StringList

GetEnabledCRMRules(int)

Retrieves the list of enabled CRM rules for the current user.

public SStringList GetEnabledCRMRules(int UserID)

Parameters

UserID int

User sepecified by ID

Returns

SStringList

StringList

GetFeatureProfile(int) 

public FeatureProfile GetFeatureProfile(int UserID)

Parameters

UserID int

Returns

FeatureProfile

GetFederatedAppointmentConfiguration(int) 

public UserFederatedAppointmentConfig GetFederatedAppointmentConfiguration(int iUserID)

Parameters

iUserID int

Returns

UserFederatedAppointmentConfig

GetFederationConfig() 

public FederationConfigInfo GetFederationConfig()

Returns

FederationConfigInfo

GetForwardingConfiguration(int) 

public ForwardingConfiguration GetForwardingConfiguration(int userId)

Parameters

userId int

Returns

ForwardingConfiguration

GetGroup(int)

Returns one group with voice message settings (Admin Only)

public GroupEntry GetGroup(int groupId)

Parameters

groupId int

id

Returns

GroupEntry

GroupEntry

GetGroupNumberMappings(int) 

public GroupNumberMappingView GetGroupNumberMappings(int groupId)

Parameters

groupId int

Returns

GroupNumberMappingView

GetGroups(int)

Returns all groups of an user

public ICollection<Group> GetGroups(int userId)

Parameters

userId int

Returns

ICollection<Group>

GetInternalNumber(string) 

public Number GetInternalNumber(string internalNumber)

Parameters

internalNumber string

Returns

Number

GetKeyValuePairs(int, SStringList)

Gets the client data of a user.

public SProfileEntryList GetKeyValuePairs(int userId, SStringList keys)

Parameters

userId int

UserID

keys SStringList

List of keys

Returns

SProfileEntryList

List of profile entries

GetLanPhonePinMACAddressList()

Retrieves a list of users(UserID, LanPhonePin, MacAddress) The List contains all users that have a LanPhonePin or that have an enabled AutoLogin

public UserLanPhonePINMACListPrimaryCollection GetLanPhonePinMACAddressList()

Returns

UserLanPhonePINMACListPrimaryCollection

UserLanPhonePINMACListPrimaryCollection

GetLineKeyConfiguration(int)

Gets the line key configuration of a user.

public SLineKeyList GetLineKeyConfiguration(int userId)

Parameters

userId int

UserID

Returns

SLineKeyList

List of LineKeyConfiguration

GetLocalSiteId() 

public int GetLocalSiteId()

Returns

int

GetLoginID()

Returns a LoginID which can be used for SIP authentification for special clients.

public Guid GetLoginID()

Returns

Guid

GetLoginID(int)

Returns a LoginID which can be used for SIP authentification for special clients. If the given user is not the current user, the APIRole IpPbxServer is required.

public Guid GetLoginID(int UserID)

Parameters

UserID int

The ID of the given user.

Returns

Guid

GetLoginID(int, LoginIdType)

Returns a LoginID which can be used for SIP authentification for special clients. If the given user is not the current user, the APIRole IpPbxServer is required.

public Guid GetLoginID(int UserID, LoginIdType type)

Parameters

UserID int

The ID of the given user.

type LoginIdType

Type of the requested id (IpPbxSrv|UaCstaSrv

Returns

Guid

GetMaxLineKeyCount(int)

Gets the maximum line key count.

public int GetMaxLineKeyCount(int userId)

Parameters

userId int

The user Id.

Returns

int

GetMaxNameKeyCount()

Get the maximum number of name keys of the current user. The maximum number is not the number of configured name keys. Default is 40

public int GetMaxNameKeyCount()

Returns

int

maximum number of name keys (default: 40)

GetMaxNameKeyCount(int)

Get the maximum number of name keys of the given user. The maximum number is not the number of configured name keys. Default is 40

public int GetMaxNameKeyCount(int UserID)

Parameters

UserID int

The id uf the user

Returns

int

maximum number of name keys (default: 40)

GetNameKeyList()

Gets the default name key list of the current user. The returned list contains always the given amount numbers of name keys. The name keys are numerated from 0 to amount-1.

public SNameKeyList GetNameKeyList()

Returns

SNameKeyList

SNameKeyList. Can be used for reading and updating the name keys of the list.

GetNameKeyList(int)

Gets the default name key list of the current user. The returned list contains always the given amount numbers of name keys. The name keys are numerated from 0 to amount-1.

public SNameKeyList GetNameKeyList(int amount)

Parameters

amount int

Number of returned name keys.

Returns

SNameKeyList

SNameKeyList. Can be used for reading and updating the name keys of the list.

GetNameKeyList(int, int)

Gets the default name key list of an user. The returned list contains always the given amount numbers of name keys. The name keys are numerated from 0 to amount-1.

public SNameKeyList GetNameKeyList(int userID, int amount)

Parameters

userID int
amount int

Number of returned name keys.

Returns

SNameKeyList

SNameKeyList. Can be used for reading and updating the name keys of the list.

GetNarrowUserList() 

public NarrowUserListPrimaryCollection GetNarrowUserList()

Returns

NarrowUserListPrimaryCollection

GetNetPromoterScoreAllowed() 

public NetPromoterScoreAllowed GetNetPromoterScoreAllowed()

Returns

NetPromoterScoreAllowed

GetNewestClientInfo(string) 

public string[] GetNewestClientInfo(string deviceId)

Parameters

deviceId string

Returns

string[]

GetNumberHistory(int, string)

Get the number history of the given user by the given name. If there is no number history an empty history will be returned

public NumberHistory GetNumberHistory(int userID, string name)

Parameters

userID int
name string

The name of the history. The name 'Redirect' will return the RedirectionNumberList from the Blob

Returns

NumberHistory

The number history.

GetNumberHistory(string)

Get the number history of the current user by the given name. If there is no number history an empty history will be returned

public NumberHistory GetNumberHistory(string name)

Parameters

name string

The name of the history. The name 'Redirect' will return the RedirectionNumberList from the Blob

Returns

NumberHistory

The number history.

GetNumbers(int)

Returns all numbers of an user

public ICollection<Number> GetNumbers(int userId)

Parameters

userId int

Returns

ICollection<Number>

GetParallelCalls(int)

Retrieves the list of configured parallel call numbers for the given user.

public SStringList GetParallelCalls(int UserID)

Parameters

UserID int

User sepecified by ID

Returns

SStringList

StringList

GetPhoneClientConfigurationView()

Retrieves a read only object with all one entry containing mostly all configuration items needed by the client application. The entry contains attributs from the pbx configuration and teh configuration of the current user.

public PhoneClientViewEntry GetPhoneClientConfigurationView()

Returns

PhoneClientViewEntry

A PhoneClientViewEntry

GetPhoneClientConfigurationView(int)

Retrieves a read only object with all one entry containing mostly all configuration items needed by the client application. The entry contains attributs from the pbx configuration and the configuration of the given user. If the user is not the current user, APIRole AdminUserRO is required.

public PhoneClientViewEntry GetPhoneClientConfigurationView(int UserID)

Parameters

UserID int

The ID for the given Swyxware user.

Returns

PhoneClientViewEntry

A PhoneClientViewEntry

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

GetPreSharedKey()

Returns the current pre shared key of this user for media encryption. The key is generated and will be changed if all phone devices of the user are logged off.

public string GetPreSharedKey()

Returns

string

string containing preshared key

Remarks

This method will use an addtional web service to provide a secure transport.

GetPreSharedKey(int)

Returns the current pre shared key of this user for media encryption. The key is generated and will be changed if all phone devices of the user are logged off.

public string GetPreSharedKey(int UserID)

Parameters

UserID int

Returns

string

string containing preshared key

Remarks

This method will use an addtional web service to provide a secure transport.

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.

GetPublicNumberOwner2(string, out bool, out bool, out int)

Searches for the owner of a public number.

public string GetPublicNumberOwner2(string PublicNumber, out bool UserFound, out bool GroupFound, out int FoundEntryID)

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.

Returns

string

The name of the owner.

GetRecordingWizardPopupState() 

public bool GetRecordingWizardPopupState()

Returns

bool

GetRecordingWizardPopupStateEx(int) 

public bool GetRecordingWizardPopupStateEx(int iUserID)

Parameters

iUserID int

Returns

bool

GetRedialItems()

Retrieve the current users redial item entries

public RedialItemPrimaryCollection GetRedialItems()

Returns

RedialItemPrimaryCollection

Collection of Redial Item Entries

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetRedialItems(int)

Retrieve the given users redial item entries

public RedialItemPrimaryCollection GetRedialItems(int UserID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

Returns

RedialItemPrimaryCollection

Collection of Redial Item Entries

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetRemoteInquiryConfiguration(int) 

public RemoteInquiryConfiguration GetRemoteInquiryConfiguration(int userId)

Parameters

userId int

Returns

RemoteInquiryConfiguration

GetServerInfo() 

public ServerInfo GetServerInfo()

Returns

ServerInfo

GetServerRequestTimeout(PhoneClientFacadeClient) 

protected override TimeSpan GetServerRequestTimeout(PhoneClientFacadeClient client)

Parameters

client PhoneClientFacadeClient

Returns

TimeSpan

GetSipCredentials(int)

Gets all sip credentials of a specific user

public UserSipCredentials GetSipCredentials(int userId)

Parameters

userId int

Returns

UserSipCredentials

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetTenantInfo(int) 

public Tenant GetTenantInfo(int userId)

Parameters

userId int

Returns

Tenant

GetUniqueServerID() 

public Guid GetUniqueServerID()

Returns

Guid

GetUserAndGroupMappings()

Retrieves a read only collection with all internal and public numbers of the current user Each entry represents on mapping internal and public number. The public number can be null if there is no mapping. The collection contains the numbers of the user and the numbers of all groups, the user is member of.

public UserNumberMappingViewPrimaryCollection GetUserAndGroupMappings()

Returns

UserNumberMappingViewPrimaryCollection

A UserNumberMappingViewPrimaryCollection

GetUserAndGroupMappings(int)

Retrieves a read only collection with all internal and public numbers of the given user Each entry represents on mapping internal and public number. The public number can be null if there is no mapping. The collection contains the numbers of the user and the numbers of all groups, the user is member of. If the given user is not the current user, the APIRole UserAdminRO is required.

public UserNumberMappingViewPrimaryCollection GetUserAndGroupMappings(int UserID)

Parameters

UserID int

Returns

UserNumberMappingViewPrimaryCollection

A UserNumberMappingViewPrimaryCollection

GetUserAppointmentText(int, out SDateTime)

Get last known user appointment text This method returns an result even if the appointment is in the past or in the future

public string GetUserAppointmentText(int iUserID, out SDateTime dExpirationDate)

Parameters

iUserID int

ID of the user

dExpirationDate SDateTime

Expiration DateTime when the appointment ends

Returns

string

GetUserConfigData()

Gets the ConfigData (blob) of the current user. This method does not load the speed dial configuration. The corresponding blob elements will always be empty.

public byte[] GetUserConfigData()

Returns

byte[]

The ConfigData Byte Array. Returns empty array if no data is available.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserConfigData(int)

Gets the ConfigData (blob) of the given user. This method does not load the speed dial configuration The corresponding blob elements will always be empty.

public byte[] GetUserConfigData(int UserID)

Parameters

UserID int

Returns

byte[]

The ConfigData Byte Array. Returns empty array if no data is available.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserFileQuotas(int) 

public UserFileQuotaInfo GetUserFileQuotas(int userId)

Parameters

userId int

Returns

UserFileQuotaInfo

GetUserFileQuotasForPortal(int) 

public UserFileQuotaInfo GetUserFileQuotasForPortal(int userId)

Parameters

userId int

Returns

UserFileQuotaInfo

GetUserFreeText(int)

Get the status text of a user

public string GetUserFreeText(int iUserID)

Parameters

iUserID int

Id of the user

Returns

string

The status text as string

GetUserIdByInternalName(string) 

public int GetUserIdByInternalName(string internalName)

Parameters

internalName string

Returns

int

GetUserIdByUserName(string)

Returns the User Id for the given UserName

public int GetUserIdByUserName(string userName)

Parameters

userName string

Username

Returns

int

GetUserInfo() 

public UserInfo GetUserInfo()

Returns

UserInfo

GetUserMINs()

Retrieves the list of MobileIdentificationNumbers (MINs) for the current user.

public SStringList GetUserMINs()

Returns

SStringList

StringList

GetUserMINs(int)

Retrieves the list of MobileIdentificationNumbers (MINs) for the current user.

public SStringList GetUserMINs(int UserID)

Parameters

UserID int

User sepecified by ID

Returns

SStringList

StringList

GetUserNumberMappings(int) 

public List<UserNumberViewEntry> GetUserNumberMappings(int userId)

Parameters

userId int

Returns

List<UserNumberViewEntry>

GetUserParallelCalls()

Retrieves the list of configured parallel call numbers for the current user.

public SStringList GetUserParallelCalls()

Returns

SStringList

StringList

GetUserPhoneCallList()

Retrieve the users phonecall entries

public UserPhoneCallListPrimaryCollection GetUserPhoneCallList()

Returns

UserPhoneCallListPrimaryCollection

Collection of Phonecall Entries including the CallbackRequestState

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserPhoneCallList(bool)

Retrieve the users phonecall entries

public UserPhoneCallListPrimaryCollection GetUserPhoneCallList(bool OnlyNew)

Parameters

OnlyNew bool

If true ony new (not viewed) entries will be returned

Returns

UserPhoneCallListPrimaryCollection

Collection of Phonecall Entries including the CallbackRequestState

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserPhoneCallList(int, bool)

Retrieve the users phonecall entries

public UserPhoneCallListPrimaryCollection GetUserPhoneCallList(int UserID, bool OnlyNew)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

OnlyNew bool

If true ony new (not viewed) entries will be returned

Returns

UserPhoneCallListPrimaryCollection

Collection of Phonecall Entries including the CallbackRequestState

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserPhoneCallbackRequests()

Retrieves a list of PhoneCallbackRequests of the current user.

public UserPhoneCallbackRequestPrimaryCollection GetUserPhoneCallbackRequests()

Returns

UserPhoneCallbackRequestPrimaryCollection

Collection of PhoneCallbackRequests Entries

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserPhoneCallbackRequests(int)

Retrieves a list of PhoneCallbackRequests of the given user.

public UserPhoneCallbackRequestPrimaryCollection GetUserPhoneCallbackRequests(int userId)

Parameters

userId int

Returns

UserPhoneCallbackRequestPrimaryCollection

Collection of PhoneCallbackRequests Entries

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

GetUserPresenceData(int, out bool, out bool)

Get user presence information

public string GetUserPresenceData(int iUserID, out bool bIsAway, out bool bDoNotDisturb)

Parameters

iUserID int

Id of the user

bIsAway bool

Out - If true user is in Away state

bDoNotDisturb bool

Out - If true user is in DND state

Returns

string

Current User Status Text as string

GetUserPresenceDataEx(int, out bool, out bool, out SDateTime)

Get user presence information

public string GetUserPresenceDataEx(int iUserID, out bool bIsAway, out bool bDoNotDisturb, out SDateTime dExpirationDate)

Parameters

iUserID int

Id of the user

bIsAway bool

Out - If true user is in Away state

bDoNotDisturb bool

Out - If true user is in DND state

dExpirationDate SDateTime

Out - Contains the state expiration datetime

Returns

string

Current User Status Text as string

GetUserProfileElements(SStringList)

Get a list of elements from the current users profile in the database. For each key an element will be returned. If the profile in database does not contain an element for a given key, an empty element will be returned.

public SUserProfileElementList GetUserProfileElements(SStringList elementKeys)

Parameters

elementKeys SStringList

List of element keys

Returns

SUserProfileElementList

List user profile elements.

GetUserProfileElements(int, SStringList)

Get a list of elements from the given users profile in the database. For each key an element will be returned. If the profile in database does not contain an element for a given key, an empty element will be returned.

public SUserProfileElementList GetUserProfileElements(int UserID, SStringList elementKeys)

Parameters

UserID int

The id of the given user

elementKeys SStringList

List of element keys

Returns

SUserProfileElementList

List user profile elements.

GetUserRefreshToken(int) 

public string GetUserRefreshToken(int userId)

Parameters

userId int

Returns

string

GetVoiceMessages(int) 

public VoiceMessageList GetVoiceMessages(int userId)

Parameters

userId int

Returns

VoiceMessageList

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

HasRoleAndCheckAccess(BuildInRoles, out bool, out bool)

Check if the current user has a role. Additionally the user expiration flag and password policy flag will be returned. The method will return false if the password expiration flag is set. Even if the user is authenticated with a windows account.

public bool HasRoleAndCheckAccess(BuildInRoles role, out bool passwordExpired, out bool passwordPolicyEnabled)

Parameters

role BuildInRoles

The role to be checked

passwordExpired bool

True is the current user is or has a IpPbxAccount and the password expiration flag ist set.

passwordPolicyEnabled bool

True is the current user is or has a IpPbxAccount and the password policy is enabled.

Returns

bool

True if the user owns the given role and the password expiration flag is not set.

HasUserNewPhoneCalls()

Returns weather the user has new, not already viewed, phonecall entries.

public bool HasUserNewPhoneCalls()

Returns

bool

True is there are not viewed entries

HasUserNewPhoneCalls(int)

Returns weather the user has new, not already viewed, phonecall entries.

public bool HasUserNewPhoneCalls(int UserID)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

Returns

bool

True is there are not viewed entries

IncreaseFailedLoginAttempts(string, out bool)

Increases the failed locked attempt counter for an user identified by its name.

public bool IncreaseFailedLoginAttempts(string ipPbxUsername, out bool locked)

Parameters

ipPbxUsername string

The name of the user

locked bool

True if the user is locked

Returns

bool

True if the user has been found and the attempt counter has been increased.

Remarks

Server role required.

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

OnAfterCall(ReleaseAction, string) 

protected override void OnAfterCall(SWCFProxy<PhoneClientFacadeClient, IPhoneClientFacade>.ReleaseAction action, string name)

Parameters

action SWCFProxy<PhoneClientFacadeClient, IPhoneClientFacade>.ReleaseAction
name string

PingService(PhoneClientFacadeClient) 

protected override void PingService(PhoneClientFacadeClient cProxy)

Parameters

cProxy PhoneClientFacadeClient

PublicateDeviceAwayState(string, int, bool)

Set the detected Away state for a specific device

public void PublicateDeviceAwayState(string sDeviceSessionID, int iUserID, bool bIsAway)

Parameters

sDeviceSessionID string

SIP Device Session ID

iUserID int

ID of the user

bIsAway bool

Defines if the user is in Away state

PublicateLineState(string, int, int, bool, bool, string, ENumberStatus)

Method to publicate line status information. The Presence Manager will aggregate an user busy state from this and other publicated information. The user busy state is not the user status shown on speed dials and in the phonebook.

public void PublicateLineState(string sDeviceSessionID, int iUserID, int iLine, bool bAllNumbers, bool bAllGroupNumbers, string sNumber, ENumberStatus eStatus)

Parameters

sDeviceSessionID string

The SIP session id

iUserID int

The id of the user

iLine int

The line number

bAllNumbers bool

if true all the line accepts calls for all internal numbers of the user

bAllGroupNumbers bool

if true all the line accepts calls for all internal group numbers of the user

sNumber string

the line accepts calls for this number

eStatus ENumberStatus

The status of the line

PutForwardingConfiguration(int, ForwardingConfiguration) 

public bool PutForwardingConfiguration(int userId, ForwardingConfiguration forwardingconfiguration)

Parameters

userId int
forwardingconfiguration ForwardingConfiguration

Returns

bool

PutGroupVoiceMailConfiguration(GroupEntry)

Puts the voice message configuration part of the group (Admin Only)

public GroupEntry PutGroupVoiceMailConfiguration(GroupEntry groupEntry)

Parameters

groupEntry GroupEntry

Returns

GroupEntry

Modified GroupEntry

PutKeyValuePairs(int, SProfileEntryList)

Puts the client data of a user.

public void PutKeyValuePairs(int userId, SProfileEntryList clientUserData)

Parameters

userId int

UserID

clientUserData SProfileEntryList

List of profile entries

PutLineKeyConfiguration(int, SLineKeyList)

Puts the line key configuration of a user.

public void PutLineKeyConfiguration(int userId, SLineKeyList lineKeys)

Parameters

userId int

UserID

lineKeys SLineKeyList

List of LineKeyConfiguration

RegisterMobileDevice(int, string, string, string, string, string, string, string, string)

Call this method to register a mobile device for the given user. The Device will be identified via given unique application Id.

public void RegisterMobileDevice(int userID, string deviceName, string deviceSessionId, string ipAddress, string privateIPAddress, string version, string language, string os, string osVersion)

Parameters

userID int

The user ID of the device owner

deviceName string

Name of the Mobile Device (e.g. My iPhone)

deviceSessionId string

Unique Id to identify the user's mobile device.

ipAddress string

The public IP address of the mobile device.

privateIPAddress string

The internal/private IP address of the mobile device (e.g. the WebAccess server IP).

version string

The version string, will be used for device list in Admin

language string

Mobile Device Language (e.g. English)

os string

Mobile Device Operating System Name (e.g. iOS)

osVersion string

Mobile Device Operating System Version (e.g. 5.0)

RegisterMobileDevice(string, string, string, string, string, string, string, string)

Call this method to register a mobile device for the current user. The Device will be identified via given unique application Id.

public void RegisterMobileDevice(string deviceName, string deviceSessionId, string ipAddress, string privateIPAddress, string version, string language, string os, string osVersion)

Parameters

deviceName string

Name of the Mobile Device (e.g. My iPhone)

deviceSessionId string

Unique Id to identify the user's mobile device.

ipAddress string

The public IP address of the mobile device.

privateIPAddress string

The internal/private IP address of the mobile device (e.g. the WebAccess server IP).

version string

The version string, will be used for device list in Admin

language string

Mobile Device Language (e.g. English)

os string

Mobile Device Operating System Name (e.g. iOS)

osVersion string

Mobile Device Operating System Version (e.g. 5.0)

ResetDeviceAwayState(int)

Resets the detected away for all devices of the user

public void ResetDeviceAwayState(int userID)

Parameters

userID int

Id of the user

ResetPublicatedLines(string, int)

Method to reset all publicated line status information. The Presence Manager will aggregate an user busy state from this and other publicated information. The user busy state is not the user status shown on speed dials and in the phonebook.

public void ResetPublicatedLines(string sDeviceSessionID, int iUserID)

Parameters

sDeviceSessionID string

The SIP session id

iUserID int

The id of the user

SetAllGroupVoiceMessageViewedAt(int, bool) 

public bool SetAllGroupVoiceMessageViewedAt(int groupId, bool viewed)

Parameters

groupId int
viewed bool

Returns

bool

SetAllUserVoiceMessageViewedAt(int, bool) 

public bool SetAllUserVoiceMessageViewedAt(int userId, bool viewed)

Parameters

userId int
viewed bool

Returns

bool

SetAppMode(int, AppMode) 

public void SetAppMode(int userId, AppMode mode)

Parameters

userId int
mode AppMode

SetAutologinMACAddress(int, string)

Set the MACAddress for the given user. This method will throw an exception if the MAC address is already used by another user.

public void SetAutologinMACAddress(int iUserID, string strMACAddress)

Parameters

iUserID int

The UserID

strMACAddress string

The MAC Address

SetDefaultMediaEncryptionType(int, int) 

public void SetDefaultMediaEncryptionType(int userId, int defaultMediaEncryptionType)

Parameters

userId int
defaultMediaEncryptionType int

SetDeviceStateAvailable(int, string, bool)

Method used by CTI+ devices to dynamically exclude the client from status aggregation in Presence Manager.

public void SetDeviceStateAvailable(int iUserID, string sSessionID, bool bAvailable)

Parameters

iUserID int

The id of the user

sSessionID string

The SIP session id

bAvailable bool

True is device status should used in status aggregation

SetFederatedAppointmentConfiguration(UserFederatedAppointmentConfig) 

public void SetFederatedAppointmentConfiguration(UserFederatedAppointmentConfig config)

Parameters

config UserFederatedAppointmentConfig

SetMaxLineKeyCount(int, int?) 

public void SetMaxLineKeyCount(int userId, int? maxLineKeyCount)

Parameters

userId int
maxLineKeyCount int?

SetMaxNameKeyCount(int)

Sets the maximum number of name keys of the current user

public void SetMaxNameKeyCount(int MaxNameKeyCount)

Parameters

MaxNameKeyCount int

The new maximum value. All configured names keys with a greater name key number will be removed

SetMaxNameKeyCount(int, int)

Sets the maximum number of name keys of the given user

public void SetMaxNameKeyCount(int UserID, int MaxNameKeyCount)

Parameters

UserID int

The id of the user

MaxNameKeyCount int

The new maximum value. All configured names keys with a greater name key number will be removed

SetParallelCalls(int, SStringList)

Sets the list of configured parallel call numbers for the given user.

public void SetParallelCalls(int UserID, SStringList Numbers)

Parameters

UserID int

User sepecified by ID

Numbers SStringList

List of numbers

SetPassword(int, string, bool)

Sets the IpPbxPassword of an user.

public void SetPassword(int userID, string newPassword, bool passwordExpired)

Parameters

userID int

The id of the user.

newPassword string

The new password

passwordExpired bool

If true the user has to change the password after next login

Remarks

UserAdmin or Server Role required.

SetRecordingWizardPopupState(bool) 

public void SetRecordingWizardPopupState(bool bValue)

Parameters

bValue bool

SetRecordingWizardPopupStateEx(int, bool) 

public void SetRecordingWizardPopupStateEx(int iUserID, bool bValue)

Parameters

iUserID int
bValue bool

SetRemoteInquiryConfiguration(int, bool, bool) 

public void SetRemoteInquiryConfiguration(int userId, bool enabled, bool usePin)

Parameters

userId int
enabled bool
usePin bool

SetRemoteInquiryConfiguration(int, bool, bool, string) 

public void SetRemoteInquiryConfiguration(int userId, bool enabled, bool usePin, string pin)

Parameters

userId int
enabled bool
usePin bool
pin string

SetUserAppointmentText(int, string, SDateTime)

Set a new user appointment text

public void SetUserAppointmentText(int iUserID, string sAppointmentText, SDateTime dExpirationDate)

Parameters

iUserID int

ID of the user

sAppointmentText string

New Appointment Text

dExpirationDate SDateTime

Expiration DateTime when the appointment ends

SetUserConfigData(byte[])

Sets the ConfigData (blob) of the current user. This method does not save the speed dial configuration.

public void SetUserConfigData(byte[] configData)

Parameters

configData byte[]

The Blob

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetUserConfigData(byte[], SUserProfileElementList)

Sets the ConfigData (blob) of the current user. This method does not save the speed dial configuration.

public void SetUserConfigData(byte[] configData, SUserProfileElementList elementList)

Parameters

configData byte[]

The Blob

elementList SUserProfileElementList

Optional additional profile elements that are not part of the old blob

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetUserConfigData(int, byte[])

Sets the ConfigData (blob) of the given user. This method does not save the speed dial configuration. If the given user is not the current user, the APIRole UserAminRW is required.

public void SetUserConfigData(int userID, byte[] configData)

Parameters

userID int

ID of the user

configData byte[]

The Blob

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetUserConfigData(int, byte[], SUserProfileElementList)

Sets the ConfigData (blob) of the given user. This method does not save the speed dial configuration. If the given user is not the current user, the APIRole UserAminRW is required.

public void SetUserConfigData(int userID, byte[] configData, SUserProfileElementList elementList)

Parameters

userID int

ID of the user

configData byte[]

The Blob

elementList SUserProfileElementList

Optional additional profile elements that are not part of the old blob

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetUserConfigDataSync(int, byte[])

Sets the ConfigData (blob) of the given user synchronously. This method is designed for testing purposes only. Do not use this method in productive environments!

public void SetUserConfigDataSync(int UserID, byte[] ConfigData)

Parameters

UserID int

ID of the user

ConfigData byte[]

The Blob

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetUserEnabledCRMRulesCalls(SStringList)

Sets the list of enabled CRM rules for the given user.

public void SetUserEnabledCRMRulesCalls(SStringList Numbers)

Parameters

Numbers SStringList

List of numbers

SetUserEnabledCRMRulesCalls(int, SStringList)

Sets the list of enabled CRM rules for the given user.

public void SetUserEnabledCRMRulesCalls(int UserID, SStringList RuleNames)

Parameters

UserID int

User sepecified by ID

RuleNames SStringList

List of rule names

SetUserFreeText(int, string)

Set a new status text for a user

public void SetUserFreeText(int iUserID, string sFreeStext)

Parameters

iUserID int

Id of the user

sFreeStext string

New status text as string

SetUserMINs(SStringList)

Sets the list of mobile idtenification numbers (MINs) for the given user.

public void SetUserMINs(SStringList MINs)

Parameters

MINs SStringList

List of MINs

SetUserMINs(int, SStringList)

Sets the list of mobile idtenification numbers (MINs) for the given user.

public void SetUserMINs(int UserID, SStringList MINs)

Parameters

UserID int

User sepecified by ID

MINs SStringList

List of MINs

SetUserParallelCalls(SStringList)

Sets the list of configured parallel call numbers for the given user.

public void SetUserParallelCalls(SStringList Numbers)

Parameters

Numbers SStringList

List of numbers

SetUserPhoneCallListAsViewed(bool)

Sets the viewed state to all UserPhoneCalls of the current user.

public void SetUserPhoneCallListAsViewed(bool value)

Parameters

value bool

True or False

SetUserPhoneCallListAsViewed(int, SIntList, bool)

Sets the viewed state to the given UserPhoneCalls of the given user.

public void SetUserPhoneCallListAsViewed(int UserID, SIntList lPhoneCallIDs, bool value)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

lPhoneCallIDs SIntList
value bool

True or False

SetUserPhoneCallListAsViewed(int, bool)

Sets the viewed state to all UserPhoneCalls of the given user.

public void SetUserPhoneCallListAsViewed(int UserID, bool value)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

value bool

True or False

SetUserPhoneCallbackRequestState(int, SPCBState)

Sets the state on a PhoneCallbackRequest. The current user must be owner of the entry.

public void SetUserPhoneCallbackRequestState(int IpPbxPhoneCallID, SPCBState CallBackState)

Parameters

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

CallBackState SPCBState

The new state

SetUserPhoneCallbackRequestState(int, int, SPCBState)

Sets the state on a PhoneCallbackRequest. The current user must be owner of the entry.

public void SetUserPhoneCallbackRequestState(int UserID, int IpPbxPhoneCallID, SPCBState CallBackState)

Parameters

UserID int

The Id of the user. It the user id is not the id of the current user, the API role IpPbxServer is required.

IpPbxPhoneCallID int

The phonecall ID. Same as the CDR CallID.

CallBackState SPCBState

The new state

SetUserPresenceData(int, bool, bool, SDateTime)

Set user presence information

public void SetUserPresenceData(int iUserID, bool bIsAway, bool bDoNotDisturb, SDateTime dExpirationDate)

Parameters

iUserID int

Id of the user

bIsAway bool

Defines if user is in "Away" state

bDoNotDisturb bool

Defines if user is in "Do not disturb" state

dExpirationDate SDateTime

Expiration date of the new user state

SetUserProfileElements(SUserProfileElementList)

Writes a list of user profile elements into the current user profile in the database.

public void SetUserProfileElements(SUserProfileElementList elementList)

Parameters

elementList SUserProfileElementList

List of profile elements

SetUserProfileElements(int, SUserProfileElementList)

Writes a list of user profile elements into the given user profile in the database.

public void SetUserProfileElements(int UserID, SUserProfileElementList elementList)

Parameters

UserID int

The id of the given user.

elementList SUserProfileElementList

List of profile elements

SetUserVoiceMessageViewedAt(int, bool) 

public bool SetUserVoiceMessageViewedAt(int callId, bool viewed)

Parameters

callId int
viewed bool

Returns

bool

SubscribeForCallJournalContentChanges(CallJournalClientSubscription) 

public void SubscribeForCallJournalContentChanges(CallJournalClientSubscription subscription)

Parameters

subscription CallJournalClientSubscription

ThrowException(int) 

public void ThrowException(int iType)

Parameters

iType int

UnSubscribeForCallJournalContentChanges() 

public void UnSubscribeForCallJournalContentChanges()

UnregisterAllMobileDevices()

Have to be called to unregister all mobile devices for the current user

public void UnregisterAllMobileDevices()

UnregisterAllMobileDevices(int)

Have to be called to unregister all mobile devices for the given user

public void UnregisterAllMobileDevices(int userId)

Parameters

userId int

The UserID of the registered user

UnregisterMobileDevice(int, string)

Have to be called to unregister a mobile device for the given user

public void UnregisterMobileDevice(int userId, string deviceSessionId)

Parameters

userId int

The UserID of the registered user

deviceSessionId string

The device session id of the device. This Id is unique for each device that is registered.

UnregisterMobileDevice(string)

Have to be called to unregister a mobile device for the current user

public void UnregisterMobileDevice(string deviceSessionId)

Parameters

deviceSessionId string

The device session id of the device. This Id is unique for each device that is registered.

UpdateCtiSettings(TCtiSettings)

Updates the CTI settings of an user. The user is specified by the UserID attribute of the tCtiSettings parameter. If the UserID is not 0 and not the id of the current user user administration role is required.

public bool UpdateCtiSettings(TCtiSettings tCtiSettings)

Parameters

tCtiSettings TCtiSettings

The new CTI settings.

Returns

bool

UpdateNumberHistory(NumberHistory)

Inserts or Updates the given number history. If the UserID of the history id different from taht of the current the admin role is required.

public void UpdateNumberHistory(NumberHistory list)

Parameters

list NumberHistory

The history to be written to database

UpdateUser(UserEntry)

Updates the atrributes of the current user. The UserEntry object contains all writeable attributes of the user.

public void UpdateUser(UserEntry entry)

Parameters

entry UserEntry

The object including the attributes to be modified All values, that are set will bve stored into database. Attributes which are set to Null will be ignored.

UpdateUser(int, UserEntry)

Updates the atrributes of the given user. The UserEntry object contains all writeable attributes of the user. If the given user is not the current user, the APIRole UserAdminRW is required.

The ID of the given user. 
public void UpdateUser(int UserID, UserEntry entry)

Parameters

UserID int
entry UserEntry

The object including the attributes to be modified All values, that are set will bve stored into database. Attributes which are set to Null will be ignored.

Wait(int) 

public void Wait(int iMilliseconds)

Parameters

iMilliseconds int