Interface IEntityDefinitionsClient
Contains functionality to get entity definitions and their entities.
Namespace: StylelabsStylelabs.MSdkClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
public interface IEntityDefinitionsClientRemarks
This client exposes a lot of methods that also have cached version. It is generally advised to use the cached variants.
Methods
CreateEntityDefinitionIdIterator(long)
Creates an iterator to iterate over all the available entity definition ids in the system. Results are ordered ascending by id.
Declaration
IIdIterator CreateEntityDefinitionIdIterator(long pageSize = null)Parameters
| Type | Name | Description |
|---|---|---|
| long | pageSize |
The page size. |
Returns
| Type | Description |
|---|---|
| IIdIterator |
An entity definition id iterator. |
CreateEntityDefinitionIterator(long)
Creates an iterator to iterate over all the available IEntityDefinition instances in the system. Results are ordered ascending by id.
Declaration
IEntityDefinitionIterator CreateEntityDefinitionIterator(long pageSize = null)Parameters
| Type | Name | Description |
|---|---|---|
| long | pageSize |
The page size. |
Returns
| Type | Description |
|---|---|
| IEntityDefinitionIterator |
An entity definition iterator. |
DeleteAsync(long)
Deletes the entity definition in Content Hub. If the entity definition doesn't exist, nothing will happen.
Declaration
Task DeleteAsync(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
The id of the entity definition to delete. |
Returns
| Type | Description |
|---|---|
| Task |
A representing the asynchronous operation. |
Exceptions
| Type | Condition |
|---|---|
| ForbiddenException |
Thrown when the entity definition exists but could not be deleted. |
DeleteAsync(string)
Deletes the entity definition in Content Hub. If the entity definition doesn't exist, nothing will happen.
Declaration
Task DeleteAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
The name of the entity definition to delete. |
Returns
| Type | Description |
|---|---|
| Task |
A representing the asynchronous operation. |
Exceptions
| Type | Condition |
|---|---|
| ForbiddenException |
Thrown when the entity definition exists but could not be deleted. |
GetAsync(long)
Gets the IEntityDefinition instance by the specified id.
Declaration
Task<IEntityDefinition> GetAsync(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
Entity definition id. |
Returns
| Type | Description |
|---|---|
| Task<>IEntityDefinition |
The IEntityDefinition or null if the entity definition does not exist. |
GetAsync(string)
Gets the IEntityDefinition instance by the specified name.
Declaration
Task<IEntityDefinition> GetAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Entity definition name (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IEntityDefinition |
The IEntityDefinition or null if the entity definition does not exist. |
GetCachedAsync(long)
Gets the cached IEntityDefinition instance by the specified id.
Declaration
Task<IEntityDefinition> GetCachedAsync(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
Entity definition id. |
Returns
| Type | Description |
|---|---|
| Task<>IEntityDefinition |
The IEntityDefinition or null if the entity definition does not exist. |
GetCachedAsync(string)
Gets the cached IEntityDefinition instance by the specified name.
Declaration
Task<IEntityDefinition> GetCachedAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Entity definition name (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IEntityDefinition |
The IEntityDefinition or null if the entity definition does not exist. |
GetIdAsync(string)
Gets the id of the specified entity definition.
Declaration
Task<long?> GetIdAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Entity definition name (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>long |
The entity definition id or null if the entity definition does not exist. |
GetIdCachedAsync(string)
Gets the id of the specified cached entity definition.
Declaration
Task<long?> GetIdCachedAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Entity definition name (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>long |
The entity definition id or null if the entity definition does not exist. |
GetIdsAsync(IEnumerable<string>)
Gets the entity definition ids by the names of the definitions.
Declaration
Task<IDictionary<string, long>> GetIdsAsync(IEnumerable<string> names)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | names |
Entity definition names (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IDictionary<, >stringlong |
Non null, case-insensitive dictionary that maps the definition names to ids. |
GetIdsCachedAsync(IEnumerable<string>)
Gets the cached entity definition ids by the names of the definitions.
Declaration
Task<IDictionary<string, long>> GetIdsCachedAsync(IEnumerable<string> names)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | names |
Entity definition names (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IDictionary<, >stringlong |
Non null, case-insensitive dictionary that maps the definition names to ids. |
GetManyAsync(IEnumerable<long>)
Gets the IEntityDefinition instances by the ids of the definitions. The result can have a different ordering and size (when definitions don't exist) than the input.
Declaration
Task<IList<IEntityDefinition>> GetManyAsync(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
The ids. |
Returns
| Type | Description |
|---|---|
| Task<>IList<>IEntityDefinition |
Non null collection of IEntityDefinition instances. |
GetManyAsync(IEnumerable<string>)
Gets the IEntityDefinition instances by the names of the definitions. The result can have a different ordering and size (when definitions don't exist) than the input.
Declaration
Task<IList<IEntityDefinition>> GetManyAsync(IEnumerable<string> names)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | names |
Entity definition names (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IList<>IEntityDefinition |
Non null collection of IEntityDefinition instances. |
GetManyCachedAsync(IEnumerable<long>)
Gets the cached IEntityDefinition instances by the ids of the definitions. The result can have a different ordering and size (when definitions don't exist) than the input.
Declaration
Task<IList<IEntityDefinition>> GetManyCachedAsync(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
The ids. |
Returns
| Type | Description |
|---|---|
| Task<>IList<>IEntityDefinition |
Non null collection of IEntityDefinition instances. |
GetManyCachedAsync(IEnumerable<string>)
Gets the cached IEntityDefinition instances by the names of the definitions. The result can have a different ordering and size (when definitions don't exist) than the input.
Declaration
Task<IList<IEntityDefinition>> GetManyCachedAsync(IEnumerable<string> names)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | names |
Entity definition names (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IList<>IEntityDefinition |
Non null collection of IEntityDefinition instances. |
GetManyIdsAsync(IEnumerable<string>)
Gets the entity definition ids by the names of the definitions.
The ids have the same ordering as the names, except for definitions that were not found.
Declaration
Task<IList<long>> GetManyIdsAsync(IEnumerable<string> names)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | names |
Entity definition names (case insensitive). |
Returns
| Type | Description |
|---|---|
| Task<>IList<>long |
Non null collection of entity definition ids. |
Remarks
It is recommended to use GetIdsAsync(IEnumerable<string>) instead, because the mapping is much clearer.
GetNameAsync(long)
Gets the name of the IEntityDefinition with the specified id.
Declaration
Task<string> GetNameAsync(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
The id of the definition to get the name of. |
Returns
| Type | Description |
|---|---|
| Task<>string |
The name of the specified definition or null if it doesn't exist. |
GetNameCachedAsync(long)
Gets the name of the cached IEntityDefinition with the specified id.
Declaration
Task<string> GetNameCachedAsync(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
The id of the definition to get the name of. |
Returns
| Type | Description |
|---|---|
| Task<>string |
The name of the specified definition or null if it doesn't exist. |
GetNamesAsync(IEnumerable<long>)
Gets the entity definition names by the ids of the definitions.
Declaration
Task<IDictionary<long, string>> GetNamesAsync(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
Entity definition ids. |
Returns
| Type | Description |
|---|---|
| Task<>IDictionary<, >longstring |
Non null dictionary that maps the definition ids to names. |
GetNamesCachedAsync(IEnumerable<long>)
Gets the cached entity definition names by the ids of the definitions.
Declaration
Task<IDictionary<long, string>> GetNamesCachedAsync(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
Entity definition ids. |
Returns
| Type | Description |
|---|---|
| Task<>IDictionary<, >longstring |
Non null dictionary that maps the definition ids to names. |
GetRangeAsync(long, long)
Gets a set of IEntityDefinition instances in the system by specified range. Results are ordered ascending by id.
Declaration
Task<IEntityDefinitionQueryResult> GetRangeAsync(long skip = null, long take = null)Parameters
| Type | Name | Description |
|---|---|---|
| long | skip |
Skip specified number of entity definitions. If no value is specified, no items will be skipped. |
| long | take |
Take only specified number of entity definitions. |
Returns
| Type | Description |
|---|---|
| Task<>IEntityDefinitionQueryResult |
A query result of entity definitions. |
GetRangeIdsAsync(long, long)
Gets a set of entity definition ids in the system by specified range. Results are ordered ascending by id.
Declaration
Task<IIdQueryResult> GetRangeIdsAsync(long skip = null, long take = null)Parameters
| Type | Name | Description |
|---|---|---|
| long | skip |
Skip specified number of entity definitions. If no value is specified, no items will be skipped. |
| long | take |
Take only specified number of entity definitions. |
Returns
| Type | Description |
|---|---|
| Task<>IIdQueryResult |
A query result of entity definition ids. |
SaveAsync(IEntityDefinition)
Saves the entity definition in Content Hub.
Declaration
Task<long> SaveAsync(IEntityDefinition entityDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityDefinition | entityDefinition |
The entity definition to save. |
Returns
| Type | Description |
|---|---|
| Task<>long |
The id of the entity definition in Content Hub. |
Exceptions
| Type | Condition |
|---|---|
| ValidationException |
Thrown when the entity definition could not be saved because a validation error occurred. |