Chapitre 13 Les essentiels de l'API
Ce chapitre détaille les méthodes et les fonctions essentielles pour réaliser le développement d'un module Dynacase. Les API décrites dans ce chapitre abordent les notions principales de Dynacase qui sont :
- la manipulation de documents,
- la recherche de documents,
- les actions et les applications.
La signature (arguments et retour) et le comportement de ces API sont stables tout au long de la version. Si des modifications de signature ou de comportements sont toutefois nécessaires dans une release, ces modifications sont notées dans la release note associée à l'annonce ainsi que dans l'historique et dans la documentation de l'API concernée en précisant les différences entre les releases.
Contenu du chapitre
- 13.1 Classe Action mis à jour
- 13.1.1 Caractéristiques de la classe Action mis à jour
- 13.1.2 Principales propriétés de la classe Action mis à jour
- 13.1.3 Action::canExecute
- 13.1.4 Action::exitError
- 13.1.5 Action::getImageUrl()
- 13.1.6 Action::addWarningMsg
- 13.1.7 Action::getWarningMsg
- 13.1.8 Action::clearWarningMsg
- 13.1.9 Action::addLogMsg
- 13.2 Classe ActionUsage
- 13.2.1 Constructeur
- 13.2.2 ActionUsage::getUsage()
- 13.3 Classe ApiUsage mis à jour
- 13.3.1 Constructeur mis à jour
- 13.3.2 ApiUsage::addEmptyParameter() nouveauté
- 13.3.3 ApiUsage::addHiddenParameter() nouveauté
- 13.3.4 ApiUsage::addRequiredParameter() nouveauté
- 13.3.5 ApiUsage::addOptionalParameter() nouveauté
- 13.3.6 ApiUsage::setDefinitionText() nouveauté
- 13.3.7 ApiUsage::setStrictMode()
- 13.3.8 ApiUsage::verify()
- 13.4 Classe Application
- 13.4.1 Propriétés de la classe Application
- 13.4.2 Propriétés fonctionnelles
- 13.4.3 Application::addCssCode
- 13.4.4 Application::addCssRef
- 13.4.5 Application::addJsCode
- 13.4.6 Application::addJsRef
- 13.4.7 Application::getCSSLink
- 13.4.8 Application::getJSLink
- 13.5 Classe Dir
- 13.5.1 Méthodes de la classe Dir mis à jour
- 13.5.2 Hameçons (hooks) de la classe Dir
- 13.6 Classe Doc mis à jour
- 13.6.1 Propriétés de la classe Doc
- 13.6.2 Hameçons (hooks) de la classe Doc
- 13.6.3 Méthodes de la classe Doc
- 13.6.4 Gestion des minuteurs de document nouveauté
- 13.7 Classe Docfam
- 13.7.1 Propriétés de la classe DocFam
- 13.8 Classe DocumentList
- 13.8.1 Constructeur
- 13.8.2 Exemples
- 13.8.3 Voir aussi
- 13.8.4 DocumentList::addDocumentIdentifiers() nouveauté
- 13.9 Classe Layout
- 13.9.1 Constructeur
- 13.9.2 Layout::gen()
- 13.9.3 Layout::set()
- 13.9.4 Layout::eSet() nouveauté
- 13.9.5 Layout::setBlockData()
- 13.9.6 Layout::eSetBlockData() nouveauté
- 13.10 Classe Log
- 13.10.1 Constructeur
- 13.10.2 Log::debug()
- 13.10.3 Log::deprecated()
- 13.10.4 Log::error()
- 13.10.5 Log::fatal()
- 13.10.6 Log::info()
- 13.10.7 Log::warning()
- 13.10.8 Log::setLogLevel() nouveauté
- 13.11 Classe ApplicationParameterManager nouveauté
- 13.11.1 Paramètre utilisateur : valeur principale et valeur personnalisée nouveauté
- 13.11.2 Paramètre global nouveauté
- 13.11.3 Héritage de paramètres nouveauté
- 13.11.4 ApplicationParameterManager::getCommonParameterValue() nouveauté
- 13.11.5 ApplicationParameterManager::getParameter() nouveauté
- 13.11.6 ApplicationParameterManager::getParameters() nouveauté
- 13.11.7 ApplicationParameterManager::getParameterValue() nouveauté
- 13.11.8 ApplicationParameterManager::getScopedParameterValue() nouveauté
- 13.11.9 ApplicationParameterManager::getUserParameterDefaultValue() nouveauté
- 13.11.10 ApplicationParameterManager::getUserParameterValue() nouveauté
- 13.11.11 ApplicationParameterManager::resetCache() nouveauté
- 13.11.12 ApplicationParameterManager::setCommonParameterValue() nouveauté
- 13.11.13 ApplicationParameterManager::setParameterValue() nouveauté
- 13.11.14 ApplicationParameterManager::setUserParameterDefaultValue() nouveauté
- 13.11.15 ApplicationParameterManager::setUserParameterValue() nouveauté
- 13.12 Classe SearchAccount nouveauté
- 13.12.1 Constructeur nouveauté
- 13.12.2 Voir aussi nouveauté
- 13.12.3 SearchAccount::addFilter() nouveauté
- 13.12.4 SearchAccount::addGroupFilter() nouveauté
- 13.12.5 SearchAccount::addRoleFilter() nouveauté
- 13.12.6 SearchAccount::getLoginFromDocName() nouveauté
- 13.12.7 SearchAccount::search() nouveauté
- 13.12.8 SearchAccount::setReturnType() nouveauté
- 13.12.9 SearchAccount::setOrder() nouveauté
- 13.12.10 SearchAccount::setSlice() nouveauté
- 13.12.11 SearchAccount::setStart() nouveauté
- 13.12.12 SearchAccount::setTypeFilter() nouveauté
- 13.12.13 SearchAccount::overrideViewControl() nouveauté
- 13.13 Classe SearchDoc
- 13.13.1 Constructeur
- 13.13.2 SearchDoc::setObjectReturn()
- 13.13.3 SearchDoc::setOrder()
- 13.13.4 SearchDoc::setPertinenceOrder() nouveauté
- 13.13.5 SearchDoc::setSlice()
- 13.13.6 SearchDoc::setStart()
- 13.13.7 SearchDoc::setRecursiveSearch() mis à jour
- 13.13.8 SearchDoc::useCollection()
- 13.13.9 SearchDoc::addFilter()
- 13.13.10 SearchDoc::addGeneralFilter() nouveauté
- 13.13.11 SearchDoc::onlyCount() mis à jour
- 13.13.12 SearchDoc::join() mis à jour
- 13.13.13 SearchDoc::overrideViewControl() nouveauté
- 13.13.14 SearchDoc::excludeConfidential()
- 13.13.15 SearchDoc::search()
- 13.13.16 SearchDoc::reset()
- 13.13.17 SearchDoc::count() mis à jour
- 13.13.18 SearchDoc::getDocumentList()
- 13.13.19 SearchDoc::getError()
- 13.13.20 SearchDoc::getIds() nouveauté
- 13.13.21 SearchDoc::returnsOnly() nouveauté
- 13.13.22 SearchDoc::getSearchInfo()
- 13.13.23 SearchDoc::getNextDoc()
- 13.14 Utilitaires de gestion de documents
- 13.14.1 Notes
- 13.14.2 new_Doc
- 13.14.3 createDoc
- 13.14.4 createTmpDoc