Interface IExportFoldersClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IExportFoldersClientMethods
CalculateFolderSize(String)
Get specified folder, calculate it's size
Declaration
FolderSizeVM CalculateFolderSize(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Returns
| Type | Description |
|---|---|
| FolderSizeVM | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CalculateFolderSizeAsync(String, System.Threading.CancellationToken)
Get specified folder, calculate it's size
Declaration
System.Threading.Tasks.Task<FolderSizeVM> CalculateFolderSizeAsync(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<FolderSizeVM> | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CopyFolder(String, String)
Move folder to a specified folder
Declaration
FileVM CopyFolder(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | moving folder id |
| System.String | folderId | destination folder id |
Returns
| Type | Description |
|---|---|
| FileVM | Success |
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. |
CopyFolderAsync(String, String, System.Threading.CancellationToken)
Move folder to a specified folder
Declaration
System.Threading.Tasks.Task<FileVM> CopyFolderAsync(string id, string folderId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | moving folder id |
| System.String | folderId | destination 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<FileVM> | Success |
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. |
DeleteFolder(String)
Delete specified folder
Declaration
void DeleteFolder(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Remarks
User with a Delete Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteFolderAsync(String, System.Threading.CancellationToken)
Delete specified folder
Declaration
System.Threading.Tasks.Task DeleteFolderAsync(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 | Success |
Remarks
User with a Delete Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetBreadcrumbs(String)
Get specified folder breadcrumbs
Declaration
BreadcrumbsVM GetBreadcrumbs(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Returns
| Type | Description |
|---|---|
| BreadcrumbsVM | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetBreadcrumbsAsync(String, System.Threading.CancellationToken)
Get specified folder breadcrumbs
Declaration
System.Threading.Tasks.Task<BreadcrumbsVM> GetBreadcrumbsAsync(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<BreadcrumbsVM> | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFolder(String)
Get specified folder
Declaration
FileVM GetFolder(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Returns
| Type | Description |
|---|---|
| FileVM | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFolderAsync(String, System.Threading.CancellationToken)
Get specified folder
Declaration
System.Threading.Tasks.Task<FileVM> GetFolderAsync(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<FileVM> | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFolders(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>)
Get all folders from specified folder
Declaration
FilesVM GetFolders(string id, int? skip = null, int? take = null, FileSorting? orderBy = null, bool? desc = null, string searchPattern = null, bool? useRegex = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.Nullable<System.Int32> | skip | number of folder and files to skip |
| System.Nullable<System.Int32> | take | number of folder and files to take |
| System.Nullable<FileSorting> | orderBy | a field to sort by |
| System.Nullable<System.Boolean> | desc | if true - sorting will be done in the descending order, otherwise - ascending |
| System.String | searchPattern | search pattern used to only include matching files in the result<br />
|
| System.Nullable<System.Boolean> | useRegex | set this to true if you want to use regular expression to search |
Returns
| Type | Description |
|---|---|
| FilesVM | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFoldersAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>, System.Threading.CancellationToken)
Get all folders from specified folder
Declaration
System.Threading.Tasks.Task<FilesVM> GetFoldersAsync(string id, int? skip = null, int? take = null, FileSorting? orderBy = null, bool? desc = null, string searchPattern = 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 folder and files to skip |
| System.Nullable<System.Int32> | take | number of folder and files to take |
| System.Nullable<FileSorting> | orderBy | a field to sort by |
| System.Nullable<System.Boolean> | desc | if true - sorting will be done in the descending order, otherwise - ascending |
| System.String | searchPattern | search pattern used to only include matching files in the result<br />
|
| System.Nullable<System.Boolean> | useRegex | set this to true if you want to use regular expression to search |
| 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<FilesVM> | Success |
Remarks
User with a Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFoldersCount(String)
Get count of folders what contains in a specified folder
Declaration
CountVM GetFoldersCount(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Returns
| Type | Description |
|---|---|
| CountVM | Success |
Remarks
User with a Get Count permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFoldersCountAsync(String, System.Threading.CancellationToken)
Get count of folders what contains in a specified folder
Declaration
System.Threading.Tasks.Task<CountVM> GetFoldersCountAsync(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> | Success |
Remarks
User with a Get Count permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissions(String)
Get user's permissions for a folder by id
Declaration
FilePermissionCRUDVM GetMyPermissions(string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | folderId | folder id |
Returns
| Type | Description |
|---|---|
| FilePermissionCRUDVM | Succes |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissionsAsync(String, System.Threading.CancellationToken)
Get user's permissions for a folder by id
Declaration
System.Threading.Tasks.Task<FilePermissionCRUDVM> GetMyPermissionsAsync(string folderId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| 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<FilePermissionCRUDVM> | Succes |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetOrCreate(String, String, String)
Get specified folder
Declaration
FileVM GetOrCreate(string name = null, string subscriptionId = null, string parentId = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | folder name |
| System.String | subscriptionId | subscriptionId |
| System.String | parentId | parent folder id |
Returns
| Type | Description |
|---|---|
| FileVM | Success |
Remarks
User with a Get (and/or Create) Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetOrCreateAsync(String, String, String, System.Threading.CancellationToken)
Get specified folder
Declaration
System.Threading.Tasks.Task<FileVM> GetOrCreateAsync(string name = null, string subscriptionId = null, string parentId = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | folder name |
| System.String | subscriptionId | subscriptionId |
| System.String | parentId | parent 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<FileVM> | Success |
Remarks
User with a Get (and/or Create) Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPermissions(String)
Get all folder permissions
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)
Get all folder permissions
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. |
GetRootFolder(String)
Get workspace's root folder
Declaration
FileVM GetRootFolder(string subscriptionId = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId |
Returns
| Type | Description |
|---|---|
| FileVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetRootFolderAsync(String, System.Threading.CancellationToken)
Get workspace's root folder
Declaration
System.Threading.Tasks.Task<FileVM> GetRootFolderAsync(string subscriptionId = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | |
| 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<FileVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFolder(String, String)
Move folder into a specified folder
Declaration
FileVM MoveFolder(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.String | folderId | destination folder id |
Returns
| Type | Description |
|---|---|
| FileVM | Success |
Remarks
User with a Update Place permission for a folder and Create Entity
for a destination Folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFolderAsync(String, String, System.Threading.CancellationToken)
Move folder into a specified folder
Declaration
System.Threading.Tasks.Task<FileVM> MoveFolderAsync(string id, string folderId, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.String | folderId | destination 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<FileVM> | Success |
Remarks
User with a Update Place permission for a folder and Create Entity
for a destination Folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFolderToBin(String)
Move specified folder to recycle bin
Declaration
void MoveFolderToBin(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
Remarks
User with a Delete Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
MoveFolderToBinAsync(String, System.Threading.CancellationToken)
Move specified folder to recycle bin
Declaration
System.Threading.Tasks.Task MoveFolderToBinAsync(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 | Success |
Remarks
User with a Delete Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
PostFolder(String, ExportFolderCreateVM)
Create folder
Declaration
FileVM PostFolder(string id, ExportFolderCreateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of parent folder id |
| ExportFolderCreateVM | body | create VM |
Returns
| Type | Description |
|---|---|
| FileVM | New folder has been created) |
Remarks
User with a Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
PostFolderAsync(String, ExportFolderCreateVM, System.Threading.CancellationToken)
Create folder
Declaration
System.Threading.Tasks.Task<FileVM> PostFolderAsync(string id, ExportFolderCreateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of parent folder id |
| ExportFolderCreateVM | body | create VM |
| 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<FileVM> | New folder has been created) |
Remarks
User with a Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RecoverFolder(String, String)
Recover specified folder
Declaration
void RecoverFolder(string id, string recoveryPath = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.String | recoveryPath | id of the folder, that recovered folder should be placed in |
Remarks
User with a Create RecycleBin permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RecoverFolderAsync(String, String, System.Threading.CancellationToken)
Recover specified folder
Declaration
System.Threading.Tasks.Task RecoverFolderAsync(string id, string recoveryPath = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | folder id |
| System.String | recoveryPath | id of the folder, that recovered folder should be placed in |
| 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 | Success |
Remarks
User with a Create RecycleBin permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RenameFolder(String, FolderRenameVM)
Rename a folder
Declaration
FileVM RenameFolder(string id, FolderRenameVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FolderRenameVM | body |
Returns
| Type | Description |
|---|---|
| FileVM | Folder name has been updated |
Remarks
User with a Update Name permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
RenameFolderAsync(String, FolderRenameVM, System.Threading.CancellationToken)
Rename a folder
Declaration
System.Threading.Tasks.Task<FileVM> RenameFolderAsync(string id, FolderRenameVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FolderRenameVM | 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<FileVM> | Folder name has been updated |
Remarks
User with a Update Name permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateIcon(String, FolderIconVM)
Update a folder's icon
Declaration
FileVM UpdateIcon(string id, FolderIconVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| FolderIconVM | body | Update icon model |
Returns
| Type | Description |
|---|---|
| FileVM | Folder's icon has been updated |
Remarks
User with a Update Icon permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateIconAsync(String, FolderIconVM, System.Threading.CancellationToken)
Update a folder's icon
Declaration
System.Threading.Tasks.Task<FileVM> UpdateIconAsync(string id, FolderIconVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| FolderIconVM | body | Update icon model |
| 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<FileVM> | Folder's icon has been updated |
Remarks
User with a 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 | folder id |
| UpdateFilePermissionsVM | body | new permissions VM |
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 | folder id |
| UpdateFilePermissionsVM | body | new permissions VM |
| 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 | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateTags(String, FolderTagsUpdateVM)
Update tags
Declaration
FileVM UpdateTags(string id, FolderTagsUpdateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FolderTagsUpdateVM | body |
Returns
| Type | Description |
|---|---|
| FileVM | Tags has been updated |
Remarks
User with a Update Tags permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateTagsAsync(String, FolderTagsUpdateVM, System.Threading.CancellationToken)
Update tags
Declaration
System.Threading.Tasks.Task<FileVM> UpdateTagsAsync(string id, FolderTagsUpdateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FolderTagsUpdateVM | 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<FileVM> | Tags has been updated |
Remarks
User with a Update Tags permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |