Class Notification

Hierarchy (view full)

Note
- Notification

Index

Constructors

Properties

channel channelId contactPubkeys? content dkxParent docIndex error? nostrEvent ownerPubKey privateChannelKeyset? type verified version

Accessors

keyset payload refId

Methods

clone delete deserialize getReactionTracker getReactions getRefs getReplies publish reply serialize

Constructors

constructor

new Notification(): Notification
Returns Notification
Inherited from Note.constructor

Properties

channel

channel: Channel

channelId

channelId: string

`Optional` contactPubkeys

contactPubkeys?: string[]

content

content: NotificationPayload

dkxParent

dkxParent: HDKIndex

docIndex

docIndex: number

`Optional` error

error?: ContentError

nostrEvent

nostrEvent: Event<number>

ownerPubKey

ownerPubKey: string

`Optional` privateChannelKeyset

privateChannelKeyset?: DocumentKeyset

type

type: NotificationType = NotificationType.Unknown

verified

verified: boolean = false

version

version: number = 1

Accessors

keyset

get keyset(): DocumentKeyset
Returns DocumentKeyset
Inherited from Note.keyset
- Defined in content/ContentDocument.ts:65
set keyset(keyset): void
Parameters
- keyset: DocumentKeyset
Returns void
Inherited from Note.keyset
- Defined in content/ContentDocument.ts:62

payload

get payload(): any[]
Returns any[]
Overrides Note.payload
- Defined in content/Notification.ts:46

refId

get refId(): any[]
Returns any[]
Inherited from Note.refId
- Defined in content/Note.ts:20

Methods

clone

clone<TCloneType>(): TCloneType
Type Parameters
- TCloneType extends ContentDocument
Returns TCloneType
Inherited from Note.clone
- Defined in content/ContentDocument.ts:92

delete

delete<TDeleteType>(): Observable<TDeleteType>
Type Parameters
- TDeleteType extends ContentDocument
Returns Observable<TDeleteType>
Inherited from Note.delete
- Defined in content/ContentDocument.ts:109

deserialize

deserialize(payload): any[]
Parameters
- payload: string
Returns any[]
Overrides Note.deserialize
- Defined in content/Notification.ts:55

getReactionTracker

getReactionTracker(documents?): {
[key: string | symbol]: number;
}
Parameters
- documents: ContentDocument[] = ...
Returns {
[key: string | symbol]: number;
}
- [key: string | symbol]: number
Overrides Note.getReactionTracker
- Defined in content/Notification.ts:42

getReactions

getReactions(documents?): Note[]
Parameters
- documents: ContentDocument[] = ...
Returns Note[]
Overrides Note.getReactions
- Defined in content/Notification.ts:38

getRefs

getRefs(documents?): undefined | Note[]
Parameters
- documents: ContentDocument[] = ...
Returns undefined | Note[]
Overrides Note.getRefs
- Defined in content/Notification.ts:30

getReplies

getReplies(documents?): Note[]
Parameters
- documents: ContentDocument[] = ...
Returns Note[]
Overrides Note.getReplies
- Defined in content/Notification.ts:34

publish

publish<TPublishType>(options?): Observable<TPublishType>
Type Parameters
- TPublishType extends ContentDocument
Parameters
- Optional options: ContentPublishOptions
Returns Observable<TPublishType>
Inherited from Note.publish
- Defined in content/ContentDocument.ts:99

reply

reply(text, kind, created_at?): Observable<Note>
Parameters
- text: string
- kind: number
- Optional created_at: number
Returns Observable<Note>
Inherited from Note.reply
- Defined in content/Note.ts:68

serialize

serialize(): string
Returns string
Inherited from Note.serialize
- Defined in content/ContentDocument.ts:77