Method GetDecorationsBulk

Namespace

GuildWars2.Pve.Home

Assembly

GW2SDK.dll

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

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

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

Parameters

decorationIds IEnumerable<int>

The decoration 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<(Decoration Value, MessageContext Context)>

A task that represents the API request(s).

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

Retrieves all homestead decorations by chunking requests and executing them in parallel.

public IAsyncEnumerable<(Decoration Value, MessageContext Context)> GetDecorationsBulk(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<(Decoration Value, MessageContext Context)>

A task that represents the API request(s).