logo
logo
  • Interface IDataSourcesClient

    Provides functionality to query, create and manipulate datasources.

    Namespace: Stylelabs.M.Sdk.Clients
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public interface IDataSourcesClient

    Methods

    CreateAsync(IDataSource)

    Creates a new datasource.

    Declaration
    Task CreateAsync(IDataSource dataSource)
    Parameters
    Type Name Description
    IDataSource dataSource

    The datasource to create.

    Returns
    Type Description
    Task

    A representing the asynchronous operation.

    Exceptions
    Type Condition
    ValidationException

    Thrown when the datasource could not be created because it is not valid. Common cases:

    • The name of the datasource is invalid.
    • The datasource contains hierarchical values but has type "Flat".
    • A datasource with the specified name already exists.
    • Not all values have an identifier.
    • The identifiers of the values are not unique.
    ForbiddenException

    Thrown when the user is not allowed to create datasources.

    DeleteAsync(String)

    Deletes the datasource with the specified name.

    Declaration
    Task DeleteAsync(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the datasource to delete (case insensitive).

    Returns
    Type Description
    Task

    A representing the asynchronous operation.

    Exceptions
    Type Condition
    ForbiddenException

    Thrown when the user is not allowed to delete the datasource.

    ValidationException

    Thrown when the datasource could not be deleted because a validation error occurred. Common case: the datasource is being used in one or more EntityDefinitions.

    GetAllAsync()

    Gets the names of all datasources that exist in the M.

    Declaration
    Task<IList<string>> GetAllAsync()
    Returns
    Type Description
    Task<IList<System.String>>

    The names of all datasources that exist in M.

    GetAsync(String)

    Gets the datasource with the specified name.

    Declaration
    Task<IDataSource> GetAsync(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the datasource to get (case insensitive).

    Returns
    Type Description
    Task<IDataSource>

    The datasource with the specified name or null if the datasource could not be found.

    UpdateAsync(IDataSource)

    Updates a datasource.

    Declaration
    Task UpdateAsync(IDataSource dataSource)
    Parameters
    Type Name Description
    IDataSource dataSource

    The datasource to update.

    Returns
    Type Description
    Task

    A representing the asynchronous operation.

    Exceptions
    Type Condition
    ValidationException

    Thrown when the datasource could not be created because it is not valid. Common cases:

    • The datasource contains hierarchical values but has type "Flat".
    • Not all values have an identifier.
    • The identifiers of the values are not unique.
    ForbiddenException

    Thrown when the user is not allowed to update datasources.

    NotFoundException

    Thrown when the datasource with the specified name could not be found.

    Can we improve this article ? Provide feedback