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.
text*
""
Suchbegriff
alert(options)
Zeigt ein Fehler-Modal an. Es hat nur die Aktion „Verstanden“.
options
{}
title
„Fehler in der Integration „Your Integration““
Fehlertitel
message
""
Fehlerbeschreibung
note
""
Fehlerhinweis
navigate(options)
Navigiert zu einer Unterhaltung.
options
{}
conversationId
""
Unterhaltungs-ID
on(event, callback, options)
Registriert einen Event-Callback.
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
data
{}
name
""
Formulartitel
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.
url*
""
URL-String
openContextMenu(data)
Öffnet ein Kontextmenü
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
setActions(actions)
Aktionen sind in der gesamten App als Option in Kontextmenüs oder als Wischaktion verfügbar.
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.
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.
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.
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:
respondToMessage(data)
Die respondToMessage Methode kann verwendet werden, um Befehle an die Befehlsleiste innerhalb der Aktion Callback des command_bar Kontexts.
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:
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
url*
""
Authentifizierungs-endpoint-URL, die einen redirectTo-Parameter empfängt
Beispiel:
So funktioniert’s:
Missive öffnet die Authentifizierungs-URL in einem neuen Browser-Tab
Fügt einen
redirectToParameter zu Ihrer URL hinzuLeiten Sie nach Abschluss von OAuth zu der bereitgestellten
redirectToURL mit Ihren Token/Daten als Abfrageparameter weiterDer Browser-Tab schließt sich automatisch
Ihre Integration empfängt die Daten im
responseObjekt
Abruf-Methoden
fetchConversations(ids)
Ruft die Attribute für die angegebenen Unterhaltungs-IDs ab.
=> Promise(Array) — Wird mit Conversation-Objekten aufgelöst
ids*
[]
Array von Unterhaltungs-IDs
Beispiel:
Verfügbare Attribute für Unterhaltungen:
fetchMessages(ids)
Ruft die Attribute für die angegebenen Nachrichten-IDs ab.
=> Promise(Array) — Wird mit Message-Objekten aufgelöst
ids*
[]
Array von Nachrichten-IDs
Verfügbare Attribute für Nachrichten:
fetchUsers()
Ruft die Attribute für alle Nutzer ab.
=> Promise(Array) — Wird mit Nutzer-Objekten aufgelöst
fetchLabels()
Ruft Attribute für alle Geteilte Labels ab.
=> Promise(Array) — Wird mit Label-Objekten aufgelöst
Methoden für Unterhaltungen
createConversation(options)
Erstellt eine neue Unterhaltung.
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.
body*
""
Inhalt des Kommentars
createTask(body, completed)
Erstellt eine Aufgabe in der Aktuelle Unterhaltung.
body*
""
Inhalt der Aufgabe
completed
false
Aufgabe als erledigt markieren
addLabels(labelIds)
Fügt der aktuellen Unterhaltung Labels hinzu.
labelIds*
[]
Array von Label-IDs
removeLabels(labelIds)
Entfernt Labels aus der aktuellen Unterhaltung.
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.
userIds*
[]
Array von Nutzer-IDs — Leeres Array entfernt alle zugewiesenen Personen
addAssignees(userIds)
Fügt der aktuellen Unterhaltung zugewiesene Personen hinzu.
userIds*
[]
Array von Nutzer-IDs
removeAssignees(userIds)
Entfernt zugewiesene Personen aus der aktuellen Unterhaltung.
userIds*
[]
Array von Nutzer-IDs
setColor(color)
Legt die Farbe der aktuellen Unterhaltung fest.
color*
""
Farbe im HEX-Format
setDescription(description)
Legt die Beschreibung der aktuellen Unterhaltung fest.
description*
""
Beschreibung der Unterhaltung
setSubject(subject)
Legt den Betreff der aktuellen Unterhaltung fest.
subject*
""
Betreff der Unterhaltung — Leer oder null setzt den Betreff zurück
Editor-Methoden
compose(options)
Erstellt einen neuen Entwurf in einer neuen Unterhaltung.
options
{}
deliver
false
Den neu erstellten Entwurf sofort senden
mailto
{}
subject
""
Betreff des Entwurfs
body
""
Text des Entwurfs
composeInConversation()
Erstellt einen neuen Entwurf in der aktuellen Unterhaltung.
Gleiche Parameter wie compose.
reply(options)
Antwortet auf die letzte Nachricht der aktuellen Unterhaltung.
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.
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.
text
""
Textinhalt
insertHtml(text)
Fügt Inhalt als HTML in den aktuell ausgewählten Editor ein.
text
""
HTML-Inhalt
Hilfsmethoden
isToday(date)
Prüft, ob date heute ist.
=> Boolean
isTomorrow(date)
Prüft, ob date morgen ist.
=> Boolean
isPast(date)
Prüft, ob date in der Vergangenheit liegt.
=> Boolean
isInLessThan(date, options)
Prüft, ob date in weniger als X Stunden / Minuten / Sekunden liegt.
=> Boolean
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
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)
getPhoneNumbers(conversations)
Gibt alle Telefonnummern zurück, die in Unterhaltungen gefunden wurden.
=> Array(PhoneField)
formatTimestamp(timestamp, options)
Formatiert den angegebenen Zeitstempel.
=> { date, formatted }
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 }
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 }
capitalize(string)
Macht den angegebenen String groß.
=> String
string*
""
Zu kapitalisierender String
classNames(classes)
Konvertiert ein Objekt in CSS-Klassennamen.
=> String
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.
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)
id
Verwenden fetchMessages um die Daten der Nachricht abzurufen.
change:conversations
Wird ausgelöst, wenn sich die ausgewählten Unterhaltungen ändern.
=> (IDs)
ids
Array der ausgewählten Unterhaltungs-IDs. Verwenden fetchConversations um die Daten neu ausgewählter Unterhaltungen abzurufen.
change:Nutzer
Ausgelöst, wenn Nutzer geändert werden.
=> ()
Verwenden fetchUsers um Nutzerdaten abzurufen.
Glossar
Aktion
{ label: 'Neue Aufgabe', callback: () => {} }
{ label: 'Weiterleiten', contexts: ['message'], callback: () => {} }
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. 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 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' }
address*
""
E-Mail-Adresse
name
""
Kontaktname
FormField
{ type: 'input', data: { … }, options: { … } }
{ type: 'calendar', data: { … } }
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)
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)
data
{}
rows
4
Anzahl sichtbarer Zeilen
focus
false
Den Textbereich automatisch fokussieren
FormField(type:select)
data
{}
value
Wert der ausgewählten Option
multiple
false
Das Auswählen mehrerer Optionen zulassen
FormField(type:calendar)
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)
data
{}
value
""
Dauer im Format HH:MM — z. B. "00:30"
FormField(type:progress)
FormField(type:html)
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:
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:
message*
""
Notiztext
url
""
Die Notiz in einen anklickbaren Link umwandeln
FormButton
Beispiele:
type*
""
Schaltflächentyp — Einer von submit, cancel
Label
""
Schaltflächenbeschriftung
Option
Beispiele:
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:
phoneNumber*
""
Telefonnummer
name
""
Kontaktname
Schritt
Beispiele:
Label*
""
Schrittbeschriftung
value*
""
Schrittwert
Verwandte Anleitungen
Benötigen Sie genauere Antworten? Kontakt
Zuletzt aktualisiert