Class GroupsList

The base class for all casts

Hierarchy (View Summary)

EventCast<KnownEvent<typeof GROUPS_LIST_KIND>>
- GroupsList

Index

Constructors

Properties

Accessors

author createdAt groups hasHidden hidden hidden$ id seen uid unlocked

Methods

Constructors

constructor

new GroupsList(event: NostrEvent, store: CastRefEventStore): GroupsList
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns GroupsList
Overrides EventCast.constructor
- Defined in common/src/casts/groups.ts:19

Properties

`Readonly`event

event: KnownEvent

`Readonly`store

store: CastRefEventStore

Accessors

author

get author(): User
Get the User that authored this event

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

groups

get groups(): GroupPointer[]
The public groups in the list

Returns GroupPointer[]
- Defined in common/src/casts/groups.ts:25

hasHidden

get hasHidden(): boolean
Whether the groups list has hidden groups

Returns boolean
- Defined in common/src/casts/groups.ts:46

hidden

get hidden(): GroupPointer[] | undefined
Get the unlocked hidden groups

Returns GroupPointer[] | undefined
- Defined in common/src/casts/groups.ts:30

hidden$

get hidden$(): ChainableObservable<GroupPointer[] | undefined>
An observable that updates when hidden groups are unlocked

Returns ChainableObservable<GroupPointer[] | undefined>
- Defined in common/src/casts/groups.ts:34

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in common/src/casts/cast.ts:64

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

unlocked

get unlocked(): boolean
Whether the groups list is unlocked

Returns boolean
- Defined in common/src/casts/groups.ts:50

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78

unlock

unlock(signer: HiddenContentSigner): Promise<GroupPointer[]>
Unlocks the hidden groups on the groups list
Parameters
- signer: HiddenContentSigner
Returns Promise<GroupPointer[]>
- Defined in common/src/casts/groups.ts:54