Table of Contents

Class MetadataBuilderTransportExtensions

Namespace
Excalibur.Dispatch
Assembly
Excalibur.Dispatch.Abstractions.dll

Extension methods for setting transport and delivery properties on IMessageMetadataBuilder.

public static class MetadataBuilderTransportExtensions
Inheritance
MetadataBuilderTransportExtensions
Inherited Members

Methods

WithDeadLetterErrorDescription(IMessageMetadataBuilder, string?)

Sets the dead letter error description.

public static IMessageMetadataBuilder WithDeadLetterErrorDescription(this IMessageMetadataBuilder builder, string? deadLetterErrorDescription)

Parameters

builder IMessageMetadataBuilder

The builder instance.

deadLetterErrorDescription string

The detailed error description for dead-lettered messages.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithDeadLetterQueue(IMessageMetadataBuilder, string?)

Sets the dead letter queue name.

public static IMessageMetadataBuilder WithDeadLetterQueue(this IMessageMetadataBuilder builder, string? deadLetterQueue)

Parameters

builder IMessageMetadataBuilder

The builder instance.

deadLetterQueue string

The name of the dead letter queue.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithDeadLetterReason(IMessageMetadataBuilder, string?)

Sets the dead letter reason.

public static IMessageMetadataBuilder WithDeadLetterReason(this IMessageMetadataBuilder builder, string? deadLetterReason)

Parameters

builder IMessageMetadataBuilder

The builder instance.

deadLetterReason string

The reason the message was dead-lettered.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithDeliveryCount(IMessageMetadataBuilder, int)

Sets the delivery count for the message.

public static IMessageMetadataBuilder WithDeliveryCount(this IMessageMetadataBuilder builder, int deliveryCount)

Parameters

builder IMessageMetadataBuilder

The builder instance.

deliveryCount int

The number of delivery attempts.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithDuplicateDetectionWindow(IMessageMetadataBuilder, TimeSpan?)

Sets the duplicate detection window.

public static IMessageMetadataBuilder WithDuplicateDetectionWindow(this IMessageMetadataBuilder builder, TimeSpan? duplicateDetectionWindow)

Parameters

builder IMessageMetadataBuilder

The builder instance.

duplicateDetectionWindow TimeSpan?

The time window for duplicate detection.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithDurable(IMessageMetadataBuilder, bool?)

Sets the durable flag indicating whether the message should survive broker restarts.

public static IMessageMetadataBuilder WithDurable(this IMessageMetadataBuilder builder, bool? durable)

Parameters

builder IMessageMetadataBuilder

The builder instance.

durable bool?

True if the message should be durable.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithLastDeliveryError(IMessageMetadataBuilder, string?)

Sets the last delivery error message.

public static IMessageMetadataBuilder WithLastDeliveryError(this IMessageMetadataBuilder builder, string? lastDeliveryError)

Parameters

builder IMessageMetadataBuilder

The builder instance.

lastDeliveryError string

The error message from the last delivery attempt.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithMaxDeliveryCount(IMessageMetadataBuilder, int?)

Sets the maximum delivery count for the message.

public static IMessageMetadataBuilder WithMaxDeliveryCount(this IMessageMetadataBuilder builder, int? maxDeliveryCount)

Parameters

builder IMessageMetadataBuilder

The builder instance.

maxDeliveryCount int?

The maximum number of delivery attempts allowed.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithPriority(IMessageMetadataBuilder, int?)

Sets the message priority.

public static IMessageMetadataBuilder WithPriority(this IMessageMetadataBuilder builder, int? priority)

Parameters

builder IMessageMetadataBuilder

The builder instance.

priority int?

The priority level of the message.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithRequiresDuplicateDetection(IMessageMetadataBuilder, bool?)

Sets whether the message requires duplicate detection.

public static IMessageMetadataBuilder WithRequiresDuplicateDetection(this IMessageMetadataBuilder builder, bool? requiresDuplicateDetection)

Parameters

builder IMessageMetadataBuilder

The builder instance.

requiresDuplicateDetection bool?

True if duplicate detection is required.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.