You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|port `int`|**Default:`None`** <br>Which port to connect to |
80
80
|ssl `bool`|**Default:`True`** <br> Use HTTPS |
81
81
|cluster `String`|**Default:`None`** <br> Convention for other clusters than the main Pusher-one. Eg: 'eu' will resolve to the api-eu.pusherapp.com host |
82
-
|backend `Object`| an object that responds to the send_request(request) method. If none is provided, a `pusher.requests.RequestsBackend` instance is created. |
82
+
|backend `Object`| an object that responds to the `send_request(request)` method. If none is provided, a `pusher.requests.RequestsBackend` instance is created. |
The constructor will throw a `TypeError` if it is called with parameters that don’t match the types listed above.
87
+
86
88
##### Example
87
89
88
90
```py
@@ -107,6 +109,8 @@ To trigger an event on one or more channels, use the `trigger` method on the `Pu
107
109
|:-:|:-:|
108
110
|buffered_events `Dict`| A parsed response that includes the event_id for each event published to a channel. See example. |
109
111
112
+
`Pusher::trigger` will throw a `TypeError` if called with parameters of the wrong type; or a `ValueError` if called on more than 10 channels, with an event name longer than 200 characters, or with more than 10240 characters of data (post JSON serialisation).
113
+
110
114
##### Example
111
115
112
116
This call will trigger to `'a_channel'` and `'another_channel'`, and exclude the recipient with socket_id `"1234.12"`.
@@ -138,6 +142,7 @@ Events are a `Dict` with keys:
138
142
|:-:|:-:|
139
143
|`Dict`| An empty dict on success |
140
144
145
+
`Pusher::trigger_batch` will throw a `TypeError` if the data parameter is not JSONable.
141
146
142
147
##### Example
143
148
@@ -224,6 +229,8 @@ data = {
224
229
|:-:|:-:|
225
230
|channels `Dict`| A parsed response from the HTTP API. See example. |
226
231
232
+
`Pusher::channels_info` will throw a `TypeError` if `prefix_filter` is not a `String`.
0 commit comments