Interface IDomainService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IDomainService : IService

Methods

View Source

Delete(IDomain)

Declaration

[Obsolete("Please use UpdateDomainsAsync. Will be removed in V15")]
Attempt<OperationResult?> Delete(IDomain domain)

Parameters

Type	Name	Description
IDomain	domain

Returns

Type	Description
Attempt<OperationResult>

View Source

Exists(string)

Declaration

bool Exists(string domainName)

Parameters

Type	Name	Description
string	domainName

Returns

Type	Description
bool

View Source

GetAll(bool)

Declaration

[Obsolete("Please use GetAllAsync. Will be removed in V15")]
IEnumerable<IDomain> GetAll(bool includeWildcards)

Parameters

Type	Name	Description
bool	includeWildcards

Returns

Type	Description
IEnumerable<IDomain>

View Source

GetAllAsync(bool)

Gets all assigned domains.

Declaration

Task<IEnumerable<IDomain>> GetAllAsync(bool includeWildcards)

Parameters

Type	Name	Description
bool	includeWildcards	Whether or not to include wildcard domains.

Returns

Type	Description
Task<IEnumerable<IDomain>>

View Source

GetAssignedDomains(int, bool)

Declaration

[Obsolete("Please use GetAssignedDomainsAsync. Will be removed in V15")]
IEnumerable<IDomain> GetAssignedDomains(int contentId, bool includeWildcards)

Parameters

Type	Name	Description
int	contentId
bool	includeWildcards

Returns

Type	Description
IEnumerable<IDomain>

View Source

GetAssignedDomainsAsync(Guid, bool)

Gets all assigned domains for content item.

Declaration

Task<IEnumerable<IDomain>> GetAssignedDomainsAsync(Guid contentKey, bool includeWildcards)

Parameters

Type	Name	Description
Guid	contentKey	The key of the content item.
bool	includeWildcards	Whether or not to include wildcard domains.

Returns

Type	Description
Task<IEnumerable<IDomain>>

View Source

GetById(int)

Declaration

IDomain? GetById(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IDomain

View Source

GetByName(string)

Declaration

IDomain? GetByName(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
IDomain

View Source

Save(IDomain)

Declaration

[Obsolete("Please use UpdateDomainsAsync. Will be removed in V15")]
Attempt<OperationResult?> Save(IDomain domainEntity)

Parameters

Type	Name	Description
IDomain	domainEntity

Returns

Type	Description
Attempt<OperationResult>

View Source

Sort(IEnumerable<IDomain>)

Declaration

[Obsolete("Please use UpdateDomainsAsync. Will be removed in V15")]
Attempt<OperationResult?> Sort(IEnumerable<IDomain> items)

Parameters

Type	Name	Description
IEnumerable<IDomain>	items

Returns

Type	Description
Attempt<OperationResult>

View Source

UpdateDomainsAsync(Guid, DomainsUpdateModel)

Updates the domain assignments for a content item.

Declaration

Task<Attempt<DomainUpdateResult, DomainOperationStatus>> UpdateDomainsAsync(Guid contentKey, DomainsUpdateModel updateModel)

Parameters

Type	Name	Description
Guid	contentKey	The key of the content item.
DomainsUpdateModel	updateModel	The domain assignments to apply.

Returns

Type	Description
Task<Attempt<DomainUpdateResult, DomainOperationStatus>>