Class DataCacheUserClientData

Namespace

SWConfigDataClientLib.Proxies.PhoneClient

Assembly

IpPbxCDSClientLib.dll

Container object for cached data used by SwyxIt!. Cached objects: All data access methods are returning locally cached data without any io operation. The cached data will be updated asynchronously by notify messages from the cds and by reload action for specified entities.

public class DataCacheUserClientData

Inheritance

object

DataCacheUserClientData

Constructors

DataCacheUserClientData()

public DataCacheUserClientData()

Methods

Clear()

Removes all data from cache and removes references to LibManager object

public void Clear()

GetCallbackOnBusyRequestList()

public SCallbackOnBusyRequestList GetCallbackOnBusyRequestList()

Returns

SCallbackOnBusyRequestList

GetCallbackOnBusyRequestList(int)

public SCallbackOnBusyRequestList GetCallbackOnBusyRequestList(int userId)

Parameters

userId int

Returns

SCallbackOnBusyRequestList

GetHotKey(int)

public HotKeyInfo GetHotKey(int index)

Parameters

index int

Returns

HotKeyInfo

GetHotKey(int, int)

public HotKeyInfo GetHotKey(int userId, int index)

Parameters

userId int

index int

Returns

HotKeyInfo

GetKeyValuePair(int, string)

public KeyValuePairInfo GetKeyValuePair(int userId, string key)

Parameters

userId int

key string

Returns

KeyValuePairInfo

GetKeyValuePair(string)

public KeyValuePairInfo GetKeyValuePair(string key)

Parameters

key string

Returns

KeyValuePairInfo

GetLineKey(int)

public LineKey GetLineKey(int index)

Parameters

index int

Returns

LineKey

GetLineKey(int, int)

public LineKey GetLineKey(int userId, int index)

Parameters

userId int

index int

Returns

LineKey

GetLineKeyList()

public SLineKeyList GetLineKeyList()

Returns

SLineKeyList

GetLineKeyList(int)

public SLineKeyList GetLineKeyList(int userId)

Parameters

userId int

Returns

SLineKeyList

GetNameKeyList()

public SNameKeyList GetNameKeyList()

Returns

SNameKeyList

GetNameKeyList(int)

public SNameKeyList GetNameKeyList(int userId)

Parameters

userId int

Returns

SNameKeyList

GetNumberOfHotKeys()

public int GetNumberOfHotKeys()

Returns

int

GetNumberOfHotKeys(int)

public int GetNumberOfHotKeys(int userId)

Parameters

userId int

Returns

int

GetNumberOfLineKeys()

public int GetNumberOfLineKeys()

Returns

int

GetNumberOfLineKeys(int)

public int GetNumberOfLineKeys(int userId)

Parameters

userId int

Returns

int

GetNumberOfRingingSounds()

public int GetNumberOfRingingSounds()

Returns

int

GetNumberOfRingingSounds(int)

public int GetNumberOfRingingSounds(int userId)

Parameters

userId int

Returns

int

GetNumberOfTabs()

public int GetNumberOfTabs()

Returns

int

GetNumberOfTabs(int)

public int GetNumberOfTabs(int userId)

Parameters

userId int

Returns

int

GetNumberOfUrlKeys()

public int GetNumberOfUrlKeys()

Returns

int

GetNumberOfUrlKeys(int)

public int GetNumberOfUrlKeys(int userId)

Parameters

userId int

Returns

int

GetPhoneSettings(int)

public PhoneSettingListDto GetPhoneSettings(int userId)

Parameters

userId int

Returns

PhoneSettingListDto

GetPredefinedKeyValuePair(PredefinedClientDataKey)

public KeyValuePairInfo GetPredefinedKeyValuePair(KeyValuePairInfo.PredefinedClientDataKey predefinedClientDataKey)

Parameters

predefinedClientDataKey PredefinedClientDataKey

Returns

KeyValuePairInfo

GetPredefinedKeyValuePair(int, PredefinedClientDataKey)

public KeyValuePairInfo GetPredefinedKeyValuePair(int userId, KeyValuePairInfo.PredefinedClientDataKey predefinedClientDataKey)

Parameters

userId int

predefinedClientDataKey PredefinedClientDataKey

Returns

KeyValuePairInfo

GetReloadContentTypeFromString(string)

public static ReloadContent GetReloadContentTypeFromString(string updateType)

Parameters

updateType string

Returns

ReloadContent

GetRingingSoundInfo(int)

public RingingSoundInfo GetRingingSoundInfo(int iIndex)

Parameters

iIndex int

Returns

RingingSoundInfo

GetRingingSoundInfo(int, int)

public RingingSoundInfo GetRingingSoundInfo(int userId, int iIndex)

Parameters

userId int

iIndex int

Returns

RingingSoundInfo

GetTabInfo(int)

public TabInfo GetTabInfo(int index)

Parameters

index int

Returns

TabInfo

GetTabInfo(int, int)

public TabInfo GetTabInfo(int userId, int index)

Parameters

userId int

index int

Returns

TabInfo

GetUpdateTypeFromString(string)

public static UserClientDataUpdateType GetUpdateTypeFromString(string updateType)

Parameters

updateType string

Returns

UserClientDataUpdateType

GetUrlKey(int)

public UrlKeyInfo GetUrlKey(int index)

Parameters

index int

Returns

UrlKeyInfo

GetUrlKey(int, int)

public UrlKeyInfo GetUrlKey(int userId, int index)

Parameters

userId int

index int

Returns

UrlKeyInfo

IsListEmpty(UserClientDataUpdateType)

public bool IsListEmpty(UserClientDataUpdateType listType)

Parameters

listType UserClientDataUpdateType

Returns

bool

IsListEmpty(int, UserClientDataUpdateType)

public bool IsListEmpty(int userId, UserClientDataUpdateType listType)

Parameters

userId int

listType UserClientDataUpdateType

Returns

bool

LoadAll()

Loads all data from the CDS (except License and Feature data)

public void LoadAll()

LoadAllAfterReconnect()

Loads all data from the CDS. Will be called after reconnection to the CDS

public void LoadAllAfterReconnect()

OnConnect(LibManager, DataCacheSubscription, bool, bool)

Initializes the cache with data connection to CDS

public void OnConnect(LibManager libManager, DataCacheSubscription subscription, bool multiUserMode, bool loadAll)

Parameters

libManager LibManager

The connection that will be used by the cache.

subscription DataCacheSubscription

multiUserMode bool

loadAll bool

If true the cache will load all data from database into cache. Should be true in most cases.

OnDisconnect()

public void OnDisconnect()

PutCallbackOnBusyRequestList(SCallbackOnBusyRequestList)

public SCallbackOnBusyRequestList PutCallbackOnBusyRequestList(SCallbackOnBusyRequestList list)

Parameters

list SCallbackOnBusyRequestList

Returns

SCallbackOnBusyRequestList

PutCallbackOnBusyRequestList(int, SCallbackOnBusyRequestList)

public SCallbackOnBusyRequestList PutCallbackOnBusyRequestList(int userId, SCallbackOnBusyRequestList list)

Parameters

userId int

list SCallbackOnBusyRequestList

Returns

SCallbackOnBusyRequestList

PutHotKey(int, HotKeyInfo, out bool)

public void PutHotKey(int index, HotKeyInfo keyInfo, out bool bValueChanged)

Parameters

index int

keyInfo HotKeyInfo

bValueChanged bool

PutHotKey(int, int, HotKeyInfo, out bool)

public void PutHotKey(int userId, int index, HotKeyInfo keyInfo, out bool bValueChanged)

Parameters

userId int

index int

keyInfo HotKeyInfo

bValueChanged bool

PutKeyValuePair(KeyValuePairInfo, bool)

public void PutKeyValuePair(KeyValuePairInfo keyValuePair, bool directUpload)

Parameters

keyValuePair KeyValuePairInfo

directUpload bool

PutKeyValuePair(int, KeyValuePairInfo, bool)

public void PutKeyValuePair(int userId, KeyValuePairInfo keyValuePair, bool directUpload)

Parameters

userId int

keyValuePair KeyValuePairInfo

directUpload bool

PutLineKeyList()

public SLineKeyList PutLineKeyList()

Returns

SLineKeyList

PutLineKeyList(SLineKeyList)

public SLineKeyList PutLineKeyList(SLineKeyList list)

Parameters

list SLineKeyList

Returns

SLineKeyList

PutLineKeyList(int)

public SLineKeyList PutLineKeyList(int userId)

Parameters

userId int

Returns

SLineKeyList

PutLineKeyList(int, SLineKeyList)

public SLineKeyList PutLineKeyList(int userId, SLineKeyList list)

Parameters

userId int

list SLineKeyList

Returns

SLineKeyList

PutNumberOfHotKeys(int)

public bool PutNumberOfHotKeys(int number)

Parameters

number int

Returns

bool

PutNumberOfHotKeys(int, int)

public bool PutNumberOfHotKeys(int userId, int number)

Parameters

userId int

number int

Returns

bool

PutNumberOfLineKeys(int)

public SLineKeyList PutNumberOfLineKeys(int numberLineKeys)

Parameters

numberLineKeys int

Returns

SLineKeyList

PutNumberOfLineKeys(int, int)

public SLineKeyList PutNumberOfLineKeys(int userId, int numberLineKeys)

Parameters

userId int

numberLineKeys int

Returns

SLineKeyList

PutNumberOfRingingSounds(int)

public void PutNumberOfRingingSounds(int number)

Parameters

number int

PutNumberOfRingingSounds(int, int)

public void PutNumberOfRingingSounds(int userId, int number)

Parameters

userId int

number int

PutNumberOfTabs(int)

public bool PutNumberOfTabs(int number)

Parameters

number int

Returns

bool

PutNumberOfTabs(int, int)

public bool PutNumberOfTabs(int userId, int number)

Parameters

userId int

number int

Returns

bool

PutPhoneSetting(int, PhoneSettingDto)

public void PutPhoneSetting(int userId, PhoneSettingDto phoneSetting)

Parameters

userId int

phoneSetting PhoneSettingDto

PutRingingSound(RingingSoundInfo)

public void PutRingingSound(RingingSoundInfo info)

Parameters

info RingingSoundInfo

PutRingingSound(int, RingingSoundInfo)

public void PutRingingSound(int userId, RingingSoundInfo info)

Parameters

userId int

info RingingSoundInfo

PutTabInfoList()

public STabInfoList PutTabInfoList()

Returns

STabInfoList

PutTabInfoList(int)

public STabInfoList PutTabInfoList(int userId)

Parameters

userId int

Returns

STabInfoList

PutUrlKey(UrlKeyInfo, out bool)

public void PutUrlKey(UrlKeyInfo keyInfo, out bool changed)

Parameters

keyInfo UrlKeyInfo

changed bool

PutUrlKey(int, UrlKeyInfo, out bool)

public void PutUrlKey(int userId, UrlKeyInfo keyInfo, out bool changed)

Parameters

userId int

keyInfo UrlKeyInfo

changed bool

SetMaxNameKeyCount(int)

public void SetMaxNameKeyCount(int count)

Parameters

count int

SetMaxNameKeyCount(int, int)

public void SetMaxNameKeyCount(int userId, int count)

Parameters

userId int

count int

SetNumberOfUrlKeys(int)

public void SetNumberOfUrlKeys(int number)

Parameters

number int

SetNumberOfUrlKeys(int, int)

public void SetNumberOfUrlKeys(int userId, int number)

Parameters

userId int

number int

SetPhoneSettingToDefault(PhoneSettingDto, string)

public static void SetPhoneSettingToDefault(PhoneSettingDto phoneSetting, string phoneType)

Parameters

phoneSetting PhoneSettingDto

phoneType string

UpdateNameKeyList()

public bool UpdateNameKeyList()

Returns

bool

UpdateNameKeyList(int)

public bool UpdateNameKeyList(int userId)

Parameters

userId int

Returns

bool

UploadChangedKeyValuePairs()

public bool UploadChangedKeyValuePairs()

Returns

bool

UploadChangedKeyValuePairs(int)

public bool UploadChangedKeyValuePairs(int userId)

Parameters

userId int

Returns

bool

UploadHotKeyInfoList()

public SHotKeyInfoList UploadHotKeyInfoList()

Returns

SHotKeyInfoList

UploadHotKeyInfoList(int)

public SHotKeyInfoList UploadHotKeyInfoList(int userId)

Parameters

userId int

Returns

SHotKeyInfoList

UploadRingingSoundList()

public bool UploadRingingSoundList()

Returns

bool

UploadRingingSoundList(int)

public bool UploadRingingSoundList(int userId)

Parameters

userId int

Returns

bool

UploadUrlKeyList()

public void UploadUrlKeyList()

UploadUrlKeyList(int)

public void UploadUrlKeyList(int userId)

Parameters

userId int

Verbose()

public string Verbose()

Returns

string

Verbose(int)

public string Verbose(int userId)

Parameters

userId int

Returns

string

Events

OnChangeReceived

Occurs after cached data has been changed

public event ChangeReceivedEventHandler OnChangeReceived

Event Type

ChangeReceivedEventHandler