@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +8 -0
- package/package.json +1 -1
- package/server/AliasUtil/index.d.ts +13 -11
- package/server/ArchiveUtil/index.d.ts +45 -43
- package/server/ArraysInstance/index.d.ts +1667 -1808
- package/server/ArticleUtil/index.d.ts +294 -226
- package/server/AuthenticationUtil/index.d.ts +73 -85
- package/server/BookmarkUtil/index.d.ts +76 -81
- package/server/BuddyIconRenderer/index.d.ts +124 -132
- package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
- package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
- package/server/ClientUtil/index.d.ts +11 -9
- package/server/CollaborationFactory/index.d.ts +37 -40
- package/server/CollaborationGroupFolderUtil/index.d.ts +30 -28
- package/server/CollaborationGroupState/index.d.ts +27 -0
- package/server/CollaborationGroupState/index.js +11 -0
- package/server/CollaborationGroupTemplateUtil/index.d.ts +48 -50
- package/server/CollaborationGroupType/index.d.ts +28 -0
- package/server/CollaborationGroupType/index.js +12 -0
- package/server/CollaborationGroupUtil/index.d.ts +86 -82
- package/server/CollectionsInstance/index.d.ts +642 -705
- package/server/ColorUtil/index.d.ts +36 -37
- package/server/CompoundAndFilterBuilder/index.d.ts +31 -29
- package/server/CompoundComparatorBuilder/index.d.ts +35 -33
- package/server/CompoundOrFilterBuilder/index.d.ts +31 -29
- package/server/ContentNodeUtil/index.d.ts +36 -34
- package/server/CurrencyFactory/index.d.ts +72 -70
- package/server/DateUtil/index.d.ts +132 -142
- package/server/DecorationUtil/index.d.ts +13 -11
- package/server/DeviceUtil/index.d.ts +21 -19
- package/server/DimensionMode/index.d.ts +17 -0
- package/server/DimensionMode/index.js +12 -0
- package/server/DirectoryUtil/index.d.ts +90 -88
- package/server/DocType/index.d.ts +30 -0
- package/server/DocType/index.js +14 -0
- package/server/DocTypeUtil/index.d.ts +129 -135
- package/server/EndecUtil/index.d.ts +330 -347
- package/server/ExtendedDismaxParserBuilder/index.d.ts +156 -170
- package/server/FileIconRenderer/index.d.ts +153 -172
- package/server/FileUtil/index.d.ts +274 -300
- package/server/FilterBuilder/index.d.ts +42 -40
- package/server/FolderUtil/index.d.ts +93 -94
- package/server/FontUtil/index.d.ts +36 -37
- package/server/FormatterBuilderFactory/index.d.ts +76 -84
- package/server/HighlightBuilder/index.d.ts +79 -86
- package/server/IconUtil/index.d.ts +27 -25
- package/server/ImageLinkRenderer/index.d.ts +34 -32
- package/server/ImageRenderer/index.d.ts +343 -379
- package/server/ImageUtil/index.d.ts +247 -265
- package/server/IndexUtil/index.d.ts +40 -37
- package/server/IndexUtil.IndexType/index.d.ts +29 -0
- package/server/IndexUtil.IndexType/index.js +13 -0
- package/server/IndexingUtil/index.d.ts +69 -47
- package/server/InstanceCreatorUtil/index.d.ts +421 -457
- package/server/InstanceTypeUtil/index.d.ts +168 -189
- package/server/JwtUtil/index.d.ts +131 -129
- package/server/LandingPageUtil/index.d.ts +84 -87
- package/server/LandingPageUtil/index.js +1 -0
- package/server/LinkPageUtil/index.d.ts +297 -251
- package/server/LinkRenderer/index.d.ts +651 -715
- package/server/LinkTargetBuilder/index.d.ts +69 -77
- package/server/LinkValueBuilder/index.d.ts +70 -77
- package/server/ListWrapper/index.d.ts +82 -91
- package/server/LocaleUtil/index.d.ts +382 -394
- package/server/LogUtil/index.d.ts +119 -128
- package/server/MailBuilder/index.d.ts +109 -124
- package/server/MailUtil/index.d.ts +58 -63
- package/server/MathInstance/index.d.ts +625 -657
- package/server/MessageDigesterFactory/index.d.ts +30 -28
- package/server/MetadataDefinitionUtil/index.d.ts +79 -83
- package/server/MetadataUtil/index.d.ts +322 -346
- package/server/MimeTypeUtil/index.d.ts +209 -215
- package/server/MonitorBuilder/index.d.ts +20 -20
- package/server/NodeComparatorUtil/index.d.ts +215 -225
- package/server/NodeFactoryUtil/index.d.ts +18 -16
- package/server/NodeFilterUtil/index.d.ts +652 -739
- package/server/NodeIteratorUtil/index.d.ts +214 -229
- package/server/NodeResolverUtil/index.d.ts +400 -406
- package/server/NodeTreeUtil/index.d.ts +214 -229
- package/server/NodeTypeUtil/index.d.ts +1432 -548
- package/server/OfflineVersionPropertyUtil/index.d.ts +8 -6
- package/server/OnlineVersionPropertyUtil/index.d.ts +8 -6
- package/server/OutputUtil/index.d.ts +385 -380
- package/server/PageUtil/index.d.ts +266 -188
- package/server/PermissionUtil/index.d.ts +393 -430
- package/server/PermissionUtil.Permission/index.d.ts +54 -0
- package/server/PermissionUtil.Permission/index.js +38 -0
- package/server/PortletContextUtil/index.d.ts +112 -107
- package/server/PortletUtil/index.d.ts +32 -22
- package/server/PrincipalUtil/index.d.ts +35 -33
- package/server/Properties/index.d.ts +69 -76
- package/server/PropertyUtil/index.d.ts +1422 -1464
- package/server/PublishingUtil/index.d.ts +248 -249
- package/server/QueryStringUtil/index.d.ts +404 -415
- package/server/RedirectUtil/index.d.ts +64 -68
- package/server/RelatedValueBuilder/index.d.ts +45 -43
- package/server/Requester/index.d.ts +125 -125
- package/server/ResourceLocatorUtil/index.d.ts +436 -476
- package/server/RestApi/index.d.ts +158 -138
- package/server/RestAppInvokerFactory/index.d.ts +28 -26
- package/server/RoleAssignmentBuilder/index.d.ts +39 -37
- package/server/RoleMatcherBuilder/index.d.ts +39 -37
- package/server/RoleUtil/index.d.ts +35 -37
- package/server/ScriptUtil/index.d.ts +458 -495
- package/server/SearchFactory/index.d.ts +90 -105
- package/server/SearchUtil/index.d.ts +75 -73
- package/server/SearcherBuilder/index.d.ts +117 -124
- package/server/Session/index.d.ts +261 -1103
- package/server/Session/index.js +1 -20
- package/server/SimpleUserUtil/index.d.ts +28 -29
- package/server/SiteCookieUtil/index.d.ts +152 -175
- package/server/SortBuilder/index.d.ts +27 -25
- package/server/SourceSetMode/index.d.ts +12 -0
- package/server/SourceSetMode/index.js +12 -0
- package/server/SpellCheckBuilder/index.d.ts +30 -30
- package/server/StandardParserBuilder/index.d.ts +36 -34
- package/server/StructureUtil/index.d.ts +85 -83
- package/server/SubscriberUtil/index.d.ts +60 -67
- package/server/SubscriptionUtil/index.d.ts +123 -130
- package/server/SystemUserUtil/index.d.ts +148 -146
- package/server/TagUtil/index.d.ts +115 -120
- package/server/TemplateUtil/index.d.ts +115 -120
- package/server/TemporaryFileNodeBuilder/index.d.ts +32 -30
- package/server/TemporaryNodeBuilder/index.d.ts +139 -177
- package/server/TextModuleRendererBuilder/index.d.ts +22 -20
- package/server/TimestampUtil/index.d.ts +103 -117
- package/server/TranslationUtil/index.d.ts +98 -104
- package/server/TrashcanUtil/index.d.ts +114 -117
- package/server/UserDataUtil/index.d.ts +110 -111
- package/server/UserFactory/index.d.ts +47 -54
- package/server/UserFieldRenderer/index.d.ts +120 -128
- package/server/UserIdentityUtil/index.d.ts +38 -36
- package/server/UserUtil/index.d.ts +32 -30
- package/server/Utils/index.d.ts +634 -723
- package/server/VelocityRenderer/index.d.ts +96 -94
- package/server/VersionUtil/index.d.ts +25 -9
- package/server/WebContentUtil/index.d.ts +277 -284
- package/server/WebResourceFactory/index.d.ts +41 -46
- package/server/XSLTUtil/index.d.ts +34 -32
- package/server/XmlParserUtil/index.d.ts +50 -48
- package/types/javax/jcr/Binary/index.d.ts +3 -21
- package/types/javax/jcr/Binary/index.js +0 -1
- package/types/javax/jcr/Credentials/index.d.ts +3 -1
- package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +27 -1
- package/types/javax/jcr/Item/index.d.ts +6 -119
- package/types/javax/jcr/Item/index.js +0 -6
- package/types/javax/jcr/ItemVisitor/index.d.ts +5 -3
- package/types/javax/jcr/NamespaceRegistry/index.d.ts +69 -43
- package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
- package/types/javax/jcr/Node/index.d.ts +37 -1506
- package/types/javax/jcr/Node/index.js +1 -34
- package/types/javax/jcr/NodeIterator/index.d.ts +5 -3
- package/types/javax/jcr/Property/index.d.ts +494 -494
- package/types/javax/jcr/Property/index.js +0 -5
- package/types/javax/jcr/PropertyIterator/index.d.ts +5 -3
- package/types/javax/jcr/RangeIterator/index.d.ts +2 -42
- package/types/javax/jcr/RangeIterator/index.js +1 -5
- package/types/javax/jcr/Repository/index.d.ts +465 -263
- package/types/javax/jcr/Repository/index.js +0 -4
- package/types/javax/jcr/RepositoryFactory/index.d.ts +4 -2
- package/types/javax/jcr/Value/index.d.ts +4 -31
- package/types/javax/jcr/Value/index.js +0 -2
- package/types/javax/jcr/ValueFactory/index.d.ts +6 -74
- package/types/javax/jcr/ValueFactory/index.js +1 -2
- package/types/javax/jcr/Workspace/index.d.ts +103 -577
- package/types/javax/jcr/Workspace/index.js +1 -12
- package/types/javax/jcr/lock/Lock/index.d.ts +4 -2
- package/types/javax/jcr/lock/LockManager/index.d.ts +4 -2
- package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +4 -105
- package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
- package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +5 -3
- package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +4 -2
- package/types/javax/jcr/nodetype/NodeType/index.d.ts +262 -269
- package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
- package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +5 -107
- package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
- package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +5 -3
- package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +9 -130
- package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
- package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +4 -2
- package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +5 -272
- package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
- package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +5 -3
- package/types/javax/jcr/observation/Event/index.d.ts +85 -42
- package/types/javax/jcr/observation/EventIterator/index.d.ts +5 -3
- package/types/javax/jcr/observation/EventJournal/index.d.ts +4 -2
- package/types/javax/jcr/observation/EventListener/index.d.ts +4 -2
- package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +5 -3
- package/types/javax/jcr/observation/ObservationManager/index.d.ts +6 -4
- package/types/javax/jcr/query/Query/index.d.ts +35 -12
- package/types/javax/jcr/query/QueryManager/index.d.ts +6 -4
- package/types/javax/jcr/query/QueryResult/index.d.ts +5 -3
- package/types/javax/jcr/query/Row/index.d.ts +5 -3
- package/types/javax/jcr/query/RowIterator/index.d.ts +5 -3
- package/types/javax/jcr/query/qom/And/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/ChildNode/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Column/index.d.ts +3 -1
- package/types/javax/jcr/query/qom/Comparison/index.d.ts +6 -4
- package/types/javax/jcr/query/qom/Constraint/index.d.ts +3 -1
- package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +5 -3
- package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Join/index.d.ts +5 -3
- package/types/javax/jcr/query/qom/JoinCondition/index.d.ts +3 -1
- package/types/javax/jcr/query/qom/Length/index.d.ts +5 -3
- package/types/javax/jcr/query/qom/Literal/index.d.ts +5 -3
- package/types/javax/jcr/query/qom/LowerCase/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/NodeName/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Not/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Operand/index.d.ts +3 -1
- package/types/javax/jcr/query/qom/Or/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Ordering/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +8 -6
- package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +76 -2
- package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +37 -35
- package/types/javax/jcr/query/qom/SameNode/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Selector/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/Source/index.d.ts +3 -1
- package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +4 -2
- package/types/javax/jcr/query/qom/UpperCase/index.d.ts +4 -2
- package/types/javax/jcr/retention/Hold/index.d.ts +3 -1
- package/types/javax/jcr/retention/RetentionManager/index.d.ts +5 -3
- package/types/javax/jcr/retention/RetentionPolicy/index.d.ts +3 -1
- package/types/javax/jcr/security/AccessControlEntry/index.d.ts +4 -2
- package/types/javax/jcr/security/AccessControlList/index.d.ts +6 -4
- package/types/javax/jcr/security/AccessControlManager/index.d.ts +6 -4
- package/types/javax/jcr/security/AccessControlPolicy/index.d.ts +3 -1
- package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +5 -3
- package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +4 -2
- package/types/javax/jcr/security/Privilege/index.d.ts +130 -44
- package/types/javax/jcr/version/Version/index.d.ts +5 -3
- package/types/javax/jcr/version/VersionHistory/index.d.ts +7 -5
- package/types/javax/jcr/version/VersionIterator/index.d.ts +5 -3
- package/types/javax/jcr/version/VersionManager/index.d.ts +7 -5
- package/types/senselogic/sitevision/api/base/Builder/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/base/Filter/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/base/FilterSplit/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/base/Loadable/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
- package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
- package/types/senselogic/sitevision/api/base/Resolver/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/base/Wrapper/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +13 -7
- package/types/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +5 -3
- package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +5 -3
- package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/mail/Mail/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +51 -0
- package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
- package/types/senselogic/sitevision/api/render/ImageScaler/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +85 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +31 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +31 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +67 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +25 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +19 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1243 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +31 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +91 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +27 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +19 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +19 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +25 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +37 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +25 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
- package/types/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +24 -2
- package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +19 -3
- package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +31 -7
- package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts +4 -2
- package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +35 -3
- package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +5 -3
- package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts +3 -1
- package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +4 -2
|
@@ -1,83 +1,4 @@
|
|
|
1
|
-
import type
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* <p>
|
|
5
|
-
* Moves a node from the current parent to another in the node structure.
|
|
6
|
-
* </p>
|
|
7
|
-
* <p>
|
|
8
|
-
* Currently supported node types are:
|
|
9
|
-
* </p>
|
|
10
|
-
* <ul>
|
|
11
|
-
* <li><code>sv:article</code></li>
|
|
12
|
-
* <li><code>sv:archive</code></li>
|
|
13
|
-
* <li><code>sv:file</code></li>
|
|
14
|
-
* <li><code>sv:folder</code></li>
|
|
15
|
-
* <li><code>sv:image</code></li>
|
|
16
|
-
* <li><code>sv:link</code></li>
|
|
17
|
-
* <li><code>sv:page</code></li>
|
|
18
|
-
* <li><code>sv:template</code></li>
|
|
19
|
-
* </ul>
|
|
20
|
-
*
|
|
21
|
-
* <p>
|
|
22
|
-
* The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
|
|
23
|
-
* </p>
|
|
24
|
-
*
|
|
25
|
-
* <pre>
|
|
26
|
-
* Node - allowed parents
|
|
27
|
-
* ------------------------------------------------------------------------------------------------------
|
|
28
|
-
* sv:article - sv:archive
|
|
29
|
-
* sv:archive - sv:sitePage, sv:page, sv:folder, sv:article
|
|
30
|
-
* sv:file - sv:folder, *fileRepos
|
|
31
|
-
* sv:folder - sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, *fileRepos
|
|
32
|
-
* sv:image - sv:folder, *fileRepos
|
|
33
|
-
* sv:link - sv:sitePage, sv:page, sv:folder, sv:article
|
|
34
|
-
* sv:page - sv:sitePage, sv:page, sv:folder, sv:article
|
|
35
|
-
* sv:template - sv:folder, sv:templateRepository
|
|
36
|
-
*
|
|
37
|
-
* Node - allowed root nodes
|
|
38
|
-
* ------------------------------------------------------------------------------------------------------
|
|
39
|
-
* sv:archive - sv:sitePage
|
|
40
|
-
* sv:article - sv:sitePage
|
|
41
|
-
* sv:file - *fileRepos
|
|
42
|
-
* sv:folder - sv:sitePage, sv:templateRepository, *fileRepos
|
|
43
|
-
* sv:image - *fileRepos
|
|
44
|
-
* sv:link - sv:sitePage
|
|
45
|
-
* sv:page - sv:sitePage
|
|
46
|
-
* sv:template - sv:templateRepository
|
|
47
|
-
*
|
|
48
|
-
* *fileRepos corresponds to sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository
|
|
49
|
-
* </pre>
|
|
50
|
-
*
|
|
51
|
-
* <p>
|
|
52
|
-
* If the node or the parent is null a <code>NullPointerException</code> is thrown.
|
|
53
|
-
* </p>
|
|
54
|
-
*
|
|
55
|
-
* <p>
|
|
56
|
-
* Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
|
|
57
|
-
* {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
|
|
58
|
-
* If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
|
|
59
|
-
* </p>
|
|
60
|
-
*
|
|
61
|
-
* <p>
|
|
62
|
-
* Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
|
|
63
|
-
* If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
|
|
64
|
-
* </p>
|
|
65
|
-
*
|
|
66
|
-
* <p>
|
|
67
|
-
* If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
|
|
68
|
-
* </p>
|
|
69
|
-
*
|
|
70
|
-
* <p>
|
|
71
|
-
* <em>
|
|
72
|
-
* Note! The move operation will be ignored if the node is already a child of the parent.
|
|
73
|
-
* </em>
|
|
74
|
-
* </p>
|
|
75
|
-
* @param aNode the node that is to be moved. May not be <code>null</code>
|
|
76
|
-
* @param aParent the new parent node. May not be <code>null</code>
|
|
77
|
-
* @throws ConstraintViolationException if current user is not authorized to move aNode to aParent or if an invalid structure would be result of the operation
|
|
78
|
-
* @throws RepositoryException if something else goes wrong
|
|
79
|
-
*/
|
|
80
|
-
export function moveNode(aNode: Node, aParent: Node): void;
|
|
1
|
+
import type Node from "../../types/javax/jcr/Node";
|
|
81
2
|
|
|
82
3
|
/**
|
|
83
4
|
* Utility interface for alterations of the node structure.
|
|
@@ -90,8 +11,89 @@ export function moveNode(aNode: Node, aParent: Node): void;
|
|
|
90
11
|
* @author Mikael Wikblom
|
|
91
12
|
* @since Sitevision 2.6.2
|
|
92
13
|
*/
|
|
93
|
-
|
|
94
|
-
|
|
14
|
+
export interface StructureUtil {
|
|
15
|
+
/**
|
|
16
|
+
* <p>
|
|
17
|
+
* Moves a node from the current parent to another in the node structure.
|
|
18
|
+
* </p>
|
|
19
|
+
* <p>
|
|
20
|
+
* Currently supported node types are:
|
|
21
|
+
* </p>
|
|
22
|
+
* <ul>
|
|
23
|
+
* <li><code>sv:article</code></li>
|
|
24
|
+
* <li><code>sv:archive</code></li>
|
|
25
|
+
* <li><code>sv:file</code></li>
|
|
26
|
+
* <li><code>sv:folder</code></li>
|
|
27
|
+
* <li><code>sv:image</code></li>
|
|
28
|
+
* <li><code>sv:link</code></li>
|
|
29
|
+
* <li><code>sv:page</code></li>
|
|
30
|
+
* <li><code>sv:template</code></li>
|
|
31
|
+
* </ul>
|
|
32
|
+
*
|
|
33
|
+
* <p>
|
|
34
|
+
* The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
|
|
35
|
+
* </p>
|
|
36
|
+
*
|
|
37
|
+
* <pre>
|
|
38
|
+
* Node - allowed parents
|
|
39
|
+
* ------------------------------------------------------------------------------------------------------
|
|
40
|
+
* sv:article - sv:archive
|
|
41
|
+
* sv:archive - sv:sitePage, sv:page, sv:folder, sv:article
|
|
42
|
+
* sv:file - sv:folder, *fileRepos
|
|
43
|
+
* sv:folder - sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, *fileRepos
|
|
44
|
+
* sv:image - sv:folder, *fileRepos
|
|
45
|
+
* sv:link - sv:sitePage, sv:page, sv:folder, sv:article
|
|
46
|
+
* sv:page - sv:sitePage, sv:page, sv:folder, sv:article
|
|
47
|
+
* sv:template - sv:folder, sv:templateRepository
|
|
48
|
+
*
|
|
49
|
+
* Node - allowed root nodes
|
|
50
|
+
* ------------------------------------------------------------------------------------------------------
|
|
51
|
+
* sv:archive - sv:sitePage
|
|
52
|
+
* sv:article - sv:sitePage
|
|
53
|
+
* sv:file - *fileRepos
|
|
54
|
+
* sv:folder - sv:sitePage, sv:templateRepository, *fileRepos
|
|
55
|
+
* sv:image - *fileRepos
|
|
56
|
+
* sv:link - sv:sitePage
|
|
57
|
+
* sv:page - sv:sitePage
|
|
58
|
+
* sv:template - sv:templateRepository
|
|
59
|
+
*
|
|
60
|
+
* *fileRepos corresponds to sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository
|
|
61
|
+
* </pre>
|
|
62
|
+
*
|
|
63
|
+
* <p>
|
|
64
|
+
* If the node or the parent is null a <code>NullPointerException</code> is thrown.
|
|
65
|
+
* </p>
|
|
66
|
+
*
|
|
67
|
+
* <p>
|
|
68
|
+
* Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
|
|
69
|
+
* {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
|
|
70
|
+
* If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
|
|
71
|
+
* </p>
|
|
72
|
+
*
|
|
73
|
+
* <p>
|
|
74
|
+
* Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
|
|
75
|
+
* If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
|
|
76
|
+
* </p>
|
|
77
|
+
*
|
|
78
|
+
* <p>
|
|
79
|
+
* If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
|
|
80
|
+
* </p>
|
|
81
|
+
*
|
|
82
|
+
* <p>
|
|
83
|
+
* <em>
|
|
84
|
+
* Note! The move operation will be ignored if the node is already a child of the parent.
|
|
85
|
+
* </em>
|
|
86
|
+
* </p>
|
|
87
|
+
* @param aNode the node that is to be moved. May not be <code>null</code>
|
|
88
|
+
* @param aParent the new parent node. May not be <code>null</code>
|
|
89
|
+
* @throws ConstraintViolationException if current user is not authorized to move aNode to aParent or if an invalid structure would be result of the operation
|
|
90
|
+
* @throws RepositoryException if something else goes wrong
|
|
91
|
+
*/
|
|
92
|
+
moveNode(aNode: Node, aParent: Node): void;
|
|
95
93
|
}
|
|
96
94
|
|
|
97
|
-
|
|
95
|
+
declare namespace StructureUtil {}
|
|
96
|
+
|
|
97
|
+
declare var structureUtil: StructureUtil;
|
|
98
|
+
|
|
99
|
+
export = structureUtil;
|
|
@@ -1,67 +1,4 @@
|
|
|
1
|
-
import type
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* <p>Access to a <code>Set</code> of subscribers (i.e. e-mail and / or phone numbers) for an active subscription.</p>
|
|
5
|
-
*
|
|
6
|
-
* <p>This method will never throw exceptions.</p>
|
|
7
|
-
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
8
|
-
* @return a <code>Set</code> of <code>String</code> with the subscribers. Will never return <code>null</code>
|
|
9
|
-
*/
|
|
10
|
-
export function getSubscribers(anActiveSubscription: Node): unknown;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* <p>
|
|
14
|
-
* Method used to add an e-mail or phone number as a subscriber to the active subscription.
|
|
15
|
-
* If the subscriber is already a subscriber nothing will be done.
|
|
16
|
-
* </p>
|
|
17
|
-
*
|
|
18
|
-
* <p>
|
|
19
|
-
* This method will not throw exceptions.
|
|
20
|
-
* </p>
|
|
21
|
-
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
22
|
-
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
23
|
-
* @return indicates that the subscriber is available as a subscriber after the operation
|
|
24
|
-
*/
|
|
25
|
-
export function addSubscriber(
|
|
26
|
-
anActiveSubscription: Node,
|
|
27
|
-
aSubscriber: string
|
|
28
|
-
): boolean;
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* <p>
|
|
32
|
-
* Removes an e-mail or phone number from the subscribers of the active subscription.
|
|
33
|
-
* If the subscriber is not a subscriber nothing will be done.
|
|
34
|
-
* </p>
|
|
35
|
-
*
|
|
36
|
-
* <p>
|
|
37
|
-
* This method will not throw exceptions.
|
|
38
|
-
* </p>
|
|
39
|
-
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
40
|
-
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
41
|
-
* @return indicates that the subscriber is not available as a subscriber after the operation
|
|
42
|
-
*/
|
|
43
|
-
export function removeSubscriber(
|
|
44
|
-
anActiveSubscription: Node,
|
|
45
|
-
aSubscriber: string
|
|
46
|
-
): boolean;
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* <p>
|
|
50
|
-
* Finds out if an e-mail of phone number is already a subscriber to the active subscription.
|
|
51
|
-
* Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
|
|
52
|
-
* </p>
|
|
53
|
-
*
|
|
54
|
-
* <p>
|
|
55
|
-
* This method will not throw exceptions.
|
|
56
|
-
* </p>
|
|
57
|
-
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
58
|
-
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
59
|
-
* @return indicates that the subscriber already is a subscriber to the active subscription
|
|
60
|
-
*/
|
|
61
|
-
export function isSubscriber(
|
|
62
|
-
anActiveSubscription: Node,
|
|
63
|
-
aSubscriber: string
|
|
64
|
-
): boolean;
|
|
1
|
+
import type Node from "../../types/javax/jcr/Node";
|
|
65
2
|
|
|
66
3
|
/**
|
|
67
4
|
* <p>
|
|
@@ -92,8 +29,64 @@ export function isSubscriber(
|
|
|
92
29
|
* @author Mikael Wikblom
|
|
93
30
|
* @since Sitevision 2.6.1_10
|
|
94
31
|
*/
|
|
95
|
-
|
|
96
|
-
|
|
32
|
+
export interface SubscriberUtil {
|
|
33
|
+
/**
|
|
34
|
+
* <p>Access to a <code>Set</code> of subscribers (i.e. e-mail and / or phone numbers) for an active subscription.</p>
|
|
35
|
+
*
|
|
36
|
+
* <p>This method will never throw exceptions.</p>
|
|
37
|
+
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
38
|
+
* @return a <code>Set</code> of <code>String</code> with the subscribers. Will never return <code>null</code>
|
|
39
|
+
*/
|
|
40
|
+
getSubscribers(anActiveSubscription: Node): unknown;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* <p>
|
|
44
|
+
* Method used to add an e-mail or phone number as a subscriber to the active subscription.
|
|
45
|
+
* If the subscriber is already a subscriber nothing will be done.
|
|
46
|
+
* </p>
|
|
47
|
+
*
|
|
48
|
+
* <p>
|
|
49
|
+
* This method will not throw exceptions.
|
|
50
|
+
* </p>
|
|
51
|
+
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
52
|
+
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
53
|
+
* @return indicates that the subscriber is available as a subscriber after the operation
|
|
54
|
+
*/
|
|
55
|
+
addSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* <p>
|
|
59
|
+
* Removes an e-mail or phone number from the subscribers of the active subscription.
|
|
60
|
+
* If the subscriber is not a subscriber nothing will be done.
|
|
61
|
+
* </p>
|
|
62
|
+
*
|
|
63
|
+
* <p>
|
|
64
|
+
* This method will not throw exceptions.
|
|
65
|
+
* </p>
|
|
66
|
+
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
67
|
+
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
68
|
+
* @return indicates that the subscriber is not available as a subscriber after the operation
|
|
69
|
+
*/
|
|
70
|
+
removeSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* <p>
|
|
74
|
+
* Finds out if an e-mail of phone number is already a subscriber to the active subscription.
|
|
75
|
+
* Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
|
|
76
|
+
* </p>
|
|
77
|
+
*
|
|
78
|
+
* <p>
|
|
79
|
+
* This method will not throw exceptions.
|
|
80
|
+
* </p>
|
|
81
|
+
* @param anActiveSubscription the active subscription <code>Node</code>
|
|
82
|
+
* @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
|
|
83
|
+
* @return indicates that the subscriber already is a subscriber to the active subscription
|
|
84
|
+
*/
|
|
85
|
+
isSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
|
|
97
86
|
}
|
|
98
87
|
|
|
99
|
-
|
|
88
|
+
declare namespace SubscriberUtil {}
|
|
89
|
+
|
|
90
|
+
declare var subscriberUtil: SubscriberUtil;
|
|
91
|
+
|
|
92
|
+
export = subscriberUtil;
|
|
@@ -1,124 +1,4 @@
|
|
|
1
|
-
import type
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* <p>Returns the active subscription <code>Node</code> of a <code>Node</code>. An active subscription
|
|
5
|
-
* is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
|
|
6
|
-
* the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
|
|
7
|
-
*
|
|
8
|
-
* <p>
|
|
9
|
-
* <code>
|
|
10
|
-
* ex: from the sitevision navigator <br>
|
|
11
|
-
* - server <br>
|
|
12
|
-
* ---site A (subscription activated, including all children) <br>
|
|
13
|
-
* -----page 1 <br>
|
|
14
|
-
* -------archive X (subscription activated, including all children) <br>
|
|
15
|
-
* ---------article V <br>
|
|
16
|
-
* -----page 2 (subscription activated) <br>
|
|
17
|
-
* -------page 21 <br>
|
|
18
|
-
* <br>
|
|
19
|
-
* getActiveSubscription(site A) -> site A <br>
|
|
20
|
-
* getActiveSubscription(page 1) -> site A <br>
|
|
21
|
-
* getActiveSubscription(archive X) -> archive X <br>
|
|
22
|
-
* getActiveSubscription(article V) -> archive X <br>
|
|
23
|
-
* getActiveSubscription(page 2) -> page 2 <br>
|
|
24
|
-
* getActiveSubscription(page 21) -> null <br>
|
|
25
|
-
* </code>
|
|
26
|
-
* </p>
|
|
27
|
-
*
|
|
28
|
-
* <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
|
|
29
|
-
* method is simply convenience to find the active <code>Node</code>.</p>
|
|
30
|
-
*
|
|
31
|
-
* <p>This method will never throw exceptions</p>
|
|
32
|
-
* @param aNode a <code>Node</code> in the navigation (e.g. a sv:page or an sv:article)
|
|
33
|
-
* @return a <code>Node</code> with activated subscription or <code>null</code> if not available
|
|
34
|
-
*/
|
|
35
|
-
export function getActiveSubscription(aNode: Node): Node;
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* <p>Activates a subscription for the given <code>Node</code>.</p>
|
|
39
|
-
*
|
|
40
|
-
* <p>The current user must have write subscription permission to activate subscriptions.</p>
|
|
41
|
-
* @param aNode the <code>Node</code> to activate a subscription for.
|
|
42
|
-
* @param subtreeScope true if activation should include subnodes, false otherwise.
|
|
43
|
-
* @param title the subscription title.
|
|
44
|
-
* @param description the subscription description.
|
|
45
|
-
* @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
|
|
46
|
-
* @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
|
|
47
|
-
* @throws RepositoryException if something else goes wrong.
|
|
48
|
-
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
49
|
-
* @since Sitevision 2.6.2_05
|
|
50
|
-
*/
|
|
51
|
-
export function activateSubscription(
|
|
52
|
-
aNode: Node,
|
|
53
|
-
subtreeScope: boolean,
|
|
54
|
-
title: string,
|
|
55
|
-
description: string
|
|
56
|
-
): void;
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* <p>Deactivates the subscription for the given <code>Node</code>.</p>
|
|
60
|
-
*
|
|
61
|
-
* <p>The current user must have write subscription permission to deactivate subscriptions.</p>
|
|
62
|
-
* @param aNode the <code>Node</code> to deactivate the subscription for.
|
|
63
|
-
* @throws RepositoryException if the current user isn't allowed to modify subscriptions.
|
|
64
|
-
* @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
|
|
65
|
-
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
66
|
-
* @since Sitevision 2.6.2_05
|
|
67
|
-
*/
|
|
68
|
-
export function deactivateSubscription(aNode: Node): void;
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* <p>Configures email properties for the subscription on the given node.</p>
|
|
72
|
-
*
|
|
73
|
-
* <p>The current user must have write subscription permission to configure subscription email.</p>
|
|
74
|
-
* @param aNode the <code>Node</code> to configure.
|
|
75
|
-
* @param from name of the sender.
|
|
76
|
-
* @param fromAddress email address of the sender.
|
|
77
|
-
* @param subject the email subject.
|
|
78
|
-
* @param footer the email footer
|
|
79
|
-
* @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
|
|
80
|
-
* @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't a subscriptionable node, if <code>fromAddress</code> is null or not a valid email adress.
|
|
81
|
-
* @throws RepositoryException if something else goes wrong.
|
|
82
|
-
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
83
|
-
* @since Sitevision 2.6.2_05
|
|
84
|
-
*/
|
|
85
|
-
export function configureSubscriptionEmail(
|
|
86
|
-
aNode: Node,
|
|
87
|
-
from: string,
|
|
88
|
-
fromAddress: string,
|
|
89
|
-
subject: string,
|
|
90
|
-
footer: string
|
|
91
|
-
): void;
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Notifies the subscribers of a given node with an active subscription.
|
|
95
|
-
*
|
|
96
|
-
* <p>
|
|
97
|
-
* This method will use the settings of the active subscription to send mail notifications to all subscribers.
|
|
98
|
-
* A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
|
|
99
|
-
* <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
|
|
100
|
-
* used to create the actual <em>body</em> of the notification. The mail template for an active subscription
|
|
101
|
-
* will typically include something like this:
|
|
102
|
-
* </p>
|
|
103
|
-
* <ol>
|
|
104
|
-
* <li>A <em>notification</em> text</li>
|
|
105
|
-
* <li>The <em>URL</em> of the node</li>
|
|
106
|
-
* <li>The mail <em>footer</em></li>
|
|
107
|
-
* </ol>
|
|
108
|
-
* <p>
|
|
109
|
-
* The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
|
|
110
|
-
* In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
|
|
111
|
-
* contain the <em>URL</em> and the <em>footer</em> only.
|
|
112
|
-
* </p>
|
|
113
|
-
* @param aNode a <code>Node</code> that has an active subscription, typically a sv:page or sv:article
|
|
114
|
-
* @param aNotificationText the notification text
|
|
115
|
-
* @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
|
|
116
|
-
* @since Sitevision 3.6.3
|
|
117
|
-
*/
|
|
118
|
-
export function notifySubscribersOf(
|
|
119
|
-
aNode: Node,
|
|
120
|
-
aNotificationText: string
|
|
121
|
-
): boolean;
|
|
1
|
+
import type Node from "../../types/javax/jcr/Node";
|
|
122
2
|
|
|
123
3
|
/**
|
|
124
4
|
* <p>
|
|
@@ -133,14 +13,127 @@ export function notifySubscribersOf(
|
|
|
133
13
|
* @author Mikael Wikblom
|
|
134
14
|
* @since Sitevision 2.6.1_10
|
|
135
15
|
*/
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
16
|
+
export interface SubscriptionUtil {
|
|
17
|
+
/**
|
|
18
|
+
* <p>Returns the active subscription <code>Node</code> of a <code>Node</code>. An active subscription
|
|
19
|
+
* is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
|
|
20
|
+
* the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
|
|
21
|
+
*
|
|
22
|
+
* <p>
|
|
23
|
+
* <code>
|
|
24
|
+
* ex: from the sitevision navigator <br>
|
|
25
|
+
* - server <br>
|
|
26
|
+
* ---site A (subscription activated, including all children) <br>
|
|
27
|
+
* -----page 1 <br>
|
|
28
|
+
* -------archive X (subscription activated, including all children) <br>
|
|
29
|
+
* ---------article V <br>
|
|
30
|
+
* -----page 2 (subscription activated) <br>
|
|
31
|
+
* -------page 21 <br>
|
|
32
|
+
* <br>
|
|
33
|
+
* getActiveSubscription(site A) -> site A <br>
|
|
34
|
+
* getActiveSubscription(page 1) -> site A <br>
|
|
35
|
+
* getActiveSubscription(archive X) -> archive X <br>
|
|
36
|
+
* getActiveSubscription(article V) -> archive X <br>
|
|
37
|
+
* getActiveSubscription(page 2) -> page 2 <br>
|
|
38
|
+
* getActiveSubscription(page 21) -> null <br>
|
|
39
|
+
* </code>
|
|
40
|
+
* </p>
|
|
41
|
+
*
|
|
42
|
+
* <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
|
|
43
|
+
* method is simply convenience to find the active <code>Node</code>.</p>
|
|
44
|
+
*
|
|
45
|
+
* <p>This method will never throw exceptions</p>
|
|
46
|
+
* @param aNode a <code>Node</code> in the navigation (e.g. a sv:page or an sv:article)
|
|
47
|
+
* @return a <code>Node</code> with activated subscription or <code>null</code> if not available
|
|
48
|
+
*/
|
|
49
|
+
getActiveSubscription(aNode: Node): Node;
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* <p>Activates a subscription for the given <code>Node</code>.</p>
|
|
53
|
+
*
|
|
54
|
+
* <p>The current user must have write subscription permission to activate subscriptions.</p>
|
|
55
|
+
* @param aNode the <code>Node</code> to activate a subscription for.
|
|
56
|
+
* @param subtreeScope true if activation should include subnodes, false otherwise.
|
|
57
|
+
* @param title the subscription title.
|
|
58
|
+
* @param description the subscription description.
|
|
59
|
+
* @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
|
|
60
|
+
* @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
|
|
61
|
+
* @throws RepositoryException if something else goes wrong.
|
|
62
|
+
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
63
|
+
* @since Sitevision 2.6.2_05
|
|
64
|
+
*/
|
|
65
|
+
activateSubscription(
|
|
66
|
+
aNode: Node,
|
|
67
|
+
subtreeScope: boolean,
|
|
68
|
+
title: string,
|
|
69
|
+
description: string
|
|
70
|
+
): void;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* <p>Deactivates the subscription for the given <code>Node</code>.</p>
|
|
74
|
+
*
|
|
75
|
+
* <p>The current user must have write subscription permission to deactivate subscriptions.</p>
|
|
76
|
+
* @param aNode the <code>Node</code> to deactivate the subscription for.
|
|
77
|
+
* @throws RepositoryException if the current user isn't allowed to modify subscriptions.
|
|
78
|
+
* @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
|
|
79
|
+
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
80
|
+
* @since Sitevision 2.6.2_05
|
|
81
|
+
*/
|
|
82
|
+
deactivateSubscription(aNode: Node): void;
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* <p>Configures email properties for the subscription on the given node.</p>
|
|
86
|
+
*
|
|
87
|
+
* <p>The current user must have write subscription permission to configure subscription email.</p>
|
|
88
|
+
* @param aNode the <code>Node</code> to configure.
|
|
89
|
+
* @param from name of the sender.
|
|
90
|
+
* @param fromAddress email address of the sender.
|
|
91
|
+
* @param subject the email subject.
|
|
92
|
+
* @param footer the email footer
|
|
93
|
+
* @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
|
|
94
|
+
* @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't a subscriptionable node, if <code>fromAddress</code> is null or not a valid email adress.
|
|
95
|
+
* @throws RepositoryException if something else goes wrong.
|
|
96
|
+
* @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
|
|
97
|
+
* @since Sitevision 2.6.2_05
|
|
98
|
+
*/
|
|
99
|
+
configureSubscriptionEmail(
|
|
100
|
+
aNode: Node,
|
|
101
|
+
from: string,
|
|
102
|
+
fromAddress: string,
|
|
103
|
+
subject: string,
|
|
104
|
+
footer: string
|
|
105
|
+
): void;
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Notifies the subscribers of a given node with an active subscription.
|
|
109
|
+
*
|
|
110
|
+
* <p>
|
|
111
|
+
* This method will use the settings of the active subscription to send mail notifications to all subscribers.
|
|
112
|
+
* A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
|
|
113
|
+
* <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
|
|
114
|
+
* used to create the actual <em>body</em> of the notification. The mail template for an active subscription
|
|
115
|
+
* will typically include something like this:
|
|
116
|
+
* </p>
|
|
117
|
+
* <ol>
|
|
118
|
+
* <li>A <em>notification</em> text</li>
|
|
119
|
+
* <li>The <em>URL</em> of the node</li>
|
|
120
|
+
* <li>The mail <em>footer</em></li>
|
|
121
|
+
* </ol>
|
|
122
|
+
* <p>
|
|
123
|
+
* The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
|
|
124
|
+
* In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
|
|
125
|
+
* contain the <em>URL</em> and the <em>footer</em> only.
|
|
126
|
+
* </p>
|
|
127
|
+
* @param aNode a <code>Node</code> that has an active subscription, typically a sv:page or sv:article
|
|
128
|
+
* @param aNotificationText the notification text
|
|
129
|
+
* @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
|
|
130
|
+
* @since Sitevision 3.6.3
|
|
131
|
+
*/
|
|
132
|
+
notifySubscribersOf(aNode: Node, aNotificationText: string): boolean;
|
|
144
133
|
}
|
|
145
134
|
|
|
146
|
-
|
|
135
|
+
declare namespace SubscriptionUtil {}
|
|
136
|
+
|
|
137
|
+
declare var subscriptionUtil: SubscriptionUtil;
|
|
138
|
+
|
|
139
|
+
export = subscriptionUtil;
|