Search Results for

    Show / Hide Table of Contents

    Class FontsClient

    Inheritance
    System.Object
    FontsClient
    Implements
    IFontsClient
    Namespace: FastReport.Cloud.Client
    Assembly: FastReport.Cloud.SDK.dll
    Syntax
    public class FontsClient : object, IFontsClient

    Constructors

    FontsClient(System.Net.Http.HttpClient)

    Declaration
    public FontsClient(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

    ReadResponseAsString

    Declaration
    public bool ReadResponseAsString { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    AddPublicFont(AddPublicFontVM)

    Allows user to add a font from a list of public fonts to their subscription

    Declaration
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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

    No Content

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    DownloadFont(String)

    Downloads font by it's id

    Declaration
    public virtual 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
    public virtual async 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.

    DownloadPublicFont(String)

    Downloads a public font by it's id

    Declaration
    public virtual FileResponse DownloadPublicFont(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.

    DownloadPublicFontAsync(String, System.Threading.CancellationToken)

    Downloads a public font by it's id

    Declaration
    public virtual async System.Threading.Tasks.Task<FileResponse> DownloadPublicFontAsync(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
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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.

    GetFontsByReport(String, Nullable<Int32>, Nullable<Int32>)

    Returns a list of fonts in the subscription by report id.

    Declaration
    public virtual UserFontsVM GetFontsByReport(string reportId, int? skip = null, int? take = null)
    Parameters
    Type Name Description
    System.String reportId

    id of a report

    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.

    GetFontsByReportAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)

    Returns a list of fonts in the subscription by report id.

    Declaration
    public virtual async System.Threading.Tasks.Task<UserFontsVM> GetFontsByReportAsync(string reportId, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    System.String reportId

    id of a report

    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.

    GetFontsByTemplate(String, Nullable<Int32>, Nullable<Int32>)

    Returns a list of fonts in the subscription by report id.

    Declaration
    public virtual UserFontsVM GetFontsByTemplate(string templateId, int? skip = null, int? take = null)
    Parameters
    Type Name Description
    System.String templateId

    id of a report

    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.

    GetFontsByTemplateAsync(String, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)

    Returns a list of fonts in the subscription by report id.

    Declaration
    public virtual async System.Threading.Tasks.Task<UserFontsVM> GetFontsByTemplateAsync(string templateId, int? skip = null, int? take = null, System.Threading.CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    System.String templateId

    id of a report

    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.

    GetFontsCss(String)

    Creates a css stylesheet for a public font

    Declaration
    public virtual string GetFontsCss(string subscriptionId = null)
    Parameters
    Type Name Description
    System.String subscriptionId
    Returns
    Type Description
    System.String

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetFontsCssAsync(String, System.Threading.CancellationToken)

    Creates a css stylesheet for a public font

    Declaration
    public virtual async System.Threading.Tasks.Task<string> GetFontsCssAsync(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<System.String>

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetFontsCssByReport(String)

    Creates a css stylesheet for a public fonts by report.

    Declaration
    public virtual string GetFontsCssByReport(string reportId)
    Parameters
    Type Name Description
    System.String reportId

    id of a report

    Returns
    Type Description
    System.String

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetFontsCssByReportAsync(String, System.Threading.CancellationToken)

    Creates a css stylesheet for a public fonts by report.

    Declaration
    public virtual async System.Threading.Tasks.Task<string> GetFontsCssByReportAsync(string reportId, System.Threading.CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    System.String reportId

    id of a report

    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<System.String>

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetFontsCssByTemplate(String)

    Creates a css stylesheet for a public font by template.

    Declaration
    public virtual string GetFontsCssByTemplate(string templateId)
    Parameters
    Type Name Description
    System.String templateId

    id of a report

    Returns
    Type Description
    System.String

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetFontsCssByTemplateAsync(String, System.Threading.CancellationToken)

    Creates a css stylesheet for a public font by template.

    Declaration
    public virtual async System.Threading.Tasks.Task<string> GetFontsCssByTemplateAsync(string templateId, System.Threading.CancellationToken cancellationToken = null)
    Parameters
    Type Name Description
    System.String templateId

    id of a report

    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<System.String>

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetMyPermissions(String)

    Get current user's permissions to a font

    Declaration
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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.

    GetPublicFontsCss()

    Creates a css stylesheet for a public font

    Declaration
    public virtual string GetPublicFontsCss()
    Returns
    Type Description
    System.String

    Success

    Exceptions
    Type Condition
    ApiException

    A server side error occurred.

    GetPublicFontsCssAsync(System.Threading.CancellationToken)

    Creates a css stylesheet for a public font

    Declaration
    public virtual async System.Threading.Tasks.Task<string> GetPublicFontsCssAsync(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<System.String>

    Success

    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<FontsClient.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<FontsClient.ObjectResponseResult<T>>
    Type Parameters
    Name Description
    T

    UpdateFont(String, UpdateUserFontVM)

    updates a user font model

    Declaration
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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
    public virtual 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
    public virtual async 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.

    Implements

    IFontsClient
    Back to top 2025.2.5 © 1998-2025 Copyright Fast Reports Inc.