Table of contents
TOC
Inhaltsverzeichnis reduzieren
Inhaltsverzeichnis erweitern
Zuletzt aktualisiert: 20.06.2018

Übersicht über Office 365 Dateihandler

Gilt für: Office 365

Dateihandler sind ein neuer Typ von Office-Add-Ins, mit dessen Hilfe sich Nicht-Microsoft-Dateitypen so in Office 365 integrieren lassen wie Office-Dateitypen.

Mit Dateihandlern können Sie die folgenden Benutzererfahrungen für Nicht-Microsoft-Dateitypen aktivieren:

  • benutzerdefinierte Dateisymbole
  • neue Dateien im Browser erstellen
  • Dateivorschau
  • erweiterte Ansicht/Funktion bearbeiten

Was ist in einem Office 365 Dateihandler

Ein Dateihandler besteht aus Folgendem:

  • Der Dateihandler-Endpunkt Eine in der Cloud gehostete App, die optional Funktionen der Erstellung, Vorschau und Bearbeitung neuer vom Dateihandler unterstützter Dateitypen bereitstellt.
  • Dateisymbol Das Bild, das den Dateityp in Office 365 darstellt.

Dateihandleranwendung

Die Dateihandleranwendung ist eine in der Cloud gehostete Anwendung. Sie enthält die Funktionslogik, über die die vom Dateihandler unterstützten Dateien erstellt, geöffnet und gespeichert werden und über die eine Dateivorschau angezeigt wird. Der Endpunkt kann auch auf anderen Stapeln als dem Microsoft-Stapel gehostet werden. Dateihandler nutzen Azure AD für den autorisierten Zugriff auf Office 365-Ressourcen. Daher muss die Anwendung bei Azure AD registriert sein. Weitere Informationen zur Registrierung einer Anwendung bei Azure AD finden Sie unter: Verwenden von Visual Studio zum Registrieren Ihrer Anwendung und Hinzufügen von Office 365-APIs und Manuelle Registrierung Ihrer App bei Azure AD, damit sie auf Office 365-APIs zugreifen kann.

Informationen für eine exemplarische Vorgehensweise zum Erstellen, Bereitstellen und Registrieren eines einfachen Dateihandlers mit Visual Studio finden Sie unter Dateihandler in Office 365 erstellen.

Ein komplexeres Beispiel für einen Dateihandler finden Sie unter GPX-FileHandler auf GitHub.

Dateihandler zur Laufzeit

Der Dateihandler wird mit der newFileUrl, openUrl oder previewUrl URL aufgerufen, die in der addIns-Eigenschaft des Azure AD-Appmanifest angegeben ist. Werfen wir, um zu verstehen, was passiert, einen Blick auf das Szenario, bei dem ein Benutzer zum Öffnen des Datei-Popups auf die Ellipsen klickt (...). Wenn es einen registrierten Dateihandler für diesen Dateityp gibt, ruft Office 365 die Dateihandler-App auf, indem er eine POST-Anforderung an die in previewUrl für das App-Manifest angegebene URL stellt und den Speicherort der Datei zusammen mit anderen Details in der Anforderung übergibt. Die previewUrl zeigt auf eine Methode in der Dateihandler-Anwendung, die einen Dateistrom für die Datei abruft, und verwendet diesen Stream dann, um eine Vorschau der Datei im Browser bereitzustellen.

Es ist der gleiche Ansatz für die offene Funktionalität. In dem Szenario, in dem der Benutzer auf Im Browser bearbeiten oder direkt auf den Dokumententitel in der Bibliothek klickt, stellt Office 365 eine POST-Anforderung an die openUrl-URL. Dieser Endpunkt lädt den Dateistrom in einen geeigneten Editor, sodass der Benutzer die Datei bearbeiten kann. Die Anwendung sollte es dem Benutzer ebenfalls ermöglichen, die Datei zu speichern, indem er den aktualisierten Dateistrom an den Speicherort zurückgibt, der im filePut-Aktivierungsparameter angegeben ist.

Wenn ein Benutzer auf Neue Dateiklickt, macht Office 365 eine POST-Anforderung an die newFileUrl. Dieser Endpunkt öffnet den entsprechenden Editor, sodass der Benutzer Inhalte der neuen Datei hinzufügen kann. Die Anwendung sollte es dem Benutzer ebenfalls ermöglichen, die Datei zurück an den Speicherort zu speichern, der im filePut-Aktivierungsparameter angegeben ist.

Aktivierungsparameter

In den Szenarien "Neu erstellen", Öffnen und Vorschau benötigt Ihre Anwendung Details, sogenannte Aktivierungsparameter, über die Datei, den Mandanten, den Office 365-Client usw., um mit der Datei zu arbeiten. Office 365 enthält diese Angaben als Formulardaten, die in der ersten POST-Anforderung an die Öffnen- oder Vorschau-Methode gesendet werden.

Tabelle 1. Beschreibungen der Aktivierungsparameter, die Office 365 beim Start des Dateihandlers sendet.

ParameterBeschreibung
ClientDer Office 365-Client, von dem aus die Datei geöffnet oder in der Vorschau angezeigt wird, z. B. "SharePoint".
CultureNameDer Kulturname des aktuellen Threads, der für die Lokalisierung verwendet wird.
FileGetDie vollständige URL des REST-Endpunkts, den Ihre App aufruft, um die Datei von Office 365 abzurufen. Ihre App muss diese mit der HTTP-GET-Methode aufrufen.
FilePutDie vollständige URL des REST-Endpunkts, den Ihre App aufruft, um die Datei zurück auf Office 365 zu speichern. Ihre App muss diese mit der HTTP-POST-Methode aufrufen.
ResourceIdDie URL des Office 365-Mandanten, mit dem der Zugriffscode von Azure AD abgerufen wurde.
FileIdDie Dokument-ID für ein bestimmtes Dokument. Sie ermöglicht Ihrer Anwendung, mehr als ein Dokument gleichzeitig zu öffnen.

Greifen Sie über den Anforderungstext mithilfe der Request.form-Sammlung auf diese Werte zu. Zum Beispiel:

Request.Form["FileId"];

Die Anwendung muss diese Werte zwischenspeichern, sobald der Dateihandler aufgerufen wird, da er beim ersten Aufruf der Anwendung für einen Benutzer kein Zugriffstoken besitzt, sodass er auf Azure AD umgeleitet wird. Dies löst den OAuth-Autorisierungscodefluss aus. Das Zwischenspeichern macht sie sofort verfügbar, nachdem die Azure AD-Autorisierung abgeschlossen wurde, und der Browser wird zurück zum Dateihandler umgeleitet. Ein Beispiel für die Verwendung eines Datenmodell-Objekts und einer Handlermethode zum Zwischenspeichern des Aktivierungsparameters in einem Cookie finden Sie im GPX-FileHandler-Beispiel, insbesondere ActivationParameters.cs und FileHandlerController.cs.

App-Manifest und die addIns-Eigenschaft

Sie geben die Dateihandler-Details in der addIns-Eigenschaft im Appmanifest an. Die addIns-Eigenschaft spezifiziert die in einer App enthaltenen Dateihandler und die zugehörigen Eigenschaften. Mit diesen Details wird ein Dateihandler für eine Erweiterung mit Office 365 konfiguriert, wobei das neue Datei-, Öffnungs- und Vorschau-Verhalten für diese Erweiterung angegeben wird.

Die Syntax für das Manifest ist:

{
    "addIns": [
        {
            "id": "unique guid",
            "type": "FileHandler",
            "properties": [
                {
                    "key": "extension",
                    "value": "List of file extensions separated by semicolons"
                },
                {
                    "key": "fileIcon",
                    "value": "URL of icon for the file type"
                },
                {
                    "key": "newFileUrl",
                    "value": "URL for the new file function"
                },
                {
                    "key": "openUrl",
                    "value": "URL for the file open function"
                },
                {
                    "key": "previewUrl",
                    "value": "URL for the file preview function"
                }
            ]
        }
    ]
}

Sie müssen für die Konfiguration des Dateihandlers das Appmanifest in Azure AD aktualisieren. Derzeit gibt es hierfür keine Benutzeroberfläche im Azure-Verwaltungsportal, Sie müssen dies daher manuell mit der Azure AD-Graph-API ausführen. Weitere Informationen finden Sie unter Konfigurieren und Aktualisieren von Dateihandlern in Office 365.

Dateihandler-Verfügbarkeit

In der folgenden Tabelle sind die Office 365-Dienste aufgeführt, die Dateihandler unterstützen.

DienstnameVerfügbarkeit
SharePoint OnlineAllgemein verfügbar
OneDrive for BusinessAllgemein verfügbar
Outlook Web AppAllgemein verfügbar

Inhalt dieses Abschnitts

© 2018 Microsoft