Interface IDataSourcesClient

Provides functionality to query, create and manipulate datasources.

Namespace: StylelabsStylelabs.MSdkClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse

public interface IDataSourcesClient

Methods

CreateAsync(IDataSource)

Creates a new datasource.

Declaration
RequestResponse

Task CreateAsync(IDataSource dataSource)
Parameters
TypeNameDescription
IDataSourcedataSource

The datasource to create.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
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
RequestResponse

Task DeleteAsync(string name)
Parameters
TypeNameDescription
stringname

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

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
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
RequestResponse

Task<IList<string>> GetAllAsync()
Returns
TypeDescription
Task<>IList<>string

The names of all datasources that exist in M.

GetAsync(string)

Gets the datasource with the specified name.

Declaration
RequestResponse

Task<IDataSource> GetAsync(string name)
Parameters
TypeNameDescription
stringname

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

Returns
TypeDescription
Task<>IDataSource

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

GetManyAsync(IEnumerable<string>)

Gets the IDataSource instances by the names of the option lists. The result can have a different ordering and size (when option list don't exist) than the input.

Declaration
RequestResponse

Task<IList<IDataSource>> GetManyAsync(IEnumerable<string> names)
Parameters
TypeNameDescription
IEnumerable<>stringnames

Option list names (case insensitive).

Returns
TypeDescription
Task<>IList<>IDataSource

Non null collection of IDataSource instances.

GetManyCachedAsync(IEnumerable<string>)

Gets the cached IDataSource instances by the names of the definitions. The result can have a different ordering and size (when option list don't exist) than the input.

Declaration
RequestResponse

Task<IList<IDataSource>> GetManyCachedAsync(IEnumerable<string> names)
Parameters
TypeNameDescription
IEnumerable<>stringnames

Option list names (case insensitive).

Returns
TypeDescription
Task<>IList<>IDataSource

Non null collection of IDataSource instances.

UpdateAsync(IDataSource)

Updates a datasource.

Declaration
RequestResponse

Task UpdateAsync(IDataSource dataSource)
Parameters
TypeNameDescription
IDataSourcedataSource

The datasource to update.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
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.

Do you have some feedback for us?

If you have suggestions for improving this article,