Class SubjectApi

Index

Constructors

Methods

addManifestation catalogue deleteSubject follow getBackingGroupIds getSubscription isAudienceMember makeSubject makeThreadSubject migrateLegacySubscription mute renameSubject reservedNames resolveBoardScoped resolveById resolveByTitle setSubscription visibleSubjects

Constructors

constructor

new SubjectApi(): SubjectApi
Returns SubjectApi

Methods

`Static`addManifestation

addManifestation(
    subject: default,
    surface: SubjectSurface,
    ref: string,
): Promise<void>
Parameters
- subject: default
- surface: SubjectSurface
- ref: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/subject.ts:78

`Static`catalogue

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

`Static`deleteSubject

deleteSubject(subject: default): Promise<void>
Parameters
- subject: default
Returns Promise<void>
- Defined in packages/server/src/mud/api/subject.ts:138

`Static`follow

follow(
    avatar: default,
    subjectId: string,
    followed: boolean,
): Promise<SubjectSubscription>
Parameters
- avatar: default
- subjectId: string
- followed: boolean
Returns Promise<SubjectSubscription>
- Defined in packages/server/src/mud/api/subject.ts:109

`Static`getBackingGroupIds

getBackingGroupIds(): Promise<ReadonlySet<string>>
Returns Promise<ReadonlySet<string>>
- Defined in packages/server/src/mud/api/subject.ts:142

`Static`getSubscription

getSubscription(
avatar: default,
subjectId: string,
): Promise<SubjectSubscription>
Parameters
- avatar: default
- subjectId: string
Returns Promise<SubjectSubscription>
- Defined in packages/server/src/mud/api/subject.ts:94

`Static`isAudienceMember

isAudienceMember(actor: Stuff, subject: default): Promise<boolean>
Parameters
- actor: Stuff
- subject: default
Returns Promise<boolean>
- Defined in packages/server/src/mud/api/subject.ts:90

`Static`makeSubject

makeSubject(
    owner: Stuff,
    title: string,
    opts?: MakeSubjectOptions,
): Promise<default>
Parameters
- owner: Stuff
- title: string
- Optionalopts: MakeSubjectOptions
Returns Promise<default>
- Defined in packages/server/src/mud/api/subject.ts:47

`Static`makeThreadSubject

makeThreadSubject(
    owner: Stuff,
    parent: default,
    threadName: string,
): Promise<default>
Parameters
- owner: Stuff
- parent: default
- threadName: string
Returns Promise<default>
- Defined in packages/server/src/mud/api/subject.ts:55

`Static`migrateLegacySubscription

migrateLegacySubscription(
    avatar: default,
    subjectId: string,
    legacy: { muted: boolean; tunedIn: boolean },
): Promise<SubjectSubscription>
Parameters
- avatar: default
- subjectId: string
- legacy: { muted: boolean; tunedIn: boolean }
Returns Promise<SubjectSubscription>
- Defined in packages/server/src/mud/api/subject.ts:126

`Static`mute

mute(
    avatar: default,
    subjectId: string,
    surface: SubjectSurface,
    muted: boolean,
): Promise<SubjectSubscription>
Parameters
- avatar: default
- subjectId: string
- surface: SubjectSurface
- muted: boolean
Returns Promise<SubjectSubscription>
- Defined in packages/server/src/mud/api/subject.ts:117

`Static`renameSubject

renameSubject(subject: default, newTitle: string): Promise<void>
Parameters
- subject: default
- newTitle: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/subject.ts:134

`Static`reservedNames

reservedNames(): Promise<ReadonlySet<string>>
Returns Promise<ReadonlySet<string>>
- Defined in packages/server/src/mud/api/subject.ts:146

`Static`resolveBoardScoped

resolveBoardScoped(
boardTitle: string,
threadName: string,
): Promise<default | null>
Parameters
- boardTitle: string
- threadName: string
Returns Promise<default | null>
- Defined in packages/server/src/mud/api/subject.ts:71

`Static`resolveById

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

`Static`resolveByTitle

resolveByTitle(title: string): Promise<default | null>
Parameters
- title: string
Returns Promise<default | null>
- Defined in packages/server/src/mud/api/subject.ts:63

`Static`setSubscription

setSubscription(
    avatar: default,
    subjectId: string,
    next: Partial<SubjectSubscription>,
): Promise<SubjectSubscription>
Parameters
- avatar: default
- subjectId: string
- next: Partial<SubjectSubscription>
Returns Promise<SubjectSubscription>
- Defined in packages/server/src/mud/api/subject.ts:101

`Static`visibleSubjects

visibleSubjects(actor: Stuff): Promise<default[]>
Parameters
- actor: Stuff
Returns Promise<default[]>
- Defined in packages/server/src/mud/api/subject.ts:86