Class ContactChannel

Hierarchy (view full)

Channel
- ContactChannel

Index

Constructors

Constructors

constructor

new ContactChannel(): ContactChannel
Returns ContactChannel
Inherited from Channel.constructor

Properties

channelId

channelId: string

content

content: ContactChannelPayload

dkxParent

dkxParent: HDKIndex

docIndex

docIndex: number

documents

documents: Note[] = []

`Optional` error

error?: ContentError

indexes

indexes: {
    [pubkey: string]: {
        dkxNotify: HDKXNotification;
        dkxRecv: HDKXTwoParty;
        dkxSend?: HDKXTwoParty;
    };
}

Type declaration

[pubkey: string]: {
    dkxNotify: HDKXNotification;
    dkxRecv: HDKXTwoParty;
    dkxSend?: HDKXTwoParty;
}
- dkxNotify: HDKXNotification
- dkxRecv: HDKXTwoParty
- Optional dkxSend?: HDKXTwoParty

lastNote

lastNote: BehaviorSubject<{
created_at: number;
text: string;
}> = ...

Type declaration

created_at: number
text: string

nostrEvent

nostrEvent: Event<number>

notifKey

notifKey: BehaviorSubject<Notification> = ...

notifRecv

notifRecv: Subject<Notification> = ...

ownerPubKey

ownerPubKey: string

verified

verified: boolean = false

version

version: number = 1

Accessors

filters

get filters(): Observable<HDKIndexRelayFilters>
Returns Observable<HDKIndexRelayFilters>
- Defined in content/ContactChannel.ts:124

keyset

set keyset(keyset): void
Parameters
- keyset: DocumentKeyset
Returns void
Overrides Channel.keyset
- Defined in content/ContactChannel.ts:55

messages

get messages(): Note[]
Returns Note[]
- Defined in content/ContactChannel.ts:338

payload

get payload(): any[]
Returns any[]
Overrides Channel.payload
- Defined in content/ContactChannel.ts:342

Methods

clone

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

delete

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

deleteMessage

deleteMessage(doc): Observable<Note>
Parameters
- doc: Note
Returns Observable<Note>
- Defined in content/ContactChannel.ts:226

deserialize

deserialize(payload): any[]
Parameters
- payload: string
Returns any[]
Overrides Channel.deserialize
- Defined in content/ContactChannel.ts:356

listen

listen(__namedParameters?): [Observable<Note>, (() => void)]
Parameters
- __namedParameters: HDKIndexQueryArgs = {}
Returns [Observable<Note>, (() => void)]
- Defined in content/ContactChannel.ts:200

notify

notify(text): Observable<Notification>
Parameters
- text: string
Returns Observable<Notification>
- Defined in content/ContactChannel.ts:294

publish

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

receiveNotification

receiveNotification(notif): void
Parameters
- notif: Notification
Returns void
- Defined in content/ContactChannel.ts:96

reply

reply(doc, text, kind): Observable<Note>
Parameters
- doc: Note
- text: string
- kind: number
Returns Observable<Note>
- Defined in content/ContactChannel.ts:234

sendMessage

sendMessage(text): Observable<Note>
Parameters
- text: string
Returns Observable<Note>
- Defined in content/ContactChannel.ts:256

serialize

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

setSendKey

setSendKey(profileKey, sendKey, created_at): void
Parameters
- profileKey: string
- sendKey: HDKey
- created_at: number
Returns void
- Defined in content/ContactChannel.ts:81

`Static` create

create(info, publish?): Observable<ContactChannel>
Parameters
- info: string[] | Notification
- Optional publish: boolean
Returns Observable<ContactChannel>
- Defined in content/ContactChannel.ts:385

`Static` getChannelId

getChannelId(pubkeys): string
Parameters
- pubkeys: string[]
Returns string
- Defined in content/ContactChannel.ts:51

Class ContactChannel

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ContactChannel

Properties

channelId

content

dkxParent

docIndex

documents

Optional error

indexes

Type declaration

[pubkey: string]: { dkxNotify: HDKXNotification; dkxRecv: HDKXTwoParty; dkxSend?: HDKXTwoParty; }

dkxNotify: HDKXNotification

dkxRecv: HDKXTwoParty

Optional dkxSend?: HDKXTwoParty

lastNote

Type declaration

created_at: number

text: string

nostrEvent

notifKey

notifRecv

ownerPubKey

verified

version

Accessors

filters

Returns Observable<HDKIndexRelayFilters>

keyset

Parameters

keyset: DocumentKeyset

Returns void

messages

Returns Note[]

payload

Returns any[]

Methods

clone

Type Parameters

TCloneType extends ContentDocument

Returns TCloneType

delete

Type Parameters

TDeleteType extends ContentDocument

Returns Observable<TDeleteType>

deleteMessage

Parameters

doc: Note

Returns Observable<Note>

deserialize

Parameters

payload: string

Returns any[]

listen

Parameters

__namedParameters: HDKIndexQueryArgs = {}

Returns [Observable<Note>, (() => void)]

notify

Parameters

text: string

Returns Observable<Notification>

publish

Type Parameters

TPublishType extends ContentDocument

Parameters

Optional options: ContentPublishOptions

Returns Observable<TPublishType>

receiveNotification

Parameters

notif: Notification

Returns void

reply

`Optional` error

[pubkey: string]: {
dkxNotify: HDKXNotification;
dkxRecv: HDKXTwoParty;
dkxSend?: HDKXTwoParty;
}

`Optional` dkxSend?: HDKXTwoParty

`Optional` options: ContentPublishOptions

`Static` create

`Optional` publish: boolean

`Static` getChannelId