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
messageScheduledMessageThe message.
cancellationTokenCancellationTokenCancels 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
nowDateTimeOffsetThe current time.
cancellationTokenCancellationTokenCancels 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
accountPhoneNumberThe sending account.
cancellationTokenCancellationTokenCancels the operation.
Returns
- Task<IReadOnlyList<ScheduledMessage>>
The messages.
RemoveAsync(Guid, CancellationToken)
Removes a message.
Task<bool> RemoveAsync(Guid id, CancellationToken cancellationToken = default)
Parameters
idGuidThe message id.
cancellationTokenCancellationTokenCancels the operation.
Returns
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
messageScheduledMessageThe updated message.
cancellationTokenCancellationTokenCancels the operation.
Returns
- Task
A task that completes when the message is updated.