Options
All
  • Public
  • Public/Protected
  • All
Menu

deltachat-node - v1.92.0

Index

Type aliases

ChatTypes

WebxdcInfo

WebxdcInfo: { document?: undefined | string; icon: string; name: string; summary: string }

Type declaration

  • Optional document?: undefined | string

    if set by the webxdc, name of the document in edit

  • icon: string
  • name: string
  • summary: string

WebxdcReceivedStatusUpdate

WebxdcReceivedStatusUpdate<T>: { info?: undefined | string; max_serial: number; payload: T; serial: number; summary?: undefined | string }

Type parameters

  • T

Type declaration

  • Optional info?: undefined | string

    optional, short, informational message.

  • max_serial: number

    the maximum serial currently known. If max_serial equals serial this update is the last update (until new network messages arrive).

  • payload: T

    the payload, deserialized json

  • serial: number

    the serial number of this update. Serials are larger 0 and newer serials have higher numbers.

  • Optional summary?: undefined | string

    optional, short text, shown beside app icon. If there are no updates, an empty JSON-array is returned.

WebxdcSendingStatusUpdate

WebxdcSendingStatusUpdate<T>: { document?: undefined | string; info?: undefined | string; payload: T; summary?: undefined | string }

Type parameters

  • T

Type declaration

  • Optional document?: undefined | string

    optional, name of the document in edit, must not be used eg. in games where the Webxdc does not create documents

  • Optional info?: undefined | string

    optional, short, informational message that will be added to the chat, eg. "Alice voted" or "Bob scored 123 in MyGame"; usually only one line of text is shown, use this option sparingly to not spam the chat.

  • payload: T

    the payload, deserialized json: any javascript primitive, array or object.

  • Optional summary?: undefined | string

    optional, short text, shown beside app icon; it is recommended to use some aggregated value, eg. "8 votes", "Highscore: 123"

Variables

Const binding

binding: any = require('../binding')

Const bindings

bindings: any = require('node-gyp-build')(join(__dirname, '../'))

bindings are not typed yet. if the availible function names are required they can be found inside of ../src/module.c

Const debug

debug: Debugger = rawDebug('deltachat:node:index')

Functions

integerToHexColor

  • integerToHexColor(integerColor: number): string
  • Parameters

    • integerColor: number

      expects a 24bit rgb integer (left to right: 8bits red, 8bits green, 8bits blue)

    Returns string

Const noop

  • noop(): void
  • noop(): void

Object literals

Const EventId2EventName

EventId2EventName: object

100

100: string = "DC_EVENT_INFO"

101

101: string = "DC_EVENT_SMTP_CONNECTED"

102

102: string = "DC_EVENT_IMAP_CONNECTED"

103

103: string = "DC_EVENT_SMTP_MESSAGE_SENT"

104

104: string = "DC_EVENT_IMAP_MESSAGE_DELETED"

105

105: string = "DC_EVENT_IMAP_MESSAGE_MOVED"

150

150: string = "DC_EVENT_NEW_BLOB_FILE"

151

151: string = "DC_EVENT_DELETED_BLOB_FILE"

2000

2000: string = "DC_EVENT_MSGS_CHANGED"

2005

2005: string = "DC_EVENT_INCOMING_MSG"

2008

2008: string = "DC_EVENT_MSGS_NOTICED"

2010

2010: string = "DC_EVENT_MSG_DELIVERED"

2012

2012: string = "DC_EVENT_MSG_FAILED"

2015

2015: string = "DC_EVENT_MSG_READ"

2020

2020: string = "DC_EVENT_CHAT_MODIFIED"

2021

2021: string = "DC_EVENT_CHAT_EPHEMERAL_TIMER_MODIFIED"

2030

2030: string = "DC_EVENT_CONTACTS_CHANGED"

2035

2035: string = "DC_EVENT_LOCATION_CHANGED"

2041

2041: string = "DC_EVENT_CONFIGURE_PROGRESS"

2051

2051: string = "DC_EVENT_IMEX_PROGRESS"

2052

2052: string = "DC_EVENT_IMEX_FILE_WRITTEN"

2060

2060: string = "DC_EVENT_SECUREJOIN_INVITER_PROGRESS"

2061

2061: string = "DC_EVENT_SECUREJOIN_JOINER_PROGRESS"

2100

2100: string = "DC_EVENT_CONNECTIVITY_CHANGED"

2110

2110: string = "DC_EVENT_SELFAVATAR_CHANGED"

2120

2120: string = "DC_EVENT_WEBXDC_STATUS_UPDATE"

300

300: string = "DC_EVENT_WARNING"

400

400: string = "DC_EVENT_ERROR"

410

410: string = "DC_EVENT_ERROR_SELF_NOT_IN_GROUP"

Generated using TypeDoc