Class DcfFacade

Namespace

SWConfigDataClientLib.Proxies.Dcf

Assembly

IpPbxCDSClientLib.dll

public class DcfFacade : DcfFacadeBase

Inheritance

object

SWCFProxy<DcfFacadeClient, IDcfFacade>

DcfFacadeBase

DcfFacade

Inherited Members

DcfFacadeBase.GetCallContext(bool)

DcfFacadeBase.CreateClient(Binding, EndpointAddress)

DcfFacadeBase.PingService(DcfFacadeClient)

DcfFacadeBase.GetServerRequestTimeout(DcfFacadeClient)

DcfFacadeBase.FreeForReuse()

DcfFacadeBase.GetSupportedClientVersions()

DcfFacadeBase.GetCurrentUserID()

DcfFacadeBase.GetCurrentUserName()

DcfFacadeBase.CheckVersion()

DcfFacadeBase.HasRole(BuildInRoles)

DcfFacadeBase.GetPossibleIpPbxUserNames()

DcfFacadeBase.m_BaseUrl

DcfFacadeBase.PoolMaxSize

DcfFacadeBase.PoolMinSize

Constructors

DcfFacade()

public DcfFacade()

Methods

ActivateVendorPackage(string, string, bool)

public bool ActivateVendorPackage(string packageId, string version, bool enabled)

Parameters

packageId string

version string

enabled bool

Returns

bool

AddFirmwareDcfs(IEnumerable<FirmwareDcf>)

public bool AddFirmwareDcfs(IEnumerable<FirmwareDcf> firmwareDcf)

Parameters

firmwareDcf IEnumerable<FirmwareDcf>

Returns

bool

AddKeyModule(int, string, DcfKeyModule)

public void AddKeyModule(int userId, string hardwareId, DcfKeyModule module)

Parameters

userId int

hardwareId string

module DcfKeyModule

CanUseRps()

public bool CanUseRps()

Returns

bool

CreateDcfDevice(UserDcfDevice)

public DcfDeviceInfo CreateDcfDevice(UserDcfDevice dcfDevice)

Parameters

dcfDevice UserDcfDevice

Returns

DcfDeviceInfo

CreateDectSystem(DectSystem)

public DectSystem CreateDectSystem(DectSystem dectSystem)

Parameters

dectSystem DectSystem

Returns

DectSystem

CreateUserPhone(int, string, string)

public DcfDeviceInfo CreateUserPhone(int userId, string macAddress, string pin)

Parameters

userId int

macAddress string

pin string

Returns

DcfDeviceInfo

DeleteDcfDevice(string)

public bool DeleteDcfDevice(string hardwareId)

Parameters

hardwareId string

Returns

bool

DeleteDcfDeviceByMacAddress(string)

public bool DeleteDcfDeviceByMacAddress(string macAddress)

Parameters

macAddress string

Returns

bool

DeleteDectSystem(int)

public DectSystem DeleteDectSystem(int dectSystemId)

Parameters

dectSystemId int

Returns

DectSystem

DeleteFirmware(string)

public bool DeleteFirmware(string phoneId)

Parameters

phoneId string

Returns

bool

DeleteFirmware(string, FirmwareFileType)

public bool DeleteFirmware(string phoneId, FirmwareFileType type)

Parameters

phoneId string

type FirmwareFileType

Returns

bool

DeleteFirmwareDcfById(int)

public bool DeleteFirmwareDcfById(int id)

Parameters

id int

Returns

bool

DeleteLogo(string)

public bool DeleteLogo(string phoneId)

Parameters

phoneId string

Returns

bool

DeletePhoneKey(int, string, int, int)

public bool DeletePhoneKey(int userId, string hardwareId, int moduleIndex, int keyIndex)

Parameters

userId int

hardwareId string

moduleIndex int

keyIndex int

Returns

bool

DeleteVendorPackage(string, string)

public bool DeleteVendorPackage(string packageId, string version)

Parameters

packageId string

version string

Returns

bool

EnableRemote(string, bool)

public EnableRemoteOnDeviceResult EnableRemote(string hardwareId, bool value)

Parameters

hardwareId string

value bool

Returns

EnableRemoteOnDeviceResult

GetAllFirmwares()

public FirmwareList GetAllFirmwares()

Returns

FirmwareList

GetAllGenericVendorDeviceInfos()

public ICollection<VendorDeviceInfo> GetAllGenericVendorDeviceInfos()

Returns

ICollection<VendorDeviceInfo>

GetAllGetFirmwareEntries(FirmwareFileType)

public FirmwareList GetAllGetFirmwareEntries(FirmwareFileType type)

Parameters

type FirmwareFileType

Returns

FirmwareList

GetAllLogos()

public FirmwareList GetAllLogos()

Returns

FirmwareList

GetAutoDetectUrlFlag()

public bool GetAutoDetectUrlFlag()

Returns

bool

GetDcfDeviceInfo(string)

public DcfDeviceInfo GetDcfDeviceInfo(string hardwareId)

Parameters

hardwareId string

Returns

DcfDeviceInfo

GetDcfDeviceInfoListOfTenant(DcfDeviceInfoFilter?, string)

public DcfDeviceInfoList GetDcfDeviceInfoListOfTenant(DcfDeviceInfoFilter? filter, string filterValue)

Parameters

filter DcfDeviceInfoFilter?

filterValue string

Returns

DcfDeviceInfoList

GetDcfDeviceInfoListOfUser(int)

public DcfDeviceInfoList GetDcfDeviceInfoListOfUser(int userId)

Parameters

userId int

Returns

DcfDeviceInfoList

GetDcfPoolUserId()

public int GetDcfPoolUserId()

Returns

int

GetDectSystem(int)

public DectSystem GetDectSystem(int dectSystemId)

Parameters

dectSystemId int

Returns

DectSystem

GetDectSystems()

public ICollection<DectSystem> GetDectSystems()

Returns

ICollection<DectSystem>

GetFirmware(string, FirmwareFileType, out string)

public string GetFirmware(string phoneId, FirmwareFileType fileType, out string fileName)

Parameters

phoneId string

fileType FirmwareFileType

fileName string

Returns

string

GetFirmwareDcfEntries()

public ICollection<FirmwareDcf> GetFirmwareDcfEntries()

Returns

ICollection<FirmwareDcf>

GetFirmwareInfo(string)

public Firmware GetFirmwareInfo(string phoneId)

Parameters

phoneId string

Returns

Firmware

GetFirmwareInfo(string, FirmwareFileType)

public Firmware GetFirmwareInfo(string phoneId, FirmwareFileType fileType)

Parameters

phoneId string

fileType FirmwareFileType

Returns

Firmware

GetFirmwareInfoAndReplace(string, string, Guid, bool)

public DcfFirmwareReplacementInfo GetFirmwareInfoAndReplace(string phoneTypeId, string originalfilename, Guid tempFileId, bool replace)

Parameters

phoneTypeId string

originalfilename string

tempFileId Guid

replace bool

Returns

DcfFirmwareReplacementInfo

GetFirmwareUri()

public string GetFirmwareUri()

Returns

string

GetHttpsRootCertificate()

public X509Certificate2 GetHttpsRootCertificate()

Returns

X509Certificate2

GetInstalledVendorPackages()

public ICollection<VendorPackage> GetInstalledVendorPackages()

Returns

ICollection<VendorPackage>

GetLocalizedKeyFunctions(IEnumerable<DeviceKeyFunction>)

public IDictionary<DeviceKeyFunction, string> GetLocalizedKeyFunctions(IEnumerable<DeviceKeyFunction> deviceKeyFunctions)

Parameters

deviceKeyFunctions IEnumerable<DeviceKeyFunction>

Returns

IDictionary<DeviceKeyFunction, string>

GetLogoInfo(string)

public Firmware GetLogoInfo(string phoneId)

Parameters

phoneId string

Returns

Firmware

GetOpenVpnServerState(out EndPoint)

public OpenVpnServerSetupState GetOpenVpnServerState(out EndPoint endPoint)

Parameters

endPoint EndPoint

Returns

OpenVpnServerSetupState

GetPhoneKey(int, string, int, int)

public UserDcfPhoneKey GetPhoneKey(int userId, string hardwareId, int keyModule, int keyIndex)

Parameters

userId int

hardwareId string

keyModule int

keyIndex int

Returns

UserDcfPhoneKey

GetPhoneKeyConfigurationByMacAddress(string)

public DcfDevicePhoneKeyConfigurationList GetPhoneKeyConfigurationByMacAddress(string hardwareId)

Parameters

hardwareId string

Returns

DcfDevicePhoneKeyConfigurationList

GetPhoneKeyFunctions(string, string)

public ICollection<DcfPhoneKeyFunctionInfo> GetPhoneKeyFunctions(string culture, string phoneId)

Parameters

culture string

phoneId string

Returns

ICollection<DcfPhoneKeyFunctionInfo>

GetPhoneKeys(int, string)

public ICollection<UserDcfPhoneKey> GetPhoneKeys(int userId, string hardwareId)

Parameters

userId int

hardwareId string

Returns

ICollection<UserDcfPhoneKey>

GetProvisioningUrl()

public string GetProvisioningUrl()

Returns

string

GetSntpServer()

public string GetSntpServer()

Returns

string

GetUserDcfDevices(UserDcfDeviceQueryParameters, out int)

public List<DcfDeviceInfo> GetUserDcfDevices(UserDcfDeviceQueryParameters parameters, out int totalCount)

Parameters

parameters UserDcfDeviceQueryParameters

totalCount int

Returns

List<DcfDeviceInfo>

ImportVendorPackageFile(Guid)

Imports a vendor package from an laready uploaded temporary package file

public bool ImportVendorPackageFile(Guid fileId)

Parameters

fileId Guid

File id of the uploaded file

Returns

bool

True if succeded

Remarks

A package file is a Zip archive containing a content.xml. In the content.xml there is a id of the package and a version. A package can be only imported once with a specified version.

MoveDcfDeviceToUser(int, string, int)

public void MoveDcfDeviceToUser(int fromUserId, string hardwareId, int toUserId)

Parameters

fromUserId int

hardwareId string

toUserId int

NotifyAllDcfPhones()

public bool NotifyAllDcfPhones()

Returns

bool

OnOpenVpnServerRenewal(out string, out string)

public OpenVpnServerUpdateInfo OnOpenVpnServerRenewal(out string revocationList, out string certificatePem)

Parameters

revocationList string

certificatePem string

Returns

OpenVpnServerUpdateInfo

OnOpenVpnServerSetup(string, int, string, out string)

public bool OnOpenVpnServerSetup(string host, int port, string protocol, out string certificatePem)

Parameters

host string

port int

protocol string

certificatePem string

Returns

bool

OnOpenVpnServerUninstall(bool)

public bool OnOpenVpnServerUninstall(bool removeConfiguration)

Parameters

removeConfiguration bool

Returns

bool

PutDcfDevice(string, UpdateDcfDeviceParameters)

public DcfDeviceInfo PutDcfDevice(string hardwareId, UpdateDcfDeviceParameters parameters)

Parameters

hardwareId string

parameters UpdateDcfDeviceParameters

Returns

DcfDeviceInfo

PutDcfDeviceAction(string, DcfDeviceAction)

public DcfDeviceInfo PutDcfDeviceAction(string hardwareId, DcfDeviceAction action)

Parameters

hardwareId string

action DcfDeviceAction

Returns

DcfDeviceInfo

PutDectSystem(DectSystem)

public DectSystem PutDectSystem(DectSystem dectSystem)

Parameters

dectSystem DectSystem

Returns

DectSystem

PutPhoneKeyConfiguration(int, string, IEnumerable<UserDcfPhoneKey>)

public bool PutPhoneKeyConfiguration(int userId, string hardwareId, IEnumerable<UserDcfPhoneKey> keyConfig)

Parameters

userId int

hardwareId string

keyConfig IEnumerable<UserDcfPhoneKey>

Returns

bool

RemoveKeyModule(int, string, int)

public void RemoveKeyModule(int userId, string hardwareId, int keyModuleToRemove)

Parameters

userId int

hardwareId string

keyModuleToRemove int

ReplaceDeviceLogo(string, string, Guid)

public bool ReplaceDeviceLogo(string phoneTypeId, string originalfilename, Guid tempFileId)

Parameters

phoneTypeId string

originalfilename string

tempFileId Guid

Returns

bool

ResetAllDcfCredentials()

public void ResetAllDcfCredentials()

RpsGetDeviceRegistrationStatusAsync(string, string, string)

public DeviceStatusResponse RpsGetDeviceRegistrationStatusAsync(string vendorId, string deviceTypeId, string macAddress)

Parameters

vendorId string

deviceTypeId string

macAddress string

Returns

DeviceStatusResponse

RpsRegisterAsync(DevicesRegistrationInfo)

public DeviceRegistrationResponse RpsRegisterAsync(DevicesRegistrationInfo devicesRegistrationInfo)

Parameters

devicesRegistrationInfo DevicesRegistrationInfo

Returns

DeviceRegistrationResponse

RpsUnregisterAsync(DevicesRegistrationInfo)

public DeviceRegistrationResponse RpsUnregisterAsync(DevicesRegistrationInfo devicesRegistrationInfo)

Parameters

devicesRegistrationInfo DevicesRegistrationInfo

Returns

DeviceRegistrationResponse

RpsUpdateRegistrationAsync(DevicesRegistrationInfo)

public DeviceRegistrationResponse RpsUpdateRegistrationAsync(DevicesRegistrationInfo devicesRegistrationInfo)

Parameters

devicesRegistrationInfo DevicesRegistrationInfo

Returns

DeviceRegistrationResponse

SetAutoDetectUrlFlag(bool)

public void SetAutoDetectUrlFlag(bool autoDetect)

Parameters

autoDetect bool

SetFirmwareUri(string)

public void SetFirmwareUri(string uri)

Parameters

uri string

SetHttpsRootCertificate(X509Certificate2Collection)

public void SetHttpsRootCertificate(X509Certificate2Collection certificateCollection)

Parameters

certificateCollection X509Certificate2Collection

SetProvisioningUrl(string)

public void SetProvisioningUrl(string provisioningUrl)

Parameters

provisioningUrl string

SetProvisioningUrlByAutoDetection()

public void SetProvisioningUrlByAutoDetection()

SetSntpServer(string)

public void SetSntpServer(string sntpServer)

Parameters

sntpServer string

UpdateDcfDeviceByUserId(int, string, DcfKeyModule, int)

public void UpdateDcfDeviceByUserId(int userId, string hardwareId, DcfKeyModule keyModule, int configuredKeyModules)

Parameters

userId int

hardwareId string

keyModule DcfKeyModule

configuredKeyModules int

UpdateDcfFirmwareInfosFromFis()

public bool UpdateDcfFirmwareInfosFromFis()

Returns

bool

UpdateLdapConfiguration()

public void UpdateLdapConfiguration()