Class InfoProviderExtensions

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Contains extension methods for IInfoProvider<TInfo>.

public static class InfoProviderExtensions

Inheritance

object

InfoProviderExtensions

Methods

GetAsync<TInfo>(IInfoProvider<TInfo>, Guid, CancellationToken?)

Asynchronously gets an instance of info object based on its GUID.

public static Task<TInfo> GetAsync<TInfo>(this IInfoProvider<TInfo> infoProvider, Guid guid, CancellationToken? cancellationToken = null) where TInfo : AbstractInfoBase<TInfo>, IInfoWithGuid, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

guid Guid

GUID of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to guid or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.

GetAsync<TInfo>(IInfoProvider<TInfo>, int, CancellationToken?)

Asynchronously gets an instance of info object based on its ID.

public static Task<TInfo> GetAsync<TInfo>(this IInfoProvider<TInfo> infoProvider, int id, CancellationToken? cancellationToken = null) where TInfo : AbstractInfoBase<TInfo>, IInfoWithId, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

id int

ID of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to id or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.

GetAsync<TInfo>(IInfoProvider<TInfo>, string, CancellationToken?)

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

public static Task<TInfo> GetAsync<TInfo>(this IInfoProvider<TInfo> infoProvider, string name, CancellationToken? cancellationToken = null) where TInfo : AbstractInfoBase<TInfo>, IInfoWithName, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

name string

Code name of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to name or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.

Get<TInfo>(IInfoProvider<TInfo>, Guid)

Gets an instance of info object based on its GUID.

public static TInfo Get<TInfo>(this IInfoProvider<TInfo> infoProvider, Guid guid) where TInfo : AbstractInfoBase<TInfo>, IInfoWithGuid, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

guid Guid

GUID of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to guid or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.

Get<TInfo>(IInfoProvider<TInfo>, int)

Gets an instance of info object based on its ID.

public static TInfo Get<TInfo>(this IInfoProvider<TInfo> infoProvider, int id) where TInfo : AbstractInfoBase<TInfo>, IInfoWithId, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

id int

ID of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to id or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.

Get<TInfo>(IInfoProvider<TInfo>, string)

Gets an instance of info object based on its code name.

public static TInfo Get<TInfo>(this IInfoProvider<TInfo> infoProvider, string name) where TInfo : AbstractInfoBase<TInfo>, IInfoWithName, new()

Parameters

infoProvider IInfoProvider<TInfo>

TInfo provider to use to retrieve the info object.

name string

Code name of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to name or null.

Type Parameters

TInfo

Type of info object managed by the provider.

Exceptions

ArgumentNullException

Thrown when infoProvider is null.