logo
logo
  • Interface IMemberDefinition

    Base interface for all member definitions.

    Namespace: Stylelabs.M.Sdk.Contracts.Base
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public interface IMemberDefinition

    Properties

    AllowUpdates

    Indicates whether this member can be updated from external sources (e.g. REST API, SDK...).

    Declaration
    bool AllowUpdates { get; set; }
    Property Value
    Type Description
    System.Boolean

    Conditions

    The conditions that are evaluated to decide if this member should be exposed in the external API/UI. These conditions have no impact on data validity.

    Declaration
    IList<IMemberCondition> Conditions { get; }
    Property Value
    Type Description
    IList<IMemberCondition>

    DefinitionType

    Type of the member.

    Declaration
    MemberDefinitionType DefinitionType { get; }
    Property Value
    Type Description
    MemberDefinitionType

    HelpText

    Collection of the culture specific help text.

    Declaration
    IDictionary<CultureInfo, string> HelpText { get; }
    Property Value
    Type Description
    IDictionary<CultureInfo, System.String>

    IsConditional

    Indicates whether this member definition has any member conditions.

    Declaration
    bool IsConditional { get; }
    Property Value
    Type Description
    System.Boolean

    IsSecured

    Indicates if the read-write access to this member is restricted.

    Declaration
    bool IsSecured { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsSystemOwned

    Indicates if the member definition is owned by the system and cannot be modified or deleted by the regular users.

    Declaration
    bool IsSystemOwned { get; set; }
    Property Value
    Type Description
    System.Boolean

    Labels

    Collection of the culture specific member labels.

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

    Name

    Language agnostic case insensitive name of the member. Must be unique per member and IEntityDefinition, except for self-referencing relations.

    Declaration
    string Name { get; set; }
    Property Value
    Type Description
    System.String

    Can we improve this article ? Provide feedback