Class StdioDeltaChat

Hierarchy (View Summary)

BaseDeltaChat<StdioTransport>
- StdioDeltaChat

Index

Constructors

constructor

new StdioDeltaChat(
    input: any,
    output: any,
    startEventLoop: boolean,
): StdioDeltaChat
Parameters
- input: any
- output: any
- startEventLoop: boolean
Returns StdioDeltaChat
Overrides BaseDeltaChat.constructor
- Defined in src/client.ts:82

Properties

`Optional`account

account?: Account

rpc

rpc: RawClient

transport

transport: StdioTransport

Methods

close

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

emit

emit<
    E extends
        | "WebxdcStatusUpdate"
        | "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"
        | "ALL",
>(
    event: E,
    ...args: Arguments<Events[E]>,
): this
Type Parameters
- E extends
      | "WebxdcStatusUpdate"
      | "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"
      | "ALL"
Parameters
- event: E
- ...args: Arguments<Events[E]>
Returns this
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:48

getContextEvents

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

listAccounts

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

off

off<
    E extends
        | "WebxdcStatusUpdate"
        | "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"
        | "ALL",
>(
    event: E,
    callback?: Events[E],
): this
Type Parameters
- E extends
      | "WebxdcStatusUpdate"
      | "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"
      | "ALL"
Parameters
- event: E
- Optionalcallback: Events[E]
Returns this
Inherited from BaseDeltaChat.off
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:7

on

on<
    E extends
        | "WebxdcStatusUpdate"
        | "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"
        | "ALL",
>(
    event: E,
    callback: Events[E],
    ctx?: any,
): this
Type Parameters
- E extends
      | "WebxdcStatusUpdate"
      | "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"
      | "ALL"
Parameters
- event: E
- callback: Events[E]
- Optionalctx: any
Returns this
Inherited from BaseDeltaChat.on
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:4

once

once<
    E extends
        | "WebxdcStatusUpdate"
        | "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"
        | "ALL",
>(
    event: E,
    callback: Events[E],
    ctx?: any,
): this
Type Parameters
- E extends
      | "WebxdcStatusUpdate"
      | "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"
      | "ALL"
Parameters
- event: E
- callback: Events[E]
- Optionalctx: any
Returns this
Inherited from BaseDeltaChat.once
- Defined in node_modules/@deltachat/tiny-emitter/index.d.ts:5

Class StdioDeltaChat

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StdioDeltaChat

Properties

Optionalaccount

rpc

transport

Methods

close

Returns void

emit

Type Parameters

Parameters

Returns this

eventLoop

Returns Promise<void>

getContextEvents

Parameters

Returns TinyEmitter<ContextEvents>

listAccounts

Returns Promise<Account[]>

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Settings

On This Page

`Optional`account