View Source

Interface IDomainCacheService

Defines operations for the domain cache service.

Namespace: Umbraco.Cms.Core.PublishedCache

Assembly: Umbraco.Core.dll

Syntax

public interface IDomainCacheService

Remarks

This service provides access to domain information with caching support, including operations for retrieving domains and handling cache refresh.

Methods

GetAll(bool)

Gets all Domain in the current domain cache, including any domains that may be referenced by documents that are no longer published.

Declaration

IEnumerable<Domain> GetAll(bool includeWildcards)

Parameters

Type	Name	Description
bool	includeWildcards	A value indicating whether to include wildcard domains.

Returns

Type	Description
IEnumerable<Domain>	A collection of all domains in the cache.

GetAssigned(int, bool)

Gets all assigned Domain for specified document, even if it is not published.

Declaration

IEnumerable<Domain> GetAssigned(int documentId, bool includeWildcards = false)

Parameters

Type	Name	Description
int	documentId	The document identifier.
bool	includeWildcards	A value indicating whether to consider wildcard domains.

Returns

Type	Description
IEnumerable<Domain>	A collection of domains assigned to the specified document.

HasAssigned(int, bool)

Determines whether a document has domains.

Declaration

bool HasAssigned(int documentId, bool includeWildcards = false)

Parameters

Type	Name	Description
int	documentId	The document identifier.
bool	includeWildcards	A value indicating whether to consider wildcard domains.

Returns

Type	Description
bool	true if the document has assigned domains; otherwise, false.

Refresh(JsonPayload[])

Refreshes the domain cache based on the provided payloads.

Declaration

void Refresh(DomainCacheRefresher.JsonPayload[] payloads)

Parameters

Type	Name	Description
JsonPayload[]	payloads	The cache refresh payloads containing domain change information.