1. EntityDefinition

Class EntityDefinition

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

An entity definition.

Inheritance
System.Object
EntityDefinition
Namespace: Stylelabs.M.Sdk.Models.Base
Assembly: Stylelabs.M.Sdk.dll
Syntax
public class EntityDefinition : object, IEntityDefinition, IResource

Properties

CreatedBy

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

Declaration
public long? CreatedBy { get; set; }
Property Value
TypeDescription
System.Nullable<System.Int64>

CreatedOn

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

Declaration
public DateTime? CreatedOn { get; set; }
Property Value
TypeDescription
System.Nullable<DateTime>

DisplayTemplate

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

Declaration
public string DisplayTemplate { get; set; }
Property Value
TypeDescription
System.String

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.

Declaration
public long? Id { get; set; }
Property Value
TypeDescription
System.Nullable<System.Int64>

IsManualSortingAllowed

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

Declaration
public bool IsManualSortingAllowed { get; set; }
Property Value
TypeDescription
System.Boolean

IsNew

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

Declaration
public bool IsNew { get; }
Property Value
TypeDescription
System.Boolean

IsPathEnabledDefinition

Gets 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

Declaration
public bool IsPathEnabledDefinition { get; set; }
Property Value
TypeDescription
System.Boolean

IsSystemOwned

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

Declaration
public bool IsSystemOwned { get; set; }
Property Value
TypeDescription
System.Boolean

IsTaxonomyItemDefinition

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

Declaration
public bool IsTaxonomyItemDefinition { get; set; }
Property Value
TypeDescription
System.Boolean

Labels

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

Declaration
public IDictionary<CultureInfo, string> Labels { get; }
Property Value
TypeDescription
IDictionary<CultureInfo, System.String>

MemberGroups

Gets the collection of member groups. Never returns null.

Declaration
public IList<IMemberGroup> MemberGroups { get; }
Property Value
TypeDescription
IList<IMemberGroup>

ModifiedBy

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

Declaration
public long? ModifiedBy { get; set; }
Property Value
TypeDescription
System.Nullable<System.Int64>

ModifiedOn

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

Declaration
public DateTime? ModifiedOn { get; set; }
Property Value
TypeDescription
System.Nullable<DateTime>

Name

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

Declaration
public string Name { get; set; }
Property Value
TypeDescription
System.String

Methods

GetPropertyDefinition(String)

Get the definition of the specified property.

Declaration
public IPropertyDefinition GetPropertyDefinition(string name)
Parameters
TypeNameDescription
System.Stringname

Name of the property.

Returns
TypeDescription
IPropertyDefinition

The property definition or null if it was not found.

GetPropertyDefinition<T>(String)

Generic version of GetPropertyDefinition(String).

Declaration
public T GetPropertyDefinition<T>(string name)
    where T : IPropertyDefinition
Parameters
TypeNameDescription
System.Stringname

Name of the property.

Returns
TypeDescription
T

The property definition or null if it was not found.

Type Parameters
NameDescription
T

A property (sub)type.

GetPropertyDefinitions()

Gets all property definitions.

Declaration
public IList<IPropertyDefinition> GetPropertyDefinitions()
Returns
TypeDescription
IList<IPropertyDefinition>

A list of all property definitions (never null)

GetRelationDefinition(String, RelationRole)

Get the definition of the specified relation.

Declaration
public IRelationDefinition GetRelationDefinition(string name, RelationRole role)
Parameters
TypeNameDescription
System.Stringname

Name of the relation.

RelationRolerole

Relation role.

Returns
TypeDescription
IRelationDefinition

The relation definition or null if it was not found.

GetRelationDefinitions()

Gets all relation definitions.

Declaration
public IList<IRelationDefinition> GetRelationDefinitions()
Returns
TypeDescription
IList<IRelationDefinition>

A list of all relation definitions (never null)

Implements

この記事を改善するための提案がある場合は、 お知らせください!