diff options
Diffstat (limited to 'actioncable/lib/action_cable/channel/broadcasting.rb')
| -rw-r--r-- | actioncable/lib/action_cable/channel/broadcasting.rb | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/actioncable/lib/action_cable/channel/broadcasting.rb b/actioncable/lib/action_cable/channel/broadcasting.rb index 6c7aec49e3..9f702e425e 100644 --- a/actioncable/lib/action_cable/channel/broadcasting.rb +++ b/actioncable/lib/action_cable/channel/broadcasting.rb @@ -15,7 +15,12 @@ module ActionCable ActionCable.server.broadcast(broadcasting_for(model), message) end - # Returns a unique broadcasting identifier for this <tt>model</tt> in this channel. + # Returns a unique broadcasting identifier for this <tt>model</tt> in this channel: + # + # CommentsChannel.broadcasting_for("all") # => "comments:all" + # + # You can pass any object as a target (e.g. Active Record model), and it + # would be serialized into a string under the hood. def broadcasting_for(model) serialize_broadcasting([ channel_name, model ]) end |