Interface SubjectSubscriber

Method contract a Subject-subscribing owner (Avatar) exposes.

interface SubjectSubscriber {
    getSubjectSubscription(
        subjectId: string,
    ): SubjectSubscription | undefined;
    hasSubjectSubscription(subjectId: string): boolean;
    removeSubjectSubscription(subjectId: string): boolean;
    setSubjectSubscription(subjectId: string, sub: SubjectSubscription): void;
    subscribedSubjectIds(): string[];
}

Index

Methods

getSubjectSubscription hasSubjectSubscription removeSubjectSubscription setSubjectSubscription subscribedSubjectIds

Methods

getSubjectSubscription

getSubjectSubscription(subjectId: string): SubjectSubscription | undefined
This owner's stored subscription for subjectId, or undefined.
Parameters
- subjectId: string
Returns SubjectSubscription | undefined
- Defined in packages/server/src/mud/lib/forum/SubjectSubscriber.ts:30

hasSubjectSubscription

hasSubjectSubscription(subjectId: string): boolean
True if this owner has any stored subscription for subjectId.
Parameters
- subjectId: string
Returns boolean
- Defined in packages/server/src/mud/lib/forum/SubjectSubscriber.ts:32

removeSubjectSubscription

removeSubjectSubscription(subjectId: string): boolean
Drop the stored subscription for subjectId. True if one was removed.
Parameters
- subjectId: string
Returns boolean
- Defined in packages/server/src/mud/lib/forum/SubjectSubscriber.ts:36

setSubjectSubscription

setSubjectSubscription(subjectId: string, sub: SubjectSubscription): void
Upsert the stored subscription for subjectId.
Parameters
- subjectId: string
- sub: SubjectSubscription
Returns void
- Defined in packages/server/src/mud/lib/forum/SubjectSubscriber.ts:34

subscribedSubjectIds

subscribedSubjectIds(): string[]
Every subjectId this owner has a stored subscription for.

Returns string[]
- Defined in packages/server/src/mud/lib/forum/SubjectSubscriber.ts:38