Class UserPhoneBookEnum

Namespace
SWConfigDataClientLib.Proxies.UserPhoneBook
Assembly
IpPbxCDSClientLib.dll
public class UserPhoneBookEnum : UserPhoneBookEnumBase, SEnum
Inheritance
SWCFProxy<UserPhoneBookEnumClient, IUserPhoneBookEnum>
SWCFEnum<UserPhoneBookEnumClient, IUserPhoneBookEnum>
UserPhoneBookEnum
Implements
Inherited Members

Constructors

UserPhoneBookEnum() 

public UserPhoneBookEnum()

Properties

AutomaticUpdateEnabled

Gets value wether automatic update by callback is enabled. (Default: false)

public bool AutomaticUpdateEnabled { 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

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

CheckVersion() 

public void CheckVersion()

Clear()

Removes all itmes and filters, DataSet on server will be removed also

public override void Clear()

Remarks

The items will not be deleted in database.

CreateAvatarCollection() 

public AvatarBitmapCollection CreateAvatarCollection()

Returns

AvatarBitmapCollection

CreateClient(Binding, EndpointAddress) 

protected override UserPhoneBookEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

UserPhoneBookEnumClient

DeleteEditablePhoneBookEntry(int)

Deletes an new PhoneBookEntry directly

public void DeleteEditablePhoneBookEntry(int EntryID)

Parameters

EntryID int

The EntryID of the entry to be deleted.

DisableAutomaticUpdate()

Stops the update by callback from the CDS service. All locally subscribed usr will be unsubscribed

public void DisableAutomaticUpdate()

EnableAutomaticUpdate(OfficeUCSubscription)

Enables the update of the local phonebook by callbacks from the CDS services.

public void EnableAutomaticUpdate(OfficeUCSubscription subscription)

Parameters

subscription OfficeUCSubscription

Office UC subscription that will be used by for notifying status changes for all subscribed users.

ExecuteFilterAll(OrderByList)

Sets filter on UserPhoneBook retrieving all entries creates and executes SQL query on PhoneBook table in configuration database

public void ExecuteFilterAll(OrderByList orderByList)

Parameters

orderByList OrderByList

Remarks

This is a remote method.

ExecuteFilterAll(OrderByList, bool)

Sets filter on UserPhoneBook retrieving all entries creates and executes SQL query on PhoneBook table in configuration database

public void ExecuteFilterAll(OrderByList orderByList, bool notForUpdate)

Parameters

orderByList OrderByList
notForUpdate bool

Remarks

This is a remote method.

ExecuteFilterAll(int, OrderByList)

Sets filter on UserPhoneBook retrieving all entries creates and executes SQL query on PhoneBook table in configuration database

public void ExecuteFilterAll(int UserID, OrderByList orderByList)

Parameters

UserID int
orderByList OrderByList

Remarks

This is a remote method.

ExecuteFilterAll(int, OrderByList, bool)

Sets filter on UserPhoneBook retrieving all entries creates and executes SQL query on PhoneBook table in configuration database

public void ExecuteFilterAll(int UserID, OrderByList orderByList, bool readOnly)

Parameters

UserID int
orderByList OrderByList
readOnly bool

Remarks

This is a remote method.

FreeForReuse() 

public override void FreeForReuse()

GetAllUserEmailAddresses()

Get all email addresses

public SStringList GetAllUserEmailAddresses()

Returns

SStringList

List of all email addresses

GetChatUserId(QualilifiedEntityID)

Lookup for user chat id

public string GetChatUserId(QualilifiedEntityID userId)

Parameters

userId QualilifiedEntityID

Returns

string

ChatUserId which is a string

GetCurrentUserID() 

public int GetCurrentUserID()

Returns

int

GetCurrentUserName() 

public string GetCurrentUserName()

Returns

string

GetEMailAddress(int)

Gets a list of configured user email addresses of the given user.

public SStringList GetEMailAddress(int userId)

Parameters

userId int

user id of the user

Returns

SStringList

List of user email addresses

GetEntityInfoText(QualilifiedEntityID) 

public string GetEntityInfoText(QualilifiedEntityID cID)

Parameters

cID QualilifiedEntityID

Returns

string

GetOrderByList()

Gets a list of all possible sorting elements.

public override OrderByList GetOrderByList()

Returns

OrderByList

The object OrderByList containing all possible sorting elements.

Remarks

Thread Safety: safe

GetPBXPhoneBook(string, bool, bool)

Gets the PBXPhoneBook optionaly filterd by Name

public PBXPhoneBookPrimaryCollection GetPBXPhoneBook(string Name, bool bShowHidden, bool bFillUserState)

Parameters

Name string

The optional name of the entry. Can contain '%' and '_'. Use '%' to get all entries.

bShowHidden bool

If true hidden entries will be returned

bFillUserState bool

If true the current state of all entries assigned to an user will be filled. This action calls the IpPbxServer.

Returns

PBXPhoneBookPrimaryCollection

Remarks

This is a remote method.

GetPBXPhoneBookEx(string, bool, bool, bool, bool)

Gets the PBXPhoneBook optionaly filterd by Name and or Number.

public PBXPhoneBookPrimaryCollection GetPBXPhoneBookEx(string SearchPattern, bool SeachNames, bool SearchNumbers, bool bShowHidden, bool bFillUserState)

Parameters

SearchPattern string

The search pattern, it an contain '%' and '_'. Use '%' to get all entries.

SeachNames bool

Search by name

SearchNumbers bool
bShowHidden bool

If true hidden entries will be returned

bFillUserState bool

If true the current state of all entries assigned to an user will be filled. This action calls the IpPbxServer.

Returns

PBXPhoneBookPrimaryCollection

Remarks

This is a remote method.

GetPBXPhoneBookLimited(string, bool, bool)

Gets the first 30 machting PBXPhoneBook entries filterd by Name

public PBXPhoneBookPrimaryCollection GetPBXPhoneBookLimited(string Name, bool bShowHidden, bool bFillUserState)

Parameters

Name string

The optional name of the entry. Can contain '%' and '_'. Use '%' to get all entries.

bShowHidden bool

If true hidden entries will be returned

bFillUserState bool

If true the current state of all entries assigned to an user will be filled. This action calls the IpPbxServer.

Returns

PBXPhoneBookPrimaryCollection

Remarks

This is a remote method.

GetPBXPhoneBookLimitedEx(string, bool, bool, bool, bool)

Gets the PBXPhoneBook optionaly filterd by Name and or Number with a maximal result of 30 entries.

public PBXPhoneBookPrimaryCollection GetPBXPhoneBookLimitedEx(string SearchPattern, bool SeachNames, bool SearchNumbers, bool bShowHidden, bool bFillUserState)

Parameters

SearchPattern string

The search pattern, it an contain '%' and '_'. Use '%' to get all entries.

SeachNames bool

Search by name

SearchNumbers bool
bShowHidden bool

If true hidden entries will be returned

bFillUserState bool

If true the current state of all entries assigned to an user will be filled. This action calls the IpPbxServer.

Returns

PBXPhoneBookPrimaryCollection

Remarks

This is a remote method.

GetPBXPhonebookElements2(int, bool, bool, bool, long, out long[], out TPBXPhonebookExternalNumberData[], out TPBXEditablePhonebookEntryData[], out TPBXPhonebookInternalNumberData[], out TPBXPhonebookPublicNumberData[], out TPBXPhonebookUserData[], out TPBXPhonebookGroupData[], out TPBXPhonebookSiteData[], out TPBXPhonebookStatusEntry2[], out TPBXPhonebookRichStatusEntry[], out long, out long) 

public void GetPBXPhonebookElements2(int iUserID, bool bAllEntries, bool bStatus, bool bRichStatus, long lClientTimestamp, out long[] aDeletedEntries, out TPBXPhonebookExternalNumberData[] aExternalNumbers, out TPBXEditablePhonebookEntryData[] aEditableEntries, out TPBXPhonebookInternalNumberData[] aInternalNumbers, out TPBXPhonebookPublicNumberData[] aPublicNumbers, out TPBXPhonebookUserData[] aUserEntries, out TPBXPhonebookGroupData[] aGroupEntries, out TPBXPhonebookSiteData[] aSiteEntries, out TPBXPhonebookStatusEntry2[] aStatusEntries, out TPBXPhonebookRichStatusEntry[] aRichStatusEntries, out long lServerTimeStamp, out long lServerProcessRef)

Parameters

iUserID int
bAllEntries bool
bStatus bool
bRichStatus bool
lClientTimestamp long
aDeletedEntries long[]
aExternalNumbers TPBXPhonebookExternalNumberData[]
aEditableEntries TPBXEditablePhonebookEntryData[]
aInternalNumbers TPBXPhonebookInternalNumberData[]
aPublicNumbers TPBXPhonebookPublicNumberData[]
aUserEntries TPBXPhonebookUserData[]
aGroupEntries TPBXPhonebookGroupData[]
aSiteEntries TPBXPhonebookSiteData[]
aStatusEntries TPBXPhonebookStatusEntry2[]
aRichStatusEntries TPBXPhonebookRichStatusEntry[]
lServerTimeStamp long
lServerProcessRef long

GetPBXPhonebookElements2(int, bool, bool, long, out long[], out TPBXPhonebookExternalNumberData[], out TPBXEditablePhonebookEntryData[], out TPBXPhonebookInternalNumberData[], out TPBXPhonebookPublicNumberData[], out TPBXPhonebookUserData[], out TPBXPhonebookGroupData[], out TPBXPhonebookSiteData[], out TPBXPhonebookStatusEntry2[], out long, out long) 

public void GetPBXPhonebookElements2(int iUserID, bool bAllEntries, bool bStatus, long lClientTimestamp, out long[] aDeletedEntries, out TPBXPhonebookExternalNumberData[] aExternalNumbers, out TPBXEditablePhonebookEntryData[] aEditableEntries, out TPBXPhonebookInternalNumberData[] aInternalNumbers, out TPBXPhonebookPublicNumberData[] aPublicNumbers, out TPBXPhonebookUserData[] aUserEntries, out TPBXPhonebookGroupData[] aGroupEntries, out TPBXPhonebookSiteData[] aSiteEntries, out TPBXPhonebookStatusEntry2[] aStatusEntries, out long lServerTimeStamp, out long lServerProcessRef)

Parameters

iUserID int
bAllEntries bool
bStatus bool
lClientTimestamp long
aDeletedEntries long[]
aExternalNumbers TPBXPhonebookExternalNumberData[]
aEditableEntries TPBXEditablePhonebookEntryData[]
aInternalNumbers TPBXPhonebookInternalNumberData[]
aPublicNumbers TPBXPhonebookPublicNumberData[]
aUserEntries TPBXPhonebookUserData[]
aGroupEntries TPBXPhonebookGroupData[]
aSiteEntries TPBXPhonebookSiteData[]
aStatusEntries TPBXPhonebookStatusEntry2[]
lServerTimeStamp long
lServerProcessRef long

GetPersonalContactsFromServer(PersonalContactQuery) 

public PersonalContactResult GetPersonalContactsFromServer(PersonalContactQuery queryParameters)

Parameters

queryParameters PersonalContactQuery

Returns

PersonalContactResult

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

GetPresenceInfoForAllChatUsers()

Get presence info for all user that have an associated chatUserId(e.g. coligo system)

public RichPresenceInfoList GetPresenceInfoForAllChatUsers()

Returns

RichPresenceInfoList

List of presence info structures

GetRichPresenceInformation(QualilifiedEntityID, ref RichPresenceInfo)

Gets the rich status information for an user.

public bool GetRichPresenceInformation(QualilifiedEntityID cID, ref RichPresenceInfo cInfo)

Parameters

cID QualilifiedEntityID

Id of the user

cInfo RichPresenceInfo

The status info

Returns

bool

True if user and status is available

GetRichPresenceInformation(string, out RichPresenceInfo)

Gets the rich status information for an user.

public bool GetRichPresenceInformation(string userEmailAddress, out RichPresenceInfo richPresenceInfo)

Parameters

userEmailAddress string

The user email address or number identifying the user.

richPresenceInfo RichPresenceInfo

The status info of the user

Returns

bool

True if user and status is available

GetServerRequestTimeout(UserPhoneBookEnumClient) 

protected override TimeSpan GetServerRequestTimeout(UserPhoneBookEnumClient client)

Parameters

client UserPhoneBookEnumClient

Returns

TimeSpan

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetUserIdByIntExtOrPubNumber(string)

Lookup for qualified user id by an internal, external or public phone number

public QualilifiedEntityID GetUserIdByIntExtOrPubNumber(string phoneNumber)

Parameters

phoneNumber string

A phone number belonging to a user in the phonebook.

Returns

QualilifiedEntityID

QualifiedEntityID of the user (or default EntityID, if not found)

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

LookupUserEmailAddress(string)

Lookup for user email address

public bool LookupUserEmailAddress(string userEmailAddress)

Parameters

userEmailAddress string

The user email address or number identifying the user.

Returns

bool

True if email address exists

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

Modifies 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.

PingService(UserPhoneBookEnumClient) 

protected override void PingService(UserPhoneBookEnumClient client)

Parameters

client UserPhoneBookEnumClient

ReloadPBXPhonebookData()

Reloads the phone book manually from the CDS. (Works only if autmatic update is enabled) This method is designed for testing purposes.

public void ReloadPBXPhonebookData()

SetOwnPresenceInfoSubscription(OwnPresenceInfoSubscription)

Sets an auxiliary subcrition to get informed about status updates of the own user

public void SetOwnPresenceInfoSubscription(OwnPresenceInfoSubscription subscription)

Parameters

subscription OwnPresenceInfoSubscription

Generic subscription

SetPhonebookReloadSubscription(GenericSubscription)

Sets an auxiliary subcrition to get informed about reloads

public void SetPhonebookReloadSubscription(GenericSubscription subscription)

Parameters

subscription GenericSubscription

Generic subscription

SubscribeForCurrentUserStatus()

Subscribes for status changes of a given user. (Locally only)

public bool SubscribeForCurrentUserStatus()

Returns

bool

True is successfull

SubscribeForStatus(int, int)

Subscribes for status changes of a given user. (Locally only)

public bool SubscribeForStatus(int userID, int siteID)

Parameters

userID int

The id of the user

siteID int

The id of the users site. Can be 0 for the local site.

Returns

bool

True is successfull

TestGetPBXPhonebookElementCount(int)

Reads all phonebook elements from CDS. Use this method for testing only!

public int TestGetPBXPhonebookElementCount(int iUserID)

Parameters

iUserID int

UserID of the user

Returns

int

UnsubscribeForStatus(int, int)

Unsubscribes for status changes of a given user. (Locally only)

public bool UnsubscribeForStatus(int userID, int siteID)

Parameters

userID int

The id of the user

siteID int

The id of the users site. Can be 0 for the local site.

Returns

bool

True is successfull