Class EntityDefinition

CreatedBy

Gets the id of the user who created this resource. null if it has not been created.

public long? CreatedBy { get; set; }

CreatedOn

Gets the date on which this resource was created. null if it has not been created.

public DateTime? CreatedOn { get; set; }

DisplayTemplate

Gets or sets the language agnostic display format for entities of this definition. Formatted as follows: {PropertyName}.

public string DisplayTemplate { get; set; }

Id

Gets the id of this definition. This is an automatically assigned unique and strictly positive number identifying the entity definition. null if has not been created.

public long? Id { get; set; }

IsManualSortingAllowed

Gets or sets a value indicating whether the items of this definition can be sorted manually (UI related).

public bool IsManualSortingAllowed { get; set; }

IsNew

Gets a value indicating whether the entity definition is new (id is null).

public bool IsNew { get; }

IsPathEnabledDefinition

Gets or sets a value indicating whether entities of this entity definition can be part of the so called paths, which are technically UI breadcrumbs. Example use cases are taxonomy entity definitions or Sitecore Content Hub Project block entity definitions.

public bool IsPathEnabledDefinition { get; set; }

IsSystemOwned

Gets or sets a value indicating whether the entity definition is owned by the system and cannot be modified or deleted by the regular users.

public bool IsSystemOwned { get; set; }

IsTaxonomyItemDefinition

Gets or sets a value indicating whether entities of this entity definition are taxonomy items, they can be used as a search facet on the web pages.

public bool IsTaxonomyItemDefinition { get; set; }

Labels

Gets a collection of the culture specific definition labels. Never returns null.

public IDictionary<CultureInfo, string> Labels { get; }

MemberGroups

Gets the collection of member groups. Never returns null.

public IList<IMemberGroup> MemberGroups { get; }

ModifiedBy

Gets the id of the user who modified this resource. null if it has not been created.

public long? ModifiedBy { get; set; }

ModifiedOn

Gets the date on which this resource was modified. null if it has not been created.

public DateTime? ModifiedOn { get; set; }

Name

Gets the unique and language agnostic name of the entity definition. It should be handled as case sensitive.

public string Name { get; set; }

GetPropertyDefinition(string)

Get the definition of the specified property.

public IPropertyDefinition GetPropertyDefinition(string name)

GetPropertyDefinition(string)

Generic version of GetPropertyDefinition(string).

public T GetPropertyDefinition<T>(string name) where T : IPropertyDefinition

GetPropertyDefinitions()

Gets all property definitions.

public IList<IPropertyDefinition> GetPropertyDefinitions()

GetRelationDefinition(string, RelationRole)

Get the definition of the specified relation.

public IRelationDefinition GetRelationDefinition(string name, RelationRole role)

GetRelationDefinitions()

Gets all relation definitions.

public IList<IRelationDefinition> GetRelationDefinitions()

Implements

IEntityDefinition

IResource