Class DeltaChat

Hierarchy

BaseDeltaChat<WebsocketTransport>
- DeltaChat

Index

Constructors

constructor

new DeltaChat(opts?: string | Opts): DeltaChat
Parameters
- Optional opts: string | Opts
Returns DeltaChat
Overrides BaseDeltaChat.constructor
- Defined in src/client.ts:91

Properties

`Optional` account

account?: Account

opts

opts: Opts

rpc

rpc: RawClient

transport

transport: WebsocketTransport

Methods

close

close(): void
Returns void
- Defined in src/client.ts:88

emit

emit<E>(event: E, ...args: Arguments<Events[E]>): DeltaChat
Type Parameters
- E extends "WebxdcStatusUpdate" | "Info" | "SmtpConnected" | "ImapConnected" | "SmtpMessageSent" | "ImapMessageDeleted" | "ImapMessageMoved" | "ImapInboxIdle" | "NewBlobFile" | "DeletedBlobFile" | "Warning" | "Error" | "ErrorSelfNotInGroup" | "MsgsChanged" | "ReactionsChanged" | "IncomingReaction" | "IncomingMsg" | "IncomingMsgBunch" | "MsgsNoticed" | "MsgDelivered" | "MsgFailed" | "MsgRead" | "MsgDeleted" | "ChatModified" | "ChatEphemeralTimerModified" | "ContactsChanged" | "LocationChanged" | "ConfigureProgress" | "ImexProgress" | "ImexFileWritten" | "SecurejoinInviterProgress" | "SecurejoinJoinerProgress" | "ConnectivityChanged" | "SelfavatarChanged" | "ConfigSynced" | "WebxdcRealtimeData" | "WebxdcRealtimeAdvertisementReceived" | "WebxdcInstanceDeleted" | "AccountsBackgroundFetchDone" | "ChatlistChanged" | "ChatlistItemChanged" | "EventChannelOverflow" | "ALL"
Parameters
- event: E
- Rest ...args: Arguments<Events[E]>
Returns DeltaChat
Inherited from BaseDeltaChat.emit
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:6

eventLoop

eventLoop(): Promise<void>
Returns Promise<void>
Inherited from BaseDeltaChat.eventLoop
- Defined in src/client.ts:45

getContextEvents

getContextEvents(account_id: number): TinyEmitter<ContextEvents>
Parameters
- account_id: number
Returns TinyEmitter<ContextEvents>
Inherited from BaseDeltaChat.getContextEvents
- Defined in src/client.ts:67

listAccounts

listAccounts(): Promise<Account[]>
Returns Promise<Account[]>
Inherited from BaseDeltaChat.listAccounts
- Defined in src/client.ts:63

off

off<E>(event: E, callback?: Events[E]): DeltaChat
Type Parameters
- E extends "WebxdcStatusUpdate" | "Info" | "SmtpConnected" | "ImapConnected" | "SmtpMessageSent" | "ImapMessageDeleted" | "ImapMessageMoved" | "ImapInboxIdle" | "NewBlobFile" | "DeletedBlobFile" | "Warning" | "Error" | "ErrorSelfNotInGroup" | "MsgsChanged" | "ReactionsChanged" | "IncomingReaction" | "IncomingMsg" | "IncomingMsgBunch" | "MsgsNoticed" | "MsgDelivered" | "MsgFailed" | "MsgRead" | "MsgDeleted" | "ChatModified" | "ChatEphemeralTimerModified" | "ContactsChanged" | "LocationChanged" | "ConfigureProgress" | "ImexProgress" | "ImexFileWritten" | "SecurejoinInviterProgress" | "SecurejoinJoinerProgress" | "ConnectivityChanged" | "SelfavatarChanged" | "ConfigSynced" | "WebxdcRealtimeData" | "WebxdcRealtimeAdvertisementReceived" | "WebxdcInstanceDeleted" | "AccountsBackgroundFetchDone" | "ChatlistChanged" | "ChatlistItemChanged" | "EventChannelOverflow" | "ALL"
Parameters
- event: E
- Optional callback: Events[E]
Returns DeltaChat
Inherited from BaseDeltaChat.off
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:7

on

on<E>(event: E, callback: Events[E], ctx?: any): DeltaChat
Type Parameters
- E extends "WebxdcStatusUpdate" | "Info" | "SmtpConnected" | "ImapConnected" | "SmtpMessageSent" | "ImapMessageDeleted" | "ImapMessageMoved" | "ImapInboxIdle" | "NewBlobFile" | "DeletedBlobFile" | "Warning" | "Error" | "ErrorSelfNotInGroup" | "MsgsChanged" | "ReactionsChanged" | "IncomingReaction" | "IncomingMsg" | "IncomingMsgBunch" | "MsgsNoticed" | "MsgDelivered" | "MsgFailed" | "MsgRead" | "MsgDeleted" | "ChatModified" | "ChatEphemeralTimerModified" | "ContactsChanged" | "LocationChanged" | "ConfigureProgress" | "ImexProgress" | "ImexFileWritten" | "SecurejoinInviterProgress" | "SecurejoinJoinerProgress" | "ConnectivityChanged" | "SelfavatarChanged" | "ConfigSynced" | "WebxdcRealtimeData" | "WebxdcRealtimeAdvertisementReceived" | "WebxdcInstanceDeleted" | "AccountsBackgroundFetchDone" | "ChatlistChanged" | "ChatlistItemChanged" | "EventChannelOverflow" | "ALL"
Parameters
- event: E
- callback: Events[E]
- Optional ctx: any
Returns DeltaChat
Inherited from BaseDeltaChat.on
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:4

once

once<E>(event: E, callback: Events[E], ctx?: any): DeltaChat
Type Parameters
- E extends "WebxdcStatusUpdate" | "Info" | "SmtpConnected" | "ImapConnected" | "SmtpMessageSent" | "ImapMessageDeleted" | "ImapMessageMoved" | "ImapInboxIdle" | "NewBlobFile" | "DeletedBlobFile" | "Warning" | "Error" | "ErrorSelfNotInGroup" | "MsgsChanged" | "ReactionsChanged" | "IncomingReaction" | "IncomingMsg" | "IncomingMsgBunch" | "MsgsNoticed" | "MsgDelivered" | "MsgFailed" | "MsgRead" | "MsgDeleted" | "ChatModified" | "ChatEphemeralTimerModified" | "ContactsChanged" | "LocationChanged" | "ConfigureProgress" | "ImexProgress" | "ImexFileWritten" | "SecurejoinInviterProgress" | "SecurejoinJoinerProgress" | "ConnectivityChanged" | "SelfavatarChanged" | "ConfigSynced" | "WebxdcRealtimeData" | "WebxdcRealtimeAdvertisementReceived" | "WebxdcInstanceDeleted" | "AccountsBackgroundFetchDone" | "ChatlistChanged" | "ChatlistItemChanged" | "EventChannelOverflow" | "ALL"
Parameters
- event: E
- callback: Events[E]
- Optional ctx: any
Returns DeltaChat
Inherited from BaseDeltaChat.once
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:5

Class DeltaChat

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: string | Opts

Returns DeltaChat

Properties

Optional account

opts

rpc

transport

Methods

close

Returns void

emit

Type Parameters

Parameters

event: E

Rest ...args: Arguments<Events[E]>

Returns DeltaChat

eventLoop

Returns Promise<void>

getContextEvents

Parameters

account_id: number

Returns TinyEmitter<ContextEvents>

listAccounts

Returns Promise<Account[]>

off

Type Parameters

Parameters

event: E

Optional callback: Events[E]

Returns DeltaChat

on

Type Parameters

Parameters

event: E

callback: Events[E]

Optional ctx: any

Returns DeltaChat

once

Type Parameters

Parameters

event: E

callback: Events[E]

Optional ctx: any

Returns DeltaChat

Settings

Member Visibility

Theme

`Optional` opts: string | Opts

`Optional` account

`Rest` ...args: Arguments<Events[E]>

`Optional` callback: Events[E]

`Optional` ctx: any

`Optional` ctx: any