Поделиться через

Указание действий для обработчиков файлов версии 2.0

  • Статья

При регистрации обработчика файлов вам следует указать набор действий, которые разрешает выполнять этот обработчик файлов.

Существует три указанных ниже встроенных действия, которые может поддерживать обработчик файлов.

  • newFile: тип файла отображается в меню Создать в OneDrive и SharePoint.
  • open: обработчик файлов, отображаемый в меню Открыть в OneDrive и SharePoint, может открывать файлы. Действия открытия запускаются в новой вкладке браузера.
  • preview: обработчик файлов может выполнять предварительный просмотр файлов. Окно предварительного просмотра открывается, когда пользователь щелкает файл левой кнопкой мыши в OneDrive или SharePoint. Действия предварительного просмотра загружаются в элемент <IFRAME> на веб-сайтах OneDrive и SharePoint.

Дополнительные обработчики файлов поддерживают тип действий custom, который позволяет обработчикам файлов создавать действия, заданные приложениями. Эти дополнительные действия отображаются на панели инструментов в OneDrive и SharePoint, и их можно добавить в файл с любым расширением.

Определение действий в манифесте обработчика файлов

Для определения действий в манифесте обработчика файлов используется пара "ключ-значение" действий. Она содержит массив действий, поддерживаемых обработчиком файлов.

Ниже показан пример определения для трех встроенных действий и одного дополнительного действия.

[
    {
        "type": "newFile",
        "url": "https://url/for/endpoint",
        "availableOn": {
            "file": { "extensions": [".bin"] },
            "web": { }
        }
    },
    {
        "type": "open",
        "url": "https://url/for/endpoint",
        "availableOn": {
            "file": { "extensions": [".bin"] },
            "web": { }
        }
    },
    {
        "type": "preview",
        "url": "https://url/for/endpoint",
        "availableOn": {
            "file": { "extensions": [".bin"] },
            "web": { }
        }
    },
    {
        "type": "custom",
        "url": "https://url/for/endpoint",
        "displayName": "Add Signature with Contoso",
        "shortDisplayName": "Add Signature",
        "icon": {
            "png1x": "https://url/for/icon.png"
        },
        "availableOn": {
            "file": { "extensions": ["*"] },
            "folder": { },
            "allowMultiSelect": true,
            "web": { }
        }
    }
]

Из-за ограничений в расширениях надстроек Azure Active Directory эти действия хранятся в сериализованном виде в строке. Перед преобразованием массива в строку для последующего сохранения в манифесте рекомендуется уменьшить массив, используя формат JSON.

Например, определенные выше действия будут сохранены в файле манифеста обработчика файлов, таком, например, как указанный ниже.

{
    "type": "FileHandler",
    "properties": [
        {
            "key": "version",
            "value": "2"
        },
        {
            "key": "actions",
            "value": "[{\"type\":\"newFile\",\"url\":\"https://url/for/endpoint\",\"availableOn\":{\"file\":{\"extensions\":[\".bin\"]},\"web\":{}}},{\"type\":\"open\",\"url\":\"https://url/for/endpoint\",\"availableOn\":{\"file\":{\"extensions\":[\".bin\"]},\"web\":{}}},{\"type\":\"preview\",\"url\":\"https://url/for/endpoint\",\"availableOn\":{\"file\":{\"extensions\":[\".bin\"]},\"web\":{}}},{\"type\":\"custom\",\"url\":\"https://url/for/endpoint\",\"displayName\":\"Add Signature with Contoso\",\"shortDisplayName\":\"Add Signature\",\"icon\":{\"png1x\":\"https://url/for/icon.png\"},\"availableOn\":{\"file\":{\"extensions\":[\"*\"]},\"folder\":{},\"allowMultiSelect\":true,\"web\":{}}}]"
        }
    ]
}

Параметры действий

Каждое действие, объявленное в параметре action, принимает следующую форму:

{
    "type": "newFile | open | preview | custom",
    "url": "url",
    "displayName": "string",
    "shortDisplayName": "string",
    "icon": { 
        "@odata.type": "microsoft.graph.displayIcon",
        "svg": "url",
        "png1x": "url",
        "png1_5x": "url",
        "png2x": "url"
    },
    "availableOn": {
        "@odata.type": "microsoft.graph.availableOn",
        "file": {
            "@odata.type": "microsoft.graph.availableOnFile",
            "extensions": [ ".pdf", ".png", ".psd" ]
        },
        "folder": {
            "@odata.type": "microsoft.graph.availableOnFolder"
        },
        "allowMultiSelect": false,
        "web": { "@odata.type": "microsoft.graph.availableOnWeb" }
    }
}

Свойства

Не все свойства являются обязательными. Это зависит от типа указанного действия.

Имя параметра Тип Описание
type строка Значение newFile, open или preview. Обязательный.
url URL-адрес URL-адрес в формате https:// для конечной точки, обрабатывающей действие обработчика файлов. Обязательный.
displayName строка Строка языкового стандарта, используемого по умолчанию для type: "custom" для представления действия. Необязательный параметр.
shortDisplayName string Строка языкового стандарта по умолчанию для type: "custom", представляющая действие на панели инструментов или в свернутом меню действий. Необязательный параметр.
availableOn object Коллекция свойств, определяющих, где доступно это действие. Обязательный.
icon displayIcon Объект, содержащий URL-адреса изображений значков в файлах этого типа. Необязательный параметр.
  • Свойство displayName применимо только к действиям типа custom и игнорируется для действий любого другого типа.

Свойства AvailableOn

Задав свойства в свойстве availableOn , можно настроить, где доступно действие:

Имя параметра Тип Описание
file.extensions Массив строк Массив расширений файлов, в которых доступно действие. Расширения должны начинаться с точки (.). Вы можете использовать подстановочный знак *, чтобы указать все расширения файлов для дополнительных действий.
folder object Объект без параметров указывает, что обработчик файлов доступен, если выбрана папка или не выбрано ни одного файла. Если свойство имеет значение null либо если оно не определено, это указывает, что действие недоступно для папок.
allowMultiSelect boolean Если значение равно true, можно выбрать несколько файлов, и действие по-прежнему будет отображаться. Если значение равно false или отсутствует, действие будет отображаться, только если выбран один элемент.
web объект Объект без параметров указывает, что обработчик файлов доступен при просмотре веб-сайта.
  • Для действий типа newFile можно указать только одно расширение файла. Это расширение, которое будут иметь создаваемые файлы. Если в списке несколько расширений файлов, будет использовано только первое расширение файла.
  • Свойства folder и allowMultiSelect применяются только к действиям типа custom. Эти значения будут проигнорированы для действий любого другого типа.