AbstractInfoProvider<TInfo, TProvider>.GetAsync Method (String, Int32, Nullable<CancellationToken>)

Asynchronously gets an instance of info object based on its code name and site ID.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public virtual Task<TInfo> GetAsync(
	string name,
	int siteId,
	Nullable<CancellationToken> cancellationToken = null
)

Parameters

name

Type: System.String
Code name of the info object to look for.

siteId

Type: System.Int32
ID of the site to which to constrain the lookup.

cancellationToken (Optional)

Type: System.Nullable<CancellationToken>
The cancellation instruction.

Return Value

Type: Task<TInfo>
Returns a task returning either an instance of TInfo corresponding to name and siteId or null.

Implements

IInfoBySiteAndNameProvider<TInfo>.GetAsync(String, Int32, Nullable<CancellationToken>)

Exceptions

Exception	Condition
NotSupportedException	Thrown when TInfo does not have the code name column.