Compartir a través de

Agregar compatibilidad con comandos de complemento en Outlook en dispositivos móviles

  • Artículo

El uso de comandos de complemento en Outlook en dispositivos móviles permite a los usuarios acceder a la misma funcionalidad (con algunas limitaciones) que ya tienen en Outlook en la Web, en Windows (nuevo y clásico) y en Mac. Para agregar compatibilidad con Outlook Mobile es necesario actualizar el manifiesto del complemento y, posiblemente, cambiar el código para escenarios móviles.

Actualizar el manifiesto

El primer paso para habilitar los comandos de complemento en Outlook mobile es definirlos en el manifiesto del complemento.

  1. En la matriz "extensions.ribbons.requirements.formFactors", agregue "mobile" como elemento. Cuando haya terminado, la matriz debe tener un aspecto similar al siguiente.

    "formFactors": [
    "mobile",
    <!-- Typically there will be other form factors listed. -->
]

  2. Si el complemento usa el modo asistente de cita, como un complemento que integra un proveedor de una aplicación de administración de notas o relaciones con el cliente (CRM), agregue "logEventMeetingDetailsAttendee" a la matriz "extensions.ribbons.contexts". A continuación se muestra un ejemplo.

    "contexts": [
    "meetingDetailsAttendee",
    "logEventMeetingDetailsAttendee"
],

  3. Si el complemento usa un proveedor de reuniones en línea integrado, agregue "onlineMeetingDetailsOrganizer" a la matriz "extensions.ribbons.contexts". A continuación se muestra un ejemplo.

    "contexts": [
    "meetingDetailsOrganizer",
    "onlineMeetingDetailsOrganizer"
],

  4. En la matriz "extensions.ribbons.tabs", busque la pestaña con "builtInTabId" de "TabDefault". Agregue una matriz secundaria "customMobileRibbonGroups" (como un elemento del mismo nivel de la propiedad "groups" existente). Dentro de esta matriz, cree un objeto y haga lo siguiente:

    • Establezca los valores "id" y "label" adecuados.
    • Cree un objeto en la matriz "controls" para representar un botón y configurarlo como se indica a continuación.
      • Establezca los valores "id" y "label" adecuados. Para asegurarse de que el botón se ajusta correctamente en la cinta de opciones, se recomienda limitar la "etiqueta" a 16 caracteres.
      • Establezca "type" en "mobileButton".
      • Asigne una función a la propiedad "actionId". Esto debe coincidir con el "id" del objeto en la matriz "extensions.runtimes.actions".
      • Asegúrese de que tiene los nueve iconos necesarios.

    A continuación se muestra un ejemplo.

    "tabs": [
    {
        "builtInTabId": "TabDefault",
        "groups": [
            <-- non-mobile group objects omitted -->
        ],
        "customMobileRibbonGroups": [
            {
                "id": "mobileApptComposeGroup",
                "label": "Contoso Meeting",
                "controls": [
                    { 
                        "id": "mobileInsertMeetingButton",
                        "label": "Add meeting",
                        "type": "mobileButton",
                        "actionId": "insertContosoMeeting",
                        "icons": [
                            {
                                "scale": 1,
                                "size": 25,
                                "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 1,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 1,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            },                                
                            {
                                "scale": 2,
                                "size": 25,
                                "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 2,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 2,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            },                                
                            {
                                "scale": 3,
                                "size": 25,
                                "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 3,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 3,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

Consideraciones de código

Diseñar un complemento para dispositivos móviles presenta algunas consideraciones adicionales.

Usar REST en lugar de servicios Web Exchange

El método Office.context.mailbox.makeEwsRequestAsync no se admite en Outlook Mobile. Los complementos deben preferir obtener información de la API de Office.js siempre que sea posible. Si los complementos necesitan información que no expone la API de Office.js, entonces deben usar las API de REST de Outlook para tener acceso al buzón del usuario.

El conjunto de requisitos de buzón 1.5 introdujo una nueva versión de Office.context.mailbox.getCallbackTokenAsync que puede solicitar un token de acceso compatible con las API REST y una nueva propiedad Office.context.mailbox.restUrl que se puede usar para buscar el punto de conexión de la API REST para el usuario.

Gesto de acercamiento

De forma predeterminada, los usuarios pueden usar el gesto "reducir zoom" para acercar los paneles de tareas. Si esto no tiene sentido para su escenario, asegúrese de deshabilitar el zoom de pellizco en el HTML.

Cerrar los paneles de tareas

En Outlook mobile, los paneles de tareas toman toda la pantalla y, de forma predeterminada, requieren que el usuario los cierre para volver al mensaje. Considere la posibilidad de usar el método Office.context.ui.closeContainer para cerrar el panel de tareas cuando se complete el escenario.

Modo de redacción y citas

Actualmente, los complementos de Outlook Mobile solo admiten la activación al leer mensajes. Los complementos no se activan al redactar mensajes o al ver o redactar citas. Sin embargo, existen excepciones.

  1. Los complementos integrados del proveedor de reuniones en línea se activan en el modo organizador de citas. Para obtener más información sobre esta excepción (incluidas las API disponibles), consulte Creación de un complemento móvil de Outlook para un proveedor de reuniones en línea.
  2. Los complementos que registran notas de citas y otros detalles para la administración de relaciones con el cliente (CRM) o los servicios de toma de notas se activan en el modo asistente de cita. Para obtener más información sobre esta excepción (incluidas las API disponibles), vea Registrar notas de citas en una aplicación externa en complementos móviles de Outlook.
  3. Los complementos basados en eventos se activan cuando se produce el OnNewMessageCompose evento. Para obtener más información sobre esta excepción (incluidas las API admitidas adicionales), vea Implementar la activación basada en eventos en complementos móviles de Outlook.

API admitidas

Aunque Outlook Mobile admite hasta el conjunto de requisitos de buzón 1.5, ahora puede implementar API adicionales de conjuntos de requisitos posteriores para ampliar aún más la funcionalidad del complemento en Outlook Mobile. Para obtener instrucciones sobre qué API puede implementar en el complemento móvil, consulte API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.

Vea también