WebsocketEvent (Jakarta EE Platform API) - Javadoc

java.lang.ObjectSE
- jakarta.faces.event.WebsocketEvent

実装されたすべてのインターフェース:
SerializableSE
```
public final class WebsocketEvent
extends ObjectSE
implements SerializableSE
```
この Web ソケットイベントは、新しい <f:websocket> が @WebsocketEvent.Opened または @WebsocketEvent.Closed になったときに発生します。アプリケーションスコープの CDI Bean は、@Observes できます。
詳しい使用方法については、@Push javadoc を参照してください。
導入:
2.3
関連事項:
Push, WebsocketEvent.Opened, WebsocketEvent.Closed, 直列化された形式

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラス	説明
`static interface`	`WebsocketEvent.Closed`	`<f:websocket>` が閉じたことを示します。
`static interface`	`WebsocketEvent.Opened`	`<f:websocket>` が開いたことを示します。

コンストラクターのサマリー
コンストラクター
コンストラクター説明
WebsocketEvent(StringSE channel, SerializableSE user, CloseReason.CloseCode code)

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッド	説明
`boolean`	`equals(ObjectSE other)`
`StringSE`	`getChannel()`	`<f:websocket channel>` を返します。
`CloseReason.CloseCode`	`getCloseCode()`	クローズコードを返します。
`<S extends SerializableSE> S`	`getUser()`	`<f:websocket user>` がある場合は、それを返します。
`int`	`hashCode()`
`StringSE`	`toString()`

クラス java.lang.ObjectSE から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE

- コンストラクターの詳細
  - WebsocketEvent
```
public WebsocketEvent(StringSE channel,
                      SerializableSE user,
                      CloseReason.CloseCode code)
```
- メソッドの詳細
  - getChannel
```
public StringSE getChannel()
```
    <f:websocket channel> を返します。
    戻り値:
    Web ソケットチャネル名。
  - getUser
```
public <S extends SerializableSE> S getUser()
```
    <f:websocket user> がある場合は、それを返します。
    型パラメーター:
    S - ユーザー ID の総称型。
    戻り値:
    Web ソケットのユーザー識別子（ある場合）。
    例外:
    ClassCastExceptionSE - S の型が間違っている場合。
  - getCloseCode
```
public CloseReason.CloseCode getCloseCode()
```
    クローズコードを返します。これが null を返す場合、WebsocketEvent.Opened でした。これが非 null を返す場合、WebsocketEvent.Closed でした。
    戻り値:
    クローズコード。
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    クラス ObjectSE の hashCode
  - equals
```
public boolean equals(ObjectSE other)
```
    オーバーライド:
    クラス ObjectSE の equalsSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toString