> For the complete documentation index, see [llms.txt](https://missiveapp.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://missiveapp.com/docs/developers/de/ui-iframe-integrations/javascript-api.md).

# JavaScript-API

Vollständige JavaScript-API-Referenz für Missive iFrame-Integrationen: Methoden, Ereignisse und Objekte.

## App-Methoden

### reload()

Lädt das iframe neu.

### search(text)

Startet eine neue Suche.

| Parameter (\* erforderlich) | Standard | Beschreibung |
| --------------------------- | -------- | ------------ |
| `text`\*                    | `""`     | Suchbegriff  |

### alert(options)

Zeigt ein Fehler-Modal an. Es hat nur die Aktion „Verstanden“.

| Parameter (\* erforderlich) | Standard                                         | Beschreibung       |
| --------------------------- | ------------------------------------------------ | ------------------ |
| `options`                   | `{}`                                             |                    |
| `title`                     | `„Fehler in der Integration „Your Integration““` | Fehlertitel        |
| `message`                   | `""`                                             | Fehlerbeschreibung |
| `note`                      | `""`                                             | Fehlerhinweis      |

### navigate(options)

Navigiert zu einer Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung     |
| --------------------------- | -------- | ---------------- |
| `options`                   | `{}`     |                  |
| `conversationId`            | `""`     | Unterhaltungs-ID |

### on(event, callback, options)

Registriert einen Event-Callback.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                 |
| --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `event`\*                   | `""`     | [Ereignis](#event-main_action) zu registrieren                                                               |
| `callback`\*                |          | Callback-Funktion                                                                                            |
| `options`                   | `{}`     |                                                                                                              |
| `retroaktiv`                | `false`  | Löst den Callback sofort aus, wenn das Ereignis bereits aufgetreten ist, bevor der Callback registriert wird |

### openForm(data)

Zeigt ein Formular-Popup an. Mehrere Formulare können übereinander gestapelt werden.

\=> Promise(Object) — Wird mit Field-Objekten aufgelöst

| Parameter (\* erforderlich) | Standard | Beschreibung                                          |
| --------------------------- | -------- | ----------------------------------------------------- |
| `data`                      | `{}`     |                                                       |
| `name`                      | `""`     | Formulartitel                                         |
| `fields`                    | `[]`     | Array von [FormField](#object-FormField) Objekten     |
| `comments`                  | `[]`     | Array von [FormComment](#object-FormComment) Objekten |
| `notes`                     | `[]`     | Array von [FormNote](#object-FormNote) Objekten       |
| `buttons`                   | `[]`     | Array von [FormButton](#object-FormButton) Objekten   |
| `options`                   | `{}`     |                                                       |
| `autoClose`                 | `true`   | Das Popup beim Absenden schließen                     |

### closeForm()

Schließt das zuletzt geöffnete Formular-Popup.

### openSelf()

Öffnet die Integrations-Seitenleiste, wenn sie geschlossen ist, und wählt die Integration aus.

### closeSelf()

Schließt die Integrations-Seitenleiste, wenn sie geöffnet ist.

### openURL(url)

Öffnet die URL in einem neuen Tab auf dem Desktop. Öffnet sich auf Mobilgeräten je nach Benutzereinstellungen im nativen Browser oder im In-App-Browser.

| Parameter (\* erforderlich) | Standard | Beschreibung |
| --------------------------- | -------- | ------------ |
| `url`\*                     | `""`     | URL-String   |

### openContextMenu(data)

Öffnet ein Kontextmenü

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                                            |
| --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `data`\*                    | `{}`     |                                                                                                                                         |
| `oben`                      | `0`      | Obere Position des Menüs — Das Menü wird unterhalb dieses Punkts angezeigt — Hinweis: nicht festlegen, wenn `data.bottom` angegeben ist |
| `unten`                     | `null`   | Obere Position des Menüs — Das Menü wird oberhalb dieses Punkts angezeigt — Hinweis: nicht festlegen, wenn `data.top` angegeben ist     |
| `links`                     | `0`      | Linke Position des Menüs — Das Menü wird rechts von diesem Punkt angezeigt — Hinweis: nicht festlegen, wenn `data.right` angegeben ist  |
| `rechts`                    | `null`   | Rechte Position des Menüs — Das Menü wird links von diesem Punkt angezeigt — Hinweis: nicht festlegen, wenn `data.left` angegeben ist   |
| `options`\*                 | `[]`     | Array von [Option](#object-Option) Objekten                                                                                             |

### setActions(actions)

Aktionen sind in der gesamten App als Option in Kontextmenüs oder als Wischaktion verfügbar.

| Parameter (\* erforderlich) | Standard | Beschreibung                                |
| --------------------------- | -------- | ------------------------------------------- |
| `Aktionen`                  | `[]`     | Array von [Aktion](#object-Action) Objekten |

### setAsUtility()

Markieren Sie die Integration als Hilfsintegration. Sie zeigt das iframe nicht in der Integrationen-Seitenleiste an. Nützlich für Integrationen, die in Kontextmenüs nur Aktionen anzeigen.

### setBerechtigungen(permissions)

Lassen Sie Missive bestimmte Medienberechtigungen anfragen. Unter macOS erforderlich für Integrationen, die die Verwendung von Kamera oder Mikrofon erfordern. Möglicherweise müssen Sie die Integration neu laden, nachdem Missive Zugriff gewährt wurde.

| Parameter (\* erforderlich) | Standard | Beschreibung                                         |
| --------------------------- | -------- | ---------------------------------------------------- |
| `Berechtigungen`            | `{}`     |                                                      |
| `Kamera`                    | `false`  | Berechtigung anfordern, um die Kamera zu verwenden   |
| `Mikrofon`                  | `false`  | Berechtigung anfordern, um das Mikrofon zu verwenden |

### storeGet(key)

Rufen Sie Daten ab, die zuvor mit `storeSet`. Die Daten bleiben zwischen Seitenneuladungen und App-Neuladungen erhalten.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                     |
| --------------------------- | -------- | -------------------------------------------------------------------------------- |
| `key`\*                     | `""`     | Eine eindeutige Kennung, die beim Speichern der Daten mit `storeSet(key, data)`. |

### storeSet(key, data)

Speichern Sie Daten, die zwischen dem Neuladen von Seiten und dem Neuladen der App konsistent bleiben.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                                        |
| --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `key`\*                     | `""`     | Ein eindeutiger Bezeichner für die zu speichernden Daten. Dieser Schlüssel wird verwendet, um die Daten später mit `storeGet(key)`. |
| `data`\*                    | `{}`     | Die zu speichernden Daten (String, Array oder Object).                                                                              |

Beispiel:

{% code title="example.js" %}

```javascript
const userData = {
  id: '1234',
  name: 'John Doe',
  email: 'john.doe@example.com'
};

Missive.storeSet('userData', userData);

Missive.storeGet('userData')
  .then(data => {
    console.log(data);
  });
```

{% endcode %}

### respondToMessage(data)

Die `respondToMessage` Methode kann verwendet werden, um Befehle an die Befehlsleiste innerhalb der [Aktion](#object-Action) Callback des `command_bar` Kontexts.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                       |
| --------------------------- | -------- | ---------------------------------------------------------------------------------- |
| `data`\*                    | `{}`     |                                                                                    |
| `Befehle`\*                 | `{}`     | Liste der Befehle, die in der Befehlsleiste gerendert werden                       |
| `id`\*                      | `""`     | Eindeutiger Bezeichner des Befehls                                                 |
| `picture`                   | `{}`     | Ein Bild, das neben dem Befehl mithilfe des `Grid-` Layout                         |
| `src`\*                     | `""`     | Pfad zum Bild                                                                      |
| `webp`                      | `""`     | Optionaler WEBP-Bildpfad, der verwendet wird, wenn der Browser ihn unterstützt     |
| `alt`                       | `""`     | Alt-Attribut für das Bild-Tag                                                      |
| `iconUrl`                   | `""`     | Ein Symbol, das neben dem Befehl mithilfe des `Listen-` Layout                     |
| `Label`                     | `""`     | Text, der mit dem Befehl mithilfe des `Listen-` Layout                             |
| `payload`                   | `{}`     | Ein Objekt, das an das Callback-Event vom Typ `execute`                            |
| `closeOnExecute`            | `false`  | Legt fest, ob die Befehlsleiste beim Ausführen des Befehls geschlossen werden soll |

Beispiel:

{% code title="command-bar.js" %}

```javascript
Missive.setActions([
  {
    label: `My command bar action`,
    contexts: ['command_bar'],
    placeholder: "Command Bar's input placeholder",
    callback: async (event, messageId) => {
      if (event.type === 'load') {
        Missive.respondToMessage(messageId, {
          commands: [
            {
              id: 'command-id',
              iconUrl: 'https://via.placeholder.com/64',
              label: 'command-text',
              payload: {},
              closeOnExecute: true,
            },
          ],
        })

        return
      }

      if (event.type === 'search') {
        const commands = searchCommands(event.value)
        Missive.respondToMessage(messageId, { commands })

        return
      }

      if (event.type === 'execute') {
        executeCommand(event.payload)

        return
      }
    },
  },
])
```

{% endcode %}

### initiateCallback(url)

Initiiert einen OAuth-Ablauf, indem die Authentifizierungs-URL in einem neuen Browser-Tab geöffnet wird. Diese Methode hilft dabei, iframe-OAuth-Einschränkungen zu umgehen, und ist mit iOS kompatibel.

\=> Promise(Object) — Wird mit Abfrageparametern aus dem OAuth-Redirect aufgelöst

| Parameter (\* erforderlich) | Standard | Beschreibung                                                             |
| --------------------------- | -------- | ------------------------------------------------------------------------ |
| `url`\*                     | `""`     | Authentifizierungs-endpoint-URL, die einen redirectTo-Parameter empfängt |

Beispiel:

{% code title="oauth.js" %}

```javascript
async function authenticateWithOAuth() {
  try {
    // 1. Initiate OAuth flow
    const response = await Missive.initiateCallback('https://your-auth-endpoint')

    // 2. Response will contain query params from the OAuth redirect
    const { access_token } = response

    // 3. Store the token for future use
    await Missive.storeSet('oauth_token', access_token)
  } catch (error) {
    console.error('OAuth flow failed:', error)
  }
}
```

{% endcode %}

So funktioniert’s:

* Missive öffnet die Authentifizierungs-URL in einem neuen Browser-Tab
* Fügt einen `redirectTo` Parameter zu Ihrer URL hinzu
* Leiten Sie nach Abschluss von OAuth zu der bereitgestellten `redirectTo` URL mit Ihren Token/Daten als Abfrageparameter weiter
* Der Browser-Tab schließt sich automatisch
* Ihre Integration empfängt die Daten im `response` Objekt

## Abruf-Methoden

### fetchConversations(ids)

Ruft die Attribute für die angegebenen Unterhaltungs-IDs ab.

\=> Promise(Array) — Wird mit Conversation-Objekten aufgelöst

| Parameter (\* erforderlich) | Standard | Beschreibung                |
| --------------------------- | -------- | --------------------------- |
| `ids`\*                     | `[]`     | Array von Unterhaltungs-IDs |

Beispiel:

{% code title="fetch-conversations.js" %}

```javascript
Missive.on('change:conversations', (ids) => {
  Missive.fetchConversations(ids).then((conversations) => {
    if (conversations.length != 1) {
      // Nichts tun, wenn mehrere Unterhaltungen ausgewählt sind.
      return
    }

    var message = conversations[0].latest_message
    if (!message || !message.from_field) {
      // Nichts tun, wenn die Unterhaltung keine Nachricht hat (nur Chat-Kommentare) oder wenn
      // die Nachricht kein From-Feld hat.
      return
    }

    var from = message.from_field
    console.log('Nachricht von:', from.name, from.address)
    console.log('Betreff der Nachricht:', message.subject)
  })
})
```

{% endcode %}

Verfügbare Attribute für Unterhaltungen:

```javascript
// Unterhaltung
{
  id: '2b3db130-e94e-43fa-970a-63bae8cb10ee',
  color: '#ff0000',
  subject: „Geheim halten, sicher aufbewahren“,
  Nutzer: [ /* Array of User objects */ ],
  assignees: [ /* Array of User objects */ ],
  authors: [ /* Array of AddressField object */ ],
  messages_count: 1,
  messages: [/* Array of Message object (see below) */],
  latest_message: {
    id: 'daa5e30e-490b-4d54-ba7b-63f19b529ab7',
    from_field: { /* AddressField */ },
    to_fields: [ /* Array of AddressField objects */ ],
    cc_fields: [ /* Array of AddressField objects */ ],
    bcc_fields: [ /* Array of AddressField objects */ ],
    reply_to_fields: [ /* Array of AddressField objects */ ],
    subject: „Geheim halten, sicher aufbewahren“,
    Vorschau: „Wo ist es? --Gandalf“,
    body: '<p>Wo ist es?</p><p>--<br>Gandalf</p>',
    delivered_at: 1550698870,
  },
  Link: 'https://mail.missiveapp.com/#inbox/conversations/37c8d757-2a20-45f6-9aa1-dbe815d27cb0',
}
```

### fetchMessages(ids)

Ruft die Attribute für die angegebenen Nachrichten-IDs ab.

\=> Promise(Array) — Wird mit Message-Objekten aufgelöst

| Parameter (\* erforderlich) | Standard | Beschreibung              |
| --------------------------- | -------- | ------------------------- |
| `ids`\*                     | `[]`     | Array von Nachrichten-IDs |

Verfügbare Attribute für Nachrichten:

```javascript
// Message
{
  id: 'daa5e30e-490b-4d54-ba7b-63f19b529ab7',
  from_field: { /* AddressField */ },
  to_fields: [ /* Array of AddressField objects */ ],
  cc_fields: [ /* Array of AddressField objects */ ],
  bcc_fields: [ /* Array of AddressField objects */ ],
  reply_to_fields: [ /* Array of AddressField objects */ ],
  subject: „Geheim halten, sicher aufbewahren“,
  Vorschau: „Wo ist es? --Gandalf“,
  body: '<p>Wo ist es?</p><p>--<br>Gandalf</p>',
  delivered_at: 1550698870,
}
```

### fetchUsers()

Ruft die Attribute für alle Nutzer ab.

\=> Promise(Array) — Wird mit Nutzer-Objekten aufgelöst

```javascript
// User
{
  id: '6b52b6b9-9b51-46ad-a4e3-82ef3c45512c',
  avatar_url: 'https://gravatar.com/avatar/014bcc1f9c5920c658a198e6649cd20b',
  email: 'frodo@fellowship.org',
  first_name: 'Frodo',
  last_name: 'Baggins',
  display_name: 'Sie',
  me: true,
}
```

### fetchLabels()

Ruft Attribute für alle Geteilte Labels ab.

{% hint style="info" %}
Der Umfang der zurückgegebenen Labels hängt davon ab, wie die Integration installiert wurde. Wenn eine Integration mit einer Organisation geteilt wird, `fetchLabels()` gibt sie Labels nur aus dieser Organisation zurück. Wenn die Integration persönlich (privat) ist, gibt sie Labels aus allen Organisationen zurück, denen der Benutzer angehört. Wenn Sie Labels über mehrere Orgs hinweg benötigen, lassen Sie jeden Benutzer die Integration privat über **Einstellungen > Integrationen** anstatt es auf Organisationsebene zu teilen.
{% endhint %}

\=> Promise(Array) — Wird mit Label-Objekten aufgelöst

```javascript
// Label
{
  avatar_url: "https://…",
  color: "#000"
  description: null
  emoji: null
  id: "93c1010b-8a43-4325-a2af-b3f2d7bedfd3"
  name: "GitHub"
  organization_id: "555abd43-5d6c-426b-bcb0-84180689bc86"
  parent_id: null
  share_with_organization: true
  share_with_team_id: null
  share_with_user_ids: []
  type: "shared_label"
  Sichtbarkeit: "Organisation"
}
```

## Methoden für Unterhaltungen

### createConversation(options)

Erstellt eine neue Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung                                    |
| --------------------------- | -------- | ----------------------------------------------- |
| `options`                   | `{}`     |                                                 |
| `auswählen`                 | `true`   | Zu den neu erstellten Unterhaltungen navigieren |
| `Anzahl`                    | `1`      | Anzahl der zu erstellenden Unterhaltungen       |

### archive()

Archiviert die Aktuelle Unterhaltung.

### trash()

Verschiebt die Aktuelle Unterhaltung in den Papierkorb.

### moveToInbox()

Verschiebt die Aktuelle Unterhaltung in den Posteingang.

### comment(body)

Erstellt einen Kommentar in der Aktuelle Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung          |
| --------------------------- | -------- | --------------------- |
| `body`\*                    | `""`     | Inhalt des Kommentars |

### createTask(body, completed)

Erstellt eine Aufgabe in der Aktuelle Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung                   |
| --------------------------- | -------- | ------------------------------ |
| `body`\*                    | `""`     | Inhalt der Aufgabe             |
| `completed`                 | `false`  | Aufgabe als erledigt markieren |

### addLabels(labelIds)

Fügt der aktuellen Unterhaltung Labels hinzu.

| Parameter (\* erforderlich) | Standard | Beschreibung        |
| --------------------------- | -------- | ------------------- |
| `labelIds`\*                | `[]`     | Array von Label-IDs |

### removeLabels(labelIds)

Entfernt Labels aus der aktuellen Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung        |
| --------------------------- | -------- | ------------------- |
| `labelIds`\*                | `[]`     | Array von Label-IDs |

### close()

Markiert die aktuelle Unterhaltung als erledigt.

### reopen()

Öffnet die aktuelle Unterhaltung wieder.

### assign(userIds)

Weist Nutzer der aktuellen Unterhaltung zu.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                            |
| --------------------------- | -------- | ----------------------------------------------------------------------- |
| `userIds`\*                 | `[]`     | Array von Nutzer-IDs — Leeres Array entfernt alle zugewiesenen Personen |

### addAssignees(userIds)

Fügt der aktuellen Unterhaltung zugewiesene Personen hinzu.

| Parameter (\* erforderlich) | Standard | Beschreibung         |
| --------------------------- | -------- | -------------------- |
| `userIds`\*                 | `[]`     | Array von Nutzer-IDs |

### removeAssignees(userIds)

Entfernt zugewiesene Personen aus der aktuellen Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung         |
| --------------------------- | -------- | -------------------- |
| `userIds`\*                 | `[]`     | Array von Nutzer-IDs |

### setColor(color)

Legt die Farbe der aktuellen Unterhaltung fest.

| Parameter (\* erforderlich) | Standard | Beschreibung        |
| --------------------------- | -------- | ------------------- |
| `color`\*                   | `""`     | Farbe im HEX-Format |

### setDescription(description)

Legt die Beschreibung der aktuellen Unterhaltung fest.

| Parameter (\* erforderlich) | Standard | Beschreibung                  |
| --------------------------- | -------- | ----------------------------- |
| `description`\*             | `""`     | Beschreibung der Unterhaltung |

### setSubject(subject)

Legt den Betreff der aktuellen Unterhaltung fest.

| Parameter (\* erforderlich) | Standard | Beschreibung                                                         |
| --------------------------- | -------- | -------------------------------------------------------------------- |
| `subject`\*                 | `""`     | Betreff der Unterhaltung — Leer oder `null` setzt den Betreff zurück |

## Editor-Methoden

### compose(options)

Erstellt einen neuen Entwurf in einer neuen Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung                                            |
| --------------------------- | -------- | ------------------------------------------------------- |
| `options`                   | `{}`     |                                                         |
| `deliver`                   | `false`  | Den neu erstellten Entwurf sofort senden                |
| `mailto`                    | `{}`     |                                                         |
| `subject`                   | `""`     | Betreff des Entwurfs                                    |
| `body`                      | `""`     | Text des Entwurfs                                       |
| `to_fields`                 | `[]`     | Array von [AddressField](#object-AddressField) Objekten |
| `cc_fields`                 | `[]`     | Array von [AddressField](#object-AddressField) Objekten |
| `bcc_fields`                | `[]`     | Array von [AddressField](#object-AddressField) Objekten |

### composeInConversation()

Erstellt einen neuen Entwurf in der aktuellen Unterhaltung.

Gleiche Parameter wie compose.

### reply(options)

Antwortet auf die letzte Nachricht der aktuellen Unterhaltung.

| Parameter (\* erforderlich) | Standard | Beschreibung                            |
| --------------------------- | -------- | --------------------------------------- |
| `options`                   | `{}`     |                                         |
| `deliver`                   | `false`  | Die neu erstellte Antwort sofort senden |
| `mailto`                    | `{}`     | Siehe oben die Methode compose          |

### forward(options)

Leitet die letzte Nachricht der aktuellen Unterhaltung weiter.

| Parameter (\* erforderlich) | Standard | Beschreibung                                           |
| --------------------------- | -------- | ------------------------------------------------------ |
| `options`                   | `{}`     |                                                        |
| `private`                   | `false`  | Entwurf in einer neuen privaten Unterhaltung erstellen |
| `deliver`                   | `false`  | Den neu erstellten Entwurf sofort senden               |
| `mailto`                    | `{}`     | Siehe oben die Methode compose                         |

### insertText(text)

Fügt Inhalt als Text in den aktuell ausgewählten Editor ein.

| Parameter (\* erforderlich) | Standard | Beschreibung |
| --------------------------- | -------- | ------------ |
| `text`                      | `""`     | Textinhalt   |

### insertHtml(text)

Fügt Inhalt als HTML in den aktuell ausgewählten Editor ein.

| Parameter (\* erforderlich) | Standard | Beschreibung |
| --------------------------- | -------- | ------------ |
| `text`                      | `""`     | HTML-Inhalt  |

## Hilfsmethoden

### isToday(date)

Prüft, ob date heute ist.

\=> Boolean

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                         |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                    |          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Objekt |

### isTomorrow(date)

Prüft, ob date morgen ist.

\=> Boolean

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                         |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                    |          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Objekt |

### isPast(date)

Prüft, ob date in der Vergangenheit liegt.

\=> Boolean

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                         |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                    |          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Objekt |

### isInLessThan(date, options)

Prüft, ob date in weniger als X Stunden / Minuten / Sekunden liegt.

\=> Boolean

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                         |
| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                    |          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Objekt |
| `options`                   | `{}`     |                                                                                                      |
| `Stunden`                   | `0`      | Stunden in der Zukunft                                                                               |
| `Minuten`                   | `0`      | Minuten in der Zukunft                                                                               |
| `Sekunden`                  | `0`      | Sekunden in der Zukunft                                                                              |

### getMonth(index, options)

Gibt den Monatsnamen eines angegebenen Index zurück.

\=> String

| Parameter (\* erforderlich) | Standard | Beschreibung                                       |
| --------------------------- | -------- | -------------------------------------------------- |
| `index`\*                   |          | Index des Monats von 0 bis 11                      |
| `options`                   | `{}`     |                                                    |
| `Kurz`                      | `false`  | Gibt die Kurzform des Monats zurück – also `"Jan"` |

### getEmailAddresses(conversations)

Gibt alle E-Mail-Adressen zurück, die in Unterhaltungen gefunden wurden.

\=> Array(AddressField)

| Parameter (\* erforderlich) | Standard | Beschreibung                                          |
| --------------------------- | -------- | ----------------------------------------------------- |
| `conversations`\*           | `[]`     | Array von [Unterhaltung](#object-Conversation) Objekt |

### getPhoneNumbers(conversations)

Gibt alle Telefonnummern zurück, die in Unterhaltungen gefunden wurden.

\=> Array(PhoneField)

| Parameter (\* erforderlich) | Standard | Beschreibung                                          |
| --------------------------- | -------- | ----------------------------------------------------- |
| `conversations`\*           | `[]`     | Array von [Unterhaltung](#object-Conversation) Objekt |

### formatTimestamp(timestamp, options)

Formatiert den angegebenen Zeitstempel.

\=> { date, formatted }

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                     |
| --------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `timestamp`\*               |          | Unix-Zeitstempel in Sekunden oder Millisekunden – also `1550586350`                              |
| `options`                   | `{}`     |                                                                                                  |
| `heute`                     | `false`  | Zeigt `„Heute“` wenn date heute ist                                                              |
| `morgen`                    | `false`  | Zeigt `„Morgen“` wenn date morgen ist                                                            |
| `Jahr`                      | `false`  | Erzwingt die Anzeige des Jahres – das Jahr wird standardmäßig nicht angezeigt, wenn current year |
| `Zeit`                      | `false`  | Zeigt Stunden und Minuten an                                                                     |
| `bis`                       |          | Unix-Zeitstempel — Wenn das Datum sich über mehrere Tage erstreckt                               |

### formatDate(string, options)

Formatiert das angegebene Datum.

\=> { date, formatted }

| Parameter (\* erforderlich) | Standard | Beschreibung                                           |
| --------------------------- | -------- | ------------------------------------------------------ |
| `string`\*                  | `""`     | Datumszeichenfolge — d. h. `"2018-10-19 17:32:45 GMT"` |
| `options`                   | `{}`     | Siehe die oben genannten Optionen für formatTimestamp  |

### formatContact(contact)

Formatiert den angegebenen Kontakt.

\=> { letters, formatted }

| Parameter (\* erforderlich) | Standard | Beschreibung                                |
| --------------------------- | -------- | ------------------------------------------- |
| `Kontakt`\*                 |          | [AddressField](#object-AddressField) Objekt |

### capitalize(string)

Macht den angegebenen String groß.

\=> String

| Parameter (\* erforderlich) | Standard | Beschreibung                |
| --------------------------- | -------- | --------------------------- |
| `string`\*                  | `""`     | Zu kapitalisierender String |

### classNames(classes)

Konvertiert ein Objekt in CSS-Klassennamen.

\=> String

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                    |
| --------------------------- | -------- | ----------------------------------------------------------------------------------------------- |
| `classes`\*                 | `{}`     | Objekt aus CSS-Klassendefinitionen und -Prüfungen — also `{ foo: true, bar: true, baz: false }` |

### writeToClipboard(text)

Schreiben Sie Text in die Zwischenablage des Benutzers.

| Parameter (\* erforderlich) | Standard | Beschreibung               |
| --------------------------- | -------- | -------------------------- |
| `text`                      | `""`     | Zu kopierende Zeichenkette |

## Ereignisse

### main\_action

Wird ausgelöst, wenn der Benutzer das Tastenkürzel „Integrationen main action“ drückt.

\=> ()

### message\_sent

Wird ausgelöst, wenn ein Benutzer eine Nachricht sendet oder wenn eine Nachricht zur Sendung geplant ist. Seien Sie vorsichtig, denn sobald es ausgelöst wurde, kann der Benutzer die Zustellung der Nachricht innerhalb kurzer Zeit noch abbrechen (Rückgängig).

\=> (id)

| Payload | Beschreibung                                                                           |
| ------- | -------------------------------------------------------------------------------------- |
| `id`    | Verwenden [fetchMessages](#method-fetchMessages) um die Daten der Nachricht abzurufen. |

### change:conversations

Wird ausgelöst, wenn sich die ausgewählten Unterhaltungen ändern.

\=> (IDs)

| Payload | Beschreibung                                                                                                                                                 |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ids`   | Array der ausgewählten Unterhaltungs-IDs. Verwenden [fetchConversations](#method-fetchConversations) um die Daten neu ausgewählter Unterhaltungen abzurufen. |

### change:Nutzer

Ausgelöst, wenn Nutzer geändert werden.

\=> ()

Verwenden [fetchUsers](#method-fetchUsers) um Nutzerdaten abzurufen.

## Glossar

### Aktion

`{ label: 'Neue Aufgabe', callback: () => {} }`

`{ label: 'Weiterleiten', contexts: ['message'], callback: () => {} }`

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contexts`                  | `[]`     | Kontexte, in denen die Aktion in der Missive-Benutzeroberfläche verfügbar ist. Einer der `draft, conversations, conversation, message, tel, comment, comment_box, swipe, command_bar, setting` — Alle, wenn weggelassen.                                                                                                                                                                                                                                                                                                                |
| `Label`\*                   | `""`     | Aktionsname                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `Emoji`                     | `""`     | Emoji-ID des Emojis, das in der Missive-Oberfläche als Aktionssymbol verwendet wird. Sie finden die ID eines bestimmten Emojis auf dieser [Seite](https://missiveapp.com/open/emoji-mart). Zum Beispiel ist für dieses 🧹 Emoji die ID `:broom:`.                                                                                                                                                                                                                                                                                       |
| `swipe_id`                  | `""`     | Eindeutiger String pro Wischaktion — also `new-task` — *Erforderlich für `swipe` Kontext*                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `callback`\*                | `null`   | Callback der Aktion — Empfängt ein Objekt mit entweder `conversations, conversation, message, tel, comment, comment_box` als Schlüssel, je nachdem, in welchem Kontext die Aktion ausgelöst wurde. Callbacks für den `command_bar` Kontext nehmen ein `event` Objekt mit entweder einem `load, search, execute` Typ sowie einer `messageId`. Der Callback kann verwendet werden, um Befehle zu senden, die in der Command Bar angezeigt werden. Weitere Details finden Sie in der [respondToMessage](#method-respondToMessage) Methode. |
| `swipe_color`               | `"#aaa"` | Hintergrundfarbe der Wischaktion                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `Layout`                    | `"list"` | Das Layout der Befehle in der Command Bar bei Verwendung des `command_bar` Kontexts. Es kann entweder `Listen-` oder `Grid-`.                                                                                                                                                                                                                                                                                                                                                                                                           |
| `placeholder`               | `""`     | Platzhalter der Eingabe der Command Bar                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

### AddressField

`{ address: 'frodo@missiveapp.com', name: 'Frodo Baggins' }`

`{ address: 'sam@missiveapp.com' }`

| Parameter (\* erforderlich) | Standard | Beschreibung   |
| --------------------------- | -------- | -------------- |
| `address`\*                 | `""`     | E-Mail-Adresse |
| `name`                      | `""`     | Kontaktname    |

### FormField

`{ type: 'input', data: { … }, options: { … } }`

`{ type: 'calendar', data: { … } }`

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                                                                                |
| --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`\*                    | `""`     | Feldtyp — Einer von `input, textarea, select, calendar, duration, progress, html`                                                                                           |
| `scope`                     | `{}`     | Filtert Felder dynamisch heraus, die diesem Umfang nicht entsprechen — also `{ project_id: 12345 }` — Würde dieses Feld nur anzeigen, wenn **Projekt 12345** ausgewählt ist |
| `data`\*                    | `{}`     | Daten für alle Typen verfügbar — Siehe folgendes `FormField(type:)` für bestimmte Datentypen                                                                                |
| `name`\*                    | `""`     | Name des Feldes — Wie Sie es normalerweise innerhalb eines `<form>`                                                                                                         |
| `value`\*                   | `""`     | Standardwert des Feldes                                                                                                                                                     |
| `placeholder`\*             | `""`     | Platzhalter des Feldes                                                                                                                                                      |
| `required`                  | `false`  | Das Formular kann erst gesendet werden, wenn der Benutzer dieses Feld ausfüllt                                                                                              |

FormField(type:input)

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                          |
| --------------------------- | -------- | ------------------------------------------------------------------------------------- |
| `data`                      | `{}`     |                                                                                       |
| `type`\*                    | `{}`     | Eingabetyp — Einer von `text, number, hidden`                                         |
| `focus`                     | `false`  | Das Eingabefeld automatisch fokussieren                                               |
| `disabled`                  | `false`  | Das Eingabefeld nicht bearbeitbar machen                                              |
| `precision`                 |          | Zahl auf eine bestimmte Genauigkeit formatieren — Für `number` nur für den Eingabetyp |
| `options`                   | `{}`     |                                                                                       |
| `prefix`                    | `false`  | Den Platzhalter immer sichtbar machen                                                 |
| `thin`                      | `false`  | Ein kleineres Eingabefeld rendern — Für `text` nur für den Eingabetyp                 |

FormField(type:textarea)

| Parameter (\* erforderlich) | Standard | Beschreibung                            |
| --------------------------- | -------- | --------------------------------------- |
| `data`                      | `{}`     |                                         |
| `rows`                      | `4`      | Anzahl sichtbarer Zeilen                |
| `focus`                     | `false`  | Den Textbereich automatisch fokussieren |

FormField(type:select)

| Parameter (\* erforderlich) | Standard | Beschreibung                                |
| --------------------------- | -------- | ------------------------------------------- |
| `data`                      | `{}`     |                                             |
| `value`                     |          | Wert der ausgewählten Option                |
| `options`                   | `[]`     | Array von [Option](#object-Option) Objekten |
| `multiple`                  | `false`  | Das Auswählen mehrerer Optionen zulassen    |

FormField(type:calendar)

| Parameter (\* erforderlich) | Standard                 | Beschreibung                                                                            |
| --------------------------- | ------------------------ | --------------------------------------------------------------------------------------- |
| `data`                      | `{}`                     |                                                                                         |
| `value`                     | `{ timestamp, all_day }` | Unix-Zeitstempel und boolescher Wert — z. B. `{ timestamp: 1550586350, all_day: true }` |
| `allow_past`                | `false`                  | Das Festlegen eines Datums in der Vergangenheit zulassen                                |
| `allow_all_day`             | `false`                  | Das Festlegen eines ganztägigen Datums zulassen                                         |

FormField(type:duration)

| Parameter (\* erforderlich) | Standard | Beschreibung                            |
| --------------------------- | -------- | --------------------------------------- |
| `data`                      | `{}`     |                                         |
| `value`                     | `""`     | Dauer im Format HH:MM — z. B. `"00:30"` |

FormField(type:progress)

| Parameter (\* erforderlich) | Standard | Beschreibung                               |
| --------------------------- | -------- | ------------------------------------------ |
| `data`                      | `{}`     |                                            |
| `value`                     |          | Wert des ausgewählten Schritts             |
| `steps`                     | `[]`     | Array von [Schritt](#object-Step) Objekten |

FormField(type:html)

| Parameter (\* erforderlich) | Standard | Beschreibung                                                                                                                  |
| --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `data`                      | `{}`     |                                                                                                                               |
| `value`                     | `""`     | HTML-String — z. B. `"<br> <p>Hallo <b>zusammen</b>!</p><br> <p>Wie geht es Ihnen <span style="color: red">?</span></p><br>"` |

### FormComment

Beispiel:

```javascript
{
  content: 'Ich werde den Ring nehmen, obwohl ich den Weg nicht kenne.',
  authorName: 'Frodo Baggins',
  authorAvatar: 'https://gravatar.com/avatar/014bcc1f9c5920c658a198e6649cd20b',
}
```

| Parameter (\* erforderlich) | Standard | Beschreibung                                                       |
| --------------------------- | -------- | ------------------------------------------------------------------ |
| `content`\*                 | `""`     | Kommentartext                                                      |
| `authorAvatar`              | `""`     | Avatar-URL des Autors                                              |
| `authorName`                | `""`     | Name des Autors                                                    |
| `date`                      | `""`     | Datumsstring mit einem Format Ihrer Wahl — z. B. `"18. Feb. 2019"` |

### FormNote

Beispiele:

```javascript
{ message: '✓ Am 18. Feb. erledigt' }
{ message: 'In Missive ansehen', url: 'https://missiveapp.com' }
```

| Parameter (\* erforderlich) | Standard | Beschreibung                                   |
| --------------------------- | -------- | ---------------------------------------------- |
| `message`\*                 | `""`     | Notiztext                                      |
| `url`                       | `""`     | Die Notiz in einen anklickbaren Link umwandeln |

### FormButton

Beispiele:

```javascript
{ type: 'cancel', label: 'Abbrechen' }
{ type: 'submit', label: 'Erstellen' }
```

| Parameter (\* erforderlich) | Standard | Beschreibung                                  |
| --------------------------- | -------- | --------------------------------------------- |
| `type`\*                    | `""`     | Schaltflächentyp — Einer von `submit, cancel` |
| `Label`                     | `""`     | Schaltflächenbeschriftung                     |

### Option

Beispiele:

```javascript
{ label: 'Mein Projekt', value: 12345 }
{ label: 'Mein Label', value: 54321, color: '#F00' }
```

| Parameter (\* erforderlich) | Standard | Beschreibung                                                    |
| --------------------------- | -------- | --------------------------------------------------------------- |
| `Label`\*                   | `""`     | Beschriftung der Option                                         |
| `value`\*                   | `""`     | Optionswert                                                     |
| `disabled`                  | `false`  | Die Option nicht anklickbar machen                              |
| `color`                     | `""`     | Farbe im HEX-Format — Der Option eine Farbmarkierung hinzufügen |
| `colorRadius`               | `"100%"` | Den Radius der Farbmarkierung angeben                           |
| `callback`                  | `null`   | Options-Callback — Für `openContextMenu` options                |

### PhoneField

Beispiele:

```javascript
{ phoneNumber: '+11231231234', name: 'Frodo Baggins' }
{ phoneNumber: '+11231231234' }
```

| Parameter (\* erforderlich) | Standard | Beschreibung  |
| --------------------------- | -------- | ------------- |
| `phoneNumber`\*             | `""`     | Telefonnummer |
| `name`                      | `""`     | Kontaktname   |

### Schritt

Beispiele:

```javascript
{ label: 'In Bearbeitung', value: 1 }
{ label: 'Erledigt', value: 2 }
```

| Parameter (\* erforderlich) | Standard | Beschreibung        |
| --------------------------- | -------- | ------------------- |
| `Label`\*                   | `""`     | Schrittbeschriftung |
| `value`\*                   | `""`     | Schrittwert         |

***

## Verwandte Anleitungen

* [⚙️ Benutzerdefinierte Kanäle](https://missiveapp.com/docs/developers/de/custom-channels.md)

Benötigen Sie genauere Antworten? [Kontakt](https://missiveapp.com/docs/developers/de/contact.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://missiveapp.com/docs/developers/de/ui-iframe-integrations/javascript-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
