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

# API de JavaScript

Referencia completa de la API de JavaScript para las Integraciones de iFrame de Missive: métodos, eventos y objetos.

## Métodos de la app

### reload()

Recarga el iframe.

### search(text)

Inicia una nueva búsqueda.

| Parámetro (\* obligatorio) | Predeterminado | Descripción         |
| -------------------------- | -------------- | ------------------- |
| `text`\*                   | `""`           | Término de búsqueda |

### alert(options)

Muestra un modal de error. Solo tiene una acción “Entendido”.

| Parámetro (\* obligatorio) | Predeterminado                                 | Descripción           |
| -------------------------- | ---------------------------------------------- | --------------------- |
| `options`                  | `{}`                                           |                       |
| `title`                    | `"Error en la integración “Your Integration”"` | Título del error      |
| `message`                  | `""`                                           | Descripción del error |
| `note`                     | `""`                                           | Nota del error        |

### navigate(options)

Navega a una conversación.

| Parámetro (\* obligatorio) | Predeterminado | Descripción           |
| -------------------------- | -------------- | --------------------- |
| `options`                  | `{}`           |                       |
| `conversationId`           | `""`           | ID de la conversación |

### on(event, callback, options)

Registra un callback de evento.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                  |
| -------------------------- | -------------- | -------------------------------------------------------------------------------------------- |
| `event`\*                  | `""`           | [Evento](#event-main_action) a registrar                                                     |
| `callback`\*               |                | Función callback                                                                             |
| `options`                  | `{}`           |                                                                                              |
| `retroactivo`              | `false`        | Dispara el callback inmediatamente si el evento ocurrió antes de que se registre el callback |

### openForm(data)

Muestra una ventana emergente de formulario. Se pueden apilar varios formularios uno sobre otro.

\=> Promise(Object) — Se resuelve con objetos Field

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                         |
| -------------------------- | -------------- | --------------------------------------------------- |
| `data`                     | `{}`           |                                                     |
| `name`                     | `""`           | Título del formulario                               |
| `fields`                   | `[]`           | Array of [FormField](#object-FormField) objetos     |
| `comments`                 | `[]`           | Array of [FormComment](#object-FormComment) objetos |
| `notes`                    | `[]`           | Array of [FormNote](#object-FormNote) objetos       |
| `buttons`                  | `[]`           | Array of [FormButton](#object-FormButton) objetos   |
| `options`                  | `{}`           |                                                     |
| `autoClose`                | `true`         | Cerrar la ventana emergente al enviar               |

### closeForm()

Cierra la última ventana emergente de formulario abierta.

### openSelf()

Abre la barra lateral de la integración si está cerrada y selecciona la integración.

### closeSelf()

Cierra la barra lateral de la integración si está abierta.

### openURL(url)

Abre la URL en una nueva pestaña en escritorio. Se abre en el navegador nativo o en el navegador de la aplicación según la configuración del usuario en móvil.

| Parámetro (\* obligatorio) | Predeterminado | Descripción |
| -------------------------- | -------------- | ----------- |
| `url`\*                    | `""`           | cadena URL  |

### openContextMenu(data)

Abre un menú contextual

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                                                    |
| -------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `data`\*                   | `{}`           |                                                                                                                                |
| `top`                      | `0`            | Posición superior del menú — El menú estará debajo de ese punto — Nota: no lo establezca si `data.bottom` se proporciona       |
| `bottom`                   | `nulo`         | Posición superior del menú — El menú estará por encima de ese punto — Nota: no lo establezca si `data.top` se proporciona      |
| `izquierda`                | `0`            | Posición izquierda del menú — El menú estará a la derecha de ese punto — Nota: no lo establezca si `data.right` se proporciona |
| `derecha`                  | `nulo`         | Posición derecha del menú — El menú estará a la izquierda de ese punto — Nota: no lo establezca si `data.left` se proporciona  |
| `options`\*                | `[]`           | Array of [Opción](#object-Option) objetos                                                                                      |

### setActions(actions)

Las acciones están disponibles en toda la app como una opción en los menús contextuales o al deslizar.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                               |
| -------------------------- | -------------- | ----------------------------------------- |
| `acciones`                 | `[]`           | Array of [Acción](#object-Action) objetos |

### setAsUtility()

Marque la integración como una integración de utilidad. No mostrará el iframe en la barra lateral de Integraciones. Útil para Integraciones que solo muestran acciones en menús contextuales.

### setPermisos(permisos)

Haga que Missive solicite ciertos permisos multimedia. Son necesarios en macOS para las integraciones que requieren el uso de la cámara o el micrófono. Es posible que deba recargar la integración una vez que Missive haya recibido acceso.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                              |
| -------------------------- | -------------- | ---------------------------------------- |
| `Permisos`                 | `{}`           |                                          |
| `cámara`                   | `false`        | Solicitar permiso para usar la cámara    |
| `micrófono`                | `false`        | Solicitar permiso para usar el micrófono |

### storeGet(key)

Recupera los datos que se han almacenado previamente usando `storeSet`. Los datos persisten entre recargas de la página y recargas de la app.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                            |
| -------------------------- | -------------- | -------------------------------------------------------------------------------------- |
| `key`\*                    | `""`           | Un identificador único que se usa al almacenar los datos usando `storeSet(key, data)`. |

### storeSet(key, data)

Almacene datos que se mantengan consistentes entre recargas de página y recargas de la aplicación.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                                                            |
| -------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `key`\*                    | `""`           | Un identificador único para los datos que se almacenarán. Esta clave se usa para recuperar los datos más tarde usando `storeGet(key)`. |
| `data`\*                   | `{}`           | Los datos (String, Array or Object) que se almacenarán.                                                                                |

Ejemplo de uso:

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

El método `respondToMessage` puede usarse para enviar comandos a la barra de comandos dentro de la [Acción](#object-Action) devolución de llamada del `command_bar` contexto.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                   |
| -------------------------- | -------------- | ----------------------------------------------------------------------------- |
| `data`\*                   | `{}`           |                                                                               |
| `comandos`\*               | `{}`           | Lista de comandos que se muestran en la barra de comandos                     |
| `id`\*                     | `""`           | Identificador único del comando                                               |
| `picture`                  | `{}`           | Una imagen mostrada junto al comando usando la `grid` layout                  |
| `src`\*                    | `""`           | Ruta de la imagen                                                             |
| `webp`                     | `""`           | Ruta opcional de imagen WEBP que se usa cuando el navegador la admite         |
| `alt`                      | `""`           | Atributo alt para la etiqueta de imagen                                       |
| `iconUrl`                  | `""`           | Icono mostrado junto al comando usando la `list` layout                       |
| `label`                    | `""`           | Texto mostrado con el comando usando la `list` layout                         |
| `payload`                  | `{}`           | Un objeto devuelto al evento de devolución de llamada de tipo `execute`       |
| `closeOnExecute`           | `false`        | Especifica si la barra de comandos debe cerrarse cuando se ejecuta el comando |

Ejemplo de uso:

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

Inicia un flujo de OAuth abriendo la URL de autenticación en una nueva pestaña del navegador. Este método ayuda a sortear las limitaciones de OAuth en iframe y es compatible con iOS.

\=> Promise(Object) — Se resuelve con los parámetros de consulta de la redirección de OAuth

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                            |
| -------------------------- | -------------- | ---------------------------------------------------------------------- |
| `url`\*                    | `""`           | URL del endpoint de autenticación que recibirá un parámetro redirectTo |

Ejemplo de uso:

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

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

    // 2. La respuesta contendrá los parámetros de consulta de la redirección de OAuth
    const { access_token } = response

    // 3. Guardar el token para uso futuro
    await Missive.storeSet('oauth_token', access_token)
  } catch (error) {
    console.error('Falló el flujo de OAuth:', error)
  }
}
```

{% endcode %}

Cómo funciona:

* Missive abre la URL de autenticación en una nueva pestaña del navegador
* Agrega un `redirectTo` parámetro a su URL
* Después de completar OAuth, redirija a la `redirectTo` URL con sus tokens/datos como parámetros de consulta
* La pestaña del navegador se cierra automáticamente
* Su integración recibe los datos en el `respuesta` objeto

## Métodos de obtención

### fetchConversations(ids)

Obtiene los atributos de los IDs de conversación indicados.

\=> Promise(Array) — Se resuelve con objetos Conversation

| Parámetro (\* obligatorio) | Predeterminado | Descripción                  |
| -------------------------- | -------------- | ---------------------------- |
| `ids`\*                    | `[]`           | Array de IDs de conversación |

Ejemplo de uso:

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

```javascript
Missive.on('change:conversations', (ids) => {
  Missive.fetchConversations(ids).then((conversations) => {
    if (conversations.length != 1) {
      // No hacer nada si se seleccionan varias conversaciones.
      return
    }

    var message = conversations[0].latest_message
    if (!message || !message.from_field) {
      // No hacer nada si la conversación no tiene mensaje (solo Comentarios de chat) o si
      // el mensaje no tiene campo From.
      return
    }

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

{% endcode %}

Atributos disponibles para las conversaciones:

```javascript
// Conversación
{
  id: '2b3db130-e94e-43fa-970a-63bae8cb10ee',
  color: '#ff0000',
  asunto: 'Manténgalo en secreto y a salvo',
  usuarios: [ /* Array de objetos Usuario */ ],
  assignees: [ /* Array of User objects */ ],
  authors: [ /* Array of AddressField object */ ],
  messages_count: 1,
  messages: [/* Array de objeto Message (ver abajo) */],
  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 */ ],
    asunto: 'Manténgalo en secreto y a salvo',
    vista previa: '¿Dónde está? --Gandalf',
    body: '<p>¿Dónde está?</p><p>--<br>Gandalf</p>',
    delivered_at: 1550698870,
  },
  enlace: 'https://mail.missiveapp.com/#inbox/conversations/37c8d757-2a20-45f6-9aa1-dbe815d27cb0',
}
```

### fetchMessages(ids)

Obtiene los atributos de los IDs de mensaje indicados.

\=> Promise(Array) — Se resuelve con objetos Message

| Parámetro (\* obligatorio) | Predeterminado | Descripción             |
| -------------------------- | -------------- | ----------------------- |
| `ids`\*                    | `[]`           | Array de IDs de mensaje |

Atributos disponibles para los mensajes:

```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 */ ],
  asunto: 'Manténgalo en secreto y a salvo',
  vista previa: '¿Dónde está? --Gandalf',
  body: '<p>¿Dónde está?</p><p>--<br>Gandalf</p>',
  delivered_at: 1550698870,
}
```

### fetchUsers()

Obtiene los atributos de todos los usuarios.

\=> Promise(Array) — Se resuelve con objetos User

```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: 'Usted',
  me: true,
}
```

### fetchLabels()

Obtiene los atributos de todas las Etiquetas compartidas.

{% hint style="info" %}
El alcance de las etiquetas devueltas depende de cómo se instale la integración. Cuando una integración se comparte con una organización, `fetchLabels()` devuelve etiquetas solo de esa organización. Cuando la integración es personal (privada), devuelve etiquetas de todas las organizaciones a las que pertenece el usuario. Si necesita etiquetas en varias organizaciones, haga que cada usuario instale la integración de forma privada mediante **Configuración > Integraciones** en lugar de compartirlo a nivel de la organización.
{% endhint %}

\=> Promise(Array) — Se resuelve con objetos Label

```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"
  visibility: "organization"
}
```

## Métodos de conversación

### createConversation(options)

Crea una nueva conversación.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                      |
| -------------------------- | -------------- | ------------------------------------------------ |
| `options`                  | `{}`           |                                                  |
| `select`                   | `true`         | Navega a la(s) conversación(es) recién creada(s) |
| `count`                    | `1`            | Número de conversaciones que crear               |

### archive()

Archiva la conversación actual.

### trash()

Elimina la conversación actual.

### moveToInbox()

Mueve la conversación actual a la bandeja de entrada.

### comment(body)

Crea un comentario en la conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción           |
| -------------------------- | -------------- | --------------------- |
| `body`\*                   | `""`           | Cuerpo del comentario |

### createTask(body, completed)

Crea una tarea en la conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                  |
| -------------------------- | -------------- | ---------------------------- |
| `body`\*                   | `""`           | Cuerpo de la tarea           |
| `completed`                | `false`        | Marcar tarea como completada |

### addLabels(labelIds)

Añade etiquetas a la conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                          |
| -------------------------- | -------------- | ------------------------------------ |
| `labelIds`\*               | `[]`           | Array de identificadores de etiqueta |

### removeLabels(labelIds)

Elimina las etiquetas de la conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                          |
| -------------------------- | -------------- | ------------------------------------ |
| `labelIds`\*               | `[]`           | Array de identificadores de etiqueta |

### close()

Finaliza la conversación actual.

### reopen()

Reabre la conversación actual.

### assign(userIds)

Asigna usuarios a la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                 |
| -------------------------- | -------------- | --------------------------------------------------------------------------- |
| `userIds`\*                | `[]`           | Arreglo de IDs de usuario — Un arreglo vacío elimina todos los responsables |

### addAssignees(userIds)

Agrega responsables a la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción               |
| -------------------------- | -------------- | ------------------------- |
| `userIds`\*                | `[]`           | Arreglo de IDs de usuario |

### removeAssignees(userIds)

Elimina los responsables de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción               |
| -------------------------- | -------------- | ------------------------- |
| `userIds`\*                | `[]`           | Arreglo de IDs de usuario |

### setColor(color)

Establece el color de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción          |
| -------------------------- | -------------- | -------------------- |
| `color`\*                  | `""`           | Color en formato HEX |

### setDescription(description)

Establece la descripción de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                    |
| -------------------------- | -------------- | ------------------------------ |
| `description`\*            | `""`           | Descripción de la conversación |

### setSubject(subject)

Establece el asunto de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                     |
| -------------------------- | -------------- | --------------------------------------------------------------- |
| `subject`\*                | `""`           | Asunto de la conversación — Vacío o `nulo` restablece el asunto |

## Métodos del compositor

### compose(options)

Crea un nuevo borrador en una nueva conversación.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                           |
| -------------------------- | -------------- | ----------------------------------------------------- |
| `options`                  | `{}`           |                                                       |
| `deliver`                  | `false`        | Envía de inmediato el borrador recién creado          |
| `mailto`                   | `{}`           |                                                       |
| `subject`                  | `""`           | Asunto del borrador                                   |
| `body`                     | `""`           | Cuerpo del borrador                                   |
| `to_fields`                | `[]`           | Array of [AddressField](#object-AddressField) objetos |
| `cc_fields`                | `[]`           | Array of [AddressField](#object-AddressField) objetos |
| `bcc_fields`               | `[]`           | Array of [AddressField](#object-AddressField) objetos |

### composeInConversation()

Crea un nuevo borrador en la Conversación actual.

Los mismos parámetros que compose.

### reply(options)

Responde al último mensaje de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                   |
| -------------------------- | -------------- | --------------------------------------------- |
| `options`                  | `{}`           |                                               |
| `deliver`                  | `false`        | Envía de inmediato la respuesta recién creada |
| `mailto`                   | `{}`           | Consulte el método compose anterior           |

### forward(options)

Reenvía el último mensaje de la Conversación actual.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                        |
| -------------------------- | -------------- | -------------------------------------------------- |
| `options`                  | `{}`           |                                                    |
| `private`                  | `false`        | Crea un borrador en una nueva conversación privada |
| `deliver`                  | `false`        | Envía de inmediato el borrador recién creado       |
| `mailto`                   | `{}`           | Consulte el método compose anterior                |

### insertText(text)

Inserta contenido como texto en el compositor actualmente seleccionado.

| Parámetro (\* obligatorio) | Predeterminado | Descripción        |
| -------------------------- | -------------- | ------------------ |
| `text`                     | `""`           | Contenido de texto |

### insertHtml(text)

Inserta contenido como HTML en el compositor actualmente seleccionado.

| Parámetro (\* obligatorio) | Predeterminado | Descripción    |
| -------------------------- | -------------- | -------------- |
| `text`                     | `""`           | Contenido HTML |

## Métodos auxiliares

### isToday(date)

Comprueba si date es hoy.

\=> Boolean

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                          |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                   |                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objeto |

### isTomorrow(date)

Comprueba si date es mañana.

\=> Boolean

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                          |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                   |                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objeto |

### isPast(date)

Comprueba si date está en el pasado.

\=> Boolean

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                          |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                   |                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objeto |

### isInLessThan(date, options)

Comprueba si date está a menos de X horas / minutos / segundos.

\=> Boolean

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                          |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------------- |
| `date`\*                   |                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objeto |
| `options`                  | `{}`           |                                                                                                      |
| `hours`                    | `0`            | Horas en el futuro                                                                                   |
| `minutes`                  | `0`            | Minutos en el futuro                                                                                 |
| `seconds`                  | `0`            | Segundos en el futuro                                                                                |

### getMonth(index, options)

Devuelve el nombre del mes de un índice dado.

\=> String

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                           |
| -------------------------- | -------------- | ----------------------------------------------------- |
| `index`\*                  |                | índice 0-11 del mes                                   |
| `options`                  | `{}`           |                                                       |
| `short`                    | `false`        | Devuelve la versión corta del mes — es decir, `“Jan”` |

### getEmailAddresses(conversations)

Devuelve todas las Direcciones de correo electrónico encontradas en conversations.

\=> Array(AddressField)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                          |
| -------------------------- | -------------- | ---------------------------------------------------- |
| `conversations`\*          | `[]`           | Array of [Conversation](#object-Conversation) objeto |

### getPhoneNumbers(conversations)

Devuelve todos los Números de teléfono encontrados en conversations.

\=> Array(PhoneField)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                          |
| -------------------------- | -------------- | ---------------------------------------------------- |
| `conversations`\*          | `[]`           | Array of [Conversation](#object-Conversation) objeto |

### formatTimestamp(timestamp, options)

Da formato al timestamp proporcionado.

\=> { date, formatted }

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                    |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------- |
| `timestamp`\*              |                | Marca de tiempo Unix en segundos o milisegundos — es decir, `1550586350`                       |
| `options`                  | `{}`           |                                                                                                |
| `today`                    | `false`        | Muestra `“Today”` cuando date es hoy                                                           |
| `tomorrow`                 | `false`        | Muestra `“Tomorrow”` cuando date es mañana                                                     |
| `year`                     | `false`        | Obliga a mostrar el año — el año no se muestra de forma predeterminada cuando es el año actual |
| `time`                     | `false`        | Muestra las horas y los minutos                                                                |
| `hasta`                    |                | Marca de tiempo Unix — Cuando la fecha abarca varios días                                      |

### formatDate(string, options)

Da formato a la fecha dada.

\=> { date, formatted }

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                             |
| -------------------------- | -------------- | ------------------------------------------------------- |
| `string`\*                 | `""`           | Cadena de fecha — es decir. `"2018-10-19 17:32:45 GMT"` |
| `options`                  | `{}`           | Consulta las opciones de formatTimestamp arriba         |

### formatContact(contact)

Da formato al contacto dado.

\=> { letters, formatted }

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                 |
| -------------------------- | -------------- | ------------------------------------------- |
| `contacto`\*               |                | [AddressField](#object-AddressField) objeto |

### capitalize(string)

Pone en mayúscula la cadena dada.

\=> String

| Parámetro (\* obligatorio) | Predeterminado | Descripción                           |
| -------------------------- | -------------- | ------------------------------------- |
| `string`\*                 | `""`           | Cadena que se va a poner en mayúscula |

### classNames(classes)

Convierte un objeto en nombres de clase CSS.

\=> String

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                         |
| -------------------------- | -------------- | --------------------------------------------------------------------------------------------------- |
| `classes`\*                | `{}`           | Objeto de definiciones y aserciones de clases CSS, es decir. `{ foo: true, bar: true, baz: false }` |

### writeToClipboard(text)

Escribe texto en el portapapeles del usuario.

| Parámetro (\* obligatorio) | Predeterminado | Descripción                        |
| -------------------------- | -------------- | ---------------------------------- |
| `text`                     | `""`           | Cadena para copiar al portapapeles |

## Eventos

### main\_action

Se activa cuando el usuario presiona el atajo de acción principal de “Integraciones”.

\=> ()

### message\_sent

Se activa cuando un usuario envía un mensaje, o cuando se programa el envío de un mensaje. Tenga cuidado, ya que, una vez activado, el usuario todavía puede cancelar la entrega del mensaje dentro de un período corto (Undo).

\=> (id)

| Payload | Descripción                                                                     |
| ------- | ------------------------------------------------------------------------------- |
| `id`    | Usar [fetchMessages](#method-fetchMessages) para obtener los datos del mensaje. |

### cambiar:conversaciones

Se activa cuando cambian las conversaciones seleccionadas.

\=> (identificadores)

| Payload | Descripción                                                                                                                                                                       |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ids`   | Array de los IDs de conversación seleccionados. Utilice [fetchConversations](#method-fetchConversations) para obtener los datos de la(s) conversación(es) recién seleccionada(s). |

### cambiar:usuarios

Se activa cuando cambian los usuarios.

\=> ()

Usar [fetchUsers](#method-fetchUsers) para obtener los datos de los usuarios.

## Glosario

### Acción

`{ label: 'Nueva tarea', callback: () => {} }`

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

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| -------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contexts`                 | `[]`           | Contextos en los que la acción estará disponible en la interfaz de Missive. Cualquiera de `draft, conversations, conversation, message, tel, comment, comment_box, swipe, command_bar, setting` — Todos si se omite.                                                                                                                                                                                                                                                                                                                           |
| `label`\*                  | `""`           | Nombre de la acción                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `emoji`                    | `""`           | ID del emoji usado como icono de la acción en la interfaz de Missive. Puede encontrar el ID de un emoji específico en esta [página](https://missiveapp.com/open/emoji-mart). Por ejemplo, para este emoji 🧹 el ID es `:broom:`.                                                                                                                                                                                                                                                                                                               |
| `swipe_id`                 | `""`           | Cadena única por acción de deslizamiento — es decir `new-task` — *Requerido para `deslizamiento` contexto*                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `callback`\*               | `nulo`         | Devolución de llamada de la acción — Recibe un objeto con cualquiera de `conversations, conversation, message, tel, comment, comment_box` como claves, según el contexto en el que se activó la acción. Las devoluciones de llamada del `command_bar` contexto reciben un `event` objeto con un `load, search, execute` tipo, así como un `messageId`. La devolución de llamada puede usarse para enviar comandos que se mostrarán en la Barra de comandos. Consulte el [respondToMessage](#method-respondToMessage) método para más detalles. |
| `swipe_color`              | `“#aaa”`       | Color de fondo de la acción de deslizamiento                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `layout`                   | `“list”`       | La disposición de los comandos dentro de la Barra de comandos al usar el `command_bar` contexto. Puede ser `list` o `grid`.                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `placeholder`              | `""`           | Marcador de posición de la entrada de la Barra de comandos                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### AddressField

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

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

| Parámetro (\* obligatorio) | Predeterminado | Descripción                     |
| -------------------------- | -------------- | ------------------------------- |
| `address`\*                | `""`           | Dirección de correo electrónico |
| `name`                     | `""`           | Nombre del contacto             |

### FormField

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

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

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                                                                                                 |
| -------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`\*                   | `""`           | Tipo de campo — cualquiera de `input, textarea, select, calendar, duration, progress, html`                                                                                 |
| `scope`                    | `{}`           | Filtra dinámicamente los campos que no coincidan con este alcance — es decir `{ project_id: 12345 }` — Solo mostraría este campo cuando **project 12345** esté seleccionado |
| `data`\*                   | `{}`           | Datos disponibles para todos los tipos — Vea lo siguiente `FormField(type:)` para ciertos tipos de datos                                                                    |
| `name`\*                   | `""`           | Nombre del campo — Como normalmente lo usaría dentro de un `<form>`                                                                                                         |
| `valor`\*                  | `""`           | Valor predeterminado del campo                                                                                                                                              |
| `placeholder`\*            | `""`           | Marcador de posición del campo                                                                                                                                              |
| `required`                 | `false`        | El formulario no se enviará a menos que el usuario complete este campo                                                                                                      |

FormField(type:input)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                         |
| -------------------------- | -------------- | --------------------------------------------------------------------------------------------------- |
| `data`                     | `{}`           |                                                                                                     |
| `type`\*                   | `{}`           | Tipo de entrada — Puede ser cualquiera de `text, number, hidden`                                    |
| `focus`                    | `false`        | Asigne foco automáticamente a la entrada                                                            |
| `disabled`                 | `false`        | Haga que la entrada no se pueda editar                                                              |
| `precision`                |                | Formatee el número con una precisión específica — Para `number` solo para el tipo de entrada number |
| `options`                  | `{}`           |                                                                                                     |
| `prefix`                   | `false`        | Haga que el marcador de posición siempre sea visible                                                |
| `thin`                     | `false`        | Muestre una entrada más pequeña — Para `text` solo para el tipo de entrada number                   |

FormField(type:textarea)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                  |
| -------------------------- | -------------- | -------------------------------------------- |
| `data`                     | `{}`           |                                              |
| `rows`                     | `4`            | Número de filas visibles                     |
| `focus`                    | `false`        | Asigne foco automáticamente al área de texto |

FormField(type:select)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                               |
| -------------------------- | -------------- | ----------------------------------------- |
| `data`                     | `{}`           |                                           |
| `valor`                    |                | Valor de la opción seleccionada           |
| `options`                  | `[]`           | Array of [Opción](#object-Option) objetos |
| `multiple`                 | `false`        | Permita seleccionar varias opciones       |

FormField(type:calendar)

| Parámetro (\* obligatorio) | Predeterminado           | Descripción                                                                            |
| -------------------------- | ------------------------ | -------------------------------------------------------------------------------------- |
| `data`                     | `{}`                     |                                                                                        |
| `valor`                    | `{ timestamp, all_day }` | Marca de tiempo Unix y booleano — es decir, `{ timestamp: 1550586350, all_day: true }` |
| `allow_past`               | `false`                  | Permitir establecer una fecha en el pasado                                             |
| `allow_all_day`            | `false`                  | Permitir establecer una fecha de día completo                                          |

FormField(type:duration)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                             |
| -------------------------- | -------------- | --------------------------------------- |
| `data`                     | `{}`           |                                         |
| `valor`                    | `""`           | Duración en HH:MM — es decir, `"00:30"` |

FormField(type:progress)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                           |
| -------------------------- | -------------- | ------------------------------------- |
| `data`                     | `{}`           |                                       |
| `valor`                    |                | Valor del paso seleccionado           |
| `steps`                    | `[]`           | Array of [Paso](#object-Step) objetos |

FormField(type:html)

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                                                                           |
| -------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------- |
| `data`                     | `{}`           |                                                                                                                       |
| `valor`                    | `""`           | Cadena HTML — es decir, `"<br> <p>Hey <b>there</b>!</p><br> <p>How <span style="color: red">are you</span>?</p><br>"` |

### FormComment

Ejemplo:

```javascript
{
  content: 'I will take the Ring, though I do not know the way.',
  authorName: 'Frodo Baggins',
  authorAvatar: 'https://gravatar.com/avatar/014bcc1f9c5920c658a198e6649cd20b',
}
```

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                           |
| -------------------------- | -------------- | --------------------------------------------------------------------- |
| `content`\*                | `""`           | Cuerpo del comentario                                                 |
| `authorAvatar`             | `""`           | URL del avatar del autor                                              |
| `authorName`               | `""`           | Nombre del autor                                                      |
| `date`                     | `""`           | Cadena de fecha con el formato que elija — es decir, `"Feb 18, 2019"` |

### FormNote

Ejemplos:

```javascript
{ message: '✓ Completed on Feb 18' }
{ message: 'View on Missive', url: 'https://missiveapp.com' }
```

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                  |
| -------------------------- | -------------- | ------------------------------------------------------------ |
| `message`\*                | `""`           | Cuerpo de la nota                                            |
| `url`                      | `""`           | Convierta la nota en un enlace en el que se pueda hacer clic |

### FormButton

Ejemplos:

```javascript
{ type: 'cancel', label: 'Cancel' }
{ type: 'submit', label: 'Create' }
```

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                              |
| -------------------------- | -------------- | -------------------------------------------------------- |
| `type`\*                   | `""`           | Tipo de botón — Puede ser cualquiera de `submit, cancel` |
| `label`                    | `""`           | Etiqueta del botón                                       |

### Opción

Ejemplos:

```javascript
{ label: 'My Project', value: 12345 }
{ label: 'My Tag', value: 54321, color: '#F00' }
```

| Parámetro (\* obligatorio) | Predeterminado | Descripción                                                         |
| -------------------------- | -------------- | ------------------------------------------------------------------- |
| `label`\*                  | `""`           | Etiqueta de la opción                                               |
| `valor`\*                  | `""`           | Valor de la opción                                                  |
| `disabled`                 | `false`        | Haga que la opción no se pueda hacer clic                           |
| `color`                    | `""`           | Color en formato HEX — Agregue un pin de color a la opción          |
| `colorRadius`              | `"100%"`       | Especifique el radio del pin de color                               |
| `callback`                 | `nulo`         | Devolución de llamada de la opción — Para `openContextMenu` options |

### PhoneField

Ejemplos:

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

| Parámetro (\* obligatorio) | Predeterminado | Descripción         |
| -------------------------- | -------------- | ------------------- |
| `phoneNumber`\*            | `""`           | Número de teléfono  |
| `name`                     | `""`           | Nombre del contacto |

### Paso

Ejemplos:

```javascript
{ label: 'En curso', value: 1 }
{ label: 'Completado', value: 2 }
```

| Parámetro (\* obligatorio) | Predeterminado | Descripción       |
| -------------------------- | -------------- | ----------------- |
| `label`\*                  | `""`           | Etiqueta del paso |
| `valor`\*                  | `""`           | Valor del paso    |

***

## Guías relacionadas

* [⚙️ Canales personalizados](https://missiveapp.com/docs/developers/es/custom-channels.md)

¿Necesita respuestas más específicas? [Contáctenos](https://missiveapp.com/docs/developers/es/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/es/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.
