Interface IGuild
Interface representing a chat server.
Inherited Members
Namespace: SociallyDistant.Core.Social
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IGuild : IChatGroup
Properties
Channels
Gets a list of all channels in the guild.
Declaration
IEnumerable<IChatChannel> Channels { get; }
Property Value
Type | Description |
---|---|
IEnumerable<IChatChannel> |
Id
Gets the unique world ID of this guild.
Declaration
ObjectId Id { get; }
Property Value
Type | Description |
---|---|
ObjectId |
See Also
Name
Gets the name of the guild.
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
string |
Methods
GetNarrativeChannel(string)
Find, or create, a channel within the guild that has the specified narrative ID.
Declaration
IChatChannel GetNarrativeChannel(string channelId)
Parameters
Type | Name | Description |
---|---|---|
string | channelId | A narrative ID to use for the channel. |
Returns
Type | Description |
---|---|
IChatChannel | An instance of IChatChannel representing the channel. |
HasMember(IProfile)
Checks that a given user is a member of this guild.
Declaration
bool HasMember(IProfile profile)
Parameters
Type | Name | Description |
---|---|---|
IProfile | profile | The user to check membership status of. |
Returns
Type | Description |
---|---|
bool | True if the user is a member of the guild. |