Table of Contents

Interface IWebPageUrlRetriever

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Retrieves URLs of web pages.

public interface IWebPageUrlRetriever
Extension Methods

Methods

Retrieve(IWebPageFieldsSource, string, CancellationToken)

Retrieves URL for a web page represented by a model that implements IWebPageFieldsSource interface and for the languageName.

Task<WebPageUrl> Retrieve(IWebPageFieldsSource webPageFieldsSource, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageFieldsSource IWebPageFieldsSource

Web page model that implements IWebPageFieldsSource with data retrieved from the database.

languageName string

Language code.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

In case the languageName doesn't match the language of the model, the URL is retrieved from the database for the languageName.

To construct the resulting URL use ForWebsite(ContentTypeQueryParameters, string, PathMatch, bool) or ForWebsite(ContentTypeQueryParameters, string, PathMatch[], bool) with 'includeUrlPath' flag set to true.

In case of limiting the columns in the query use UrlPathColumns(ContentTypeQueryParameters) to add all required columns to construct the URL.

Exceptions

ArgumentNullException

Thrown when webPageFieldsSource is null.

ArgumentException

Thrown when SystemFields in webPageFieldsSource is null.

InvalidOperationException

Thrown when webPageFieldsSource model does not contain web page identifier specified in SystemFields system data. Thrown when content language identified by languageName does not exist. Thrown when web page identified by WebPageItemID in SystemFields does not exist.

Retrieve(IWebPageFieldsSource, CancellationToken)

Retrieves URL for a web page represented by a model that implements IWebPageFieldsSource interface.

Task<WebPageUrl> Retrieve(IWebPageFieldsSource webPageFieldsSource, CancellationToken cancellationToken = default)

Parameters

webPageFieldsSource IWebPageFieldsSource

Web page model that implements IWebPageFieldsSource with data retrieved from the database.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

To construct the resulting URL use ForWebsite(ContentTypeQueryParameters, string, PathMatch, bool) or ForWebsite(ContentTypeQueryParameters, string, PathMatch[], bool) with 'includeUrlPath' flag set to true.

In case of limiting the columns in the query use UrlPathColumns(ContentTypeQueryParameters) to add all required columns to construct the URL.

Exceptions

ArgumentNullException

Thrown when webPageFieldsSource is null.

ArgumentException

Thrown when SystemFields in webPageFieldsSource is null.

InvalidOperationException

Thrown when webPageFieldsSource model does not contain web page identifier or content language identifier specified in SystemFields system data. Thrown when web page identified by WebPageItemID in SystemFields does not exist.

Retrieve(IReadOnlyCollection<Guid>, string, string, bool, CancellationToken)

Retrieves the URLs for a web page language variants identified by webPageItemGuids, websiteChannelName and languageName.

Task<IDictionary<Guid, WebPageUrl>> Retrieve(IReadOnlyCollection<Guid> webPageItemGuids, string websiteChannelName, string languageName, bool forPreview = false, CancellationToken cancellationToken = default)

Parameters

webPageItemGuids IReadOnlyCollection<Guid>

Web page item identifiers.

websiteChannelName string

Website channel name.

languageName string

Language code.

forPreview bool

Indicates whether the latest version of the URL should be retrieved. The default value is false.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<IDictionary<Guid, WebPageUrl>>

Remarks

The method doesn't cache the retrieved URLs.

Exceptions

ArgumentNullException

Thrown when webPageItemGuids, languageName or websiteChannelName is null.

InvalidOperationException

Thrown when website channel identified by websiteChannelName or when content language identified by languageName does not exists.

Retrieve(Guid, string, bool, CancellationToken)

Retrieves the URL for a web page language variant identified by webPageItemGuid and languageName.

Task<WebPageUrl> Retrieve(Guid webPageItemGuid, string languageName, bool forPreview = false, CancellationToken cancellationToken = default)

Parameters

webPageItemGuid Guid

Web page item identifier.

languageName string

Language code.

forPreview bool

Indicates whether the latest version of the URL should be retrieved. The default value is false.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

The method caches the retrieved URL unless retrieving the latest version of the URL for preview.

Exceptions

ArgumentNullException

Thrown when languageName is null.

InvalidOperationException

Thrown when web page identified by webPageItemGuid or when content language identified by languageName does not exists.

Retrieve(int, string, bool, CancellationToken)

Retrieves the URL for a web page language variant identified by webPageItemId and languageName.

Task<WebPageUrl> Retrieve(int webPageItemId, string languageName, bool forPreview = false, CancellationToken cancellationToken = default)

Parameters

webPageItemId int

Web page item identifier.

languageName string

Language code.

forPreview bool

Indicates whether the latest version of the URL should be retrieved. The default value is false.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

The method caches the retrieved URL unless retrieving the latest version of the URL for preview.

Exceptions

ArgumentNullException

Thrown when languageName is null.

InvalidOperationException

Thrown when web page identified by webPageItemId or when content language identified by languageName does not exists.

Retrieve(string, string, int, string, CancellationToken)

Retrieves URL for a web page represented by webPageUrlPath, webPageTreePath, websiteChannelId and languageName.

Task<WebPageUrl> Retrieve(string webPageUrlPath, string webPageTreePath, int websiteChannelId, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageUrlPath string

Web page URL path.

webPageTreePath string

Web page tree path.

websiteChannelId int

Website channel identifier.

languageName string

Language code.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

To construct the resulting URL use ForWebsite(ContentTypeQueryParameters, string, PathMatch, bool) or ForWebsite(ContentTypeQueryParameters, string, PathMatch[], bool) with 'includeUrlPath' flag set to true.

Use UrlPathColumns(ContentTypeQueryParameters) to add all required columns to the query to construct the URL.

Exceptions

InvalidOperationException

Thrown when webPageTreePath is null or empty. Thrown when website channel identified by websiteChannelId does not exist. Thrown when content language identified by languageName does not exist.

ArgumentNullException

Thrown when languageName is null.

Retrieve(string, string, string, bool, CancellationToken)

Retrieves the URL for a web page language variant identified by webPageTreePath, websiteChannelName and languageName.

Task<WebPageUrl> Retrieve(string webPageTreePath, string websiteChannelName, string languageName, bool forPreview = false, CancellationToken cancellationToken = default)

Parameters

webPageTreePath string

Web page tree path.

websiteChannelName string

Website channel name.

languageName string

Language code.

forPreview bool

Indicates whether the latest version of the URL should be retrieved. The default value is false.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<WebPageUrl>

Remarks

The method caches the retrieved URL unless retrieving the latest version of the URL for preview.

Exceptions

ArgumentNullException

Thrown when languageName, webPageTreePath or websiteChannelName is null.

InvalidOperationException

Thrown when web page identified by webPageTreePath or when website channel identified by websiteChannelName or when content language identified by languageName does not exists.