> 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/fr/ui-iframe-integrations/javascript-api.md).

# API JavaScript

Référence complète de l’API JavaScript pour les Intégrations iFrame Missive : méthodes, événements et objets.

## Méthodes de l’application

### reload()

Recharge l’iframe.

### search(text)

Lance une nouvelle recherche.

| Paramètre (\* obligatoire) | Par défaut | Description        |
| -------------------------- | ---------- | ------------------ |
| `text`\*                   | `""`       | Terme de recherche |

### alert(options)

Affiche une fenêtre modale d’erreur. Elle n’a qu’une action « J’ai compris ».

| Paramètre (\* obligatoire) | Par défaut                                       | Description             |
| -------------------------- | ------------------------------------------------ | ----------------------- |
| `options`                  | `{}`                                             |                         |
| `titre`                    | `Erreur dans l’intégration « Your Integration »` | Titre de l’erreur       |
| `message`                  | `""`                                             | Description de l’erreur |
| `note`                     | `""`                                             | Note d’erreur           |

### navigate(options)

Navigue vers une conversation.

| Paramètre (\* obligatoire) | Par défaut | Description        |
| -------------------------- | ---------- | ------------------ |
| `options`                  | `{}`       |                    |
| `conversationId`           | `""`       | ID de conversation |

### on(event, callback, options)

Enregistre une fonction de rappel d’événement.

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                            |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------ |
| `event`\*                  | `""`       | [Événement](#event-main_action) à enregistrer                                                          |
| `callback`\*               |            | Fonction de rappel                                                                                     |
| `options`                  | `{}`       |                                                                                                        |
| `rétroactif`               | `false`    | Déclenche le callback immédiatement si l’événement s’est produit avant que le callback soit enregistré |

### openForm(data)

Affiche une fenêtre contextuelle de formulaire. Plusieurs formulaires peuvent être empilés les uns sur les autres.

\=> Promise(Object) — Se résout avec des objets Field

| Paramètre (\* obligatoire) | Par défaut | Description                                          |
| -------------------------- | ---------- | ---------------------------------------------------- |
| `data`                     | `{}`       |                                                      |
| `name`                     | `""`       | Titre du formulaire                                  |
| `champs`                   | `[]`       | Tableau de [FormField](#object-FormField) objets     |
| `comments`                 | `[]`       | Tableau de [FormComment](#object-FormComment) objets |
| `notes`                    | `[]`       | Tableau de [FormNote](#object-FormNote) objets       |
| `buttons`                  | `[]`       | Tableau de [FormButton](#object-FormButton) objets   |
| `options`                  | `{}`       |                                                      |
| `autoClose`                | `true`     | Ferme la fenêtre contextuelle lors de l’envoi        |

### closeForm()

Ferme la dernière fenêtre contextuelle de formulaire ouverte.

### openSelf()

Ouvre la barre latérale de l’intégration si elle est fermée et sélectionne l’intégration.

### closeSelf()

Ferme la barre latérale de l’intégration si elle est ouverte.

### openURL(url)

Ouvre l’URL dans un nouvel onglet sur ordinateur. Ouvre dans le navigateur natif ou dans le navigateur intégré à l’application selon les paramètres utilisateur sur mobile.

| Paramètre (\* obligatoire) | Par défaut | Description |
| -------------------------- | ---------- | ----------- |
| `url`\*                    | `""`       | Chaîne URL  |

### openContextMenu(data)

Ouvre un menu contextuel

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                                                     |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `data`\*                   | `{}`       |                                                                                                                                 |
| `top`                      | `0`        | Position supérieure du menu — Le Menu apparaîtra en dessous de ce point — Remarque : ne pas définir si `data.bottom` est fourni |
| `bottom`                   | `null`     | Position supérieure du menu — Le Menu apparaîtra au-dessus de ce point — Remarque : ne pas définir si `data.top` est fourni     |
| `left`                     | `0`        | Position gauche du menu — Le Menu apparaîtra à droite de ce point — Remarque : ne pas définir si `data.right` est fourni        |
| `right`                    | `null`     | Position droite du menu — Le Menu apparaîtra à gauche de ce point — Remarque : ne pas définir si `data.left` est fourni         |
| `options`\*                | `[]`       | Tableau de [Option](#object-Option) objets                                                                                      |

### setActions(actions)

Les actions sont disponibles dans toute l’application comme option dans les menus contextuels ou via une action de balayage.

| Paramètre (\* obligatoire) | Par défaut | Description                                |
| -------------------------- | ---------- | ------------------------------------------ |
| `actions`                  | `[]`       | Tableau de [Action](#object-Action) objets |

### setAsUtility()

Marque l’intégration comme une intégration utilitaire. Elle n’affichera pas l’iframe dans la barre latérale de l’intégration. Utile pour les intégrations qui n’affichent des actions que dans les menus contextuels.

### setPermissions(permissions)

Demande à Missive certaines autorisations multimédias. Requis sur macOS pour les intégrations qui nécessitent l’utilisation de la caméra ou du microphone. Vous devrez peut-être recharger l’intégration une fois que Missive aura obtenu l’accès.

| Paramètre (\* obligatoire) | Par défaut | Description                                      |
| -------------------------- | ---------- | ------------------------------------------------ |
| `permissions`              | `{}`       |                                                  |
| `camera`                   | `false`    | Demander l’autorisation d’utiliser la caméra     |
| `microphone`               | `false`    | Demander l’autorisation d’utiliser le microphone |

### storeGet(key)

Récupère les données qui ont été stockées précédemment à l’aide de `storeSet`. Les données persistent entre les rechargements de la page et de l’application.

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                   |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------- |
| `key`\*                    | `""`       | Un identifiant unique utilisé lors du stockage des données à l’aide de `storeSet(key, data)`. |

### storeSet(key, data)

Stocke les données qui persistent entre les rechargements de la page et de l’application.

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                                                                |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `key`\*                    | `""`       | Un identifiant unique pour les données à stocker. Cette clé est utilisée pour récupérer les données plus tard à l’aide de `storeGet(key)`. |
| `data`\*                   | `{}`       | Les données (String, Array ou Object) à stocker.                                                                                           |

Exemple d’utilisation :

{% 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)

Le `respondToMessage` méthode peut être utilisée pour envoyer des commandes à la Command Bar dans le [Action](#object-Action) callback du `command_bar` contexte.

| Paramètre (\* obligatoire) | Par défaut | Description                                                                     |
| -------------------------- | ---------- | ------------------------------------------------------------------------------- |
| `data`\*                   | `{}`       |                                                                                 |
| `commands`\*               | `{}`       | Liste des commandes affichées dans la barre de commandes                        |
| `id`\*                     | `""`       | Identifiant unique de la commande                                               |
| `picture`                  | `{}`       | Une image affichée à côté de la commande à l’aide de la `grid` disposition      |
| `src`\*                    | `""`       | Chemin vers l’image                                                             |
| `webp`                     | `""`       | Chemin d’image WEBP facultatif utilisé lorsque le navigateur le prend en charge |
| `alt`                      | `""`       | Attribut alt de la balise image                                                 |
| `iconUrl`                  | `""`       | Icône affichée à côté de la commande à l’aide de la `list` disposition          |
| `libellé`                  | `""`       | Texte affiché avec la commande à l’aide de la `list` disposition                |
| `payload`                  | `{}`       | Un objet renvoyé au callback de l’événement de type `execute`                   |
| `closeOnExecute`           | `false`    | Indique si la Command Bar doit se fermer lorsque la commande est exécutée       |

Exemple d’utilisation :

{% 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)

Lance un flux OAuth en ouvrant l’URL d’authentification dans un nouvel onglet de navigateur. Cette méthode aide à contourner les limitations OAuth de l’iframe et est compatible avec iOS.

\=> Promise(Object) — Se résout avec les paramètres de requête de la redirection OAuth

| Paramètre (\* obligatoire) | Par défaut | Description                                                            |
| -------------------------- | ---------- | ---------------------------------------------------------------------- |
| `url`\*                    | `""`       | URL du endpoint d’authentification qui recevra un paramètre redirectTo |

Exemple d’utilisation :

{% 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 %}

Fonctionnement :

* Missive ouvre l’URL d’authentification dans un nouvel onglet de navigateur
* Ajoute un `redirectTo` paramètre à votre URL
* Après la fin de l’OAuth, redirige vers la `redirectTo` URL avec vos jetons/données comme paramètres de requête
* L’onglet du navigateur se ferme automatiquement
* Votre intégration reçoit les données dans le `response` objet

## Méthodes de récupération

### fetchConversations(ids)

Récupère les attributs des ID de conversation fournis.

\=> Promise(Array) — Se résout avec des objets Conversation

| Paramètre (\* obligatoire) | Par défaut | Description                  |
| -------------------------- | ---------- | ---------------------------- |
| `ids`\*                    | `[]`       | Tableau d’ID de conversation |

Exemple d’utilisation :

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

```javascript
Missive.on('change:conversations', (ids) => {
  Missive.fetchConversations(ids).then((conversations) => {
    if (conversations.length != 1) {
      // Ne rien faire si plusieurs conversations sont sélectionnées.
      return
    }

    var message = conversations[0].latest_message
    if (!message || !message.from_field) {
      // Ne rien faire si la conversation n’a aucun message (seulement des commentaires de chat) ou si
      // le message n’a pas de champ From.
      return
    }

    var from = message.from_field
    console.log('Message de :', from.name, from.address)
    console.log('Objet du message :', message.subject)
  })
})
```

{% endcode %}

Attributs disponibles pour les conversations :

```javascript
// Conversation
{
  id: '2b3db130-e94e-43fa-970a-63bae8cb10ee',
  color: '#ff0000',
  subject: « Garde-le secret, garde-le en sécurité »,
  users: [ /* Array of User objects */ ],
  assignees: [ /* Array of User objects */ ],
  authors: [ /* Array of AddressField object */ ],
  messages_count: 1,
  messages: [/* Tableau d’objets Message (voir ci-dessous) */],
  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: « Garde-le secret, garde-le en sécurité »,
    preview: 'Where is it? --Gandalf',
    body: '<p>Where is it?</p><p>--<br>Gandalf</p>',
    delivered_at: 1550698870,
  },
  link: 'https://mail.missiveapp.com/#inbox/conversations/37c8d757-2a20-45f6-9aa1-dbe815d27cb0',
}
```

### fetchMessages(ids)

Récupère les attributs pour les identifiants de message donnés.

\=> Promise(Array) — Se résout avec des objets Message

| Paramètre (\* obligatoire) | Par défaut | Description                       |
| -------------------------- | ---------- | --------------------------------- |
| `ids`\*                    | `[]`       | Tableau d’identifiants de message |

Attributs disponibles pour les messages :

```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: « Garde-le secret, garde-le en sécurité »,
  preview: 'Where is it? --Gandalf',
  body: '<p>Where is it?</p><p>--<br>Gandalf</p>',
  delivered_at: 1550698870,
}
```

### fetchUsers()

Récupère les attributs de tous les utilisateurs.

\=> Promise(Array) — Se résout avec des objets Utilisateur

```javascript
// Utilisateur
{
  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: 'Vous',
  me: true,
}
```

### fetchLabels()

Récupère les attributs de tous les libellés partagés.

{% hint style="info" %}
Le périmètre des libellés renvoyés dépend de la manière dont l’intégration est installée. Lorsqu’une intégration est partagée avec une Organisation, `fetchLabels()` elle renvoie uniquement les libellés de cette Organisation. Lorsque l’intégration est personnelle (privée), elle renvoie les libellés de toutes les Organisations auxquelles l’utilisateur appartient. Si vous avez besoin de libellés sur plusieurs organisations, faites installer l’intégration en privé par chaque utilisateur via **Paramètres > Intégrations** au lieu de le partager au niveau de l’organisation.
{% endhint %}

\=> Promise(Array) — Se résout avec des objets Label

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

## Méthodes de conversation

### createConversation(options)

Crée une nouvelle conversation.

| Paramètre (\* obligatoire) | Par défaut | Description                                           |
| -------------------------- | ---------- | ----------------------------------------------------- |
| `options`                  | `{}`       |                                                       |
| `sélectionner`             | `true`     | Accédez à la ou aux conversations nouvellement créées |
| `nombre`                   | `1`        | Nombre de conversations à créer                       |

### archive()

Archive la conversation actuelle.

### trash()

Met la conversation actuelle à la corbeille.

### moveToInbox()

Déplace la conversation actuelle vers la boîte de réception.

### comment(body)

Crée un commentaire dans la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description            |
| -------------------------- | ---------- | ---------------------- |
| `body`\*                   | `""`       | Contenu du commentaire |

### createTask(body, completed)

Crée une tâche dans la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                     |
| -------------------------- | ---------- | ------------------------------- |
| `body`\*                   | `""`       | Contenu de la tâche             |
| `completed`                | `false`    | Marquer la tâche comme terminée |

### addLabels(labelIds)

Ajoute des libellés à la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                        |
| -------------------------- | ---------- | ---------------------------------- |
| `labelIds`\*               | `[]`       | Tableau d’identifiants de libellés |

### removeLabels(labelIds)

Supprime des libellés de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                        |
| -------------------------- | ---------- | ---------------------------------- |
| `labelIds`\*               | `[]`       | Tableau d’identifiants de libellés |

### close()

Termine la conversation actuelle.

### reopen()

Rouvre la conversation actuelle.

### assign(userIds)

Assigne des utilisateurs à la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                                                                            |
| -------------------------- | ---------- | -------------------------------------------------------------------------------------- |
| `userIds`\*                | `[]`       | Tableau d’identifiants d’utilisateurs — Un tableau vide supprime tous les responsables |

### addAssignees(userIds)

Ajoute des responsables à la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                           |
| -------------------------- | ---------- | ------------------------------------- |
| `userIds`\*                | `[]`       | Tableau d’identifiants d’utilisateurs |

### removeAssignees(userIds)

Supprime des responsables de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                           |
| -------------------------- | ---------- | ------------------------------------- |
| `userIds`\*                | `[]`       | Tableau d’identifiants d’utilisateurs |

### setColor(color)

Définit la couleur de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description           |
| -------------------------- | ---------- | --------------------- |
| `color`\*                  | `""`       | Couleur au format HEX |

### setDescription(description)

Définit la description de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                    |
| -------------------------- | ---------- | ------------------------------ |
| `description`\*            | `""`       | Description de la conversation |

### setSubject(subject)

Définit le sujet de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                                                     |
| -------------------------- | ---------- | --------------------------------------------------------------- |
| `subject`\*                | `""`       | Sujet de la conversation — Vide ou `null` réinitialise le sujet |

## Méthodes de Rédaction

### compose(options)

Crée un nouveau brouillon dans une nouvelle conversation.

| Paramètre (\* obligatoire) | Par défaut | Description                                            |
| -------------------------- | ---------- | ------------------------------------------------------ |
| `options`                  | `{}`       |                                                        |
| `deliver`                  | `false`    | Envoie immédiatement le brouillon nouvellement créé    |
| `mailto`                   | `{}`       |                                                        |
| `subject`                  | `""`       | Sujet du brouillon                                     |
| `body`                     | `""`       | Corps du brouillon                                     |
| `to_fields`                | `[]`       | Tableau de [AddressField](#object-AddressField) objets |
| `cc_fields`                | `[]`       | Tableau de [AddressField](#object-AddressField) objets |
| `bcc_fields`               | `[]`       | Tableau de [AddressField](#object-AddressField) objets |

### composeInConversation()

Crée un nouveau brouillon dans la conversation actuelle.

Mêmes paramètres que compose.

### reply(options)

Répond au dernier message de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                                        |
| -------------------------- | ---------- | -------------------------------------------------- |
| `options`                  | `{}`       |                                                    |
| `deliver`                  | `false`    | Envoie immédiatement la réponse nouvellement créée |
| `mailto`                   | `{}`       | Voir la méthode compose ci-dessus                  |

### forward(options)

Transfère le dernier message de la conversation actuelle.

| Paramètre (\* obligatoire) | Par défaut | Description                                              |
| -------------------------- | ---------- | -------------------------------------------------------- |
| `options`                  | `{}`       |                                                          |
| `private`                  | `false`    | Créer un brouillon dans une nouvelle conversation privée |
| `deliver`                  | `false`    | Envoie immédiatement le brouillon nouvellement créé      |
| `mailto`                   | `{}`       | Voir la méthode compose ci-dessus                        |

### insertText(text)

Insère le contenu sous forme de texte dans la Rédaction actuellement sélectionnée.

| Paramètre (\* obligatoire) | Par défaut | Description   |
| -------------------------- | ---------- | ------------- |
| `text`                     | `""`       | Contenu texte |

### insertHtml(text)

Insère le contenu sous forme de HTML dans la Rédaction actuellement sélectionnée.

| Paramètre (\* obligatoire) | Par défaut | Description  |
| -------------------------- | ---------- | ------------ |
| `text`                     | `""`       | Contenu HTML |

## Méthodes utilitaires

### isToday(date)

Teste si la date est aujourd’hui.

\=> Boolean

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                         |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `date`\*                   |            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objet |

### isTomorrow(date)

Teste si la date est demain.

\=> Boolean

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                         |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `date`\*                   |            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objet |

### isPast(date)

Teste si la date est passée.

\=> Boolean

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                         |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `date`\*                   |            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objet |

### isInLessThan(date, options)

Teste si la date est dans moins de X heures / minutes / secondes.

\=> Boolean

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                         |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `date`\*                   |            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objet |
| `options`                  | `{}`       |                                                                                                     |
| `heures`                   | `0`        | Heures dans le futur                                                                                |
| `minutes`                  | `0`        | Minutes dans le futur                                                                               |
| `secondes`                 | `0`        | Secondes dans le futur                                                                              |

### getMonth(index, options)

Renvoie le nom du mois pour un index donné.

\=> String

| Paramètre (\* obligatoire) | Par défaut | Description                                                 |
| -------------------------- | ---------- | ----------------------------------------------------------- |
| `index`\*                  |            | index du mois de 0 à 11                                     |
| `options`                  | `{}`       |                                                             |
| `court`                    | `false`    | Renvoie la version abrégée du mois — c’est-à-dire `« Jan »` |

### getEmailAddresses(conversations)

Renvoie toutes les Adresses e-mail trouvées dans les conversations.

\=> Array(AddressField)

| Paramètre (\* obligatoire) | Par défaut | Description                                           |
| -------------------------- | ---------- | ----------------------------------------------------- |
| `conversations`\*          | `[]`       | Tableau de [Conversation](#object-Conversation) objet |

### getPhoneNumbers(conversations)

Renvoie tous les Numéros de téléphone trouvés dans les conversations.

\=> Array(PhoneField)

| Paramètre (\* obligatoire) | Par défaut | Description                                           |
| -------------------------- | ---------- | ----------------------------------------------------- |
| `conversations`\*          | `[]`       | Tableau de [Conversation](#object-Conversation) objet |

### formatTimestamp(timestamp, options)

Formate l’horodatage donné.

\=> { date, formatted }

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                   |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------- |
| `horodatage`\*             |            | Horodatage Unix en secondes ou en millisecondes — c’est-à-dire `1550586350`                   |
| `options`                  | `{}`       |                                                                                               |
| `aujourd’hui`              | `false`    | Affiche `« Aujourd’hui »` lorsque la date est aujourd’hui                                     |
| `demain`                   | `false`    | Affiche `« Demain »` lorsque la date est demain                                               |
| `année`                    | `false`    | Force l’affichage de l’année — l’année n’est pas affichée par défaut lorsque l’année en cours |
| `heure`                    | `false`    | Affiche les heures et les minutes                                                             |
| `until`                    |            | Horodatage Unix — Lorsque la date s’étend sur plusieurs jours                                 |

### formatDate(string, options)

Formate la date fournie.

\=> { date, formatted }

| Paramètre (\* obligatoire) | Par défaut | Description                                            |
| -------------------------- | ---------- | ------------------------------------------------------ |
| `string`\*                 | `""`       | Chaîne de date — c.-à-d. `« 2018-10-19 17:32:45 GMT »` |
| `options`                  | `{}`       | Voir les options de formatTimestamp ci-dessus          |

### formatContact(contact)

Formate le contact fourni.

\=> { letters, formatted }

| Paramètre (\* obligatoire) | Par défaut | Description                                |
| -------------------------- | ---------- | ------------------------------------------ |
| `contact`\*                |            | [AddressField](#object-AddressField) objet |

### capitalize(string)

Met la chaîne donnée en majuscule.

\=> String

| Paramètre (\* obligatoire) | Par défaut | Description                  |
| -------------------------- | ---------- | ---------------------------- |
| `string`\*                 | `""`       | Chaîne à mettre en majuscule |

### classNames(classes)

Convertit l'objet en noms de classes CSS.

\=> String

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                         |
| -------------------------- | ---------- | --------------------------------------------------------------------------------------------------- |
| `classes`\*                | `{}`       | Objet des définitions et assertions de classes CSS — c.-à-d. `{ foo: true, bar: true, baz: false }` |

### writeToClipboard(text)

Écrire le texte dans le presse-papiers de l’utilisateur.

| Paramètre (\* obligatoire) | Par défaut | Description                            |
| -------------------------- | ---------- | -------------------------------------- |
| `text`                     | `""`       | Chaîne à copier dans le presse-papiers |

## Événements

### main\_action

Déclenché lorsque l’utilisateur appuie sur le raccourci « action principale d’Intégrations ».

\=> ()

### message\_sent

Déclenché lorsqu’un utilisateur envoie un message, ou lorsqu’un message est planifié pour être envoyé. Faites attention, car une fois déclenché, l’utilisateur peut encore annuler l’envoi du message pendant un court laps de temps (Annuler).

\=> (id)

| Payload | Description                                                                            |
| ------- | -------------------------------------------------------------------------------------- |
| `id`    | Utilisez [fetchMessages](#method-fetchMessages) pour récupérer les données du message. |

### change:conversations

Déclenché lorsque la ou les conversations sélectionnées changent.

\=> (ids)

| Payload | Description                                                                                                                                                                            |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ids`   | Tableau des ID des conversations sélectionnées. Utilisez [fetchConversations](#method-fetchConversations) pour récupérer les données des conversation(s) nouvellement sélectionnée(s). |

### modifier:utilisateurs

Déclenché lorsque les utilisateurs changent.

\=> ()

Utilisez [fetchUsers](#method-fetchUsers) pour récupérer les données des utilisateurs.

## Glossaire

### Action

`{ label: 'Nouvelle tâche', callback: () => {} }`

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

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `contexts`                 | `[]`       | Contextes dans lesquels l’action sera disponible dans l’interface Missive. Parmi `draft, conversations, conversation, message, tel, comment, comment_box, swipe, command_bar, setting` — Tous lorsqu’omis.                                                                                                                                                                                                                                                                                                                                             |
| `libellé`\*                | `""`       | Nom de l’action                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `emoji`                    | `""`       | ID de l’emoji utilisé comme icône d’action dans l’interface Missive. Vous pouvez trouver l’ID d’un emoji spécifique sur cette [page](https://missiveapp.com/open/emoji-mart). Par exemple, pour cet emoji 🧹, l’ID est `:broom:`.                                                                                                                                                                                                                                                                                                                      |
| `swipe_id`                 | `""`       | Chaîne unique pour chaque action de balayage — c’est-à-dire `new-task` — *Requis pour `swipe` contexte*                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `callback`\*               | `null`     | Fonction de rappel d’action — Reçoit un objet contenant soit `conversations, conversation, message, tel, comment, comment_box` comme clés selon le contexte dans lequel l’action a été déclenchée. Les fonctions de rappel pour le `command_bar` contexte prennent un `event` objet contenant soit un `load, search, execute` type ainsi qu’un `messageId`. La fonction de rappel peut servir à envoyer des commandes qui s’afficheront dans la barre de commandes. Voir la [respondToMessage](#method-respondToMessage) méthode pour plus de détails. |
| `swipe_color`              | `"#aaa"`   | Couleur d’arrière-plan de l’action de balayage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `disposition`              | `"list"`   | La disposition des commandes dans la barre de commandes lors de l’utilisation du `command_bar` contexte. Elle peut être soit `list` ou `grid`.                                                                                                                                                                                                                                                                                                                                                                                                         |
| `placeholder`              | `""`       | Texte indicatif de l’entrée de la barre de commandes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

### AddressField

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

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

| Paramètre (\* obligatoire) | Par défaut | Description    |
| -------------------------- | ---------- | -------------- |
| `address`\*                | `""`       | Adresse e-mail |
| `name`                     | `""`       | Nom du contact |

### FormField

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

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

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                                                                                                   |
| -------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`\*                   | `""`       | Type de champ — L’un des `input, textarea, select, calendar, duration, progress, html`                                                                                        |
| `scope`                    | `{}`       | Filtrez dynamiquement les champs ne correspondant pas à ce scope — c’est-à-dire `{ project_id: 12345 }` — N’afficherait ce champ que lorsque **projet 12345** est sélectionné |
| `data`\*                   | `{}`       | Données disponibles pour tous les types — Voir le `FormField(type:)` pour des types de données spécifiques                                                                    |
| `name`\*                   | `""`       | Nom du champ — Comme vous l’utiliseriez normalement à l’intérieur d’un `<form>`                                                                                               |
| `value`\*                  | `""`       | Valeur par défaut du champ                                                                                                                                                    |
| `placeholder`\*            | `""`       | Texte indicatif du champ                                                                                                                                                      |
| `required`                 | `false`    | Le formulaire ne sera pas envoyé tant que l’utilisateur n’aura pas rempli ce champ                                                                                            |

FormField(type:input)

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                        |
| -------------------------- | ---------- | -------------------------------------------------------------------------------------------------- |
| `data`                     | `{}`       |                                                                                                    |
| `type`\*                   | `{}`       | Type de saisie — L’un des `text, number, hidden`                                                   |
| `focus`                    | `false`    | Mettre automatiquement le focus sur le champ de saisie                                             |
| `disabled`                 | `false`    | Rendre le champ non modifiable                                                                     |
| `precision`                |            | Formater le nombre avec une précision spécifique — Pour `number` pour le type de saisie uniquement |
| `options`                  | `{}`       |                                                                                                    |
| `préfixe`                  | `false`    | Rendre le texte indicatif toujours visible                                                         |
| `thin`                     | `false`    | Afficher un champ de saisie plus petit — Pour `text` pour le type de saisie uniquement             |

FormField(type:textarea)

| Paramètre (\* obligatoire) | Par défaut | Description                                          |
| -------------------------- | ---------- | ---------------------------------------------------- |
| `data`                     | `{}`       |                                                      |
| `rows`                     | `4`        | Nombre de lignes visibles                            |
| `focus`                    | `false`    | Mettre automatiquement le focus sur la zone de texte |

FormField(type:select)

| Paramètre (\* obligatoire) | Par défaut | Description                                 |
| -------------------------- | ---------- | ------------------------------------------- |
| `data`                     | `{}`       |                                             |
| `value`                    |            | Valeur de l’option sélectionnée             |
| `options`                  | `[]`       | Tableau de [Option](#object-Option) objets  |
| `multiple`                 | `false`    | Autoriser la sélection de plusieurs options |

FormField(type:calendar)

| Paramètre (\* obligatoire) | Par défaut               | Description                                                                         |
| -------------------------- | ------------------------ | ----------------------------------------------------------------------------------- |
| `data`                     | `{}`                     |                                                                                     |
| `value`                    | `{ timestamp, all_day }` | Horodatage Unix et booléen — par exemple `{ timestamp: 1550586350, all_day: true }` |
| `allow_past`               | `false`                  | Autoriser la définition d’une date passée                                           |
| `allow_all_day`            | `false`                  | Autoriser la définition d’une date sur toute la journée                             |

FormField(type:duration)

| Paramètre (\* obligatoire) | Par défaut | Description                                   |
| -------------------------- | ---------- | --------------------------------------------- |
| `data`                     | `{}`       |                                               |
| `value`                    | `""`       | Durée au format HH:MM — par exemple `"00:30"` |

FormField(type:progress)

| Paramètre (\* obligatoire) | Par défaut | Description                             |
| -------------------------- | ---------- | --------------------------------------- |
| `data`                     | `{}`       |                                         |
| `value`                    |            | Valeur de l’étape sélectionnée          |
| `steps`                    | `[]`       | Tableau de [Étape](#object-Step) objets |

FormField(type:html)

| Paramètre (\* obligatoire) | Par défaut | Description                                                                                                                           |
| -------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `data`                     | `{}`       |                                                                                                                                       |
| `value`                    | `""`       | Chaîne HTML — par exemple `"<br> <p>Bonjour <b>à vous</b> !</p><br> <p>Comment <span style="color: red">allez-vous</span> ?</p><br>"` |

### FormComment

Exemple :

```javascript
{
  content: 'Je prendrai l’Anneau, même si je ne connais pas le chemin.',
  authorName: 'Frodon Sacquet',
  authorAvatar: 'https://gravatar.com/avatar/014bcc1f9c5920c658a198e6649cd20b',
}
```

| Paramètre (\* obligatoire) | Par défaut | Description                                                             |
| -------------------------- | ---------- | ----------------------------------------------------------------------- |
| `content`\*                | `""`       | Corps du commentaire                                                    |
| `authorAvatar`             | `""`       | URL de l’avatar de l’auteur                                             |
| `authorName`               | `""`       | Nom de l’auteur                                                         |
| `date`                     | `""`       | Chaîne de date au format de votre choix — par exemple `"18 févr. 2019"` |

### FormNote

Exemples :

```javascript
{ message: '✓ Terminé le 18 févr.' }
{ message: 'Voir sur Missive', url: 'https://missiveapp.com' }
```

| Paramètre (\* obligatoire) | Par défaut | Description                           |
| -------------------------- | ---------- | ------------------------------------- |
| `message`\*                | `""`       | Corps de la note                      |
| `url`                      | `""`       | Transformer la note en lien cliquable |

### FormButton

Exemples :

```javascript
{ type: 'cancel', label: 'Annuler' }
{ type: 'submit', label: 'Créer' }
```

| Paramètre (\* obligatoire) | Par défaut | Description                                |
| -------------------------- | ---------- | ------------------------------------------ |
| `type`\*                   | `""`       | Type du bouton — L’un des `submit, cancel` |
| `libellé`                  | `""`       | Libellé du bouton                          |

### Option

Exemples :

```javascript
{ label: 'Mon projet', value: 12345 }
{ label: 'Mon libellé', value: 54321, color: '#F00' }
```

| Paramètre (\* obligatoire) | Par défaut | Description                                                     |
| -------------------------- | ---------- | --------------------------------------------------------------- |
| `libellé`\*                | `""`       | Libellé de l’option                                             |
| `value`\*                  | `""`       | Valeur de l’option                                              |
| `disabled`                 | `false`    | Rendre l’option non cliquable                                   |
| `color`                    | `""`       | Couleur au format HEX — Ajouter un repère de couleur à l’option |
| `colorRadius`              | `"100%"`   | Spécifier le rayon du repère de couleur                         |
| `callback`                 | `null`     | Callback de l’option — Pour `openContextMenu` options           |

### PhoneField

Exemples :

```javascript
{ phoneNumber: '+11231231234', name: 'Frodon Sacquet' }
{ phoneNumber: '+11231231234' }
```

| Paramètre (\* obligatoire) | Par défaut | Description         |
| -------------------------- | ---------- | ------------------- |
| `phoneNumber`\*            | `""`       | Numéro de téléphone |
| `name`                     | `""`       | Nom du contact      |

### Étape

Exemples :

```javascript
{ label: 'En cours', value: 1 }
{ label: 'Terminée', value: 2 }
```

| Paramètre (\* obligatoire) | Par défaut | Description        |
| -------------------------- | ---------- | ------------------ |
| `libellé`\*                | `""`       | Libellé de l’étape |
| `value`\*                  | `""`       | Valeur de l’étape  |

***

## Guides associés

* [⚙️ Canaux personnalisés](https://missiveapp.com/docs/developers/fr/custom-channels.md)

Besoin de réponses plus précises ? [Contactez-nous](https://missiveapp.com/docs/developers/fr/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/fr/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.
