Consumers

class djangochannelsrestframework.consumers.APIConsumerMetaclass(name, bases, body)

Metaclass that records action methods

class djangochannelsrestframework.consumers.AsyncAPIConsumer(*args, **kwargs)

Be very inspired by django rest framework ViewSets

async check_permissions(action: str, **kwargs)

Check if the action should be permitted. Raises an appropriate exception if the request is not permitted.

async get_permissions(action: str, **kwargs)

Instantiates and returns the list of permissions that this view requires.

async handle_action(action: str, request_id: str, **kwargs)

run the action.

async handle_exception(exc: Exception, action: str, request_id)

Handle any exception that occurs, by sending an appropriate message

async receive_json(content: Dict, **kwargs)

Called with decoded JSON content.

class djangochannelsrestframework.consumers.DjangoViewAsConsumer(*args, **kwargs)

async handle_action(action: str, request_id: str, **kwargs)

run the action.

async receive_json(content: Dict, **kwargs)

Called with decoded JSON content.

djangochannelsrestframework.consumers.view_as_consumer(wrapped_view: Callable[[django.http.request.HttpRequest], django.http.response.HttpResponse], mapped_actions: Optional[Dict[str, str]] = None) → djangochannelsrestframework.consumers.DjangoViewAsConsumer

Wrap a django View so that it will be triggered by actions over this json

websocket consumer.