Interface ICatalogResource

Namespace

TcgDex.Resources

Assembly

TcgDex.CSharpSdk.dll

Reads the enumeration endpoints — the distinct values a field can take.

public interface ICatalogResource

Remarks

Useful for building valid filters and for populating pickers. Note that TcgDex.Resources.ICatalogResource.HitPointsAsync(System.Threading.CancellationToken), TcgDex.Resources.ICatalogResource.RetreatCostsAsync(System.Threading.CancellationToken) and TcgDex.Resources.ICatalogResource.DexIdsAsync(System.Threading.CancellationToken) return numbers where the rest return text.

Methods

CategoriesAsync(CancellationToken)

The card categories: Pokemon, Trainer, Energy.

Task<IReadOnlyList<string>> CategoriesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every category value in use.

DexIdsAsync(CancellationToken)

Every National Pokédex number represented.

Task<IReadOnlyList<int>> DexIdsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<int>>

Every dex id in use.

EnergyTypesAsync(CancellationToken)

The energy categories: Normal and Special.

Task<IReadOnlyList<string>> EnergyTypesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every energy type value in use.

HitPointsAsync(CancellationToken)

Every hit-point value in use.

Task<IReadOnlyList<int>> HitPointsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<int>>

Every HP value in use.

IllustratorsAsync(CancellationToken)

Every illustrator credited on a card.

Task<IReadOnlyList<string>> IllustratorsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every illustrator name in use.

RaritiesAsync(CancellationToken)

Every rarity in use.

Task<IReadOnlyList<string>> RaritiesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every rarity value in use.

RegulationMarksAsync(CancellationToken)

Every regulation mark.

Task<IReadOnlyList<string>> RegulationMarksAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every regulation mark in use.

RetreatCostsAsync(CancellationToken)

Every retreat cost in use.

Task<IReadOnlyList<int>> RetreatCostsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<int>>

Every retreat cost in use.

StagesAsync(CancellationToken)

Every evolution stage.

Task<IReadOnlyList<string>> StagesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every stage value in use.

SuffixesAsync(CancellationToken)

Every card-name suffix, such as EX or VMAX.

Task<IReadOnlyList<string>> SuffixesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every suffix value in use.

TrainerTypesAsync(CancellationToken)

Every Trainer subtype.

Task<IReadOnlyList<string>> TrainerTypesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every trainer type value in use.

TypesAsync(CancellationToken)

Every elemental energy type.

Task<IReadOnlyList<string>> TypesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every type value in use.

VariantsAsync(CancellationToken)

Every printing variant name.

Task<IReadOnlyList<string>> VariantsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels the request.

Returns

Task<IReadOnlyList<string>>

Every variant name in use.