Hinzufügen von Unterstützung für Add-In-Befehle in Outlook auf mobilen Geräten

Artikel
09/25/2024

Die Verwendung von Add-In-Befehlen in Outlook auf mobilen Geräten ermöglicht Es Ihren Benutzern, auf dieselben Funktionen (mit einigen Einschränkungen) zuzugreifen, die sie bereits in Outlook im Web, unter Windows (neu und klassisch) und unter Mac haben. Um Unterstützung für Outlook Mobile hinzuzufügen, müssen Sie das Add-In-Manifest aktualisieren und möglicherweise Ihren Code für mobile Szenarien ändern.

Aktualisieren des Manifests

Der erste Schritt zum Aktivieren von Add-In-Befehlen in Outlook Mobile besteht darin, sie im Add-In-Manifest zu definieren.

Einheitliches Manifest für Microsoft 365
Manifest nur für Add-Ins

Fügen Sie im Array "extensions.ribbons.requirements.formFactors" "mobile" als Element hinzu. Wenn Sie fertig sind, sollte das Array wie folgt aussehen.
```
"formFactors": [
    "mobile",
    
]
```
Wenn Ihr Add-In den Terminteilnehmermodus verwendet, z. B. ein Add-In, das einen Anbieter einer Crm-Anwendung (Note-Taking oder Customer Relationship Management) integriert, fügen Sie dem Array "extensions.ribbons.contexts" "logEventMeetingDetailsAttendee" hinzu. Es folgt ein Beispiel.
```
"contexts": [
    "meetingDetailsAttendee",
    "logEventMeetingDetailsAttendee"
],
```
Wenn Ihr Add-In einen integrierten Onlinebesprechungsanbieter verwendet, fügen Sie "onlineMeetingDetailsOrganizer" zum Array "extensions.ribbons.contexts" hinzu. Es folgt ein Beispiel.
```
"contexts": [
    "meetingDetailsOrganizer",
    "onlineMeetingDetailsOrganizer"
],
```

Suchen Sie im Array "extensions.ribbons.tabs" die Registerkarte mit der "builtInTabId" von "TabDefault". Fügen Sie ein untergeordnetes "customMobileRibbonGroups"-Array hinzu (als Peer der vorhandenen Eigenschaft "groups"). Erstellen Sie in diesem Array ein -Objekt, und führen Sie die folgenden Schritte aus:

Legen Sie die entsprechenden Werte für "id" und "label" fest.
Erstellen Sie ein Objekt im Array "controls", das eine Schaltfläche darstellt, und konfigurieren Sie sie wie folgt.
- Legen Sie die entsprechenden Werte für "id" und "label" fest. Um sicherzustellen, dass die Schaltfläche ordnungsgemäß in das Menüband passt, wird empfohlen, die Bezeichnung auf 16 Zeichen zu beschränken.
- Legen Sie "type" auf "mobileButton" fest.
- Weisen Sie der Eigenschaft "actionId" eine Funktion zu. Dies sollte mit der "ID" des Objekts im Array "extensions.runtimes.actions" übereinstimmen.
- Stellen Sie sicher, dass Sie über alle neun erforderlichen Symbole verfügen.

Es folgt ein Beispiel.

"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"
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

Version 1.1 des VersionOverrides-Schemas definiert einen neuen Formfaktor für mobile Umgebungen, MobileFormFactor.

Dieses Element enthält alle Informationen zum Laden des Add-Ins in mobilen Clients. Mit diesem Element können Sie komplett andere Benutzeroberflächenelemente und JavaScript-Dateien für die mobile Erfahrung definieren.

Das folgende Beispiel zeigt eine einzelne Aufgabenbereich-Schaltfläche in einem <MobileFormFactor-Element> .

<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
  ...
  <MobileFormFactor>
    <FunctionFile resid="residUILessFunctionFileUrl" />
    <ExtensionPoint xsi:type="MobileMessageReadCommandSurface">
      <Group id="mobileMsgRead">
        <Label resid="groupLabel" />
        <Control xsi:type="MobileButton" id="TaskPaneBtn">
          <Label resid="residTaskPaneButtonName" />
          <Icon xsi:type="bt:MobileIconList">
            <bt:Image size="25" scale="1" resid="tp0icon" />
            <bt:Image size="25" scale="2" resid="tp0icon" />
            <bt:Image size="25" scale="3" resid="tp0icon" />

            <bt:Image size="32" scale="1" resid="tp0icon" />
            <bt:Image size="32" scale="2" resid="tp0icon" />
            <bt:Image size="32" scale="3" resid="tp0icon" />

            <bt:Image size="48" scale="1" resid="tp0icon" />
            <bt:Image size="48" scale="2" resid="tp0icon" />
            <bt:Image size="48" scale="3" resid="tp0icon" />
          </Icon>
          <Action xsi:type="ShowTaskpane">
            <SourceLocation resid="residTaskpaneUrl" />
          </Action>
        </Control>
      </Group>
    </ExtensionPoint>
  </MobileFormFactor>
  ...
</VersionOverrides>

Dieses ähnelt stark Elementen, die in einem DesktopFormFactor-Element enthalten sind, wobei einige wichtige Unterschiede erkennbar sind.

Das OfficeTab-Element wird nicht verwendet.
Das ExtensionPoint-Element darf nur ein untergeordnetes Element enthalten. Wenn Ihr Add-In den Erweiterungspunkt MobileOnlineMeetingCommandSurface oder MobileLogEventAppointmentAttendee implementiert, müssen Sie ein untergeordnetes Control-Element einschließen. Wenn Ihr Add-In den Erweiterungspunkt MobileMessageReadCommandSurface implementiert, müssen Sie ein untergeordnetes Group-Element einschließen, das mehrere Control-Elemente<> enthält.
Es gibt keine Menu Typäquivalente für das <Control-Element> .
Das Supertip-Element wird nicht verwendet.
Die erforderlichen Symbolgrößen weichen ab. Mobile Add-Ins müssen mindestens Symbole mit einer Größe von 25 x 25, 32 x 32 und 48 x 48 unterstützen. Weitere Informationen finden Sie unter Zusätzliche Anforderungen für mobile Formfaktoren.

Codeüberlegungen

Beim Entwerfen eines Add-Ins für mobile Umgebungen müssen zusätzliche Aspekte berücksichtigt werden.

Verwenden Sie REST anstelle von Exchange-Webdiensten.

Die Office.context.mailbox.makeEwsRequestAsync-Methode wird in Outlook Mobile nicht unterstützt. Add-Ins sollten nach Möglichkeit das Abrufen von Informationen aus der Office.js-API vorziehen. Wenn Add-Ins Informationen erfordern, die nicht von der Office.js-API zur Verfügung gestellt werden, sollten sie die Outlook-REST-APIs für den Zugriff auf das Postfach des Benutzers verwenden.

Im Postfachanforderungssatz 1.5 wurde eine neue Version von Office.context.mailbox.getCallbackTokenAsync eingeführt, die ein mit den REST-APIs kompatibles Zugriffstoken anfordern kann, sowie eine neue Office.context.mailbox.restUrl-Eigenschaft , die verwendet werden kann, um den REST-API-Endpunkt für den Benutzer zu finden.

Vergrößern

Standardmäßig können Benutzer die Geste "Zoom zusammendrücken" verwenden, um Aufgabenbereiche zu vergrößern. Wenn dies für Ihr Szenario nicht sinnvoll ist, deaktivieren Sie den Zoom in Ihrem HTML-Code.

Schließen von Aufgabenbereichen

In Outlook Mobile nehmen Aufgabenbereiche den gesamten Bildschirm ein und erfordern standardmäßig, dass der Benutzer sie schließen muss, um zur Nachricht zurückzukehren. Erwägen Sie die Verwendung der Office.context.ui.closeContainer-Methode , um den Aufgabenbereich zu schließen, wenn Ihr Szenario abgeschlossen ist.

Verfassenmodus und Termine

Derzeit unterstützen Add-Ins in Outlook Mobile nur die Aktivierung beim Lesen von Nachrichten. Add-Ins werden beim Verfassen von Nachrichten oder beim Anzeigen oder Verfassen von Terminen nicht aktiviert. Es gibt jedoch Ausnahmen.

Integrierte Add-Ins des Onlinebesprechungsanbieters werden im Terminorganisationsmodus aktiviert. Weitere Informationen zu dieser Ausnahme (einschließlich verfügbarer APIs) finden Sie unter Erstellen eines mobilen Outlook-Add-Ins für einen Onlinebesprechungsanbieter.
Add-Ins, die Terminnotizen und andere Details zu Customer Relationship Management (CRM) oder Notizendiensten protokollieren, werden im Terminteilnehmermodus aktiviert. Weitere Informationen zu dieser Ausnahme (einschließlich verfügbarer APIs) finden Sie unter Protokollieren von Terminnotizen für eine externe Anwendung in mobilen Outlook-Add-Ins.
Ereignisbasierte Add-Ins werden aktiviert, wenn das OnNewMessageCompose Ereignis eintritt. Weitere Informationen zu dieser Ausnahme (einschließlich zusätzlicher unterstützter APIs) finden Sie unter Implementieren der ereignisbasierten Aktivierung in mobilen Outlook-Add-Ins.

Unterstützte APIs

Obwohl Outlook Mobile bis zum Postfachanforderungssatz 1.5 unterstützt, können Sie jetzt zusätzliche APIs aus späteren Anforderungssätzen implementieren, um die Funktionen Ihres Add-Ins auf Outlook Mobile weiter zu erweitern. Eine Anleitung dazu, welche APIs Sie in Ihrem mobilen Add-In implementieren können, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.

Freigeben über