$doc.delete

Description

Ferme un dossier et supprime celui-ci de la base de données. La méthode gère autant les dossiers ouverts en mémoire que ceux qui ne sont pas ouverts en mémoire. Dans le cas où un dossier n'est pas ouvert, la méthode se charge de supprimer le dossier directement au niveau de la base de données.

Syntaxe

$doc.delete( context [ , options ] )

Paramètres

context string / map

Object décrivant le contexte, ou tableau d'objets décrivant le contexte de dossier à supprimer. Le paramètre peut être soit une valeur unique, soit un tableau de valeurs. La ou les valeurs peuvent désigner soit un0 contexte (exprimé en tant que string en clair, p.ex. "vendeur[123]" ou sous forme de hash) ou un map décrivant le contexte. Dans ce cas, le map doit a minima contenir une valeur pour les propriétés modelName et docId. Dans le cas où le paramètre est un tableau, ce dernier peut contenir soit des contextes sous forme de string, soit sous forme de map, soit un mélange des deux.

options map

Map d'options. Les options reconnues sont:

ignorePolicies boolean

Flag indiquant de ne pas tenir compte des policies lors du traitement.

Par défaut, les policies sont vérifiées si l'application gère des policies et si le thread courant est un thread "client", c'est-à-dire un thread initié par une requête du client. Si la méthode est invoquée par un script démarré par le scheduler, les policies ne seront pas vérifiées par défaut.

notify boolean

Flag true/false indiquant si le moteur doit déclencher la notification doc-delete. Par défaut le flag est false.

Voir la description détaillée dans la documentation de la méthode $doc.create.

notificationParams map

Paramètres supplémentaires à passer lors de la notification doc-delete. N'est pris en compte que lorsque notify est true.

Le paramètre attendu est un map de clés-valeurs. Les clés modelName et docId sont réservées et renseignées automatiquement par la méthode.

Le fait de spécifier des paramètres de notification active automatiquement l'option notify (pour autant qu'elle ne soit pas explicitement définir à false).

Retour

La méthode retourne le nombre de dossiers supprimés.

Exemple

Non disponible