Interface ITemplateFolderAndFileClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface ITemplateFolderAndFileClient

Methods

ClearRecycleBin(String)

Delete all folders and files from recycle bin

Declaration

void ClearRecycleBin(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription id

Remarks

User with a Delete RecycleBin permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

ClearRecycleBinAsync(String, System.Threading.CancellationToken)

Delete all folders and files from recycle bin

Declaration

System.Threading.Tasks.Task ClearRecycleBinAsync(string subscriptionId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription 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 RecycleBin permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

CopyFiles(String, SelectedFilesVM)

Copy folders and files to a specified folder

Declaration

void CopyFiles(string subscriptionId, SelectedFilesVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of current subscription
SelectedFilesVM	body	File selection VM

Remarks

User with a Get permission for a files and Create permission for a destination folder can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

CopyFilesAsync(String, SelectedFilesVM, System.Threading.CancellationToken)

Copy folders and files to a specified folder

Declaration

System.Threading.Tasks.Task CopyFilesAsync(string subscriptionId, SelectedFilesVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of current subscription
SelectedFilesVM	body	File selection 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

Remarks

User with a Get permission for a files and Create permission for a destination folder can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

CountRecycleBinFoldersAndFiles(String, String, Nullable<Boolean>)

Count all folders and files from recycle bin

Declaration

CountVM CountRecycleBinFoldersAndFiles(string subscriptionId, string searchPattern = null, bool? useRegex = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription id
System.String	searchPattern	search pattern used to only include matching files in the recycle bin count<br /> (leave unspecified to count all files and folders)
System.Nullable<System.Boolean>	useRegex	set this to true if you want to use regular expression to search

Returns

Type	Description
CountVM	Success

Remarks

User with a Get DeletedFiles permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

CountRecycleBinFoldersAndFilesAsync(String, String, Nullable<Boolean>, System.Threading.CancellationToken)

Count all folders and files from recycle bin

Declaration

System.Threading.Tasks.Task<CountVM> CountRecycleBinFoldersAndFilesAsync(string subscriptionId, string searchPattern = null, bool? useRegex = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription id
System.String	searchPattern	search pattern used to only include matching files in the recycle bin count<br /> (leave unspecified to count all files and folders)
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<CountVM>	Success

Remarks

User with a Get DeletedFiles permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

DeleteFiles(String, SelectedFilesVM)

Delete folders and files from a folder or the recycle bin

Declaration

void DeleteFiles(string subscriptionId, SelectedFilesVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of the subscription
SelectedFilesVM	body	File selection VM

Remarks

User with a Delete permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

DeleteFilesAsync(String, SelectedFilesVM, System.Threading.CancellationToken)

Delete folders and files from a folder or the recycle bin

Declaration

System.Threading.Tasks.Task DeleteFilesAsync(string subscriptionId, SelectedFilesVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of the subscription
SelectedFilesVM	body	File selection 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

Remarks

User with a Delete permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetCount(String, String, Nullable<Boolean>)

Count folders and files in a folder

Declaration

CountVM GetCount(string id, string searchPattern = null, bool? useRegex = null)

Parameters

Type	Name	Description
System.String	id	folder id
System.String	searchPattern	search pattern used to only include matching files in the count<br /> (leave unspecified to count all files and folders)
System.Nullable<System.Boolean>	useRegex	set this to true if you want to use regular expression to search

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.

GetCountAsync(String, String, Nullable<Boolean>, System.Threading.CancellationToken)

Count folders and files in a folder

Declaration

System.Threading.Tasks.Task<CountVM> GetCountAsync(string id, string searchPattern = null, bool? useRegex = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	folder id
System.String	searchPattern	search pattern used to only include matching files in the count<br /> (leave unspecified to count all files and folders)
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<CountVM>	Success

Remarks

User with a Get Count permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetFoldersAndFiles(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>)

Get all folders and files from specified folder

Declaration

FilesVM GetFoldersAndFiles(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 /> (leave unspecified to list all files and folders)
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.

GetFoldersAndFilesAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>, System.Threading.CancellationToken)

Get all folders and files from specified folder

Declaration

System.Threading.Tasks.Task<FilesVM> GetFoldersAndFilesAsync(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 /> (leave unspecified to list all files and folders)
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.

GetRecycleBinFoldersAndFiles(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>)

Get all folders and files from recycle bin

Declaration

FilesVM GetRecycleBinFoldersAndFiles(string subscriptionId, int? skip = null, int? take = null, FileSorting? orderBy = null, bool? desc = null, string searchPattern = null, bool? useRegex = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription 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 recycle bin<br /> (leave unspecified to list all files and folders)
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 DeletedFiles permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetRecycleBinFoldersAndFilesAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<FileSorting>, Nullable<Boolean>, String, Nullable<Boolean>, System.Threading.CancellationToken)

Get all folders and files from recycle bin

Declaration

System.Threading.Tasks.Task<FilesVM> GetRecycleBinFoldersAndFilesAsync(string subscriptionId, 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	subscriptionId	subscription 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 recycle bin<br /> (leave unspecified to list all files and folders)
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 DeletedFiles permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

MoveFiles(String, SelectedFilesVM)

Move folders and files to a specified folder

Declaration

void MoveFiles(string subscriptionId, SelectedFilesVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of current subscription
SelectedFilesVM	body	File selection VM

Remarks

User with a Update Place permission for a files and Create permission for a destination folder can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

MoveFilesAsync(String, SelectedFilesVM, System.Threading.CancellationToken)

Move folders and files to a specified folder

Declaration

System.Threading.Tasks.Task MoveFilesAsync(string subscriptionId, SelectedFilesVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of current subscription
SelectedFilesVM	body	File selection 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

Remarks

User with a Update Place permission for a files and Create permission for a destination folder can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

MoveFilesToBin(String, SelectedFilesVM)

Move folders and files to the recycle bin

Declaration

void MoveFilesToBin(string subscriptionId, SelectedFilesVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of the subscription
SelectedFilesVM	body	File selection VM

Remarks

User with a Delete Entity permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

MoveFilesToBinAsync(String, SelectedFilesVM, System.Threading.CancellationToken)

Move folders and files to the recycle bin

Declaration

System.Threading.Tasks.Task MoveFilesToBinAsync(string subscriptionId, SelectedFilesVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id of the subscription
SelectedFilesVM	body	File selection 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

Remarks

User with a Delete Entity permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

RecoverAllFromRecycleBin(String)

Recover all folders and files from recycle bin

Declaration

void RecoverAllFromRecycleBin(string subscriptionId)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription id

Remarks

User with a Create RecycleBin permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

RecoverAllFromRecycleBinAsync(String, System.Threading.CancellationToken)

Recover all folders and files from recycle bin

Declaration

System.Threading.Tasks.Task RecoverAllFromRecycleBinAsync(string subscriptionId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	subscription 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 Create RecycleBin permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

RecoverFiles(String, SelectedFilesVM)

Recover folders and files from the recycle bin

Declaration

void RecoverFiles(string subscriptionId, SelectedFilesVM body = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id the subscription
SelectedFilesVM	body	File selection VM

Remarks

User with a SubscriptionCreate permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.

RecoverFilesAsync(String, SelectedFilesVM, System.Threading.CancellationToken)

Recover folders and files from the recycle bin

Declaration

System.Threading.Tasks.Task RecoverFilesAsync(string subscriptionId, SelectedFilesVM body = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	subscriptionId	id the subscription
SelectedFilesVM	body	File selection 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

Remarks

User with a SubscriptionCreate permission can access this method.

Exceptions

Type	Condition
ApiException	A server side error occurred.