Method GetItemsBulk

Namespace

GuildWars2.Items

Assembly

GW2SDK.dll

GetItemsBulk(IEnumerable<int>, Language?, MissingMemberBehavior, int, int, IProgress<BulkProgress>?, CancellationToken)

Retrieves items by their IDs by chunking requests and executing them in parallel. Supports more than 200 IDs.

public IAsyncEnumerable<(Item Value, MessageContext Context)> GetItemsBulk(IEnumerable<int> itemIds, Language? language = null, MissingMemberBehavior missingMemberBehavior = MissingMemberBehavior.Error, int degreeOfParallelism = 20, int chunkSize = 200, IProgress<BulkProgress>? progress = null, CancellationToken cancellationToken = default)

Parameters

itemIds IEnumerable<int>

The item IDs.

language Language

The language to use for descriptions.

missingMemberBehavior MissingMemberBehavior

The desired behavior when JSON contains unexpected members.

degreeOfParallelism int

The maximum number of chunks to request in parallel.

chunkSize int

How many IDs to request per chunk.

progress IProgress<BulkProgress>

A progress report provider.

cancellationToken CancellationToken

A token to cancel the request(s).

Returns

IAsyncEnumerable<(Item Value, MessageContext Context)>

A task that represents the API request(s).

GetItemsBulk(Language?, MissingMemberBehavior, int, int, IProgress<BulkProgress>?, CancellationToken)

Retrieves all items by chunking requests and executing them in parallel.

public IAsyncEnumerable<(Item Value, MessageContext Context)> GetItemsBulk(Language? language = null, MissingMemberBehavior missingMemberBehavior = MissingMemberBehavior.Error, int degreeOfParallelism = 20, int chunkSize = 200, IProgress<BulkProgress>? progress = null, CancellationToken cancellationToken = default)

Parameters

language Language

The language to use for descriptions.

missingMemberBehavior MissingMemberBehavior

The desired behavior when JSON contains unexpected members.

degreeOfParallelism int

The maximum number of chunks to request in parallel.

chunkSize int

How many IDs to request per chunk.

progress IProgress<BulkProgress>

A progress report provider.

cancellationToken CancellationToken

A token to cancel the request(s).

Returns

IAsyncEnumerable<(Item Value, MessageContext Context)>

A task that represents the API request(s).