Table of Contents

Interface IScheduledMessageStore

Namespace
Signal.Application.Scheduling
Assembly
Signal.Application.dll

Persists scheduled messages. The default keeps them in memory (lost on restart); implement this port with a database to keep reminders across restarts. Implementations must be thread-safe.

public interface IScheduledMessageStore

Methods

AddAsync(ScheduledMessage, CancellationToken)

Adds a message.

Task AddAsync(ScheduledMessage message, CancellationToken cancellationToken = default)

Parameters

message ScheduledMessage

The message.

cancellationToken CancellationToken

Cancels the operation.

Returns

Task

A task that completes when the message is stored.

GetDueAsync(DateTimeOffset, CancellationToken)

Gets the messages due at or before now.

Task<IReadOnlyList<ScheduledMessage>> GetDueAsync(DateTimeOffset now, CancellationToken cancellationToken = default)

Parameters

now DateTimeOffset

The current time.

cancellationToken CancellationToken

Cancels the operation.

Returns

Task<IReadOnlyList<ScheduledMessage>>

The due messages.

ListAsync(PhoneNumber, CancellationToken)

Lists the messages scheduled for an account, ordered by due time.

Task<IReadOnlyList<ScheduledMessage>> ListAsync(PhoneNumber account, CancellationToken cancellationToken = default)

Parameters

account PhoneNumber

The sending account.

cancellationToken CancellationToken

Cancels the operation.

Returns

Task<IReadOnlyList<ScheduledMessage>>

The messages.

RemoveAsync(Guid, CancellationToken)

Removes a message.

Task<bool> RemoveAsync(Guid id, CancellationToken cancellationToken = default)

Parameters

id Guid

The message id.

cancellationToken CancellationToken

Cancels the operation.

Returns

Task<bool>

true if it existed.

UpdateAsync(ScheduledMessage, CancellationToken)

Replaces the stored message with the same Id (e.g. its next due time).

Task UpdateAsync(ScheduledMessage message, CancellationToken cancellationToken = default)

Parameters

message ScheduledMessage

The updated message.

cancellationToken CancellationToken

Cancels the operation.

Returns

Task

A task that completes when the message is updated.