Interface IExportsClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IExportsClientMethods
CopyFile(String, String)
Copy file to a specified folder
Declaration
ExportVM CopyFile(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
Returns
| Type | Description |
|---|---|
| ExportVM | File has been copied |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CopyFileAsync(String, String, System.Threading.CancellationToken)
Copy file to a specified folder
Declaration
System.Threading.Tasks.Task<ExportVM> CopyFileAsync(string id, string folderId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | File has been copied |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateSharingKey(String, CreateFileShareVM)
Create a new key, that can be used to share access to a file
(You need Administrate.Anon permission to create a new key)
Declaration
FileSharingKeysVM CreateSharingKey(string id, CreateFileShareVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| CreateFileShareVM | body | parameters for sharing key creation |
Returns
| Type | Description |
|---|---|
| FileSharingKeysVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateSharingKeyAsync(String, CreateFileShareVM, System.Threading.CancellationToken)
Create a new key, that can be used to share access to a file
(You need Administrate.Anon permission to create a new key)
Declaration
System.Threading.Tasks.Task<FileSharingKeysVM> CreateSharingKeyAsync(string id, CreateFileShareVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| CreateFileShareVM | body | parameters for sharing key creation |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileSharingKeysVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteFile(String)
Delete specified file
Declaration
void DeleteFile(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteFileAsync(String, System.Threading.CancellationToken)
Delete specified file
Declaration
System.Threading.Tasks.Task DeleteFileAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | File succesfully deleted |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteSharingKey(String, String)
Deletes a sharing key, making links, that utilizing it no longer work
Declaration
void DeleteSharingKey(string id, string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | key | key to delete |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteSharingKeyAsync(String, String, System.Threading.CancellationToken)
Deletes a sharing key, making links, that utilizing it no longer work
Declaration
System.Threading.Tasks.Task DeleteSharingKeyAsync(string id, string key, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | key | key to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | No Content |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByTaskId(String)
Get exports by specified task id
Declaration
ExportsVM GetByTaskId(string taskId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskId | task id |
Returns
| Type | Description |
|---|---|
| ExportsVM | Exports are found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByTaskIdAsync(String, System.Threading.CancellationToken)
Get exports by specified task id
Declaration
System.Threading.Tasks.Task<ExportsVM> GetByTaskIdAsync(string taskId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskId | task id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportsVM> | Exports are found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByTaskMessageId(String)
Get export by specified task message id
Declaration
ExportVM GetByTaskMessageId(string taskMessageId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskMessageId | task message id |
Returns
| Type | Description |
|---|---|
| ExportVM | Export is found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetByTaskMessageIdAsync(String, System.Threading.CancellationToken)
Get export by specified task message id
Declaration
System.Threading.Tasks.Task<ExportVM> GetByTaskMessageIdAsync(string taskMessageId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskMessageId | task message id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | Export is found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFile(String)
Get export by specified id
Declaration
ExportVM GetFile(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of export |
Returns
| Type | Description |
|---|---|
| ExportVM | Export is found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFileAsync(String, System.Threading.CancellationToken)
Get export by specified id
Declaration
System.Threading.Tasks.Task<ExportVM> GetFileAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of export |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | Export is found |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFileHistory(String, Nullable<Int32>, Nullable<Int32>)
Returns list of actions, performed on this file
Declaration
AuditActionsVM GetFileHistory(string id, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take |
Returns
| Type | Description |
|---|---|
| AuditActionsVM | Returns the actions |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFileHistoryAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns list of actions, performed on this file
Declaration
System.Threading.Tasks.Task<AuditActionsVM> GetFileHistoryAsync(string id, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AuditActionsVM> | Returns the actions |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFilesCount(String)
Get count of files what contains in a specified folder
Declaration
CountVM GetFilesCount(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Returns
| Type | Description |
|---|---|
| CountVM | Returns count of the files in a specified folder |
Remarks
User with Get Count permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFilesCountAsync(String, System.Threading.CancellationToken)
Get count of files what contains in a specified folder
Declaration
System.Threading.Tasks.Task<CountVM> GetFilesCountAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<CountVM> | Returns count of the files in a specified folder |
Remarks
User with Get Count permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFilesList(String, Nullable<Int32>, Nullable<Int32>, String, Nullable<FileSorting>, Nullable<Boolean>, Nullable<Boolean>)
Get all files from specified folder. <br />
User with Get Entity permission can access this method. <br />
The method will returns minimal infomration about the file: <br />
id, name, size, editedTime, createdTime, tags, status, statusReason.
Declaration
ExportsVM GetFilesList(string id, int? skip = null, int? take = null, string searchPattern = null, FileSorting? orderBy = null, bool? desc = null, bool? useRegex = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.Nullable<System.Int32> | skip | number of files, that have to be skipped |
| System.Nullable<System.Int32> | take | number of files, that have to be returned |
| System.String | searchPattern | |
| System.Nullable<FileSorting> | orderBy | |
| System.Nullable<System.Boolean> | desc | |
| System.Nullable<System.Boolean> | useRegex |
Returns
| Type | Description |
|---|---|
| ExportsVM | Returns list of the files from a specified folder |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFilesListAsync(String, Nullable<Int32>, Nullable<Int32>, String, Nullable<FileSorting>, Nullable<Boolean>, Nullable<Boolean>, System.Threading.CancellationToken)
Get all files from specified folder. <br />
User with Get Entity permission can access this method. <br />
The method will returns minimal infomration about the file: <br />
id, name, size, editedTime, createdTime, tags, status, statusReason.
Declaration
System.Threading.Tasks.Task<ExportsVM> GetFilesListAsync(string id, int? skip = null, int? take = null, string searchPattern = null, FileSorting? orderBy = null, bool? desc = null, bool? useRegex = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.Nullable<System.Int32> | skip | number of files, that have to be skipped |
| System.Nullable<System.Int32> | take | number of files, that have to be returned |
| System.String | searchPattern | |
| System.Nullable<FileSorting> | orderBy | |
| System.Nullable<System.Boolean> | desc | |
| System.Nullable<System.Boolean> | useRegex | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportsVM> | Returns list of the files from a specified folder |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissions(String)
Get current user's permissions to file
Declaration
FilePermissionCRUDVM GetMyPermissions(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
Returns
| Type | Description |
|---|---|
| FilePermissionCRUDVM | got permissions successfully |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissionsAsync(String, System.Threading.CancellationToken)
Get current user's permissions to file
Declaration
System.Threading.Tasks.Task<FilePermissionCRUDVM> GetMyPermissionsAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FilePermissionCRUDVM> | got permissions successfully |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPermissions(String)
Declaration
FilePermissionsVM GetPermissions(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Returns
| Type | Description |
|---|---|
| FilePermissionsVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPermissionsAsync(String, System.Threading.CancellationToken)
Declaration
System.Threading.Tasks.Task<FilePermissionsVM> GetPermissionsAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FilePermissionsVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetSharingKeys(String)
Returns all sharing keys, associated with the file
Declaration
FileSharingKeysVM GetSharingKeys(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
Returns
| Type | Description |
|---|---|
| FileSharingKeysVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetSharingKeysAsync(String, System.Threading.CancellationToken)
Returns all sharing keys, associated with the file
Declaration
System.Threading.Tasks.Task<FileSharingKeysVM> GetSharingKeysAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileSharingKeysVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFile(String, String)
Move file to a specified folder
Declaration
ExportVM MoveFile(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
Returns
| Type | Description |
|---|---|
| ExportVM | File has been moved |
Remarks
User with a Update Place permission for a folder and Create Entity
for a Parent Folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFileAsync(String, String, System.Threading.CancellationToken)
Move file to a specified folder
Declaration
System.Threading.Tasks.Task<ExportVM> MoveFileAsync(string id, string folderId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | File has been moved |
Remarks
User with a Update Place permission for a folder and Create Entity
for a Parent Folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFileToBin(String)
Move specified file to recycle bin
Declaration
void MoveFileToBin(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFileToBinAsync(String, System.Threading.CancellationToken)
Move specified file to recycle bin
Declaration
System.Threading.Tasks.Task MoveFileToBinAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | File succesfully deleted |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RecoverFile(String, String)
Recover specified file from bin
Declaration
void RecoverFile(string id, string recoveryPath = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | recoveryPath |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RecoverFileAsync(String, String, System.Threading.CancellationToken)
Recover specified file from bin
Declaration
System.Threading.Tasks.Task RecoverFileAsync(string id, string recoveryPath = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | recoveryPath | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | File succesfully recovered |
Remarks
User with Delete permission can access the method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RenameFile(String, FileRenameVM)
Rename a file
Declaration
ExportVM RenameFile(string id, FileRenameVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileRenameVM | body |
Returns
| Type | Description |
|---|---|
| ExportVM | File name has been updated |
Remarks
User with Update Name permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RenameFileAsync(String, FileRenameVM, System.Threading.CancellationToken)
Rename a file
Declaration
System.Threading.Tasks.Task<ExportVM> RenameFileAsync(string id, FileRenameVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileRenameVM | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | File name has been updated |
Remarks
User with Update Name permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateIcon(String, FileIconVM)
Update a files's icon
Declaration
ExportVM UpdateIcon(string id, FileIconVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileIconVM | body |
Returns
| Type | Description |
|---|---|
| ExportVM | File's icon has been updated |
Remarks
User with Update Icon permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateIconAsync(String, FileIconVM, System.Threading.CancellationToken)
Update a files's icon
Declaration
System.Threading.Tasks.Task<ExportVM> UpdateIconAsync(string id, FileIconVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileIconVM | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | File's icon has been updated |
Remarks
User with Update Icon permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdatePermissions(String, UpdateFilePermissionsVM)
Update permissions
Declaration
void UpdatePermissions(string id, UpdateFilePermissionsVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateFilePermissionsVM | body |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdatePermissionsAsync(String, UpdateFilePermissionsVM, System.Threading.CancellationToken)
Update permissions
Declaration
System.Threading.Tasks.Task UpdatePermissionsAsync(string id, UpdateFilePermissionsVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateFilePermissionsVM | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | File's permissions has been updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateTags(String, FileTagsUpdateVM)
Update tags
Declaration
ExportVM UpdateTags(string id, FileTagsUpdateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileTagsUpdateVM | body |
Returns
| Type | Description |
|---|---|
| ExportVM | Tags has been updated |
Remarks
User with Update Tags permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateTagsAsync(String, FileTagsUpdateVM, System.Threading.CancellationToken)
Update tags
Declaration
System.Threading.Tasks.Task<ExportVM> UpdateTagsAsync(string id, FileTagsUpdateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileTagsUpdateVM | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ExportVM> | Tags has been updated |
Remarks
User with Update Tags permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |