Class ForumsApi

Constructors

constructor

new ForumsApi(): ForumsApi
Returns ForumsApi

Methods

`Static`attachClaim

attachClaim(
    actor: Stuff,
    parent: default,
    relation: ArgumentRelation,
    body: string,
): Promise<default>
Attach a typed claim (pro/con/question) on an argument board.
Parameters
- actor: Stuff
- parent: default
- relation: ArgumentRelation
- body: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:149

`Static`cancelAllForInteractive

cancelAllForInteractive(interactive: default): void
Parameters
- interactive: default
Returns void
- Defined in packages/server/src/mud/api/forums.ts:237

`Static`castVote

castVote(actor: Stuff, entry: default, direction: VoteValue): Promise<default>
Parameters
- actor: Stuff
- entry: default
- direction: VoteValue
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:189

`Static`createBoardOnSubject

createBoardOnSubject(
subject: default,
opts?: { description?: string; organizer?: BoardOrganizer },
): Promise<default>
Parameters
- subject: default
- Optionalopts: { description?: string; organizer?: BoardOrganizer }
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:108

`Static`displayScoreFor

displayScoreFor(entry: default): Promise<number | null>
Parameters
- entry: default
Returns Promise<number | null>
- Defined in packages/server/src/mud/api/forums.ts:201

`Static`editBody

editBody(actor: Stuff, entry: default, body: string): Promise<default>
Edit a claim/post body in place (lossless 'entry-edited' trail).
Parameters
- actor: Stuff
- entry: default
- body: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:159

`Static`getBoard

getBoard(id: string): Promise<default | null>
Parameters
- id: string
Returns Promise<default | null>
- Defined in packages/server/src/mud/api/forums.ts:127

`Static`getEntry

getEntry(id: string): Promise<default | null>
Parameters
- id: string
Returns Promise<default | null>
- Defined in packages/server/src/mud/api/forums.ts:167

`Static`getVoteState

getVoteState(entry: default, voter: string): Promise<VoteState>
Parameters
- entry: default
- voter: string
Returns Promise<VoteState>
- Defined in packages/server/src/mud/api/forums.ts:197

`Static`handleSubscribe

handleSubscribe(req: ForumSubscribeRequest): Promise<void>
Parameters
- req: ForumSubscribeRequest
Returns Promise<void>
- Defined in packages/server/src/mud/api/forums.ts:226

`Static`handleUnsubscribe

handleUnsubscribe(interactive: default, subscriptionId: string): void
Parameters
- interactive: default
- subscriptionId: string
Returns void
- Defined in packages/server/src/mud/api/forums.ts:230

`Static`listBoards

listBoards(actor: Stuff): Promise<BoardView[]>
Parameters
- actor: Stuff
Returns Promise<BoardView[]>
- Defined in packages/server/src/mud/api/forums.ts:131

`Static`makeForum

makeForum(
    creator: Stuff,
    name: string,
    opts?: MakeForumOptions,
): Promise<BoardView>
Parameters
- creator: Stuff
- name: string
- Optionalopts: MakeForumOptions
Returns Promise<BoardView>
- Defined in packages/server/src/mud/api/forums.ts:115

`Static`matureArgument

matureArgument(actor: Stuff, board: default): Promise<void>
Mark an argument deliberation matured — emits a decoupled mature event the deferred vote layer will consume; binds nothing in v1.
Parameters
- actor: Stuff
- board: default
Returns Promise<void>
- Defined in packages/server/src/mud/api/forums.ts:217

`Static`postThread

postThread(
    actor: Stuff,
    board: default,
    title: string,
    body: string,
): Promise<default>
Parameters
- actor: Stuff
- board: default
- title: string
- body: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:135

`Static`promoteThread

promoteThread(
    actor: Stuff,
    thread: default,
    threadName: string,
): Promise<default>
Parameters
- actor: Stuff
- thread: default
- threadName: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:205

`Static`readArgumentLens

readArgumentLens(board: default): Promise<ArgumentLensNode[]>
The neutral default lens over a whole argument board (spine + tree).
Parameters
- board: default
Returns Promise<ArgumentLensNode[]>
- Defined in packages/server/src/mud/api/forums.ts:180

`Static`readArgumentThread

readArgumentThread(root: default): Promise<ArgumentLensNode[]>
The neutral default lens over a subtree rooted at root.
Parameters
- root: default
Returns Promise<ArgumentLensNode[]>
- Defined in packages/server/src/mud/api/forums.ts:185

`Static`readBoard

readBoard(board: default, sort?: EntrySort): Promise<default[]>
Parameters
- board: default
- Optionalsort: EntrySort
Returns Promise<default[]>
- Defined in packages/server/src/mud/api/forums.ts:171

`Static`readThread

readThread(root: default, sort?: EntrySort): Promise<ThreadView>
Parameters
- root: default
- Optionalsort: EntrySort
Returns Promise<ThreadView>
- Defined in packages/server/src/mud/api/forums.ts:175

`Static`reply

reply(actor: Stuff, parent: default, body: string): Promise<default>
Parameters
- actor: Stuff
- parent: default
- body: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/forums.ts:144

`Static`resolveBoardByHandle

resolveBoardByHandle(handle: string): Promise<BoardView | null>
Parameters
- handle: string
Returns Promise<BoardView | null>
- Defined in packages/server/src/mud/api/forums.ts:123