@@ -15,33 +15,33 @@ $ pip install graphql-subscriptions
1515```
1616
1717## API
18- ### RedisPubsub(self, host='localhost', port=6379, \* args, ** kwargs)
18+ ### RedisPubsub(host='localhost', port=6379, \* args, ** kwargs)
1919#### Arguments
2020- ` host ` : Redis server instance url or IP
2121- ` port ` : Redis server port
2222- ` args, kwargs ` : additional position and keyword args will be passed
2323 to Redis-py constructor
2424
2525#### Methods
26- - ` publish(self, trigger_name, message) ` : Trigger name is a subscription
26+ - ` publish(trigger_name, message) ` : Trigger name is a subscription
2727 or pubsub channel; message is the mutation object or message that will end
2828 up being passed to the subscription root_value; this method will be called inside of
2929 mutation resolve function
30- - ` subscribe(self, trigger_name, on_message_handler, options) ` : Trigger name
30+ - ` subscribe(trigger_name, on_message_handler, options) ` : Trigger name
3131 is a subscription or pubsub channel; on_message_handler is the callback
3232 that will be triggered on each mutation; this method is called by the subscription
3333 manager
34- - ` unsubscribe(self, sub_id) ` : Sub_id is the subscription ID that is being
34+ - ` unsubscribe(sub_id) ` : Sub_id is the subscription ID that is being
3535 tracked by the pubsub instance -- it is returned from the ` subscribe ` method
3636 and called by the subscription manager
37- - ` wait_and_get_message(self ) ` : Called by the subscribe method during the first
37+ - ` wait_and_get_message() ` : Called by the subscribe method during the first
3838 subscription for server; run in a separate greenlet and calls Redis ` get_message() `
3939 method to constantly poll for new messages on pubsub channels
40- - ` handle_message(self, message) ` : Called by pubsub when a message is
40+ - ` handle_message(message) ` : Called by pubsub when a message is
4141 received on a subscribed channel; will check all existing pubsub subscriptons and
4242 then calls ` on_message_handler() ` for all matches
4343
44- ### SubscriptionManager(self, schema, pubsub, setup_funcs={})
44+ ### SubscriptionManager(schema, pubsub, setup_funcs={})
4545#### Arguments
4646- ` schema ` : graphql schema instance
4747- ` pubsub ` : any pubsub instance with publish, subscribe, and unsubscribe
@@ -66,19 +66,19 @@ $ pip install graphql-subscriptions
6666 ```
6767
6868#### Methods
69- - ` publish(self, trigger_name, payload) ` : Trigger name is the subscription
69+ - ` publish(trigger_name, payload) ` : Trigger name is the subscription
7070 or pubsub channel; payload is the mutation object or message that will
7171 end up being passed to the subscription root_value; method called inside of
7272 mutation resolve function
73- - `subscribe(self, query, operation_name, callback, variables, context,
73+ - `subscribe(query, operation_name, callback, variables, context,
7474 format_error, format_response)`: Called by ApolloSubscriptionServer upon
7575 receiving a new subscription from a websocket. Arguments are parsed by
7676 ApolloSubscriptionServer from graphql subscription query
77- - ` unsubscribe(self, sub_id) ` : Sub_id is the subscription ID that is being
77+ - ` unsubscribe(sub_id) ` : Sub_id is the subscription ID that is being
7878 tracked by the subscription manager instance -- returned from the
7979 ` subscribe() ` method and called by the ApolloSubscriptionServer
8080
81- ### ApolloSubscriptionServer(self, subscription_manager, websocket, keep_alive=None, on_subscribe=None, on_unsubscribe=None, on_connect=None, on_disconnect=None)
81+ ### ApolloSubscriptionServer(subscription_manager, websocket, keep_alive=None, on_subscribe=None, on_unsubscribe=None, on_connect=None, on_disconnect=None)
8282#### Arguments
8383- ` subscription_manager ` : TODO
8484- ` websocket ` : TODO
0 commit comments