| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Poll |
| Handler Class | org.primefaces.component.poll.PollHandler |
| Renderer Type | None |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
async | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued.Default is false. |
autoStart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In autoStart mode, polling starts automatically on page load, to start polling on demand set to false.Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
delay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used. |
form | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Form to serialize for an ajax request.Default is The enclosing form. |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.Default is true. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
ignoreAutoUpdate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.Default is false. |
ignoreComponentNotFound | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, unresolvable components (ComponentNotFoundException) referenced in the update/process attribute are ignored.Default is false. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component.Default is false. |
interval | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Interval in seconds to do periodic AJAX requests.Default is 2. |
intervalType | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Type of interval value. Valid values are "second" and "millisecond".Default is second. |
listener | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| An action listener to process when command is executed. |
onactivated | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the poller is activated. Return false to prevent poller from starting. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request is completed. |
ondeactivated | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the poller is deactivated. Return false to prevent poller from stopping. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request fails. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute before ajax request begins. |
onsuccess | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request succeeds. |
partialSubmit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables serialization of values belonging to the partially processed components only.Default is false. |
partialSubmitFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to use when partial submit is on, default is ":input" to select all descendant inputs of a partially processed components. |
process | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to process in partial request. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered.Default is true. |
resetValues | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, local values of input components to be updated within the ajax request would be reset.Default is false. |
stop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Stops polling when true.Default is false. |
timeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Timeout in milliseconds for ajax request, whereas 0 means no timeout.Default is 0. |
update | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to update with ajax. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.