Class InboxDescriptor
Namespace: Cephalon.Abstractions.Data
Assembly: Cephalon.Abstractions.dll
Describes one inbox surface contributed to the active runtime.
public sealed class InboxDescriptorInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”InboxDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)
Section titled “ InboxDescriptor(string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyDictionary<string, string>?)”Creates a new inbox descriptor.
public InboxDescriptor(string id, string displayName, string description, string sourceModuleId, string provider, string mode = "processed-message-store", IReadOnlyList<string>? channelIds = null, IReadOnlyList<string>? tags = null, IReadOnlyDictionary<string, string>? metadata = null)Parameters
Section titled “Parameters”id string
The stable inbox identifier.
displayName string
The operator-facing inbox name.
description string
The human-readable inbox description.
sourceModuleId string
The module identifier that owns the inbox surface.
provider string
The logical provider identifier that backs the inbox.
mode string
The inbox mode such as processed-message-table or durable-log.
channelIds IReadOnlyList<string>?
Optional channel identifiers that this inbox is explicitly scoped to.
tags IReadOnlyList<string>?
Optional descriptive tags associated with the inbox.
metadata IReadOnlyDictionary<string, string>?
Optional operator-facing metadata associated with the inbox.
Properties
Section titled “Properties”ChannelIds
Section titled “ ChannelIds”Gets the optional channel identifiers that this inbox is explicitly scoped to.
public IReadOnlyList<string> ChannelIds { get; }Property Value
Section titled “Property Value”Description
Section titled “ Description”Gets the human-readable inbox description.
public string Description { get; }Property Value
Section titled “Property Value”DisplayName
Section titled “ DisplayName”Gets the operator-facing inbox name.
public string DisplayName { get; }Property Value
Section titled “Property Value”Gets the stable inbox identifier.
public string Id { get; }Property Value
Section titled “Property Value”Metadata
Section titled “ Metadata”Gets operator-facing metadata associated with the inbox.
public IReadOnlyDictionary<string, string> Metadata { get; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets the inbox mode.
public string Mode { get; }Property Value
Section titled “Property Value”Provider
Section titled “ Provider”Gets the logical provider identifier that backs the inbox.
public string Provider { get; }Property Value
Section titled “Property Value”SourceModuleId
Section titled “ SourceModuleId”Gets the identifier of the module that owns the inbox surface.
public string SourceModuleId { get; }Property Value
Section titled “Property Value”Gets descriptive tags associated with the inbox.
public IReadOnlyList<string> Tags { get; }