Class TemplatesClient
Inheritance
Implements
Namespace: FastReport.Cloud.Client
Assembly: FastReport.Cloud.SDK.dll
Syntax
public class TemplatesClient : object, ITemplatesClientConstructors
TemplatesClient(System.Net.Http.HttpClient)
Declaration
public TemplatesClient(System.Net.Http.HttpClient httpClient)Parameters
| Type | Name | Description |
|---|---|---|
| System.Net.Http.HttpClient | httpClient |
Properties
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }Property Value
| Type | Description |
|---|---|
| Newtonsoft.Json.JsonSerializerSettings |
PrepareRequestCallback
Declaration
public Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, string> PrepareRequestCallback { get; set; }Property Value
| Type | Description |
|---|---|
| Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, System.String> |
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
CopyFile(String, String)
Copy file to a specified folder
Declaration
public virtual TemplateVM CopyFile(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
Returns
| Type | Description |
|---|---|
| TemplateVM | 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
public virtual async System.Threading.Tasks.Task<TemplateVM> 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<TemplateVM> | 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
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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. |
Export(String, ExportTemplateVM)
Export specified report template to a specified format
Declaration
public virtual ExportVM Export(string id, ExportTemplateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| ExportTemplateVM | body | export parameters (string only) |
Returns
| Type | Description |
|---|---|
| ExportVM | Specified report has been exported |
Remarks
User with Execute Export permission on prepared report and
Create Entity on an export folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
ExportAsync(String, ExportTemplateVM, System.Threading.CancellationToken)
Export specified report template to a specified format
Declaration
public virtual async System.Threading.Tasks.Task<ExportVM> ExportAsync(string id, ExportTemplateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| ExportTemplateVM | body | export parameters (string only) |
| 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> | Specified report has been exported |
Remarks
User with Execute Export permission on prepared report and
Create Entity on an export folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFile(String)
Get specified file
Declaration
public virtual TemplateVM GetFile(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
Returns
| Type | Description |
|---|---|
| TemplateVM | Returns the specified file |
Remarks
User with Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFileAsync(String, System.Threading.CancellationToken)
Get specified file
Declaration
public virtual async System.Threading.Tasks.Task<TemplateVM> GetFileAsync(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<TemplateVM> | Returns the specified file |
Remarks
User with Get Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFileHistory(String, Nullable<Int32>, Nullable<Int32>)
Returns list of actions, performed on this file
Declaration
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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
public virtual TemplatesVM 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 |
|---|---|
| TemplatesVM | 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
public virtual async System.Threading.Tasks.Task<TemplatesVM> 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<TemplatesVM> | 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
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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
public virtual 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
public virtual async 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
public virtual TemplateVM MoveFile(string id, string folderId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | file id |
| System.String | folderId | folder id |
Returns
| Type | Description |
|---|---|
| TemplateVM | 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
public virtual async System.Threading.Tasks.Task<TemplateVM> 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<TemplateVM> | 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
public virtual 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
public virtual async 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. |
Prepare(String, PrepareTemplateVM)
Prepare specified template to report
Declaration
public virtual ReportVM Prepare(string id, PrepareTemplateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| PrepareTemplateVM | body | Template prepare view model |
Returns
| Type | Description |
|---|---|
| ReportVM | Specified template has been prepared |
Remarks
User with Execute Prepare permission on report and
Create Entity on a prepared report folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
PrepareAsync(String, PrepareTemplateVM, System.Threading.CancellationToken)
Prepare specified template to report
Declaration
public virtual async System.Threading.Tasks.Task<ReportVM> PrepareAsync(string id, PrepareTemplateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| PrepareTemplateVM | body | Template prepare view 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<ReportVM> | Specified template has been prepared |
Remarks
User with Execute Prepare permission on report and
Create Entity on a prepared report folder can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage, System.Collections.Generic.IReadOnlyDictionary<String, System.Collections.Generic.IEnumerable<String>>, System.Threading.CancellationToken)
Declaration
protected virtual async System.Threading.Tasks.Task<TemplatesClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage response, System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IEnumerable<string>> headers, System.Threading.CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| System.Net.Http.HttpResponseMessage | response | |
| System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> | headers | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TemplatesClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |
RecoverFile(String, String)
Recover specified file from bin
Declaration
public virtual 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
public virtual async 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
public virtual TemplateVM RenameFile(string id, FileRenameVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileRenameVM | body |
Returns
| Type | Description |
|---|---|
| TemplateVM | 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
public virtual async System.Threading.Tasks.Task<TemplateVM> 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<TemplateVM> | File name has been updated |
Remarks
User with Update Name permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
StaticPreview(String, PreviewTemplateVM)
Make preview for the report.
Generate a new or return exist prepared svg files.
If template was changed will be returned a new.
Pass the `` parameter to check prepared timestamp
Declaration
public virtual ExportVM StaticPreview(string id, PreviewTemplateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| PreviewTemplateVM | body | Model with parameters |
Returns
| Type | Description |
|---|---|
| ExportVM | Specified template has been prepared |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
StaticPreviewAsync(String, PreviewTemplateVM, System.Threading.CancellationToken)
Make preview for the report.
Generate a new or return exist prepared svg files.
If template was changed will be returned a new.
Pass the `` parameter to check prepared timestamp
Declaration
public virtual async System.Threading.Tasks.Task<ExportVM> StaticPreviewAsync(string id, PreviewTemplateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| PreviewTemplateVM | body | Model with parameters |
| 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> | Specified template has been prepared |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateContent(String, UpdateFileContentVM)
Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
Declaration
public virtual void UpdateContent(string id, UpdateFileContentVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| UpdateFileContentVM | body | VM with only byte[] with new content |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateContentAsync(String, UpdateFileContentVM, System.Threading.CancellationToken)
Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
Declaration
public virtual async System.Threading.Tasks.Task UpdateContentAsync(string id, UpdateFileContentVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| UpdateFileContentVM | body | VM with only byte[] with new content |
| 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. |
UpdateContentV2(String, FileParameter)
Updates contnet of the template.
Declaration
public virtual void UpdateContentV2(string id, FileParameter fileContent = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| FileParameter | fileContent |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateContentV2Async(String, FileParameter, System.Threading.CancellationToken)
Updates contnet of the template.
Declaration
public virtual async System.Threading.Tasks.Task UpdateContentV2Async(string id, FileParameter fileContent = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | template id |
| FileParameter | fileContent | |
| 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 | Template has been updated |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateIcon(String, FileIconVM)
Update a files's icon
Declaration
public virtual TemplateVM UpdateIcon(string id, FileIconVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileIconVM | body |
Returns
| Type | Description |
|---|---|
| TemplateVM | 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
public virtual async System.Threading.Tasks.Task<TemplateVM> 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<TemplateVM> | 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. |
UpdateParameters(String, ReportParametersVM)
Declaration
public virtual TemplateVM UpdateParameters(string id, ReportParametersVM body)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| ReportParametersVM | body |
Returns
| Type | Description |
|---|---|
| TemplateVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateParametersAsync(String, ReportParametersVM, System.Threading.CancellationToken)
Declaration
public virtual async System.Threading.Tasks.Task<TemplateVM> UpdateParametersAsync(string id, ReportParametersVM body, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| ReportParametersVM | 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<TemplateVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdatePermissions(String, UpdateFilePermissionsVM)
Update permissions
Declaration
public virtual 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
public virtual async 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
public virtual TemplateVM UpdateTags(string id, FileTagsUpdateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| FileTagsUpdateVM | body |
Returns
| Type | Description |
|---|---|
| TemplateVM | 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
public virtual async System.Threading.Tasks.Task<TemplateVM> 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<TemplateVM> | Tags has been updated |
Remarks
User with Update Tags permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFile(String, TemplateCreateVM)
Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
Declaration
public virtual TemplateVM UploadFile(string id, TemplateCreateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| TemplateCreateVM | body | file's view model |
Returns
| Type | Description |
|---|---|
| TemplateVM | File has been uploaded |
Remarks
User with Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFileAsync(String, TemplateCreateVM, System.Threading.CancellationToken)
Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
Declaration
public virtual async System.Threading.Tasks.Task<TemplateVM> UploadFileAsync(string id, TemplateCreateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| TemplateCreateVM | body | file's view 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<TemplateVM> | File has been uploaded |
Remarks
User with Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFileV2(String, System.Collections.Generic.IEnumerable<String>, FileParameter, FileParameter)
Alternative api for upload a file to the specified folder!
Declaration
public virtual TemplateVM UploadFileV2(string id, System.Collections.Generic.IEnumerable<string> tags = null, FileParameter icon = null, FileParameter fileContent = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| System.Collections.Generic.IEnumerable<System.String> | tags | |
| FileParameter | icon | |
| FileParameter | fileContent |
Returns
| Type | Description |
|---|---|
| TemplateVM | File has been uploaded |
Remarks
User with Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFileV2Async(String, System.Collections.Generic.IEnumerable<String>, FileParameter, FileParameter, System.Threading.CancellationToken)
Alternative api for upload a file to the specified folder!
Declaration
public virtual async System.Threading.Tasks.Task<TemplateVM> UploadFileV2Async(string id, System.Collections.Generic.IEnumerable<string> tags = null, FileParameter icon = null, FileParameter fileContent = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Identifier of folder |
| System.Collections.Generic.IEnumerable<System.String> | tags | |
| FileParameter | icon | |
| FileParameter | fileContent | |
| 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<TemplateVM> | File has been uploaded |
Remarks
User with Create Entity permission can access this method.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
WasmStaticPreview(String, PreviewTemplateVM)
Make preview for the report (template).
Generate a new or return exist prepared fpx file.
If template was changed will be returned a new.
Declaration
public virtual ReportVM WasmStaticPreview(string id, PreviewTemplateVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Template id |
| PreviewTemplateVM | body | Model with parameters |
Returns
| Type | Description |
|---|---|
| ReportVM | Specified template has been prepared |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
WasmStaticPreviewAsync(String, PreviewTemplateVM, System.Threading.CancellationToken)
Make preview for the report (template).
Generate a new or return exist prepared fpx file.
If template was changed will be returned a new.
Declaration
public virtual async System.Threading.Tasks.Task<ReportVM> WasmStaticPreviewAsync(string id, PreviewTemplateVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Template id |
| PreviewTemplateVM | body | Model with parameters |
| 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<ReportVM> | Specified template has been prepared |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |