View Source

Class DocumentUrlDto

Represents a data transfer object that encapsulates URL-related information for a document entity in Umbraco CMS. This DTO is typically used for persisting or transferring document URL data between application layers or for database operations.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Persistence.Dtos

Assembly: Umbraco.Infrastructure.dll

Syntax

public class DocumentUrlDto

Constructors

DocumentUrlDto()

Declaration

public DocumentUrlDto()

Fields

IsDraftColumnName

Declaration

public const string IsDraftColumnName = "isDraft"

Field Value

Type	Description
string

IsPrimaryColumnName

Declaration

public const string IsPrimaryColumnName = "isPrimary"

Field Value

Type	Description
string

LanguageIdColumnName

Declaration

public const string LanguageIdColumnName = "languageId"

Field Value

Type	Description
string

PrimaryKeyColumnName

Declaration

public const string PrimaryKeyColumnName = "id"

Field Value

Type	Description
string

TableName

Declaration

public const string TableName = "umbracoDocumentUrl"

Field Value

Type	Description
string

UniqueIdColumnName

Declaration

public const string UniqueIdColumnName = "uniqueId"

Field Value

Type	Description
string

UrlSegmentColumnName

Declaration

public const string UrlSegmentColumnName = "urlSegment"

Field Value

Type	Description
string

Properties

IsDraft

Gets or sets a value indicating whether the document URL is a draft.

Declaration

public bool IsDraft { get; set; }

Property Value

Type	Description
bool

IsPrimary

Gets or sets a value indicating whether this URL is the primary URL.

Declaration

[Constraint(Default = 1)]
public bool IsPrimary { get; set; }

Property Value

Type	Description
bool

LanguageId

Gets or sets the language identifier associated with the document URL.

Declaration

[Obsolete("Use NullableLanguageId instead. This property returns 0 for invariant content. Scheduled for removal in Umbraco 18, when the NullableLanguageId will also be renamed to LanguageId.")]
public int LanguageId { get; set; }

Property Value

Type	Description
int

Remarks

This property returns 0 for invariant content. Use NullableLanguageId instead, which correctly returns null for invariant content.

NodeId

Gets or sets the unique identifier for the node.

Declaration

[PrimaryKeyColumn(Clustered = false, AutoIncrement = true)]
public int NodeId { get; set; }

Property Value

Type	Description
int

NullableLanguageId

Gets or sets the language Id. NULL indicates invariant content (not language-specific).

Declaration

[NullSetting(NullSetting = NullSettings.Null)]
[ForeignKey(typeof(LanguageDto))]
public int? NullableLanguageId { get; set; }

Property Value

Type	Description
int?

UniqueId

Gets or sets the unique identifier (GUID) of the document node associated with this URL.

Declaration

[Index(IndexTypes.UniqueClustered, ForColumns = "uniqueId, languageId, isDraft, urlSegment", Name = "IX_umbracoDocumentUrl")]
[ForeignKey(typeof(NodeDto), Column = "uniqueId")]
public Guid UniqueId { get; set; }

Property Value

Type	Description
Guid

UrlSegment

Gets or sets the URL segment, which is the part of the document's URL typically used for routing and identifying the document in URLs.

Declaration

[NullSetting(NullSetting = NullSettings.NotNull)]
public string UrlSegment { get; set; }

Property Value

Type	Description
string