Class ChatApi

Index

Constructors

Methods

attachChatToSubject catalogue createPlayerChannel disbandPlayerChannel getBackingGroupIds getSubscription historyFor openAdHoc postToChannel promoteAdHocToManaged renamePlayerChannel resolveByName resolveHandleForActor setSubscription visibleChannels

Constructors

constructor

new ChatApi(): ChatApi
Returns ChatApi

Methods

`Static`attachChatToSubject

attachChatToSubject(
subject: default,
procedure?: "free" | "rules-of-order",
): Promise<Channel>
Parameters
- subject: default
- Optionalprocedure: "free" | "rules-of-order"
Returns Promise<Channel>
- Defined in packages/server/src/mud/api/chat.ts:78

`Static`catalogue

catalogue(): Promise<default>
Returns Promise<default>
- Defined in packages/server/src/mud/api/chat.ts:129

`Static`createPlayerChannel

createPlayerChannel(owner: Stuff, name: string): Promise<Channel>
Parameters
- owner: Stuff
- name: string
Returns Promise<Channel>
- Defined in packages/server/src/mud/api/chat.ts:71

`Static`disbandPlayerChannel

disbandPlayerChannel(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
- Defined in packages/server/src/mud/api/chat.ts:85

`Static`getBackingGroupIds

getBackingGroupIds(): Promise<ReadonlySet<string>>
Set of Group _ids that back chat channels. Consumed by GroupController.executeList to filter channel-backing Groups out of the user-facing group list view. Groups themselves know nothing about chat; ownership of this bookkeeping lives here.

Returns Promise<ReadonlySet<string>>
- Defined in packages/server/src/mud/api/chat.ts:139

`Static`getSubscription

getSubscription(avatar: default, channel: Channel): Promise<ChannelSubscription>
Parameters
- avatar: default
- channel: Channel
Returns Promise<ChannelSubscription>
- Defined in packages/server/src/mud/api/chat.ts:106

`Static`historyFor

historyFor(channelId: string): Promise<readonly MessageFrame<unknown>[]>
Parameters
- channelId: string
Returns Promise<readonly MessageFrame<unknown>[]>
- Defined in packages/server/src/mud/api/chat.ts:96

`Static`openAdHoc

openAdHoc(creator: Stuff, members: Iterable<Stuff>): Promise<AdHocChannel>
Parameters
- creator: Stuff
- members: Iterable<Stuff>
Returns Promise<AdHocChannel>
- Defined in packages/server/src/mud/api/chat.ts:56

`Static`postToChannel

postToChannel(speaker: Stuff, channel: Channel, body: string): Promise<void>
Parameters
- speaker: Stuff
- channel: Channel
- body: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/chat.ts:63

`Static`promoteAdHocToManaged

promoteAdHocToManaged(
    handle: string,
    newName: string,
    promoter: Stuff,
): Promise<Channel>
Parameters
- handle: string
- newName: string
- promoter: Stuff
Returns Promise<Channel>
- Defined in packages/server/src/mud/api/chat.ts:121

`Static`renamePlayerChannel

renamePlayerChannel(oldName: string, newName: string): Promise<Channel>
Parameters
- oldName: string
- newName: string
Returns Promise<Channel>
- Defined in packages/server/src/mud/api/chat.ts:89

`Static`resolveByName

resolveByName(name: string): Promise<Channel | null>
Parameters
- name: string
Returns Promise<Channel | null>
- Defined in packages/server/src/mud/api/chat.ts:45

`Static`resolveHandleForActor

resolveHandleForActor(
actor: Stuff,
handle: string,
): Promise<AdHocChannel | null>
Parameters
- actor: Stuff
- handle: string
Returns Promise<AdHocChannel | null>
- Defined in packages/server/src/mud/api/chat.ts:49

`Static`setSubscription

setSubscription(
    avatar: default,
    channel: Channel,
    next: Partial<ChannelSubscription>,
): Promise<ChannelSubscription>
Parameters
- avatar: default
- channel: Channel
- next: Partial<ChannelSubscription>
Returns Promise<ChannelSubscription>
- Defined in packages/server/src/mud/api/chat.ts:113

`Static`visibleChannels

visibleChannels(
actor: Stuff,
): Promise<{ adHoc: AdHocChannel[]; persistent: Channel[] }>
Parameters
- actor: Stuff
Returns Promise<{ adHoc: AdHocChannel[]; persistent: Channel[] }>
- Defined in packages/server/src/mud/api/chat.ts:100