Table of Contents

Class MetadataBuilderTemporalExtensions

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

Extension methods for setting temporal properties on IMessageMetadataBuilder.

public static class MetadataBuilderTemporalExtensions
Inheritance
MetadataBuilderTemporalExtensions
Inherited Members

Methods

WithCreatedTimestampUtc(IMessageMetadataBuilder, DateTimeOffset)

Sets the UTC timestamp when the message was created.

public static IMessageMetadataBuilder WithCreatedTimestampUtc(this IMessageMetadataBuilder builder, DateTimeOffset createdTimestampUtc)

Parameters

builder IMessageMetadataBuilder

The builder instance.

createdTimestampUtc DateTimeOffset

The UTC creation timestamp.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithExpiresAtUtc(IMessageMetadataBuilder, DateTimeOffset?)

Sets the UTC timestamp when the message expires.

public static IMessageMetadataBuilder WithExpiresAtUtc(this IMessageMetadataBuilder builder, DateTimeOffset? expiresAtUtc)

Parameters

builder IMessageMetadataBuilder

The builder instance.

expiresAtUtc DateTimeOffset?

The UTC expiration timestamp, or null to clear.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithReceivedTimestampUtc(IMessageMetadataBuilder, DateTimeOffset?)

Sets the UTC timestamp when the message was received.

public static IMessageMetadataBuilder WithReceivedTimestampUtc(this IMessageMetadataBuilder builder, DateTimeOffset? receivedTimestampUtc)

Parameters

builder IMessageMetadataBuilder

The builder instance.

receivedTimestampUtc DateTimeOffset?

The UTC received timestamp, or null to clear.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithScheduledEnqueueTimeUtc(IMessageMetadataBuilder, DateTimeOffset?)

Sets the UTC timestamp when the message should be enqueued.

public static IMessageMetadataBuilder WithScheduledEnqueueTimeUtc(this IMessageMetadataBuilder builder, DateTimeOffset? scheduledEnqueueTimeUtc)

Parameters

builder IMessageMetadataBuilder

The builder instance.

scheduledEnqueueTimeUtc DateTimeOffset?

The UTC scheduled enqueue time, or null to clear.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithSentTimestampUtc(IMessageMetadataBuilder, DateTimeOffset?)

Sets the UTC timestamp when the message was sent.

public static IMessageMetadataBuilder WithSentTimestampUtc(this IMessageMetadataBuilder builder, DateTimeOffset? sentTimestampUtc)

Parameters

builder IMessageMetadataBuilder

The builder instance.

sentTimestampUtc DateTimeOffset?

The UTC sent timestamp, or null to clear.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithTimeToLive(IMessageMetadataBuilder, TimeSpan?)

Sets the time-to-live duration for the message.

public static IMessageMetadataBuilder WithTimeToLive(this IMessageMetadataBuilder builder, TimeSpan? timeToLive)

Parameters

builder IMessageMetadataBuilder

The builder instance.

timeToLive TimeSpan?

The time-to-live duration, or null to clear.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.

WithTiming(IMessageMetadataBuilder, DateTimeOffset, DateTimeOffset, TimeSpan?)

Sets common timing metadata in a single call.

public static IMessageMetadataBuilder WithTiming(this IMessageMetadataBuilder builder, DateTimeOffset sentTimestampUtc, DateTimeOffset receivedTimestampUtc, TimeSpan? timeToLive = null)

Parameters

builder IMessageMetadataBuilder

The builder instance.

sentTimestampUtc DateTimeOffset

The UTC sent timestamp.

receivedTimestampUtc DateTimeOffset

The UTC received timestamp.

timeToLive TimeSpan?

Optional time-to-live duration.

Returns

IMessageMetadataBuilder

The builder instance for method chaining.