A DataType is what you see in the backoffice in the Settings / DataTypes tree. The listed nodes are definitions of the DataTypes that are available to use on your PropertyTypes.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

using Umbraco.Cms.Core.Models;

Constructors

new DataType(IDataEditor editor, IConfigurationEditorJsonSerializer serializer, int parentId = -1)

Constructor for creating a new DataType object where the necessary parameters are a IDataEditor and a IConfigurationEditorJsonSerializer. Optionally, the parentId can be added, if not provided the default value is -1, which means it will be created at root level.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given DataType was created.

.CreatorId

Gets or Sets the Id of the User who created the DataType.

.DatabaseType

Gets or Sets the DatabaseType as a ValueStorageType enum for which the DataType's value is saved as.

.Id

Returns the unique DataType ID as an Int. The ID, derived from a database identity field, isn't safe for code references as they are moved across instances. Therefore it's recommended to use Key instead.

.Key

Returns the Guid assigned to the DataType during creation. This value is unique, and should never change, even if the DataType is moved between instances.

.Level

Gets or Sets the given DataType level in the site hierarchy as an Int. DataType placed at the root of the site, will return 1, DataType right underneath will return 2, and so on.

.Name

Gets or Sets the name of the DataType as a String.

.ParentId

Gets or Sets the parent DataType Id as an Int.

.Path

Gets or Sets the path of the DataType as a String. This string contains a comma separated list of the ancestor Ids including the current contents own id at the end of the string.

.SortOrder

Returns the given DataType index, compared to sibling DataType.

.Trashed

Returns a Bool indicating whether the given DataType is currently in the recycle bin.

The Content class represents a single item in the content tree, its values are fetched directly from the database, not from the cache. Notice the Content class should strictly be used for CRUD operations, not complex queries, as it is not flexible nor fast enough for this.

All content is versioned, so on each individual change, a new version is stored. Past versions can only be retrieved from the Content api, not from the cache.

• Namespace: Umbraco.Cms.Core.Models

• 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.Cms.Core.Models;
using Umbraco.Cms.Core.Services;

Constructors

new Content(string name, IContent parent, IContentType contentType, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object and the ContentType as an IContentType object for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, IContent parent, IContentType contentType, int userId, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object, the ContentType as an IContentType object for the Content being created and the id of the user as a int. In addition, there is an optional parameter for the culture.

new Content(string name, IContent parent, IContentType contentType, PropertyCollection properties, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object, the ContentType as an IContentType object and a PropertyCollection for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the id of the parent as int and the ContentType as an IContentType object for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, int userId, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent id of the Content as an int object, the ContentType as an IContentType object for the Content being created and the id of the user as a int. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, PropertyCollection properties, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the id of the parent as int, the ContentType as an IContentType object and a PropertyCollection for the Content being created.In addition, there is an optional parameter for the culture.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given Content was created.

// Given a `ContentService` object get Content by its Id and return CreateDate
var content = contentService.GetById(1234);
return content.CreateDate;

.CreatorId

Gets or Sets the Id of the User who created the Content.

// Given a `ContentService` object get Content by its Id and return the Id of the Creator
var content = contentService.GetById(1234);
return content.CreatorId;

.ContentType

Returns a ISimpleContentType object representing the DocumentType used by the given Content.

// Given a `ContentService` object get Content by its Id and return ContentType
var content = contentService.GetById(1234);
return content.ContentType;

.ContentTypeId

Returns the id as an int of the ContentType object representing the DocumentType used by the given Content.

// Given a `ContentService` object get Content by its Id and return the Id of the ContentType
var content = contentService.GetById(1234);
return content.ContentTypeId;

.Id

Returns the unique Content Id as a Int, this ID is based on a Database identity field, and is therefore not safe to reference in code which are moved between different instances, use Key instead.

.Key

Returns the Guid assigned to the Content during creation. This value is unique, and should never change, even if the content is moved between instances.

// Given a `ContentService` object get Content by its Id and return the Key
var content = contentService.GetById(1234);
return content.Key;

.PublishedCultures

Gets Languages of the Content as a IEnumerable<string>.

.Level

Gets or Sets the given Content level in the site hierarchy as an Int. Content placed at the root of the site, will return 1, content right underneath will return 2, and so on.

// Given a `ContentService` object get Content by its Id and return the Level
var content = contentService.GetById(1234);
return content.Level;

.Name

Gets or Sets the name of the content as a String.

// Given a `ContentService` object get Content by its Id and return its Name
var content = contentService.GetById(1234);
return content.Name;

.ParentId

Gets or Sets the parent Content Id as an Int.

// Given a `ContentService` object get Content by its Id and return the Id of the Parent Content
var content = contentService.GetById(1234);
return content.ParentId;

.Path

Gets or Sets the path of the content as a String. This string contains a comma separated list of the ancestor Ids including the current contents own id at the end of the string.

// Given a `ContentService` object get Content by its Id and return the Path
var content = contentService.GetById(1234);
return content.Path;

.Properties

Gets or Sets the IPropertyCollection object, which is a collection of IProperty objects. Each property corresponds to a PropertyType, which is defined on the ContentType.

// Given a `ContentService` object get Content by its Id and loop through all Properties
var content = contentService.GetById(1234);
foreach (var property in content.Properties)
{
    string alias = property.Alias;
    object value = property.GetValue();

}

.Published

Returns a Bool indicating whether the given Content is published and available on the website or not. Notice: the published flag does not check the current in-memory cache, so this flag is not a guarantee that the Content is/is not available in the cache and the frontend of the website.

// Given a `ContentService` object get Content by its Id and return Published
var content = contentService.GetById(1234);
return content.Published;

.PublishDate

If set, returns DateTime? indicating when the Content should be published and made available on the website and cache.

// Given a `ContentService` object get Content by its Id and set the release date to 4 days from now
var content = contentService.GetById(1234);
return content.PublishDate

.SortOrder

Returns the given Content index, compared to sibling content.

// Given a `ContentService` object get Content by its Id and return its SortOrder
var content = contentService.GetById(1234);
return content.SortOrder;

.PublishedState

Returns a IPublishedState enum with the status of the Content being either Unpublished, Published, Publishing, Unpublishing.

// Given a `ContentService` object get Content by its Id and return its Status
var content = contentService.GetById(1234);
return content.PublishedState;

.TemplateId

Gets or sets the template id used to render the content.

// Given a `ContentService` object get Content by its Id and return its Template
var content = contentService.GetById(1234);
return content.TemplateId;

.Trashed

Returns a Bool indicating whether the given Content is currently in the recycle bin.

// Given a `ContentService` object get Content by its Id and return Trashed
var content = contentService.GetById(1234);
return content.Trashed;

.UpdateDate

Gets or Sets a DateTime object, indicating when the given Content was last updated.

// Given a `ContentService` object get Content by its Id and return UpdateDate
var content = contentService.GetById(1234);
return content.UpdateDate;

.VersionId

Returns the current Version Id as a int, for each change made to a content item, its values are stored under a new Version. This version is identified by a int.

// Given a `ContentService` object get Content by its Id and return its Version
var content = contentService.GetById(1234);
return content.VersionId;

.WriterId

Gets or Sets the Id of the User who made the latest edit on the Content.

// Given a `ContentService` object get Content by its Id and return the Id of the Writer
var content = contentService.GetById(1234);
return content.WriterId;

Methods

.GetCreatorProfile(IUserService userService)

Gets the IProfile object for the Creator of this Content, which contains the Id and Name of the User who created this Content item.

// Given a `ContentService` object get Content by its Id and get the `IProfile` of the Creator
var content = contentService.GetById(1234);
var profile = content.GetCreatorProfile(userService);
var id = profile.Id;
string name = profile.Name;

.GetValue(string propertyTypeAlias)

Gets the value of a Property as an Object.

// Given a `ContentService` object get Content by its Id and get a value by alias
var content = contentService.GetById(1234);
object value = content.GetValue("bodyText");
string text = value as string;

.GetValue< TPassType >(string propertyTypeAlias)

Gets the value of a Property as the defined type 'TPassType'.

// Given a `ContentService` object get Content by its Id and get a value by alias while specifying the return type
var content = contentService.GetById(1234);
string value = content.GetValue<string>("bodyText");

.GetWriterProfile(IUserService userService)

Gets the IProfile object for the Writer of this Content, which contains the Id and Name of the User who last updated this Content item.

// Given a `ContentService` object get Content by its Id and get the `IProfile` of the Writer
var content = contentService.GetById(1234);
var profile = content.GetWriterProfile(userService);
var id = profile.Id;
string name = profile.Name;

.HasProperty(string propertyTypeAlias)

Returns a Bool indicating whether the Content object has a property with the supplied alias.

// Given a `ContentService` object get Content by its Id and check if certain properties exist
var content = contentService.GetById(1234);
bool tagsExists = content.HasProperty("myTagProperty");
bool bodyTextExists = content.HasProperty("bodyText");

.SetValue(string propertyTypeAlias, object value)

Sets the value of a property by its alias.

// Given a `ContentService` object get Content by its Id, set a few values
// and saves the Content through the `ContentService`
var content = contentService.GetById(1234);
content.SetValue("bodyText", "This text will be added to by RTE field");
content.SetValue("date", DateTime.Now);
contentService.Save(content);

.ToXml(IEntityXmlSerializer serializer)

Returns an XElement containing the Content data, based off the latest changes. Is used when the published content is sent to the in-memory xml cache.

// Given a `ContentService` object get Content by its Id and returns the xml
var content = contentService.GetById(1234);
XElement xml = content.ToXml(serializer);
return xml;

Represents a Dictionary Item. A Dictionary Item is what you see in the Translation / Dictionary tree.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

using Umbraco.Cms.Core.Models;

Constructors

new DictionaryItem(string itemKey)

Constructor for creating a new DictionaryItem object where the necessary parameter is the key of the DictionaryItem as a string.

new DictionaryItem(Guid? parentId, string itemKey)

Constructor for creating a new DictionaryItem object where the necessary parameters are the parentKey as Guid and the key of the DictionaryItem as a string. Use this one if you want to create a DictionaryItem underneath another one.

Properties

.ItemKey

Gets or sets the Key for the Dictionary Item.

// Create a DictionaryItem and return the key
var dictionaryItem = new DictionaryItem("your_key");
return dictionaryItem.ItemKey;

.ParentId

Gets or Sets a Guid? of the Dictionary Item ParentId.

// Create a DictionaryItem and return the parentId
DictionaryItem dictionaryItem = new DictionaryItem("your_key");
Guid? parentId = dictionaryItem.ParentId;
return parentId;

.Translations

Gets or sets a IEnumerable<IDictionaryTranslation> of translations for the Dictionary Item.

// Create a DictionaryItem and return the translations
var dictionaryItem = new DictionaryItem("your_key");
return dictionaryItem.Translations;

The Media class represents a single item in the media tree, its values are fetched directly from the database, not from the cache. Notice the Media class should strictly be used for CRUD operations. Media is already stored in cache, so for querying Media you'd want to use the IUmbracoContext.IPublishedMediaCache to get the media. Then one would use .

• Namespace: Umbraco.Cms.Core.Models

• 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:

Constructors

new Media(string name, IMedia parent, IMediaType mediaType)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the parent of the Media as an IMedia object and the MediaType as an IMediaType object for the Media being created.

new Media(string name, IMedia parent, IMediaType mediaType, IPropertyCollection properties)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the parent of the Media as an IMedia object, the MediaType as an IMediaType object and a IPropertyCollection for the Media being created.

new Media(string name, int parentId, IMediaType mediaType)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the id of the parent as int and the MediaType as an IMediaType object for the Media being created.

new Media(string name, int parentId, IMediaType mediaType, IPropertyCollection properties)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the id of the parent as int, the MediaType as an IMediaType object and a IPropertyCollection for the Media being created.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given Media was created.

.CreatorId

Gets or Sets the Id of the User as an int who created the Media.

.ContentType

Returns a ISimpleContentType object representing the ContentType used by the given Media.

.ContentTypeId

Returns the id as an int of the MediaType object representing the ContentType used by the given Media.

.Id

Returns the unique Media Id as a Int, this ID is based on a Database identity field, and is therefore not safe to reference in code which are moved between different instances, use Key instead.

.Key

Returns the Guid assigned to the Media during creation. This value is unique, and should never change, even if the Media is moved between instances.

.Level

Gets or Sets the given Media level in the site hierarchy as an Int. Media placed at the root of the tree, will return 1, Media right underneath will return 2, and so on.

.Name

Gets or Sets the name of the Media as a String.

.ParentId

Gets or Sets the parent Media Id as an Int.

.Path

Gets or Sets the path of the Media as a String. This string contains a comma separated list of the ancestors Ids including the current medias own id at the end of the string.

.Properties

Gets or Sets the PropertyCollection object, which is a collection of Property objects. Each property corresponds to a PropertyType, which is defined on the MediaType.

.SortOrder

Returns the given Media index, compared to sibling media.

.Trashed

Returns a Bool indicating whether the given Media is currently in the recycle bin.

.UpdateDate

Gets or Sets a DateTime object, indicating when the given Media was last updated.

.Version

Returns the current Version Id as a Guid, For each change made to a Media item, its values are stored under a new Version. This version is identified by a Guid.

Methods

.ChangeContentType(IMediaType mediaType)

Changes the IMediaType for the current Media object and removes PropertyTypes and Properties, which are not part of the new MediaType. Please use with caution as this remove differences between the new and old MediaType.

.GetCreatorProfile()

Gets the IProfile object for the Creator of this Media, which contains the Id and Name of the User who created this Media item.

.GetValue(string propertyTypeAlias)

Gets the value of a Property as an Object.

.GetValue< TPassType >(string propertyTypeAlias)

Gets the value of a Property as the defined type 'TPassType'.

.HasProperty(string propertyTypeAlias)

Returns a Bool indicating whether the Media object has a property with the supplied alias.

.SetValue(string propertyTypeAlias, object value)

Sets the value of a property by its alias.

It is worth noting that it is also possible to pass a HttpPostedFile, HttpPostedFileBase or HttpPostedFileWrapper to the SetValue method, so it can be used for uploads.

.ToXml()

Returns an XElement containing the Media data, based off the latest changes. When the Media item is saved the xml is stored in the database.

The RelationType class represents a relation definition between two node types (content or media). For example keeping track of node usage across the site, in order to avoid deleting content that is used else where. When querying a relation, it is typically done using the parent node key. However, if the RelationType is bidirectional, querying with the child node key is also possible.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

Constructors

new RelationType(string name, string alias, bool isBidrectional, Guid? parentObjectType, Guid? childObjectType)

Create a new RelationType object with this constructor. It requires a string alias, the relation type's name, and a bool for bidirectionality. Additionally, specify the Guid? keys for both child and parent object types involved in the relation.

Properties

.Name

Gets or sets the Name of the RelationType as a String.

.Alias

Gets or sets the Alias of the RelationType as String.

.IsBidirectional

Gets or sets a boolean indicating whether the RelationType is Bidirectional (true) or Parent to Child (false)

.ParentObjectType

Gets or sets the Parents object type key as Guid?

.ChildObjectType

Gets or sets the Childs object type key as Guid?

The intended audience for these reference pages are .NET developers. It is assumed the reader already has knowledge of the basics of Umbraco and knows .NET & C#.

Here you will find references for the models in the public API. The models include Content, ContentType, DataTypeDefinition, DictionaryItem, Language, Media, MediaType, Relation, RelationType, Task, TaskType, and Template classes.

Here you will find references for the services which are available for performing Create, Read, Update and Delete (CRUD) operations for the models mentioned above.

Represents a Relation between two items.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

Constructors

new Relation(int parentId, int childId, IRelationType relationType)

Constructor for creating a new Relation object. The necessary parameters are the Id of the parent item as an int, the Id of the child as an int and the relationType as IRelationType.

new Relation(int parentId, int childId, Guid parentObjectType, Guid childObjectType, IRelationType relationType)

A second constructor exists but it should not be used because it is used to reconstruct a relation from the data source.

Properties

.ChildId

Gets or sets the Child Id of the Relation (Destination)

.Comment

Gets or sets a comment for the Relation

.ParentId

Gets or sets the Parent Id of the Relation (Source)

.RelationType

Gets or sets the RelationType for the Relation

.RelationTypeId

Gets the Id of the RelationType that this Relation is based on.

Represents a Language. Installed languages can be found in the settings section.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

Constructors

new Language(GlobalSettings globalSettings, string isoCode)

Constructor for creating a new Language object where the necessary parameter are the global settings as GlobalSettings and the isoCode as a string.

Properties

.CultureInfo

Gets the CultureInfo object for the language.

.CultureName

Gets or sets the culture name of the language.

.FallbackLanguageId

Gets or sets the identifier of a fallback language. The fallback language can be used in multi-lingual scenarios, to help define fallback strategies when a value does not exist for a requested language.

.IsDefault

Gets or sets a value indicating whether the language is the default language.

.IsMandatory

Gets or sets a value indicating whether the language is mandatory. When a language is mandatory, a multi-lingual document cannot be published without that language being published, and unpublishing that language unpublishes the entire document.

.IsoCode

Gets or sets the ISO code of the language.

A MediaType is almost the same as a , that is, a model / data definition for your media nodes

You can set icon, thumbnail and description. It is also possible to add groups and properties.

A Media Type differs from a Document Type in that it has no templates.

• Namespace: Umbraco.Cms.Core.Models

• 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:

Constructors

new MediaType(IShortStringHelper shortStringHelper, int parentId)

Constructor for creating a new MediaType object where the necessary parameters are a short string helper IShortStringHelper and the Id of the parent MediaType as an Int.

new MediaType(IShortStringHelper shortStringHelper,IMediaType parent)

Constructor for creating a new MediaType object where the necessary parameter are a short string helper IShortStringHelper and the parent MediaType as an IMediaType object.

new MediaType(IShortStringHelper shortStringHelper, IMediaType parent, string alias)

This constructor creates a new MediaType object and requires the following parameters: a short string helper IShortStringHelper and the parent MediaType as an IMediaType object. Additionally, the alias of the MediaType should be provided as a string.

Properties

.Alias

Gets or Sets the Alias as a String of the MediaType.

.AllowedContentTypes

Gets or Sets an Enumerable list of ContentTypeSort objects of the MediaTypes allowed under the current MediaType.

The ContentTypeSort is an object with a lazy Id, int SortOrder and string Alias used to sort the MediaTypes within the list of AllowedContentTypes.

.ContentTypeComposition

Gets a list of MediaTypes as IContentTypeComposition objects that make up a composition of PropertyGroups and PropertyTypes for the current MediaType.

The ContentTypeComposition provides a mixin-type functionality in that you can compose a MediaType of one or more other MediaTypes in a complex structure. But please keep in mind that the backoffice does not fully support these complex structures yet

.CompositionPropertyGroups

Gets a list of all PropertyGroup objects from the composition including PropertyGroups from the current MediaType.

.CompositionPropertyTypes

Gets a list of all PropertyType objects from the composition including PropertyTypes from the current MediaType.

.CreateDate

Gets or Sets a DateTime object, indicating then the given MediaType was created.

.CreatorId

Gets or Sets the Id of the User who created the MediaType.

.Description

Gets or Sets the Description as a String for the MediaType.

.Icon

Gets or Sets the Icon as a String for the MediaType.

.Id

Retrieves the unique MediaType ID as an Int. This ID is based on a Database identity field and is therefore not safe to reference in code when moved between different instances.

.Key

Gets the Guid assigned to the MediaType during creation. This value is unique, and should never change, even if the content is moved between instances.

.Level

Gets or Sets the given MediaType level in the site hierarchy as an Int. MediaTypes placed at the root of the tree, will return 1, content right underneath will return 2, and so on.

.Name

Gets or Sets the name of the MediaType as a String.

.ParentId

Gets or Sets the parent MediaType Id as an Int.

.Path

Gets or Sets the path of the MediaType as a String. This string contains a comma separated list of the ancestor Ids including the current MediaTypes own id at the end of the string.

.PropertyGroups

Gets or Sets a PropertyGroupCollection containing a list of PropertyGroups for the current MediaType.

.PropertyTypes

Gets an Enumerable list of PropertyTypes aggregated for all groups within the current MediaType, as well as PropertyTypes not within a group.

.SortOrder

Gets the given MediaType index, compared to sibling content.

.Thumbnail

Gets or Sets the Thumbnail as a String for the MediaType.

Methods

.AddContentType(IContentTypeComposition mediaType)

Adds a new MediaType to the list of composite MediaTypes.

.CompositionAliases()

Returns an Enumerable list of MediaType aliases as String from the current composition.

.CompositionIds()

Returns an Enumerable list of MediaType Ids as Int from the current composition.

.ContentTypeCompositionExists(string alias)

Checks if a MediaType with the supplied alias exists in the list of composite MediaTypes.

.RemoveContentType(string alias)

Removes a MediaType with the supplied alias from the list of composite MediaTypes.

.RemovePropertyType(string propertyTypeAlias)

Removes a PropertyType from the current MediaType.

A ContentType corresponds to the Document Type found in the backoffice. The ContentType is a model / data definition for your content nodes. Every content node on an Umbraco web site always maps to a backing Document Type.

A Document Type is composed by Properties, which are grouped by Tabs (or PropertyGroups in the API). It can also inherit properties and tabs from other Document Types.

It is possible to link one or more Templates to a Document Type. This determines how your model/data is rendered to the user.

• Namespace: Umbraco.Cms.Core.Models

• 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:

Constructors

ContentType(IShortStringHelper shortStringHelper, IContentType parent, string alias)

Constructor for creating a new ContentType object. The necessary parameters are a short string helper IShortStringHelper, the parent ContentType as an IContentType and the alias of the new ContentType as string.

new ContentType(IShortStringHelper shortStringHelper, int parentId)

Constructor for creating a new ContentType object where the necessary parameters are a short string helper IShortStringHelper and the Id of the parent ContentType as an Int.

Properties

.Alias

Gets or Sets the Alias as a String of the ContentType.

.AllowedAsRoot

Gets or Sets a Bool indicating whether this ContentType is allowed at the root. If one or more ContentTypes are set to 'AllowedAsRoot' only they are shown in the create dialog at the root level in the backoffice.

.AllowedContentTypes

Gets or Sets an Enumerable list of ContentTypeSort objects of the ContentTypes allowed under the current ContentType.

The ContentTypeSort is an object with a lazy Id, int SortOrder and string Alias used to sort the MediaTypes within the list of AllowedContentTypes.

.AllowedTemplates

Gets or Sets an Enumerable list of ITemplates which are allowed for the current ContentType.

.ContentTypeComposition

Gets a list of ContentTypes as IContentTypeComposition objects that make up a composition of PropertyGroups and PropertyTypes for the current ContentType.

The ContentTypeComposition provides a mixin-type functionality in that you can compose a ContentType of one or more other ContentTypes in a complex structure. But please be aware that the backoffice does not fully support these complex structures yet.

.CompositionPropertyGroups

Gets a list of all 'PropertyGroup` objects from the composition including PropertyGroups from the current ContentType.

.CompositionPropertyTypes

Gets a list of all PropertyType objects from the composition including PropertyTypes from the current ContentType.

.CreateDate

Gets or Sets a DateTime object, indicating then the given ContentType was created.

.CreatorId

Gets or Sets the Id of the User who created the ContentType.

.Description

Gets or Sets the Description as a String for the ContentType.

.DefaultTemplate

Gets the default Template set as an ITemplate object for this ContentType.

.Icon

Gets or Sets the Icon as a String for the ContentType.

.Id

Gets the unique ContentType Id as an Int. The ID, derived from a database identity field, isn't safe for code references as they are moved across instances. Therefore it's recommended to use Key instead.

.Key

Gets the Guid assigned to the ContentType during creation. This value is unique, and should never change, even if the content is moved between instances.

.Level

Gets or Sets the given ContentType level in the site hierarchy as an Int. ContentTypes placed at the root of the tree, will return 1, content right underneath will return 2, and so on.

.Name

Gets or Sets the name of the ContentType as a String.

.ParentId

Gets or Sets the parent ContentType Id as an Int.

.Path

Gets or Sets the path of the ContentType as a String. This string contains a comma separated list of the ancestors Ids including the current ContentTypes own id at the end of the string.

.PropertyGroups

Gets or Sets a PropertyGroupCollection containing a list of PropertyGroups for the current ContentType.

.PropertyTypes

Gets an Enumerable list of PropertyTypes aggregated for all groups within the current ContentType, as well as PropertyTypes not within a group.

.SortOrder

Gets the given ContentType index, compared to sibling content.

.Thumbnail

Gets or Sets the Thumbnail as a String for the ContentType.

Methods

.AddContentType(IContentTypeComposition contentType)

Adds a new ContentType to the list of composite ContentTypes.

.CompositionAliases()

Returns an Enumerable list of ContentType aliases as String from the current composition.

.CompositionIds()

Returns an Enumerable list of ContentType Ids as Int from the current composition.

.ContentTypeCompositionExists(string alias)

Checks if a ContentType with the supplied alias exists in the list of composite ContentTypes.

.SetDefaultTemplate(ITemplate template)

Sets the default Template for the current ContentType.

.RemoveContentType(string alias)

Removes a ContentType with the supplied alias from the list of composite ContentTypes.

.RemovePropertyType(string propertyTypeAlias)

Removes a PropertyType from the current ContentType.

.RemoveTemplate(ITemplate template)

Removes a Template from the list of allowed templates.

Represents a Template file.

• Namespace: Umbraco.Cms.Core.Models

• 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.Cms.Core.Models;

Constructors

new Template(IShortStringHelper shortStringHelper, string name, string alias)

Constructor for creating a new Template object. The necessary parameters include a short String Helper as an IShortStringHelper. The name and alias of the Template must be provided as string values.

Properties

.Alias

Gets the Alias of the File, which is the name without the extension.

var template = new Template(shortStringHelper, "Page", "page");
return template.Alias;

.IsMasterTemplate

Returns true if the template is used as a layout for other templates (that is, it has 'children')

var template = new Template(shortStringHelper,"Page", "page");
return template.IsMasterTemplate;

.MasterTemplateAlias

Returns the alias of the master template if one is set.

var template = new Template(shortStringHelper, "Page", "page");
return template.MasterTemplateAlias;

.MasterTemplateId

Returns the id of the master template if one is set.

var template = new Template(shortStringHelper, "Page", "page");
return template.MasterTemplateId;

.Name

Gets the Name of the File including extension.

var template = new Template(shortStringHelper, "Page", "page");
return template.Name;

Methods

.SetMasterTemplate(ITemplate masterTemplate)

Sets the master template of the template.

// Create a new template
var template = new Template(shortStringHelper, "Page", "page");
// Get a master template 
var masterTemplate = fileService.GetTemplate(1234);
// Set the master template to new created template
template.SetMasterTemplate(masterTemplate);
// Save the new template
fileService.SaveTemplate(template);

Applies to Umbraco 9 and newer

Browse the API documentation for ConsentService.

• Namespace: Umbraco.Cms.Core.Services

• Assembly: Umbraco.Core.dll

A service for handling lawful data processing requirements.

What is a Consent

A consent is fully identified by a source (whoever is consenting), a context (for example, an application), and an action (whatever is consented). A consent state registers the state of the consent (granted, revoked...).

Register a new consent

Consent can be given or revoked or changed via the RegisterConsent method, which creates a new Consent entity to track the consent.

Get the current state

Getter methods of this service return the current state of a consent, that is the latest IConsent entity that was created.

Revoking a consent

Revoking a consent is performed by registering a revoked consent.

A consent cannot be deleted. It can only be revoked by registering a "revoked consent".

Examples

// store a new consent
var newConsent = _consentService.RegisterConsent("userId", "Our.Custom.Umbraco.Plugin", "AllowedToEmail", ConsentState.Granted, "some comments");

// lookup a consent
var consents = _consentService.LookupConsent("userId", "Our.Custom.Umbraco.Plugin", "AllowedToEmail", sourceStartsWith : true);
if (consents != null && consents.Any())
{
    var currentConsent = consents.First(c => c.Current == true);
    if(currentConsent.State  == ConsentState.Granted)
    {
        // Do what you need
    }
    else
    {
        // the state is None, Pending or Revoked
    }
}

In Razor views, you can access the consent service through the @inject directive:

@inject IConsentService ConsentService

The AuditService acts as a "gateway" to Umbraco data for operations which are related to the audit trail.

Browse the API documentation for IAuditService interface.

• Namespace: Umbraco.Cms.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.Cms.Core.Services;

For Razor views:

@using Umbraco.Cms.Core.Services

Getting the service

Dependency Injection

If you wish to use the audit service in a class, you need to use Dependency Injection (DI). For instance if you have registered your own class in Umbraco's DI container, you can specify the IAuditService interface in your constructor:

public class MyClass
{
    private IAuditService _auditService;
    
    public MyClass(IAuditService auditService)
    {
        _auditService = auditService;
    }
}

In Razor views, you can access the audit service through the @inject directive:

@inject IAuditService AuditService

The DataTypeService acts as a "gateway" to Umbraco data for operations which are related to DataTypes and DataTypeDefinitions.

Browse the API documentation for IDataTypeService.

• Namespace: Umbraco.Cms.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.Cms.Core.Services;

For Razor views:

@using Umbraco.Cms.Core.Services

Getting the service

Dependency Injection

If you wish to use the Data Type service in a class, you need to specify the IDataTypeService interface in your constructor:

public class MyClass
{
    private IDataTypeService _dataTypeService;
    
    public MyClass(IDataTypeService dataTypeService)
    {
        _dataTypeService = dataTypeService;
    }
}

In Razor views, you can access the Data Type service through the @inject directive:

@inject IDataTypeService DataTypeService

The DomainService acts as a "gateway" to Umbraco data for operations which are related to domains.

Browse the API documentation for IDomainService.

• Namespace: Umbraco.Cms.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.Cms.Core.Services;

For Razor views:

@using Umbraco.Cms.Core.Services

Getting the service

Dependency Injection

If you wish to use the domain service in a class, you need to specify the IDomainService interface in your constructor:

public class MyClass
{
    private IDomainService _domainService;
    
    public MyClass(IDomainService domainService)
    {
        _domainService = domainService;
    }
}

In Razor views, you can access the domain service through the @inject directive:

@inject IDomainService DomainService

The ServerRegistration class represents a registered server in a multiple-servers environment.

• Namespace: Umbraco.Cms.Core.Models

• 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 statement:

using Umbraco.Cms.Core.Models;

Constructors

new ServerRegistration(string serverAddress, string serverIdentity, DateTime registered)

Constructor for creating a new ServerRegistration object. The necessary parameters are the serverAddress as a string, the serverIdentity as a string and the date and time of registration as a DateTime

new ServerRegistration(int id, string serverAddress, string serverIdentity, DateTime registered, DateTime accessed, bool isActive, bool isSchedulingPublisher)

A second constructor exists but it should not be used because it is used to reconstruct a ServerRegistration from the data source.

Properties

.Accessed

Gets the date and time the registration was last accessed.

// Given a `IServerRegistrationService` object get the first ServerRegistration and return Accessed
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.Accessed;

.IsActive

Gets or sets a value indicating whether the server is active.

// Given a `IServerRegistrationService` object get the first ServerRegistration and return IsActive
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.IsActive;

.IsSchedulingPublisher

Gets or sets a value indicating whether the server has the SchedulingPublisher role

// Given a `IServerRegistrationService` object get the first ServerRegistration and return IsSchedulingPublisher
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.IsSchedulingPublisher;

.Registered

Gets the date and time the registration was created.

// Given a `IServerRegistrationService` object get the first ServerRegistration and return Registered
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.Registered;

.ServerAddress

Gets or sets the server URL.

// Given a `IServerRegistrationService` object get the first ServerRegistration and return ServerAddress
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.ServerAddress;

.ServerIdentity

Gets or sets the server unique identity.

// Given a `IServerRegistrationService` object get the first ServerRegistration and return ServerIdentity
var serverRegistration = serverRegistrationService.GetActiveServers().FirstOrDefault();
return serverRegistration.ServerIdentity;

The FileService acts as a "gateway" to Umbraco data for operations which are related to Scripts, Stylesheets and Templates.

Browse the API documentation for IFileService.

• Namespace: Umbraco.Cms.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.Cms.Core.Services;

For Razor views:

@using Umbraco.Cms.Core.Services

Getting the service

Dependency Injection

If you wish to use the file service in a class, you need to specify the IFileService interface in your constructor:

public class MyClass
{
    private IFileService _fileService;
    
    public MyClass(IFileService fileService)
    {
        _fileService = fileService;
    }
}

In Razor views, you can access the file service through the @inject directive:

@inject IFileService FileService

Defines the MacroService, which is an access to operations involving IMacro.

.

• Namespace: Umbraco.Cms.Core.Services

• Assembly: Umbraco.Core.dll

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

• Umbraco.Core.dll

For Razor views:

Getting the service

Dependency Injection

If you wish to use the macro service in a class, you need to specify the IMacroService interface in your constructor:

In Razor views, you can access the macro service through the @inject directive:

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

.

• Namespace: Umbraco.Cms.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:

For Razor views:

Getting the service

Dependency Injection

If you wish to use the entity service in a class, you need to specify the IEntityService interface in your constructor:

In Razor views, you can access the entity service through the @inject directive:

The ExternalLoginService is used to store the external login info and can be replaced with your own implementation.

.

• Namespace: Umbraco.Cms.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:

Getting the service

Dependency Injection

If you wish to use the entity service in a class, you need to specify the IExternalLoginService interface in your constructor:

In Razor views, you can access the entity service through the @inject directive:

The MediaService acts as a "gateway" to Umbraco data for operations which are related to media.

.

• Namespace: Umbraco.Cms.Core.Services

• Assembly: Umbraco.Core.dll

All samples in this document will require reference to the following packages:

Samples in this document will require the following using statements:

Getting the service

Dependency Injection

If you wish to use the media service in a class, you need to specify the IMediaService interface in your constructor:

In Razor views, you can access the media service through the @inject directive:

Samples

Creating a new folder

To create a new folder at the root of the media archive, your code could look like the following:

Alternatively, you can replace the Constants in the above sample with hardcoded values.

For the CreateMedia method, the first parameter is the name of the folder to be created.

The second parameter is the ID of the parent media item. Constants.System.Root is a constant defined in Umbraco with the value of -1, which is used for indicating the root of the media archive. Instead of specifying the numeric ID of the parent, you may instead specify either a Guid ID or an IMedia instance representing the parent media.

The third parameter is the alias of the Media Type. As Umbraco comes with a Folder Type by default, we can use the Constants.Conventions.MediaTypes.Folder constant to specify that the alias of the Media Type is Folder.

Besides the three mandatory parameters, you can specify a user's numeric ID for media creation attribution. Unspecified cases default to the "Administrator" user with ID -1.

Creating a new media item from a stream

You can specify a Stream for the contents of the file that should be created.

As an example, if you have an image on disk named unicorn.jpg in the images folder of wwwroot. You can open a new stream for a file on the disk, and then create a new media item for that file in Umbraco:

Please be aware that you will need to inject the following services:

• MediaFileManager _mediaFileManager

• IShortStringHelper _shortStringHelper

• IContentTypeBaseServiceProvider _contentTypeBaseServiceProvider

• MediaUrlGeneratorCollection _mediaUrlGeneratorCollection

• IMediaService _mediaService

• IWebHostEnvironment _webHostEnvironment

Again Umbraco will make sure the necessary properties are updated.

The MemberService acts as a "gateway" to Umbraco data for operations which are related to Members.

.

• Namespace: Umbraco.Cms.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:

For Razor views:

Getting the service

Dependency Injection

If you wish to use the member service in a class, you need to specify the IMemberService interface in your constructor:

In Razor views, you can access the member service through the @inject directive:

The PackagingService provides import/export functionality for the Core models of the API.

.

• Namespace: Umbraco.Cms.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:

Getting the service

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 IPackagingService interface in your constructor:

In Razor views, you can access the member service through the @inject directive:

The RedirectUrlService is used for CRUD operations related to Redirects.

.

• Namespace: Umbraco.Cms.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:

Getting the service

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 IRedirectUrlService interface in your constructor:

In Razor views, you can access the member service through the @inject directive:

The NotificationServices is used to perform operations related to backoffice notifications.

.

• Namespace: Umbraco.Cms.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:

Getting the service

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 INotificationService interface in your constructor:

In Razor views, you can access the member type service through the @inject directive:

The MemberGroupService acts as a "gateway" to Umbraco data for operations which are related to Member groups, which are also known as Member Roles.

.

• Namespace: Umbraco.Cms.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:

For Razor views:

Getting the service

Dependency Injection

If you wish to use the member group service in a class, you need to specify the IMemberGroupService interface in your constructor:

In Razor views, you can access the member group service through the @inject directive:

Service to handle public access.

.

• Namespace: Umbraco.Cms.Core.Services

• Assembly: Umbraco.Core.dll

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

• Umbraco.Core.dll