Interface IInboxCatalog
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Exposes the inbox surfaces visible to the current runtime.
public interface IInboxCatalogProperties
Section titled “Properties”Inboxes
Section titled “ Inboxes”Gets all inbox surfaces visible to the current runtime.
IReadOnlyList<InboxDescriptor> Inboxes { get; }Property Value
Section titled “Property Value”IReadOnlyList<InboxDescriptor>
Methods
Section titled “Methods”GetByChannelId(string)
Section titled “ GetByChannelId(string)”Gets all inboxes that explicitly declare the requested channel identifier.
IReadOnlyList<InboxDescriptor> GetByChannelId(string channelId)Parameters
Section titled “Parameters”channelId string
The channel identifier to filter by.
Returns
Section titled “Returns”IReadOnlyList<InboxDescriptor>
The matching inboxes, or an empty list when no inbox declares that channel.
GetById(string)
Section titled “ GetById(string)”Gets one inbox by its stable identifier.
InboxDescriptor? GetById(string inboxId)Parameters
Section titled “Parameters”inboxId string
The inbox identifier to resolve.
Returns
Section titled “Returns”The matching inbox, or null when it is not active.
GetByProvider(string)
Section titled “ GetByProvider(string)”Gets all inboxes backed by the requested provider identifier.
IReadOnlyList<InboxDescriptor> GetByProvider(string provider)Parameters
Section titled “Parameters”provider string
The provider identifier to filter by.
Returns
Section titled “Returns”IReadOnlyList<InboxDescriptor>
The matching inboxes, or an empty list when the provider contributes none.
GetBySourceModule(string)
Section titled “ GetBySourceModule(string)”Gets all inboxes contributed by the requested module.
IReadOnlyList<InboxDescriptor> GetBySourceModule(string sourceModuleId)Parameters
Section titled “Parameters”sourceModuleId string
The source module identifier to filter by.
Returns
Section titled “Returns”IReadOnlyList<InboxDescriptor>
The matching inboxes, or an empty list when the module contributed none.