Interface IEntityDefinitionsClient

Contains functionality to get entity definitions and their entities.

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

public interface IEntityDefinitionsClient
Remarks

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
RequestResponse

IIdIterator CreateEntityDefinitionIdIterator(long pageSize = null)
Parameters
TypeNameDescription
longpageSize

The page size.

Returns
TypeDescription
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
RequestResponse

IEntityDefinitionIterator CreateEntityDefinitionIterator(long pageSize = null)
Parameters
TypeNameDescription
longpageSize

The page size.

Returns
TypeDescription
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
RequestResponse

Task DeleteAsync(long id)
Parameters
TypeNameDescription
longid

The id of the entity definition to delete.

Returns
TypeDescription
Task

A representing the asynchronous operation.

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

Task DeleteAsync(string name)
Parameters
TypeNameDescription
stringname

The name of the entity definition to delete.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ForbiddenException

Thrown when the entity definition exists but could not be deleted.

GetAsync(long)

Gets the IEntityDefinition instance by the specified id.

Declaration
RequestResponse

Task<IEntityDefinition> GetAsync(long id)
Parameters
TypeNameDescription
longid

Entity definition id.

Returns
TypeDescription
Task<>IEntityDefinition

The IEntityDefinition or null if the entity definition does not exist.

GetAsync(string)

Gets the IEntityDefinition instance by the specified name.

Declaration
RequestResponse

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

Entity definition name (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IEntityDefinition> GetCachedAsync(long id)
Parameters
TypeNameDescription
longid

Entity definition id.

Returns
TypeDescription
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
RequestResponse

Task<IEntityDefinition> GetCachedAsync(string name)
Parameters
TypeNameDescription
stringname

Entity definition name (case insensitive).

Returns
TypeDescription
Task<>IEntityDefinition

The IEntityDefinition or null if the entity definition does not exist.

GetIdAsync(string)

Gets the id of the specified entity definition.

Declaration
RequestResponse

Task<long?> GetIdAsync(string name)
Parameters
TypeNameDescription
stringname

Entity definition name (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<long?> GetIdCachedAsync(string name)
Parameters
TypeNameDescription
stringname

Entity definition name (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IDictionary<string, long>> GetIdsAsync(IEnumerable<string> names)
Parameters
TypeNameDescription
IEnumerable<>stringnames

Entity definition names (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IDictionary<string, long>> GetIdsCachedAsync(IEnumerable<string> names)
Parameters
TypeNameDescription
IEnumerable<>stringnames

Entity definition names (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IList<IEntityDefinition>> GetManyAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids.

Returns
TypeDescription
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
RequestResponse

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

Entity definition names (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IList<IEntityDefinition>> GetManyCachedAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids.

Returns
TypeDescription
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
RequestResponse

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

Entity definition names (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<IList<long>> GetManyIdsAsync(IEnumerable<string> names)
Parameters
TypeNameDescription
IEnumerable<>stringnames

Entity definition names (case insensitive).

Returns
TypeDescription
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
RequestResponse

Task<string> GetNameAsync(long id)
Parameters
TypeNameDescription
longid

The id of the definition to get the name of.

Returns
TypeDescription
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
RequestResponse

Task<string> GetNameCachedAsync(long id)
Parameters
TypeNameDescription
longid

The id of the definition to get the name of.

Returns
TypeDescription
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
RequestResponse

Task<IDictionary<long, string>> GetNamesAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

Entity definition ids.

Returns
TypeDescription
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
RequestResponse

Task<IDictionary<long, string>> GetNamesCachedAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

Entity definition ids.

Returns
TypeDescription
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
RequestResponse

Task<IEntityDefinitionQueryResult> GetRangeAsync(long skip = null, long take = null)
Parameters
TypeNameDescription
longskip

Skip specified number of entity definitions. If no value is specified, no items will be skipped.

longtake

Take only specified number of entity definitions.

Returns
TypeDescription
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
RequestResponse

Task<IIdQueryResult> GetRangeIdsAsync(long skip = null, long take = null)
Parameters
TypeNameDescription
longskip

Skip specified number of entity definitions. If no value is specified, no items will be skipped.

longtake

Take only specified number of entity definitions.

Returns
TypeDescription
Task<>IIdQueryResult

A query result of entity definition ids.

SaveAsync(IEntityDefinition)

Saves the entity definition in Content Hub.

Declaration
RequestResponse

Task<long> SaveAsync(IEntityDefinition entityDefinition)
Parameters
TypeNameDescription
IEntityDefinitionentityDefinition

The entity definition to save.

Returns
TypeDescription
Task<>long

The id of the entity definition in Content Hub.

Exceptions
TypeCondition
ValidationException

Thrown when the entity definition could not be saved because a validation error occurred.

Do you have some feedback for us?

If you have suggestions for improving this article,