Partager via

Spécification des actions pour les gestionnaires de fichiers 2.0

  • Article

Lorsque vous enregistrez un gestionnaire de fichiers, vous spécifiez un ensemble d’actions activées par le gestionnaire de fichiers.

Un gestionnaire de fichiers peut choisir de prendre en charge trois actions intégrées :

  • newFile: Le type de fichier s’affiche dans le menu Nouveau de OneDrive et SharePoint.
  • open: Les fichiers peuvent être ouverts par le gestionnaire de fichiers, qui s’affiche dans le menu Ouvrir de OneDrive et SharePoint. Les actions ouvertes sont lancées dans un nouvel onglet du navigateur.
  • preview: Le gestionnaire de fichiers peut prévisualiser les fichiers. Pour ce faire, l’utilisateur doit cliquer avec le bouton gauche de la souris sur un fichier dans OneDrive et SharePoint. Les actions prévisualisées sont chargées dans un élément <IFRAME> à l’intérieur des sites web SharePoint et OneDrive.
  • custom: les fichiers peuvent utiliser un gestionnaire de fichiers pour créer des actions définies par l’application. Ces actions supplémentaires s’affichent dans la barre d’outils de OneDrive et SharePoint, et peuvent être ajoutées à n’importe quelle extension de fichier.

Définition d’actions dans le manifeste du gestionnaire de fichiers

Les actions sont définies dans le manifeste du gestionnaire de fichiers dans la paire clé-valeur actions qui contient un tableau d’actions prises en charge par le gestionnaire de fichiers.

Voici un exemple de définition pour les trois actions intégrées et une action personnalisée unique :

[
    {
        "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": { }
        }
    }
]

En raison des limitations des extensions addIn Azure Active Directory, ces actions sont stockées de manière sérialisée lors de leur enregistrement dans une chaîne. Il est recommandé de réduire le tableau avant de le convertir en valeur de chaîne pour l’enregistrement dans le manifeste.

Par exemple, les actions définies ci-dessus sont enregistrées dans le manifeste du gestionnaire de fichiers comme suit :

{
    "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\":{}}}]"
        }
    ]
}

Paramètres d’action

Chaque action déclarée dans le paramètre d’action prend la forme suivante :

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

Propriétés

Toutes les propriétés ne sont pas obligatoires. Cela dépend du type d’action spécifié.

Nom du paramètre Type Description
type string Valeur , newFilecustom, openou preview. Obligatoire.
url URL URL https:// du point de terminaison qui gère l’action du gestionnaire de fichiers. Obligatoire.
displayName string Chaîne de paramètres régionaux par défaut utilisée pour représenter l’action. Optional. La valeur par défaut est « Ouvrir dans le navigateur » pour type: "open".
shortDisplayName string Chaîne de paramètres régionaux par défaut utilisée pour représenter l’action dans la barre d’outils ou le menu d’action réduit. Optional.
availableOn objet Ensemble de propriétés qui permettent de définir où cette action est disponible. Obligatoire.
icône displayIcon Objet contenant des URL vers les images d’icône pour ce type de fichier. Optional.

Propriétés AvailableOn

En définissant les propriétés dans la propriété availableOn , vous pouvez personnaliser l’emplacement où l’action est disponible :

Nom du paramètre Type Description
file.extensions tableau de chaînes Tableau des extensions de fichier où l’action est disponible. Les extensions de fichier doivent commencer par un point (.). Un caractère générique * peut être utilisé pour indiquer toutes les extensions de fichier pour les actions personnalisées.
folder objet Un objet sans paramètre indique que le gestionnaire de fichiers est disponible lorsqu’un dossier est sélectionné, ou lorsqu’aucun fichier n’est sélectionné. Une valeur Null ou bien une propriété non définie indique que l’action n’est pas disponible pour les dossiers.
allowMultiSelect booléen Si la valeur est true, plusieurs fichiers peuvent être sélectionnés et l’action s’affiche toujours. Si la valeur est false ou manquante, l’action s’affiche uniquement lorsqu’un seul élément est sélectionné.
web object Objet sans paramètre qui indique que le gestionnaire de fichiers est disponible quand vous naviguez sur le site web.
  • Une seule extension de fichier peut être spécifiée pour les actions de type newFile. Il s’agit de l’extension du fichier qui vient d’être créé. Si plusieurs extensions de fichier sont répertoriées, seule la première extension de fichier est utilisée.
  • Les propriétés folder et allowMultiSelect s’appliquent uniquement aux actions de type custom. Ces valeurs sont ignorées pour les actions d’un autre type.