Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IDataTypeService

    Defines the DataType Service, which is an easy access to operations involving IDataType

    Namespace: Umbraco.Cms.Core.Services
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IDataTypeService : IService

    Methods

    View Source

    Copy(IDataType, Int32)

    Declaration
    virtual Attempt<OperationResult<MoveOperationStatusType, IDataType>> Copy(IDataType copying, int containerId)
    Parameters
    Type Name Description
    IDataType copying
    System.Int32 containerId
    Returns
    Type Description
    Attempt<OperationResult<MoveOperationStatusType, IDataType>>
    View Source

    Copy(IDataType, Int32, Int32)

    Copies the give IDataType to a given container We have the default implementation here to avoid breaking changes for the user

    Declaration
    virtual Attempt<OperationResult<MoveOperationStatusType, IDataType>> Copy(IDataType copying, int containerId, int userId = -1)
    Parameters
    Type Name Description
    IDataType copying

    The data type that will be copied

    System.Int32 containerId

    The container ID under where the data type will be copied

    System.Int32 userId

    The user that did the Copy action

    Returns
    Type Description
    Attempt<OperationResult<MoveOperationStatusType, IDataType>>
    View Source

    CreateContainer(Int32, Guid, String, Int32)

    Declaration
    Attempt<OperationResult<OperationResultType, EntityContainer>> CreateContainer(int parentId, Guid key, string name, int userId = -1)
    Parameters
    Type Name Description
    System.Int32 parentId
    Guid key
    System.String name
    System.Int32 userId
    Returns
    Type Description
    Attempt<OperationResult<OperationResultType, EntityContainer>>
    View Source

    Delete(IDataType, Int32)

    Deletes an IDataType

    Declaration
    void Delete(IDataType dataType, int userId = -1)
    Parameters
    Type Name Description
    IDataType dataType

    IDataType to delete

    System.Int32 userId

    Id of the user issuing the deletion

    Remarks

    Please note that deleting a IDataType will remove all the IPropertyType data that references this IDataType.

    View Source

    DeleteContainer(Int32, Int32)

    Declaration
    Attempt<OperationResult> DeleteContainer(int containerId, int userId = -1)
    Parameters
    Type Name Description
    System.Int32 containerId
    System.Int32 userId
    Returns
    Type Description
    Attempt<OperationResult>
    View Source

    GetAll(Int32[])

    Gets all IDataType objects or those with the ids passed in

    Declaration
    IEnumerable<IDataType> GetAll(params int[] ids)
    Parameters
    Type Name Description
    System.Int32[] ids

    Optional array of Ids

    Returns
    Type Description
    IEnumerable<IDataType>

    An enumerable list of IDataType objects

    View Source

    GetByEditorAlias(String)

    Gets a IDataType by its control Id

    Declaration
    IEnumerable<IDataType> GetByEditorAlias(string propertyEditorAlias)
    Parameters
    Type Name Description
    System.String propertyEditorAlias

    Alias of the property editor

    Returns
    Type Description
    IEnumerable<IDataType>

    Collection of IDataType objects with a matching control id

    View Source

    GetContainer(Guid)

    Declaration
    EntityContainer GetContainer(Guid containerId)
    Parameters
    Type Name Description
    Guid containerId
    Returns
    Type Description
    EntityContainer
    View Source

    GetContainer(Int32)

    Declaration
    EntityContainer GetContainer(int containerId)
    Parameters
    Type Name Description
    System.Int32 containerId
    Returns
    Type Description
    EntityContainer
    View Source

    GetContainers(Int32[])

    Declaration
    IEnumerable<EntityContainer> GetContainers(int[] containerIds)
    Parameters
    Type Name Description
    System.Int32[] containerIds
    Returns
    Type Description
    IEnumerable<EntityContainer>
    View Source

    GetContainers(String, Int32)

    Declaration
    IEnumerable<EntityContainer> GetContainers(string folderName, int level)
    Parameters
    Type Name Description
    System.String folderName
    System.Int32 level
    Returns
    Type Description
    IEnumerable<EntityContainer>
    View Source

    GetContainers(IDataType)

    Declaration
    IEnumerable<EntityContainer> GetContainers(IDataType dataType)
    Parameters
    Type Name Description
    IDataType dataType
    Returns
    Type Description
    IEnumerable<EntityContainer>
    View Source

    GetDataType(Guid)

    Gets a IDataType by its unique guid Id

    Declaration
    IDataType GetDataType(Guid id)
    Parameters
    Type Name Description
    Guid id

    Unique guid Id of the DataType

    Returns
    Type Description
    IDataType IDataType
    View Source

    GetDataType(Int32)

    Gets a IDataType by its Id

    Declaration
    IDataType GetDataType(int id)
    Parameters
    Type Name Description
    System.Int32 id

    Id of the IDataType

    Returns
    Type Description
    IDataType IDataType
    View Source

    GetDataType(String)

    Gets a IDataType by its Name

    Declaration
    IDataType GetDataType(string name)
    Parameters
    Type Name Description
    System.String name

    Name of the IDataType

    Returns
    Type Description
    IDataType IDataType
    View Source

    GetReferences(Int32)

    Returns a dictionary of content type Udis and the property type aliases that use a IDataType

    Declaration
    IReadOnlyDictionary<Udi, IEnumerable<string>> GetReferences(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    IReadOnlyDictionary<Udi, IEnumerable<System.String>>
    View Source

    Move(IDataType, Int32)

    Declaration
    Attempt<OperationResult<MoveOperationStatusType>> Move(IDataType toMove, int parentId)
    Parameters
    Type Name Description
    IDataType toMove
    System.Int32 parentId
    Returns
    Type Description
    Attempt<OperationResult<MoveOperationStatusType>>
    View Source

    RenameContainer(Int32, String, Int32)

    Declaration
    Attempt<OperationResult<OperationResultType, EntityContainer>> RenameContainer(int id, string name, int userId = -1)
    Parameters
    Type Name Description
    System.Int32 id
    System.String name
    System.Int32 userId
    Returns
    Type Description
    Attempt<OperationResult<OperationResultType, EntityContainer>>
    View Source

    Save(IEnumerable<IDataType>, Int32)

    Saves a collection of IDataType

    Declaration
    void Save(IEnumerable<IDataType> dataTypeDefinitions, int userId = -1)
    Parameters
    Type Name Description
    IEnumerable<IDataType> dataTypeDefinitions

    IDataType to save

    System.Int32 userId

    Id of the user issuing the save

    View Source

    Save(IDataType, Int32)

    Saves an IDataType

    Declaration
    void Save(IDataType dataType, int userId = -1)
    Parameters
    Type Name Description
    IDataType dataType

    IDataType to save

    System.Int32 userId

    Id of the user issuing the save

    View Source

    SaveContainer(EntityContainer, Int32)

    Declaration
    Attempt<OperationResult> SaveContainer(EntityContainer container, int userId = -1)
    Parameters
    Type Name Description
    EntityContainer container
    System.Int32 userId
    Returns
    Type Description
    Attempt<OperationResult>
    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • Copy(IDataType, Int32)
      • Copy(IDataType, Int32, Int32)
      • CreateContainer(Int32, Guid, String, Int32)
      • Delete(IDataType, Int32)
      • DeleteContainer(Int32, Int32)
      • GetAll(Int32[])
      • GetByEditorAlias(String)
      • GetContainer(Guid)
      • GetContainer(Int32)
      • GetContainers(Int32[])
      • GetContainers(String, Int32)
      • GetContainers(IDataType)
      • GetDataType(Guid)
      • GetDataType(Int32)
      • GetDataType(String)
      • GetReferences(Int32)
      • Move(IDataType, Int32)
      • RenameContainer(Int32, String, Int32)
      • Save(IEnumerable<IDataType>, Int32)
      • Save(IDataType, Int32)
      • SaveContainer(EntityContainer, Int32)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX