Interface IFontsClient
Namespace: FastReport.Cloud
Assembly: FastReport.Cloud.SDK.dll
Syntax
public interface IFontsClientMethods
AddPublicFont(AddPublicFontVM)
Allows user to add a font from a list of public fonts to their subscription
Declaration
UserFontVM AddPublicFont(AddPublicFontVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| AddPublicFontVM | body | a body with font id and workspace id |
Returns
| Type | Description |
|---|---|
| UserFontVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AddPublicFontAsync(AddPublicFontVM, System.Threading.CancellationToken)
Allows user to add a font from a list of public fonts to their subscription
Declaration
System.Threading.Tasks.Task<UserFontVM> AddPublicFontAsync(AddPublicFontVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| AddPublicFontVM | body | a body with font id and workspace 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<UserFontVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CountFonts(String)
Returns a number of fonts in a subscription
Declaration
CountVM CountFonts(string subscriptionId = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | subscripiton id |
Returns
| Type | Description |
|---|---|
| CountVM | Everything is all right |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CountFontsAsync(String, System.Threading.CancellationToken)
Returns a number of fonts in a subscription
Declaration
System.Threading.Tasks.Task<CountVM> CountFontsAsync(string subscriptionId = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | subscripiton 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> | Everything is all right |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CountPublicFonts()
Returns a number of pulbic fonts
Declaration
CountVM CountPublicFonts()Returns
| Type | Description |
|---|---|
| CountVM | Everything is all right |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CountPublicFontsAsync(System.Threading.CancellationToken)
Returns a number of pulbic fonts
Declaration
System.Threading.Tasks.Task<CountVM> CountPublicFontsAsync(System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| 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> | Everything is all right |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteFont(String)
deletes a font from the subscirption by id
Declaration
void DeleteFont(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | font id |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DeleteFontAsync(String, System.Threading.CancellationToken)
deletes a font from the subscirption by id
Declaration
System.Threading.Tasks.Task DeleteFontAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | font 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 | Created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DownloadFont(String)
Downloads font by it's id
Declaration
FileResponse DownloadFont(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of the font |
Returns
| Type | Description |
|---|---|
| FileResponse | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
DownloadFontAsync(String, System.Threading.CancellationToken)
Downloads font by it's id
Declaration
System.Threading.Tasks.Task<FileResponse> DownloadFontAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of the font |
| 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<FileResponse> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFontFamilies(String, Nullable<Int32>, Nullable<Int32>)
Returns distinct font names from public and private font lists (excluding disabled fonts)
Declaration
FontNamesVM GetFontFamilies(string subscriptionId = null, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | id of a subscription, to pull the font names from. If null or the subscription has no fonts, only the public fonts will be returned |
| System.Nullable<System.Int32> | skip | how many names to skip |
| System.Nullable<System.Int32> | take | how many namrs to take |
Returns
| Type | Description |
|---|---|
| FontNamesVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFontFamiliesAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns distinct font names from public and private font lists (excluding disabled fonts)
Declaration
System.Threading.Tasks.Task<FontNamesVM> GetFontFamiliesAsync(string subscriptionId = null, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | id of a subscription, to pull the font names from. If null or the subscription has no fonts, only the public fonts will be returned |
| System.Nullable<System.Int32> | skip | how many names to skip |
| System.Nullable<System.Int32> | take | how many namrs to 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<FontNamesVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFonts(String, Nullable<Int32>, Nullable<Int32>)
returns a list of fonts in the subscription
Declaration
UserFontsVM GetFonts(string subscriptionId = null, int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | id of a subscription, to pull the fonts from. If null, only the public fonts will be returned |
| System.Nullable<System.Int32> | skip | how many fonts to skip |
| System.Nullable<System.Int32> | take | how many fonts to take |
Returns
| Type | Description |
|---|---|
| UserFontsVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetFontsAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
returns a list of fonts in the subscription
Declaration
System.Threading.Tasks.Task<UserFontsVM> GetFontsAsync(string subscriptionId = null, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | subscriptionId | id of a subscription, to pull the fonts from. If null, only the public fonts will be returned |
| System.Nullable<System.Int32> | skip | how many fonts to skip |
| System.Nullable<System.Int32> | take | how many fonts to 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<UserFontsVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissions(String)
Get current user's permissions to a font
Declaration
UserFontPermissionCRUDVM GetMyPermissions(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | user font id |
Returns
| Type | Description |
|---|---|
| UserFontPermissionCRUDVM | got permissions successfully |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetMyPermissionsAsync(String, System.Threading.CancellationToken)
Get current user's permissions to a font
Declaration
System.Threading.Tasks.Task<UserFontPermissionCRUDVM> GetMyPermissionsAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | user font 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<UserFontPermissionCRUDVM> | got permissions successfully |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPermissions(String)
Get font's permissions
Declaration
UserFontPermissionsVM GetPermissions(string id)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | user font id |
Returns
| Type | Description |
|---|---|
| UserFontPermissionsVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPermissionsAsync(String, System.Threading.CancellationToken)
Get font's permissions
Declaration
System.Threading.Tasks.Task<UserFontPermissionsVM> GetPermissionsAsync(string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | user font 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<UserFontPermissionsVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPublicFonts(Nullable<Int32>, Nullable<Int32>)
Returns a list of public fonts
Declaration
FontsVM GetPublicFonts(int? skip = null, int? take = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | skip | |
| System.Nullable<System.Int32> | take |
Returns
| Type | Description |
|---|---|
| FontsVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
GetPublicFontsAsync(Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Returns a list of public fonts
Declaration
System.Threading.Tasks.Task<FontsVM> GetPublicFontsAsync(int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| 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<FontsVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateFont(String, UpdateUserFontVM)
updates a user font model
Declaration
UserFontVM UpdateFont(string id, UpdateUserFontVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of the font |
| UpdateUserFontVM | body | update VM body |
Returns
| Type | Description |
|---|---|
| UserFontVM | Created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdateFontAsync(String, UpdateUserFontVM, System.Threading.CancellationToken)
updates a user font model
Declaration
System.Threading.Tasks.Task<UserFontVM> UpdateFontAsync(string id, UpdateUserFontVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | id of the font |
| UpdateUserFontVM | body | update VM 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<UserFontVM> | Created |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdatePermissions(String, UpdateUserFontPermissionsVM)
Update permissions
Declaration
void UpdatePermissions(string id, UpdateUserFontPermissionsVM body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateUserFontPermissionsVM | body |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UpdatePermissionsAsync(String, UpdateUserFontPermissionsVM, System.Threading.CancellationToken)
Update permissions
Declaration
System.Threading.Tasks.Task UpdatePermissionsAsync(string id, UpdateUserFontPermissionsVM body = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | |
| UpdateUserFontPermissionsVM | 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 | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFont(FileParameter, String, Nullable<Boolean>)
Allows user to upload a new truetype font to their subscription
Declaration
UserFontsVM UploadFont(FileParameter file = null, string subscriptionId = null, bool? enabled = null)Parameters
| Type | Name | Description |
|---|---|---|
| FileParameter | file | |
| System.String | subscriptionId | |
| System.Nullable<System.Boolean> | enabled |
Returns
| Type | Description |
|---|---|
| UserFontsVM | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
UploadFontAsync(FileParameter, String, Nullable<Boolean>, System.Threading.CancellationToken)
Allows user to upload a new truetype font to their subscription
Declaration
System.Threading.Tasks.Task<UserFontsVM> UploadFontAsync(FileParameter file = null, string subscriptionId = null, bool? enabled = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| FileParameter | file | |
| System.String | subscriptionId | |
| System.Nullable<System.Boolean> | enabled | |
| 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<UserFontsVM> | Success |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |