adhocracy_core.websockets.schemas module¶
Colander schemas to validate and (de)serialize Websocket messages.
-
class
Action(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.SingleLineAn action requested by a client.
-
validator= <colander.OneOf object>¶
-
-
class
SubscribableResource(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.ResourceTemporary fix for #2244.
TODO: implement proper solution
-
missing= <object object>¶
-
-
class
ClientRequestSchema(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.MappingSchemaData structure for client requests.
-
class
Status(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.SingleLineA status sent to the client.
-
validator= <colander.OneOf object>¶
-
default= 'ok'¶
-
-
class
StatusConfirmation(*arg, **kw)[source]¶ Bases:
adhocracy_core.websockets.schemas.ClientRequestSchemaData structure for status confirmations sent to the client.
-
class
Event(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.SingleLineThe type of event notifications sent to the client.
-
validator= <colander.OneOf object>¶
-
default= 'modified'¶
-
-
class
ServerNotification(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.MappingSchemaNotification sent to the server from the Pyramid WS client.
-
class
Notification(*arg, **kw)[source]¶ Bases:
adhocracy_core.schema.MappingSchemaNotification sent to a client if a resource has changed.
-
class
ChildNotification(*arg, **kw)[source]¶ Bases:
adhocracy_core.websockets.schemas.NotificationServerNotification involving a child resource.
-
class
VersionNotification(*arg, **kw)[source]¶ Bases:
adhocracy_core.websockets.schemas.NotificationServerNotification involving a version.