$ged.deleteNode¶
Description¶
Supprime un nœud et ses fils en GED. La méthode
Syntaxe¶
$ged.deleteNode( nodeid [ , options ] )
Paramètres¶
nodeidstring- Identifiant du node dont on souhaite obtenir des informations.
optionsmap-
Map d'options pouvant contenir les propriétés suivantes:
connectionstring- Nom de connexion à utiliser. Fait référence à un
named'entréeged.connectiondu config. versionstring / 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
0ou le textelatestpour désigner la dernière version existante.La suppression d'une version individuelle est permanente. La propriété
permanentest donc ignorée lorsque la suppression porte sur une version en particulier.
permanentboolean-
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éversionest définie.Valeur par défaut:
false
permanentboolean-
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é
versionest 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 | |