| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Socket |
| Handler Class | None |
| Renderer Type | org.primefaces.component.SocketRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
channel | true | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Channel name of the connection. |
transport | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Desired protocol to be used valid values are websocket (default), sse, streaming, long-polling, jsonp. |
fallbackTransport | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Fallback protocol to be used when desired transport is not supported in environment, valid values are websocket, sse, streaming, long-polling (default), jsonp. |
onMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler that is processed when the server publishes data. |
onError | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler that is processed when there is an error. |
onClose | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onClose callback. |
onOpen | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onOpen callback. |
onReconnect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onReconnect callback. |
onMessagePublished | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onMessagePublished callback. |
onTransportFailure | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onTransportFailure callback. |
onLocalMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event handler for atmospheres onLocalMessage callback. |
autoConnect | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if client should connect to the channel on page load. |
Output generated by Vdldoc View Declaration Language Documentation Generator.