Class BaseDeltaChat<Transport>

Type Parameters

Transport extends BaseTransport<any>

Hierarchy (View Summary)

TinyEmitter<Events>
- BaseDeltaChat
  - StdioDeltaChat

Index

Constructors

constructor

new BaseDeltaChat<Transport extends BaseTransport<any>>(
transport: Transport,
startEventLoop: boolean,
): BaseDeltaChat<Transport>
Type Parameters
- Transport extends BaseTransport<any>
Parameters
- transport: Transport
- startEventLoop: boolean
  Whether to start calling RawClient.getNextEvent and emitting the respective events on this class.
Returns BaseDeltaChat<Transport>
Overrides TinyEmitter<Events>.constructor
- Defined in src/client.ts:36

Properties

rpc

rpc: RawClient

transport

transport: Transport

Methods

emit

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

eventLoop

eventLoop(): Promise<void>
Returns Promise<void>
See
the constructor's startEventLoop
- Defined in src/client.ts:54

getContextEvents

getContextEvents(account_id: number): TinyEmitter<ContextEvents>
A convenience function to listen on events binned by account_id (see RawClient.getAllAccounts).
Parameters
- account_id: number
Returns TinyEmitter<ContextEvents>
- Defined in src/client.ts:83

listAccounts

listAccounts(): Promise<Account[]>
Returns Promise<Account[]>
Deprecated
use BaseDeltaChat.rpc.getAllAccounts instead.
- Defined in src/client.ts:75

off

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

on

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

once

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

Class BaseDeltaChat<Transport>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseDeltaChat<Transport>

Properties

rpc

transport

Methods

emit

Type Parameters

Parameters

Returns this

eventLoop

Returns Promise<void>

See

getContextEvents

Parameters

Returns TinyEmitter<ContextEvents>

listAccounts

Returns Promise<Account[]>

Deprecated

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Settings

On This Page