Class Udi

Represents an entity identifier.

Inheritance

object

Namespace: Umbraco.Cms.Core

Assembly: Umbraco.Core.dll

Syntax

[TypeConverter(typeof(UdiTypeConverter))]
public abstract class Udi

Remarks

An Udi can be fully qualified or "closed" eg umb://document/{guid} or "open" eg umb://document.

Constructors

View Source

Udi(string, string)

Initializes a new instance of the Udi class.

Declaration

protected Udi(string entityType, string stringValue)

Parameters

Type	Name	Description
string	entityType	The entity type part of the identifier.
string	stringValue	The string value of the identifier.

View Source

Udi(Uri)

Initializes a new instance of the Udi class.

Declaration

protected Udi(Uri uriValue)

Parameters

Type	Name	Description
Uri	uriValue	The uri value of the identifier.

Properties

View Source

EntityType

Gets the entity type part of the identifier.

Declaration

public string EntityType { get; }

Property Value

Type	Description
string

View Source

IsRoot

Gets a value indicating whether this Udi is a root Udi.

Declaration

public abstract bool IsRoot { get; }

Property Value

Type	Description
bool

Remarks

A root Udi points to the "root of all things" for a given entity type, e.g. the content tree root.

View Source

UriValue

Declaration

public Uri UriValue { get; }

Property Value

Type	Description
Uri

Methods

View Source

CompareTo(Udi?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public int CompareTo(Udi? other)

Parameters

Type	Name	Description
Udi	other	An object to compare with this instance.

Returns

Type Description

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes `other` in the sort order.
Zero	This instance occurs in the same position in the sort order as `other`.
Greater than zero	This instance follows `other` in the sort order.

View Source

Create(string)

Creates a root Udi for an entity type.

Declaration

public static Udi Create(string entityType)

Parameters

Type	Name	Description
string	entityType	The entity type.

Returns

Type	Description
Udi	The root Udi for the entity type.

View Source

Create(string?, Guid)

Creates a Guid Udi.

Declaration

public static Udi Create(string? entityType, Guid id)

Parameters

Type	Name	Description
string	entityType	The entity type.
Guid	id	The identifier.

Returns

Type	Description
Udi	The Guid Udi for the entity type and identifier.

View Source

Create(string, string)

Creates a string Udi.

Declaration

public static Udi Create(string entityType, string id)

Parameters

Type	Name	Description
string	entityType	The entity type.
string	id	The identifier.

Returns

Type	Description
Udi	The string Udi for the entity type and identifier.

View Source

Create(Uri)

Declaration

public static Udi Create(Uri uri)

Parameters

Type	Name	Description
Uri	uri

Returns

Type	Description
Udi

View Source

EnsureNotRoot()

Ensures that this Udi is not a root Udi.

Declaration

public Udi EnsureNotRoot()

Returns

Type	Description
Udi	This Udi.

Exceptions

Type	Condition
Exception	When this Udi is a Root Udi.

View Source

EnsureType(params string[])

Declaration

public void EnsureType(params string[] validTypes)

Parameters

Type	Name	Description
string[]	validTypes

View Source

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

View Source

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

View Source

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Operators

View Source

operator ==(Udi?, Udi?)

Declaration

public static bool operator ==(Udi? udi1, Udi? udi2)

Parameters

Type	Name	Description
Udi	udi1
Udi	udi2

Returns

Type	Description
bool

View Source

operator !=(Udi?, Udi?)

Declaration

public static bool operator !=(Udi? udi1, Udi? udi2)

Parameters

Type	Name	Description
Udi	udi1
Udi	udi2

Returns

Type	Description
bool