Skip to content

$ged.deleteNode

Description

Supprime un nœud et ses fils en GED. La méthode

Syntaxe

$ged.deleteNode( nodeid [ , options ] )

Paramètres

nodeid string
Identifiant du node dont on souhaite obtenir des informations.
options map

Map d'options pouvant contenir les propriétés suivantes:

connection string
Nom de connexion à utiliser. Fait référence à un name d'entrée ged.connection du config.
version string / number

Numéro de version du document à supprimer. Le numéro de version doit avoir la forme M.m" oùMdésigne le numéro de version majeur etmle numéro de version mineur, par exemple1.2`.

Il est possible de spécifier une valeur vide, la valeur 0 ou le texte latest pour désigner la dernière version existante.

La suppression d'une version individuelle est permanente. La propriété permanent est donc ignorée lorsque la suppression porte sur une version en particulier.

permanent boolean

Flag permettant de demander une suppression définitive. Les noeuds sont retirés des tables index de façon récursive et les fichiers sont physiquement supprimés du filesystem.

Lorsque le flag n'est pas défini ou qu'il vaut false, le noeud est simplement marqué comme supprimé. Cette option est sans effet si la propriété version est définie.

Valeur par défaut: false

permanent boolean

Flag permettant de demander à la GED d'effectuer une suppression définitive, c'est-à-dire sans envoi dans la corbeille.

Cette option est sans effet si la propriété version est définie.

Valeur par défaut: false

Retour

Nodeid reçu en entrée si la suppression a pu se faire sans erreur ou null si elle a rencontré une erreur.

Exemple

1
2
3
4
5
var nodeid = $ged.createDocument("b8a4f19a-f7c7-4015-bf5f-3836cbd0a87c",
                                 $file.load("/path-to/test.docx"));

var res = $ged.deleteNode(nodeid);
$logger.info(res);