- SiteVision 2.6
- | SiteVision 2.6
- | Developer guide
- | Custom templates
- | Portlets
- | Subscribe
Subscribe portlet
The custom Velocity templates in the Subscribe portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here. There are two templates available; one is rendered in the "normal" case then the current page is an active subscription, the other is used otherwise.
| Name | Type and Description |
|---|---|
| portlet | javax.jcr.Node |
| This portlet. See properties below | |
| sitevisionUtils | senselogic.sitevision.api.Utils |
| The main entry point to all utility classes | |
| jcrSession | javax.jcr.Session |
| The JCR Session | |
| request | javax.portlet.PortletRequest |
| The portlet request |
| Name | Type and Description | |
|---|---|---|
| subscribeText | javax.jcr.PropertyType.STRING | |
| Corresponds to 'Text for subscribe' in the portlet configuration | ||
| unsubscribeText | javax.jcr.PropertyType.STRING | |
| Corresponds to 'Text for unsubscribe' in the portlet configuration | ||
| subscribeFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Subscription type font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font | ||
| useSubmitText | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the selection 'Standard button' in the portlet configuration | ||
| submitText | javax.jcr.PropertyType.STRING | |
| Corresponds to the text 'Button text' in the portlet configuration | ||
| submitTextFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Standard button font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font | ||
| subscribeSubmitImage | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Image' in the portlet configuration. A JCR-Node that has property URI pointing at the image resource | ||
| submitImageDescription | javax.jcr.PropertyType.STRING | |
| Corresponds to 'Image description' in the portlet configuration | ||
| defaultInput | javax.jcr.PropertyType.STRING | |
| Corresponds to 'Default value' in the portlet configuration | ||
| inputWidth | javax.jcr.PropertyType.LONG | |
| Corresponds to 'Width' in the portlet configuration | ||
| inputFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Text field font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font | ||
| allowEmail | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to 'Allow e-mail' in the portlet configuration | ||
| allowPhone | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to 'Allow phone number' in the portlet configuration | ||
| errorFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Font for error messages' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font | ||
| showSentMessage | javax.jcr.PropertyType.BOOLEAN | |
| Corresponds to the selection 'Show message after subscription' in the portlet configuration | ||
| sentMessage | javax.jcr.PropertyType.STRING | |
| Corresponds to the text 'Show message after subscription' in the portlet configuration | ||
| sentMessageFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| Corresponds to 'Show message after subscription font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font . | ||
| redirectURL | javax.jcr.PropertyType.URI | |
| Corresponds to the 'Send user to an other page after subscription' in the portlet configuration | ||
| inputName | javax.jcr.PropertyType.STRING | |
| The name of the text input field containing the e-mail or phone number | ||
| operationName | javax.jcr.PropertyType.STRING | |
| The name of the form element (e.g. checkbox) that has a value from bellow | ||
| operationSubscribe | javax.jcr.PropertyType.STRING | |
| The value of the form element (e.g. checkbox) used to subscribe | ||
| operationUnsubscribe | javax.jcr.PropertyType.STRING | |
| The value of the form element (e.g. checkbox) used to unsubscribe | ||
| addedSubscription | javax.jcr.PropertyType.BOOLEAN | |
| Indicates that the previous request added a subscription | ||
| addRemoveURL | javax.jcr.PropertyType.URI | |
| The URL to the action | ||
| isActiveSubscription | javax.jcr.PropertyType.BOOLEAN | |
| Indicates if the current page or article is an active subscription | ||
| activeSubscription | javax.jcr.PropertyType.WEAKREFERENCE | |
| A JCR-node containing the subscription (i.e. sv:page or sv:article) | ||
| inputFieldValue | javax.jcr.PropertyType.STRING | |
| Corresponds to the value of the input field | ||
| currentEmail | javax.jcr.PropertyType.STRING | |
| Corresponds to the e-mail for the current user (needs to be logged in) | ||
| isSubscriber | javax.jcr.PropertyType.BOOLEAN | |
| Indicates that the entered e-mail is already a subscriber | ||
| addCurrentUserURL | javax.jcr.PropertyType.URI | |
| An URL used to add the current user as a subscriber | ||
| removeCurrentUserURL | javax.jcr.PropertyType.URI | |
| An URL used to remove the current user from the subscribers | ||
| toggleCurrentUserURL | javax.jcr.PropertyType.URI | |
| An URL used to toggle subscribe / unsubscribe for the current user | ||
| bundle | javax.jcr.PropertyType.WEAKREFERENCE | |
| A JCR-node containing the language dependent strings. The strings are javax.jcr.PropertyType.STRING properties | ||
| errors | javax.jcr.PropertyType.WEAKREFERENCE | |
| A JCR-node containing the input errors. The errors are javax.jcr.PropertyType.STRING properties with names prefixed with "error" |
SSC1N2.sitevision-cloud.net