パッケージ org.springframework.messaging.simp.annotation

アノテーションインターフェース SendToUser

@TargetSE({TYPESE,METHODSE}) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface SendToUser
メッセージ処理メソッドの戻り値を、Message として指定された宛先に送信する必要があることを示します。さらに、"/user/{username}" が前に付加されて、処理される入力メッセージのヘッダーからユーザー名が抽出されます。

@SendTo と @SendToUser の両方を同じメソッドで使用できます。この場合、メッセージは両方のアノテーションの宛先に送信されます。

このアノテーションはクラスレベルで配置できます。その場合、クラスのメソッドによって継承されます。同時に、メソッドレベルの @SendTo または @SendToUser アノテーションは、クラスレベルでオーバーライドします。

導入:
4.0
作成者:
Rossen Stoyanchev, Sam Brannen
関連事項:

  • オプション要素のサマリー

    オプション要素
    修飾子と型
    オプションの要素
    説明
    boolean
    broadcast
    ユーザーに関連付けられたすべてのセッションにメッセージを送信するか、処理中の入力メッセージのセッションのみにメッセージを送信するか。
    StringSE[]
    destinations
    メッセージを送信する 1 つ以上の宛先。
    StringSE[]
    value
    destinations() のエイリアス。

  • 要素の詳細

    • value

      @AliasFor("destinations") StringSE[] value
      destinations() のエイリアス。
      関連事項:
      デフォルト:
      {}

    • destinations

      @AliasFor("value") StringSE[] destinations
      メッセージを送信する 1 つ以上の宛先。

      指定しない場合、処理される入力メッセージの宛先に基づいてデフォルトの宛先が選択されます。

      導入:
      4.2
      関連事項:
      デフォルト:
      {}

    • broadcast

      boolean broadcast
      ユーザーに関連付けられたすべてのセッションにメッセージを送信するか、処理中の入力メッセージのセッションのみにメッセージを送信するか。

      デフォルトでは、これは true に設定されています。この場合、メッセージはすべてのセッションにブロードキャストされます。

      デフォルト:
      true