Cómo: Registrar un complemento de controlador de archivos manualmente

  • Artículo

Para desarrollar un complemento de controlador de archivos, primero necesita cargar el manifiesto del controlador de archivos en el registro de la aplicación en Azure Active Directory. Esto se puede hacer mediante programación o mediante el editor de manifiestos de la aplicación de Azure Active Directory.

Manifiesto de la aplicación y la propiedad addIns

Los manifiestos del controlador de archivos se almacenan junto al manifiesto de la aplicación en Azure Active Directory. La propiedad addIns del manifiesto de la aplicación muestra los componentes de complemento de una aplicación, como controladores de archivos y sus propiedades asociadas.

El manifiesto se compone de un conjunto de propiedades clave-valor, que definen las propiedades del controlador de archivos. Para obtener más información sobre el manifiesto del controlador de archivos, vea Información general del controlador de archivos.

Un manifiesto del controlador de archivos de ejemplo:

{
"id": "968A844F-7A47-430C-9163-07AE7C31D407",
"type": "FileHandler",
"properties": [
    { "key": "version", "value": "2" },
    { "key": "fileTypeDisplayName", "value": "Display name of the file format" },
    { "key": "fileTypeIcon", "value": "{\"svg\":\"https://example.org/icon.svg\",\"png1x\":\"https://example.org/icon@1x.png\",\"png1.5x\":\"https://example.org/icon@1.5x.png\",\"png2x\":\"https://example.org/icon@2x.png\"}" },
    { "key": "appIcon", "value": "{\"svg\":\"https://example.org/app-icon.svg\",\"png1x\":\"https://example.org/app-icon@1x.png\",\"png1.5x\":\"https://example.org/app-icon@1.5x.png\",\"png2x\":\"https://example.org/app-icon@2x.png\"}" },
    { "key": "actions", "value": "json string of additional actions"}
  ]
}

Para registrar un controlador de archivos, necesita actualizar la colección addIns en el manifiesto de la aplicación almacenado en Azure Active Directory.

Actualización del manifiesto de aplicación en AAD

Este método requiere que actualice el manifiesto JSON directamente en AAD.

  1. Vaya a la aplicación en Azure Active Directory.
  2. Seleccione la opción de menú izquierdo "Manifiesto".
  3. Pegue el controlador de archivos Add-In JSON en la matriz "addIns", como se muestra a continuación:
{
	"id": "9280aaa1-65c3-4a01-9ced-4f3e8e989c56",
	"acceptMappedClaims": null,
	"accessTokenAcceptedVersion": 2,
	"addIns": [
		{
			"id": "328486ea-7159-4b6a-a2aa-f036b2423b23",
			"type": "FileHandler",
			"properties": [
				{
					"key": "version",
					"value": "2"
				},
				{
					"key": "fileTypeDisplayName",
					"value": "Contoso Markdown"
				},
				{
					"key": "fileTypeIcon",
					"value": "{\"svg\":\"https://localhost:3000/images/icons/icon.svg\",\"png1x\":\"https://localhost:3000/images/icons/icon@1x.png\",\"png1.5x\":\"https://localhost:3000/images/icons/icon@1.5x.png\",\"png2x\":\"https://localhost:3000/images/icons/icon@2x.png\"}"
				},
				{
					"key": "appIcon",
					"value": "{\"svg\":\"https://localhost:3000/images/icons/app-icon.svg\",\"png1x\":\"https://localhost:3000/images/icons/app-icon@1x.png\",\"png1.5x\":\"https://localhost:3000/images/icons/app-icon@1.5x.png\",\"png2x\":\"https://localhost:3000/images/icons/app-icon@2x.png\"}"
				},
				{
					"key": "actions",
					"value": "[{\"type\":\"newFile\",\"url\":\"https://localhost:3000/markdown/create\",\"availableOn\":{\"file\":{\"extensions\":[\".md\"]},\"web\":{}}},{\"type\":\"open\",\"url\":\"https://localhost:3000/markdown/edit\",\"availableOn\":{\"file\":{\"extensions\":[\".md\"]},\"web\":{}}},{\"type\":\"preview\",\"url\":\"https://localhost:3000/markdown/preview\",\"availableOn\":{\"file\":{\"extensions\":[\".md\"]},\"web\":{}}}]"
				}
			]
		}
	],
  "allowPublicClient": true,
  remainder omitted...
}
  1. Seleccione "Guardar" en la barra de menús superior.

Uso de Microsoft Graph para registrar un controlador de archivos

Puede actualizar mediante programación un registro de aplicación de AAD para agregar el manifiesto del controlador de archivos. Esto requiere dos aplicaciones existentes: la aplicación Controlador de archivos y una aplicación con Directory.ReadWrite.All permisos para permitir actualizaciones en el registro del controlador de archivos.

  1. Tendrá que adquirir un token de portador para acceder a Microsoft Graph. Para obtener más información sobre el token, consulte la documentación de tokens de AAD. Este token debe incluir los Directory.ReadWrite.All permisos como se mencionó anteriormente.

  2. Tenga en cuenta el identificador de objeto de la aplicación que representa el registro del controlador de archivos en el que se insertará el manifiesto. Esto se puede encontrar en la página "Información general" del registro de la aplicación y es diferente del identificador de aplicación.

  3. Ahora, con el token del paso 1 y el identificador de objeto del paso 2, puede realizar una solicitud PUT para https://graph.microsoft.com/v1.0/applications/${objectId}/addIns incluir el manifiesto en el cuerpo como se muestra.

PUT https://graph.microsoft.com/v1.0/applications/${objectId}/addIns HTTP/1.1
Authorization: Bearer ${AAD Token}
Accept: application/json
Content-Type: application/json

{
  "value": [{
      {
        "id": "968A844F-7A47-430C-9163-07AE7C31D407",
        "type": "FileHandler",
        "properties": [
            { "key": "version", "value": "2" },
            { "key": "fileTypeDisplayName", "value": "Display name of the file format" },
            { "key": "fileTypeIcon", "value": "{\"svg\":\"https://example.org/icon.svg\",\"png1x\":\"https://example.org/icon@1x.png\",\"png1.5x\":\"https://example.org/icon@1.5x.png\",\"png2x\":\"https://example.org/icon@2x.png\"}" },
            { "key": "appIcon", "value": "{\"svg\":\"https://example.org/app-icon.svg\",\"png1x\":\"https://example.org/app-icon@1x.png\",\"png1.5x\":\"https://example.org/app-icon@1.5x.png\",\"png2x\":\"https://example.org/app-icon@2x.png\"}" },
            { "key": "actions", "value": "json string of additional actions"}
        ]
        }
  }]
}

Ahora que el manifiesto del controlador de archivos se ha registrado con su aplicación en AAD, puede seguir creando y probando su complemento del controlador de archivos.

Nota:

Puede ver un ejemplo completo de adquisición de un token, creación de una aplicación y registro del complemento de controlador de archivos en las herramientas del ejemplo Nodejs.

Importante

Los cambios en el manifiesto del controlador de archivos pueden tardar entre 24 y 48 horas en aparecer. Vea Refresh file handler cache (Actualizar la caché del controlador de archivos) para obtener información sobre cómo forzar la caché para que se borre por motivos de desarrollo.