The EntityService acts as a "gateway" to Umbraco data for operations which are related to entities.

    Browse the API documentation for IEntityService interface.

    • Namespace: Umbraco.Core.Services
    • Assembly: Umbraco.Core.dll

    All samples in this document will require references to the following dll:

    • Umbraco.Core.dll

    All samples in this document will require the following using statements:

    using Umbraco.Core;
    using Umbraco.Core.Models;
    using Umbraco.Core.Services;

    Getting the service

    Services property

    If you wish to use use the entity service in a class that inherits from one of the Umbraco base classes (eg. SurfaceController, UmbracoApiController or UmbracoAuthorizedApiController), you can access the entity service through a local Services property:

    IEntityService entityService = Services.EntityService;

    Dependency Injection

    In other cases, you may be able to use Dependency Injection. For instance if you have registered your own class in Umbraco's dependency injection, you can specify the IEntityService interface in your constructor:

    public class MyClass
    	private IEntityService _entityService;
    	public MyClass(IEntityService entityService)
    		_entityService = entityService;

    Static accessor

    If neither a Services property or Dependency Injection is available, you can also reference the static Current class directly:

    IEntityService entityService = Umbraco.Core.Composing.Current.Services.EntityService;