Interface IChatChannel

Interface representing a channel of messages in chat.

Namespace: SociallyDistant.Core.Social
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IChatChannel

Properties

ChannelType

Gets a MessageChannelType indicating the type of channel this is.

Declaration
MessageChannelType ChannelType { get; }
Property Value
Type Description
MessageChannelType

DeleteObservable

Gets an observable subject that notifies when a message is deleted from the channel.

Declaration
IObservable<IUserMessage> DeleteObservable { get; }
Property Value
Type Description
IObservable<IUserMessage>

Description

Gets the description of the channel.

Declaration
string Description { get; }
Property Value
Type Description
string

EditObservable

Gets an observable subject that notifies when a message is edited in the channel.

Declaration
IObservable<IUserMessage> EditObservable { get; }
Property Value
Type Description
IObservable<IUserMessage>

GuildId

If this channel is part of a guild, gets the world ID of the guild.

Declaration
ObjectId? GuildId { get; }
Property Value
Type Description
ObjectId?

Id

Gets the unique world ID of this channel.

Declaration
ObjectId Id { get; }
Property Value
Type Description
ObjectId
See Also

Messages

Gets a list of all messages in the channel.

Declaration
IEnumerable<IUserMessage> Messages { get; }
Property Value
Type Description
IEnumerable<IUserMessage>

Name

Gets the name of the channel.

Declaration
string Name { get; }
Property Value
Type Description
string

NarrativeId

Gets the narrative identifier of the channel, if any.

Declaration
string? NarrativeId { get; }
Property Value
Type Description
string

SendObservable

Gets an observable subject that notifies when a message is sent in the channel.

Declaration
IObservable<IUserMessage> SendObservable { get; }
Property Value
Type Description
IObservable<IUserMessage>

TypingUsers

Gets a list of all users typing within the conversation.

Declaration
IEnumerable<IProfile> TypingUsers { get; }
Property Value
Type Description
IEnumerable<IProfile>

Methods

GetIcon()

Gets a ChannelIconData value representing the icon to show for the channel.

Declaration
ChannelIconData GetIcon()
Returns
Type Description
ChannelIconData

A value reprersenting the channel's icon.

ObserveTypingUsers(Action<IEnumerable<IProfile>>)

Get notified when a user starts or stops typing within the channel.

Declaration
IDisposable ObserveTypingUsers(Action<IEnumerable<IProfile>> callback)
Parameters
Type Name Description
Action<IEnumerable<IProfile>> callback

A callback that executes every time the list of typing users is changed.
Returns
Type Description
IDisposable

A resource that can be disposed when you want to stop receiving callbacks.