Interface IReferenceManager

Defines the reference manager interface.

Namespace: Quark.CMSAdapters.Core.Interfaces
Assembly: Quark.CMSAdapters.Core.dll
Syntax
public interface IReferenceManager

Properties

URLPrefix

Gets the prefix of the "UniformResourceLocator" set in the Drag-n-Drop data object e.g. qps:.

Declaration
string URLPrefix { get; }
Property Value
Type Description
System.String

The URL prefix.

URNPrefix

Gets the prefix of the urn denoting CMS asset e.g qdps://.

Declaration
string URNPrefix { get; }
Property Value
Type Description
System.String

The URN prefix.

Methods

GetContentInfo(String)

Gets the content info.

Declaration
ContentInfo GetContentInfo(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
ContentInfo

The content info of the specified reference.

GetLocalUrn(String, SaveOptions)

Gets the local urn.

Declaration
string GetLocalUrn(string urn, SaveOptions parentDocumentSaveOptions)
Parameters
Type Name Description
System.String urn

The urn.
SaveOptions parentDocumentSaveOptions

The parent document save options.
Returns
Type Description
System.String

The local urn.

GetParentNodes(String)

Gets the parent nodes.

Declaration
List<ParentNode> GetParentNodes(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.Collections.Generic.List<ParentNode>

GetPinnedUrn(String)

Gets the urn pinned to specific asset version.

Declaration
string GetPinnedUrn(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.String

The pinned urn.

GetReferenceNodes(String)

Gets the reference nodes.

Declaration
List<ReferenceNode> GetReferenceNodes(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.Collections.Generic.List<ReferenceNode>

A list of reference nodes.

GetUnpinnedUrn(String)

Gets the unpinned urn.

Declaration
string GetUnpinnedUrn(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.String

The unpinned urn.

GetURLInfo(String)

Gets complete information of the "UniformResourceLocator" set in the Drag-n-Drop data object.

Declaration
ContentInfo GetURLInfo(string url)
Parameters
Type Name Description
System.String url

The URL.
Returns
Type Description
ContentInfo

IsPinnedUrn(String)

Determines whether the specified urn is pinned to the specific asset version.

Declaration
bool IsPinnedUrn(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.Boolean

true if specified urn is pinned to the specific asset version; otherwise, false.

IsValid(String)

Determines whether the specified urn is valid. API never throws exception.

Declaration
bool IsValid(string urn)
Parameters
Type Name Description
System.String urn

The urn.
Returns
Type Description
System.Boolean

true if the specified urn is valid; otherwise, false.

ValidateReplaceUrn(ref String, String)

Validates the urn which replaces local urn.

Declaration
void ValidateReplaceUrn(ref string urn, string localUrn)
Parameters
Type Name Description
System.String urn

The urn.
System.String localUrn

The local urn.

Extension Methods