Class Report

Cast a kind 1984 event to a Report

Hierarchy (View Summary)

EventCast<KnownEvent<typeof REPORT_KIND>>
- Report

Index

Constructors

Properties

Accessors

author blobs comment createdAt id isEventReport isUserReport reason reported reportedEvent$ reportedEventId reportedPubkey reportedUser seen servers uid

Methods

Constructors

constructor

new Report(event: NostrEvent, store: CastRefEventStore): Casts.Report
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Casts.Report
Overrides EventCast.constructor
- Defined in common/src/casts/report.ts:16

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

blobs

get blobs(): string[] | undefined
Get the blob hashes being reported (for event reports with x tags)

Returns string[] | undefined
- Defined in common/src/casts/report.ts:79

comment

get comment(): string | undefined
Get the comment/content of the report

Returns string | undefined
- Defined in common/src/casts/report.ts:42

createdAt

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

id

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

isEventReport

get isEventReport(): boolean
Check if this is an event report

Returns boolean
- Defined in common/src/casts/report.ts:32

isUserReport

get isUserReport(): boolean
Check if this is a user report

Returns boolean
- Defined in common/src/casts/report.ts:27

reason

get reason(): ReportReason | undefined
Get the reason for the report

Returns ReportReason | undefined
- Defined in common/src/casts/report.ts:37

reported

get reported(): ReportedUser | ReportedEvent | null
Get the parsed report data (either a user or event report)

Returns ReportedUser | ReportedEvent | null
- Defined in common/src/casts/report.ts:22

reportedEvent$

get reportedEvent$(): ChainableObservable<NostrEvent | undefined>
Get the event being reported (for event reports)

Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/report.ts:65

reportedEventId

get reportedEventId(): string | undefined
Get the event ID being reported (for event reports)

Returns string | undefined
- Defined in common/src/casts/report.ts:60

reportedPubkey

get reportedPubkey(): string | undefined
Get the pubkey of the user being reported

Returns string | undefined
- Defined in common/src/casts/report.ts:48

reportedUser

get reportedUser(): User | undefined
Get the User being reported

Returns User | undefined
- Defined in common/src/casts/report.ts:53

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

servers

get servers(): string[]
Get the server URLs for blob reports

Returns string[]
- Defined in common/src/casts/report.ts:84

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.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