Class FilesFacade
- Namespace
- SWConfigDataClientLib.Proxies.Files
- Assembly
- IpPbxCDSClientLib.dll
Facade class handling with files in the database. This facade is intended to be used by administrative and non administrative users. The FileFacade provides a client file cache for each user and client application.
public class FilesFacade : FilesFacadeBase
- Inheritance
-
SWCFProxy<FilesFacadeClient, IFilesFacade>FilesFacade
- Inherited Members
Constructors
FilesFacade()
Creates instance of FilesFacade. (For use by Unmanaged Wrapper only)
public FilesFacade()
Remarks
Use the LibManager to create an instance of this class.
Properties
AutoAdaptingFileChunkSize
Get or sets the weather the block size will be adapted automatically.
public bool AutoAdaptingFileChunkSize { get; set; }
Property Value
DownloadChunkSizeInBytes
Get or sets the block size used for downloading files
public int DownloadChunkSizeInBytes { get; set; }
Property Value
PoolMaxSize
depcreated
public static int PoolMaxSize { get; set; }
Property Value
PoolMinSize
depcreated
public static int PoolMinSize { get; set; }
Property Value
UploadChunkSizeInBytes
Get or sets the block size used for uploading files
public int UploadChunkSizeInBytes { get; set; }
Property Value
m_BaseUrl
protected override string m_BaseUrl { get; }
Property Value
Methods
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, bool, bool, string, bool, bool, string, byte[], bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, bool, bool, string, bool, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, bool, bool, string, bool, bool, string, string, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, bool, bool, string, bool, bool, string, string, bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, int, bool, bool, string, bool, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, int GroupID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or 0 if Scope is Global.
GroupID
intThe id of the owning user. Or 0 if Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, PreDefinedFileCategory, int, int, bool, bool, string, bool, bool, string, string, bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, PreDefinedFileCategory Category, int UserID, int GroupID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
UserID
intThe id of the owning user. Or 0 if Scope is Global.
GroupID
intThe id of the owning group. Or 0 if Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, bool, bool, string, bool, bool, string, byte[], bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, bool, bool, string, bool, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, bool, bool, string, bool, bool, string, string, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or o is Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, bool, bool, string, bool, bool, string, string, bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or 0 if Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, int, bool, bool, string, bool, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, int GroupID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or 0 if Scope is Global.
GroupID
intThe id of the owning user. Or 0 if Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxFile(string, FileScope, string, int, int, bool, bool, string, bool, bool, string, string, bool, bool)
Method to add file to database, this method is intended tu be used by administrators only.
public FileListEntry AddIpPbxFile(string Name, FileScope Scope, string Category, int UserID, int GroupID, bool bHidden, bool bPrivate, string Description, bool bSystem, bool bReadOnly, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
UserID
intThe id of the owning user. Or 0 if Scope is Global.
GroupID
intThe id of the owning group. Or 0 if Scope is Global.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
bReadOnly
boolIf true only read access will be provided.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxGroupFile(int, string, PreDefinedFileCategory, bool, bool, string, bool, string, string, bool, bool)
Method to add files to database into the group scope, this method is intended to be used for user self administration and administrators. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxGroupFile(int groupId, string name, PreDefinedFileCategory category, bool hidden, bool privateFile, string description, bool system, string culture, string localFilename, bool overwrite, bool skipCompression)
Parameters
groupId
intname
stringName of the new file.
category
PreDefinedFileCategoryCategory of the file.
hidden
boolSet true is file should be hidden
privateFile
boolSet true to deny read access by users/administrators that are not group members
description
stringDescription of the new file.
system
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
culture
stringCulture string
localFilename
stringThe full qualified filename of the local file to be added.
overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
skipCompression
boolIf true the file will not be compressend in file storage of database
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, PreDefinedFileCategory, bool, bool, string, bool, string, byte[], bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, PreDefinedFileCategory Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, byte[] FileData, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, PreDefinedFileCategory, bool, bool, string, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, PreDefinedFileCategory Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, PreDefinedFileCategory, bool, bool, string, bool, string, string, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, PreDefinedFileCategory Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, string FileName, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, PreDefinedFileCategory, bool, bool, string, bool, string, string, bool, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, PreDefinedFileCategory Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
PreDefinedFileCategoryCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, string, bool, bool, string, bool, string, byte[], bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, byte[] FileData, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, string, bool, bool, string, bool, string, byte[], bool, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, byte[] FileData, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileData
byte[]The data of the new file.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, string, bool, bool, string, bool, string, string, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, string FileName, bool Overwrite)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
AddIpPbxUserFile(string, FileScope, string, bool, bool, string, bool, string, string, bool, bool)
Method to add file to database, this method is intended to be used for user self administration. The file will be stored with the UserID of the current user, if the scope is not Global.
public FileListEntry AddIpPbxUserFile(string Name, FileScope Scope, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, string FileName, bool Overwrite, bool SkipFileCompression)
Parameters
Name
stringName of the new file.
Scope
FileScopeScope of the file.
Category
stringCategory of the file.
bHidden
boolSet true is file should be hidden
bPrivate
boolSet true to deny read access by other users/administrators
Description
stringDescription of the new file.
bSystem
boolSet to true if this file is a system file. System files can only be written with a special administrative role.
Culture
stringCulture string
FileName
stringThe full qualified filename of the local file to be added.
Overwrite
boolIf set to true and an entry with same key parameters will be replaced by the new file
SkipFileCompression
boolIt True, the file compression will be skipped
Returns
- FileListEntry
FileListEntry class containing the file informations. The file will added to the local file cache.
CheckVersion()
public void CheckVersion()
ClearLocalFileCache()
Clears the local file cache.
public static void ClearLocalFileCache()
CopyIpPbxFile(Guid, string, FileScope, int, int, string, bool, bool, string, bool, string, bool, bool)
Copies a file.
public FileListEntry CopyIpPbxFile(Guid FileID, string Name, FileScope Scope, int UserID, int GroupID, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, bool bReadOnly, bool bOverwrite)
Parameters
FileID
GuidFileID of the file to be copied
Name
stringNew name
Scope
FileScopeNew Scope
UserID
intNew UserID can be 0
GroupID
intNew GroupID can be 0
Category
stringNew Category
bHidden
boolNew bHidden value
bPrivate
boolNew bPrivate value
Description
stringNew Description
bSystem
boolNew bSystem value
Culture
stringNew culture
bReadOnly
boolNew bReadOnly value
bOverwrite
boolOverwrite file is a file with this attrubutes already exists
Returns
CopyIpPbxFile(Guid, string, FileScope, int, string, bool, bool, string, bool, string, bool, bool)
Copies a file.
public FileListEntry CopyIpPbxFile(Guid FileID, string Name, FileScope Scope, int UserID, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, bool bReadOnly, bool bOverwrite)
Parameters
FileID
GuidFileID of the file to be copied
Name
stringNew name
Scope
FileScopeNew Scope
UserID
intNew UserID can be 0
Category
stringNew Category
bHidden
boolNew bHidden value
bPrivate
boolNew bPrivate value
Description
stringNew Description
bSystem
boolNew bSystem value
Culture
stringNew culture
bReadOnly
boolNew bReadOnly value
bOverwrite
boolOverwrite file is a file with this attrubutes already exists
Returns
CreateClient(Binding, EndpointAddress)
protected override FilesFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)
Parameters
binding
BindingendpointAdrress
EndpointAddress
Returns
- FilesFacadeClient
DeleteAllFilesOfUser(int)
Deletes all files of a specific user.
public void DeleteAllFilesOfUser(int UserID)
Parameters
UserID
int
DeleteAllSystemIpPbxFiles()
Deletes all system files in the database. This method requires role 'FileStystemAdmin' Files in Scope User or UserDefault will not be deleted
public void DeleteAllSystemIpPbxFiles()
DeleteAllSystemIpPbxFiles(int)
Deletes all system files of a sepcial in the database. This method requires role 'FileStystemAdmin'
public void DeleteAllSystemIpPbxFiles(int UserID)
Parameters
UserID
int
DeleteAllSystemIpPbxFilesForGroups(int)
public void DeleteAllSystemIpPbxFilesForGroups(int GroupID)
Parameters
GroupID
int
DeleteIpPbxFile(Guid)
Deletes a single file in database and cache.
public void DeleteIpPbxFile(Guid FileID)
Parameters
FileID
Guid
Dispose()
public virtual void Dispose()
FreeForReuse()
public override void FreeForReuse()
GetAllFiles()
Retrieves a read only collection with all files.
public FileListPrimaryCollection GetAllFiles()
Returns
- FileListPrimaryCollection
A FileListPrimaryCollection
GetCategoryFileSize(PreDefinedFileCategory[], out long, out int, out long, out DriveType)
Returns the file size (compressed) of all files in a set of categories.
public long GetCategoryFileSize(PreDefinedFileCategory[] aCategoryList, out long TotalUncompressedFileSize, out int NumberOfCategoriesLocatedInFileSystem, out long lAvailableSpaceFileSystemInBytes, out DriveType eDriveType)
Parameters
aCategoryList
PreDefinedFileCategory[]List of categiories.
TotalUncompressedFileSize
longReturns the file size uncompressed.
NumberOfCategoriesLocatedInFileSystem
intReturns the number of categoreuis from the list that are located in the file system.
lAvailableSpaceFileSystemInBytes
longReturns the available space on the configured file location.
eDriveType
DriveTypeReturns the type of the configured file location.
Returns
- long
Size of compressed files.
GetCurrentUserID()
public int GetCurrentUserID()
Returns
GetCurrentUserName()
public string GetCurrentUserName()
Returns
GetFileBufferFromCacheOnly(Guid)
Retrieves FileData from the FileCache.
public byte[] GetFileBufferFromCacheOnly(Guid FileID)
Parameters
FileID
GuidID of the file
Returns
- byte[]
FileData
GetFileCopyFromCacheOnly(Guid, string, bool)
Copies the file from the local filecache into the given file.
public void GetFileCopyFromCacheOnly(Guid FileID, string localFileName, bool bOverwriteLocalFile)
Parameters
FileID
GuidlocalFileName
stringLocal destination filename.
bOverwriteLocalFile
boolOverwrites the destination file, if set to true and destination file already exists.
GetFileDataLocationCheckResult(bool)
public FileDataLocationCheckResult GetFileDataLocationCheckResult(bool resetResult)
Parameters
resetResult
bool
Returns
- FileDataLocationCheckResult
GetFileDataLocationConfiguration()
public FileDataLocationCategoryInfo GetFileDataLocationConfiguration()
Returns
- FileDataLocationCategoryInfo
GetFileList(string, FileScope, PreDefinedFileCategory, PreDefinedFileCategory, PreDefinedFileCategory, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, PreDefinedFileCategory category1, PreDefinedFileCategory category2, PreDefinedFileCategory category3, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
category1
PreDefinedFileCategoryfirst category
category2
PreDefinedFileCategoryalternative category
category3
PreDefinedFileCategoryanother alternative category
UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, PreDefinedFileCategory, PreDefinedFileCategory, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, PreDefinedFileCategory category1, PreDefinedFileCategory category2, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
category1
PreDefinedFileCategoryfirst category
category2
PreDefinedFileCategoryalternative category
UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, PreDefinedFileCategory, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, PreDefinedFileCategory category, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
category
PreDefinedFileCategorycategory
UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, PreDefinedFileCategory, int, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, PreDefinedFileCategory category, int UserID, int GroupID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
category
PreDefinedFileCategorycategory
UserID
intOwning User.
GroupID
intOwning Group.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, PreDefinedFileCategory[], int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, PreDefinedFileCategory[] Categories, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Categories
PreDefinedFileCategory[]List of categories
UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, string[], int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, string[] Categories, int UserID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Categories
string[]UserID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileList(string, FileScope, string[], int, int, bool)
Retrieves a list of FileList entries, specified by a set of parameters.
public FileListPrimaryCollection GetFileList(string Name, FileScope Scope, string[] Categories, int UserID, int GroupID, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Categories
string[]UserID
intThe UserID.
GroupID
intThe UserID.
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
If the given UserId is not the UserID of the currently logged in user, the user must own the role FileList.
GetFileListEntryByFileID(Guid)
Retrieves a FileListEntry by a FileID. This method can be to retrieve all nessesary data to download the file.
public FileListEntry GetFileListEntryByFileID(Guid FileID)
Parameters
FileID
GuidFileID
Returns
- FileListEntry
FileListEntry
GetFileNameFromCacheOnly(Guid)
Retrieves FileName from the FileCache.
public string GetFileNameFromCacheOnly(Guid FileID)
Parameters
FileID
GuidID of the file
Returns
- string
filename
GetIpPbxFile(FileListEntry)
Retrieves the full qualified filename of the file in the local file cache. The file will be updated in the file cache if nesessary.
public string GetIpPbxFile(FileListEntry fileListEntry)
Parameters
fileListEntry
FileListEntryFileListEntry of the file.
Returns
- string
Path to local file in cache.
Remarks
The descision if a file in the application file cache is acutal will be made ty the LastModification property of the given FileEntry.
GetIpPbxFileBuffer(FileListEntry)
Retrieves the FileData of the given file.
public byte[] GetIpPbxFileBuffer(FileListEntry fileListEntry)
Parameters
fileListEntry
FileListEntryFileListEntry of the file.
Returns
- byte[]
FileData
Remarks
The descision if a file in the application file cache is acutal will be made ty the LastModification property of the given FileEntry.
GetIpPbxFileBuffer(FileListEntry, bool)
Retrieves the FileData of the given file.
public byte[] GetIpPbxFileBuffer(FileListEntry fileListEntry, bool bIgnoreCache)
Parameters
fileListEntry
FileListEntryFileListEntry of the file.
bIgnoreCache
boolIf true the file will be taken from database in any case.
Returns
- byte[]
FileData
GetIpPbxFileCopy(FileListEntry, string, bool)
Copies the file from database (file cache) into the given file.
public void GetIpPbxFileCopy(FileListEntry fileListEntry, string localFileName, bool bOverwriteLocalFile)
Parameters
fileListEntry
FileListEntryFileListEntry of the file.
localFileName
stringLocal destination filename.
bOverwriteLocalFile
boolOverwrites the destination file, if set to true and destination file already exists.
Remarks
The descision if a file in the application file cache is acutal will be made ty the LastModification property of the given FileEntry.
GetIpPbxFileCopy(FileListEntry, string, bool, bool)
Copies the file from database into the given file.
public void GetIpPbxFileCopy(FileListEntry fileListEntry, string localFileName, bool bOverwriteLocalFile, bool bIgnoreCache)
Parameters
fileListEntry
FileListEntryFileListEntry of the file.
localFileName
stringLocal destination filename.
bOverwriteLocalFile
boolOverwrites the destination file, if set to true and destination file already exists.
bIgnoreCache
boolIf true the file will be taken from database in any case.
Remarks
The descision if a file in the application file cache is acutal will be made ty the LastModification property of the given FileEntry.
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
GetScriptFileList(string, int, bool, SStringList)
Retrieves a FileList including the file specified by the name and all (recursivly) included files. Only files with category 'CallRoutingScripts' will be returned. Only one entry per named file will be returned (UserScope > GlobalScope)
public FileListPrimaryCollection GetScriptFileList(string Name, int UserID, bool bShowHidden, SStringList MissingIncludes)
Parameters
Name
stringThe name of the intial script. No wildcards allowed.
UserID
intThe UserID. Can be 0 (NoUser)
bShowHidden
boolSet this parameter to retrieve hidden files.
MissingIncludes
SStringListOut parameter includes a list of included files that could not be found in database.
Returns
- FileListPrimaryCollection
Collection from type FileListPrimaryCollection.
Remarks
The result list will contains all matching files sorted by their scope.
GetScriptFileList(string, int, int, bool, SStringList)
Retrieves a FileList including the file specified by the name and all (recursivly) included files. Only files with category 'CallRoutingScripts' will be returned. Only one entry per named file will be returned (UserScope > GlobalScope)
public FileListPrimaryCollection GetScriptFileList(string Name, int UserID, int GroupID, bool bShowHidden, SStringList MissingIncludes)
Parameters
Name
stringThe name of the intial script. No wildcards allowed.
UserID
intThe UserID. Can be 0 (NoUser)
GroupID
intThe UserID. Can be 0 (NoUser)
bShowHidden
boolSet this parameter to retrieve hidden files.
MissingIncludes
SStringListOut parameter includes a list of included files that could not be found in database.
Returns
- FileListPrimaryCollection
Collection from type FileListPrimaryCollection.
Remarks
The result list will contains all matching files sorted by their scope.
GetServerRequestTimeout(FilesFacadeClient)
protected override TimeSpan GetServerRequestTimeout(FilesFacadeClient client)
Parameters
client
FilesFacadeClient
Returns
GetSupportedClientVersions()
public SStringList GetSupportedClientVersions()
Returns
GetTotalFileSize(out long)
Returns the total file size (compressed) of all files in database.
public long GetTotalFileSize(out long TotalUncompressedFileSize)
Parameters
TotalUncompressedFileSize
longReturns the file size uncompressed.
Returns
GetUserFileList(string, FileScope, PreDefinedFileCategory, PreDefinedFileCategory, PreDefinedFileCategory, bool)
Retrieves a list of FileList entries, specified by a set of parameters and the current UserID.
public FileListPrimaryCollection GetUserFileList(string Name, FileScope Scope, PreDefinedFileCategory Category1, PreDefinedFileCategory Category2, PreDefinedFileCategory Category3, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Category1
PreDefinedFileCategoryCategory2
PreDefinedFileCategoryCategory3
PreDefinedFileCategorybShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
It is recommanded to use the FileScope ALL when searching for a specific file. The result list will contain all matching files sorted by their scope. This proceeding will insure to get the correct file.
GetUserFileList(string, FileScope, PreDefinedFileCategory, PreDefinedFileCategory, bool)
Retrieves a list of FileList entries, specified by a set of parameters and the current UserID.
public FileListPrimaryCollection GetUserFileList(string Name, FileScope Scope, PreDefinedFileCategory Category1, PreDefinedFileCategory Category2, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Category1
PreDefinedFileCategoryCategory2
PreDefinedFileCategorybShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
It is recommanded to use the FileScope ALL when searching for a specific file. The result list will contain all matching files sorted by their scope. This proceeding will insure to get the correct file.
GetUserFileList(string, FileScope, PreDefinedFileCategory, bool)
Retrieves a list of FileList entries, specified by a set of parameters and the current UserID.
public FileListPrimaryCollection GetUserFileList(string Name, FileScope Scope, PreDefinedFileCategory Category, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Category
PreDefinedFileCategorybShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
It is recommanded to use the FileScope ALL when searching for a specific file. The result list will contain all matching files sorted by their scope. This proceeding will insure to get the correct file.
GetUserFileList(string, FileScope, PreDefinedFileCategory[], bool)
Retrieves a list of FileList entries, specified by a set of parameters and the current UserID.
public FileListPrimaryCollection GetUserFileList(string Name, FileScope Scope, PreDefinedFileCategory[] Categories, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Categories
PreDefinedFileCategory[]List of categories
bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
It is recommanded to use the FileScope ALL when searching for a specific file. The result list will contain all matching files sorted by their scope. This proceeding will insure to get the correct file.
GetUserFileList(string, FileScope, string[], bool)
Retrieves a list of FileList entries, specified by a set of parameters and the current UserID.
public FileListPrimaryCollection GetUserFileList(string Name, FileScope Scope, string[] Categories, bool bShowHidden)
Parameters
Name
stringScope
FileScopeScope(s) of the files. It is possible to search for more than one Scope
Categories
string[]bShowHidden
boolIf true hidden files will returned.
Returns
- FileListPrimaryCollection
Collection of FileListEntries
Remarks
It is recommanded to use the FileScope ALL when searching for a specific file. The result list will contain all matching files sorted by their scope. This proceeding will insure to get the correct file.
HasRole(BuildInRoles)
public bool HasRole(BuildInRoles eRole)
Parameters
eRole
BuildInRoles
Returns
ModifyIpPbxFileAttributes(Guid, string, FileScope, PreDefinedFileCategory, bool, bool, string, bool, string, bool)
Modifies the paramters of a file.
public void ModifyIpPbxFileAttributes(Guid FileID, string Name, FileScope Scope, PreDefinedFileCategory Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, bool bReadOnly)
Parameters
FileID
GuidFileID of the file to be modified
Name
stringNew name
Scope
FileScopeNew Scope
Category
PreDefinedFileCategoryNew Category
bHidden
boolNew bHidden value
bPrivate
boolNew bPrivate value
Description
stringNew Description
bSystem
boolNew bSystem value
Culture
stringNew culture
bReadOnly
boolNew bReadOnly value
ModifyIpPbxFileAttributes(Guid, string, FileScope, string, bool, bool, string, bool, string, bool)
Modifies the paramters of a file.
public void ModifyIpPbxFileAttributes(Guid FileID, string Name, FileScope Scope, string Category, bool bHidden, bool bPrivate, string Description, bool bSystem, string Culture, bool bReadOnly)
Parameters
FileID
GuidFileID of the file to be modified
Name
stringNew name
Scope
FileScopeNew Scope
Category
stringNew Category
bHidden
boolNew bHidden value
bPrivate
boolNew bPrivate value
Description
stringNew Description
bSystem
boolNew bSystem value
Culture
stringNew culture
bReadOnly
boolNew bReadOnly value
OnTimeoutChanged(TimeSpan)
protected override void OnTimeoutChanged(TimeSpan span)
Parameters
span
TimeSpan
ParseAllScriptFileForIncludeStatements()
Parse all script file in database and generate file reference entries. Needs APIRole FileRW
public void ParseAllScriptFileForIncludeStatements()
PingService(FilesFacadeClient)
protected override void PingService(FilesFacadeClient client)
Parameters
client
FilesFacadeClient
PutFileDataLocationConfiguration(FileDataLocationCategories)
public void PutFileDataLocationConfiguration(FileDataLocationCategories categories)
Parameters
categories
FileDataLocationCategories
RemoveFileFromCache(Guid)
public void RemoveFileFromCache(Guid fileId)
Parameters
fileId
Guid
StartFileDataLocationCheck()
public bool StartFileDataLocationCheck()
Returns
UpdateXmlFilesWithVersionTagInGlobalScope(PreDefinedFileCategory)
public void UpdateXmlFilesWithVersionTagInGlobalScope(PreDefinedFileCategory category)
Parameters
category
PreDefinedFileCategory
Events
FileTransferProgress
public event FileTransferProgress FileTransferProgress