Class UserEntry
- Namespace
- SWConfigDataClientLib.Proxies.Users
- Assembly
- IpPbxCDSClientLib.dll
UserEntry is an updateable user configuration item.
public class UserEntry : UserEntryBase- Inheritance
-
UserEntry
- Inherited Members
Constructors
UserEntry()
Standard Contructor
public UserEntry()Properties
IsIpPbxPasswordNull
Returns true if the item attribute has Null value (DBNull).
public bool IsIpPbxPasswordNull { get; }Property Value
Remarks
Thread Safety: safe
LoginTimeUser
Gets or sets the Login Time of this user in user local time.
public virtual SDateTime LoginTimeUser { get; set; }Property Value
Name
public override string Name { get; set; }Property Value
Remarks
Thread Safety: safe
RIPINDecrypted
Get and sets the Remote Inquiry PIN (decrypted)
public string RIPINDecrypted { get; set; }Property Value
Methods
AddRedialItem(RedialItemEntry)
adds given redial item to user's redial item list. This function writes the data straight into the database. There's no need to call Update(true).
public void AddRedialItem(RedialItemEntry entry)Parameters
entryRedialItemEntryRedialItem to be addded
Remarks
if the redial list reaches its maximum size the oldest entry will be removed
Exceptions
- UserDbException
On database failure
ApplyChanges(TForwardingConfig)
public void ApplyChanges(TForwardingConfig config)Parameters
configTForwardingConfig
ApplyChanges(TRemoteInquiry)
public void ApplyChanges(TRemoteInquiry config)Parameters
configTRemoteInquiry
ApplyChanges(TUserMediaConfig)
public void ApplyChanges(TUserMediaConfig config)Parameters
configTUserMediaConfig
ApplyChanges(TUserStatic)
public void ApplyChanges(TUserStatic config)Parameters
configTUserStatic
ApplyChanges(TVoicemailCounter)
public void ApplyChanges(TVoicemailCounter config)Parameters
configTVoicemailCounter
DeleteRedialItem(int)
delete phone call from user's phone call list
public void DeleteRedialItem(int RedialItemID)Parameters
RedialItemIDint
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
DeleteRedialItems()
Deletes the users List of redial items to database. All existing phonebook entries will be removed.
public void DeleteRedialItems()Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
DeleteUserPhoneCall(int)
Delete a single UserPhoneCall
public void DeleteUserPhoneCall(int IpPbxPhoneCallID)Parameters
IpPbxPhoneCallIDintThe phonecall ID. Same as the CDR CallID.
DeleteUserPhoneCallbackRequest(int)
Deletes a single UserPhoneCallbackRequest.
public void DeleteUserPhoneCallbackRequest(int IpPbxPhoneCallID)Parameters
IpPbxPhoneCallIDintThe phonecall ID. Same as the CDR CallID.
DeleteUserPhoneCallbackRequests()
Deletes all PhoneCallbackRequests of the current user.
public void DeleteUserPhoneCallbackRequests()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
GetIntrusionNumbers()
Returns the UTC Bias of this user
public string GetIntrusionNumbers()Returns
GetPhoneBook(string)
Retrieve the users phonebook entries matching the name
public PhoneBookEntryCollection GetPhoneBook(string name)Parameters
namestringif non empty only the entry with name szName is returned
Returns
- PhoneBookEntryCollection
Collection of Phonebook Entries
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
GetRedialItems()
Retrieve the users redial item entries
public RedialItemEntryCollection GetRedialItems()Returns
- RedialItemEntryCollection
Collection of Redial Item Entries
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
GetSituations()
retrieve user defined situations into database
public UserSituationEntryCollection GetSituations()Returns
- UserSituationEntryCollection
Collection of UserSituatuions
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
GetUTCBias()
Returns the UTC Bias of this user. (Including DLST)
public int GetUTCBias()Returns
GetUserConfigData()
Set the users ConfigData (blob)
public byte[] GetUserConfigData()Returns
- byte[]
The ConfigData Byte Array. Return empty array if no data is avaiable.
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
GetUserMINs()
Retrieves the list of MobileIdentificationNumbers (MINs) for the current user.
public SStringList GetUserMINs()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
OnlyNewbool
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
HasUserNewPhoneCalls()
Returns weather the user has new, not already viewed, phonecall entries.
public bool HasUserNewPhoneCalls()Returns
- bool
True is there are not viewed entries
RemoveFromEnum()
Removes the user item from enumaration. The user will left unchanged in the database.
public void RemoveFromEnum()Remarks
This is a remote method.
SetPhoneBook(PhoneBookEntryCollection)
Saves the users Phonebook to database. All existing phonebook entries will be removed.
public void SetPhoneBook(PhoneBookEntryCollection entries)Parameters
entriesPhoneBookEntryCollection
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
SetScriptPathForUpdate(string)
Set the attribute scriptPath. This attribute will be filled automaticly. So this method should only be used in context of update from SwyxWare 5.1 to SwyxWare 6.0.
public void SetScriptPathForUpdate(string scriptPath)Parameters
scriptPathstring
SetSituations(UserSituationEntryCollection)
save user defined situations into database
public void SetSituations(UserSituationEntryCollection userSituations)Parameters
userSituationsUserSituationEntryCollectionCollection of UserSituatuions
Remarks
This writes the situations into the database. No Update(true) required.
Exceptions
- UserDbException
On database failure
SetUserConfigData(byte[])
Set the users ConfigData (blob)
public void SetUserConfigData(byte[] ConfigData)Parameters
ConfigDatabyte[]Blob data as byte array
Remarks
This is a remote method.
Exceptions
- UserDbException
On database failure
SetUserMINs(SStringList)
Sets the list of mobile idtenification numbers (MINs) for the given user.
public void SetUserMINs(SStringList MINs)Parameters
MINsSStringListList of MINs
SetUserPhoneCallListAsViewed(bool)
Sets the viewed state to all UserPhoneCalls of the current user.
public void SetUserPhoneCallListAsViewed(bool value)Parameters
valueboolTrue 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
IpPbxPhoneCallIDintThe phonecall ID. Same as the CDR CallID.
CallBackStateSPCBStateThe new state
ToString()
String representation
public override string ToString()