django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-04-20 08:42:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

fields update for binding

Browse Source
This commit is contained in:
Andrew Godwin 2016-07-22 21:36:28 -04:00
parent 8c6050fbba
commit 174430c817
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/binding.rst
View File

@ -65,6 +65,7 @@ get started and likely close to what you want. Start off like this::
model = IntegerValue
stream = "intval"
fields = ["name", "value"]
def group_names(self, instance, action):
return ["intval-updates"]
@ -73,9 +74,13 @@ get started and likely close to what you want. Start off like this::
return True
This defines a WebSocket binding - so it knows to send outgoing messages
formatted as JSON WebSocket frames - and provides the two methods you must
formatted as JSON WebSocket frames - and provides the three things you must
always provide:
* ``fields`` is a whitelist of fields to return in the serialized request.
Channels does not default to all fields for security concerns; if you want
this, set it to the value ``["__all__"]``.
* ``group_names`` returns a list of groups to send outbound updates to based
on the model and action. For example, you could dispatch posts on different
liveblogs to groups that included the parent blog ID in the name; here, we