クラス GraphQlWebSocketMessage

java.lang.ObjectSE
org.springframework.graphql.server.support.GraphQlWebSocketMessage
public class GraphQlWebSocketMessage extends ObjectSE
GraphQL over WebSocket プロトコルメッセージを表します。
導入:
1.0.0
作成者:
Rossen Stoyanchev
関連事項:

  • 方法の詳細

    • getId

      public @Nullable StringSE getId()
      リクエストに関連付けられたメッセージに適用可能なリクエスト ID、または接続レベルメッセージの null を返します。

    • getType

      public StringSE getType()
      ネットワーク上に表示されるメッセージ型の値を返します。

    • resolvedType

      public GraphQlWebSocketMessageType resolvedType()
      メッセージ型を列挙型として返します。

    • getPayload

      public <P> P getPayload()
      ペイロードを返します。逆直列化されたメッセージの場合、これは通常、"error" メッセージの Map または List です。
      型パラメーター:
      P - ペイロード型

    • setId

      public void setId(@Nullable StringSE id)

    • setType

      public void setType(StringSE type)

    • setPayload

      public void setPayload(@Nullable ObjectSE payload)

    • equals

      public boolean equals(ObjectSE o)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • connectionInit

      public static GraphQlWebSocketMessage connectionInit(@Nullable ObjectSE payload)
      "connection_init" クライアントメッセージを作成します。
      パラメーター:
      payload - オプションのペイロード

    • connectionAck

      public static GraphQlWebSocketMessage connectionAck(@Nullable ObjectSE payload)
      "connection_ack" サーバーメッセージを作成します。
      パラメーター:
      payload - オプションのペイロード

    • subscribe

      public static GraphQlWebSocketMessage subscribe(StringSE id, GraphQlRequest request)
      "subscribe" クライアントメッセージを作成します。
      パラメーター:
      id - 一意のリクエスト ID
      request - メッセージペイロードとして追加するリクエスト

    • next

      public static GraphQlWebSocketMessage next(StringSE id, MapSE<StringSE,ObjectSE> responseMap)
      "next" サーバーメッセージを作成します。
      パラメーター:
      id - 一意のリクエスト ID
      responseMap - レスポンスマップ

    • error

      public static GraphQlWebSocketMessage error(StringSE id, ListSE<graphql.GraphQLError> errors)
      "error" サーバーメッセージを作成します。
      パラメーター:
      id - 一意のリクエスト ID
      errors - メッセージペイロードとして追加するエラー

    • complete

      public static GraphQlWebSocketMessage complete(StringSE id)
      "complete" サーバーメッセージを作成します。
      パラメーター:
      id - 一意のリクエスト ID

    • ping

      public static GraphQlWebSocketMessage ping(@Nullable ObjectSE payload)
      "ping" クライアントまたはサーバーメッセージを作成します。
      パラメーター:
      payload - オプションのペイロード

    • pong

      public static GraphQlWebSocketMessage pong(@Nullable ObjectSE payload)
      "pong" クライアントまたはサーバーメッセージを作成します。
      パラメーター:
      payload - オプションのペイロード