blob: 3659c9ca46300984a65ec1c18b9d3aa6a6c178c8 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/*
* decaffeinate suggestions:
* DS102: Remove unnecessary code created because of implicit returns
* DS206: Consider reworking classes to avoid initClass
* DS207: Consider shorter variations of null checks
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
// A new subscription is created through the ActionCable.Subscriptions instance available on the consumer.
// It provides a number of callbacks and a method for calling remote procedure calls on the corresponding
// Channel instance on the server side.
//
// An example demonstrates the basic functionality:
//
// App.appearance = App.cable.subscriptions.create "AppearanceChannel",
// connected: ->
// # Called once the subscription has been successfully completed
//
// disconnected: ({ willAttemptReconnect: boolean }) ->
// # Called when the client has disconnected with the server.
// # The object will have an `willAttemptReconnect` property which
// # says whether the client has the intention of attempting
// # to reconnect.
//
// appear: ->
// @perform 'appear', appearing_on: @appearingOn()
//
// away: ->
// @perform 'away'
//
// appearingOn: ->
// $('main').data 'appearing-on'
//
// The methods #appear and #away forward their intent to the remote AppearanceChannel instance on the server
// by calling the `@perform` method with the first parameter being the action (which maps to AppearanceChannel#appear/away).
// The second parameter is a hash that'll get JSON encoded and made available on the server in the data parameter.
//
// This is how the server component would look:
//
// class AppearanceChannel < ApplicationActionCable::Channel
// def subscribed
// current_user.appear
// end
//
// def unsubscribed
// current_user.disappear
// end
//
// def appear(data)
// current_user.appear on: data['appearing_on']
// end
//
// def away
// current_user.away
// end
// end
//
// The "AppearanceChannel" name is automatically mapped between the client-side subscription creation and the server-side Ruby class name.
// The AppearanceChannel#appear/away public methods are exposed automatically to client-side invocation through the @perform method.
(function() {
let extend = undefined
const Cls = (ActionCable.Subscription = class Subscription {
static initClass() {
extend = function(object, properties) {
if (properties != null) {
for (let key in properties) {
const value = properties[key]
object[key] = value
}
}
return object
}
}
constructor(consumer, params, mixin) {
this.consumer = consumer
if (params == null) { params = {} }
this.identifier = JSON.stringify(params)
extend(this, mixin)
}
// Perform a channel action with the optional data passed as an attribute
perform(action, data) {
if (data == null) { data = {} }
data.action = action
return this.send(data)
}
send(data) {
return this.consumer.send({command: "message", identifier: this.identifier, data: JSON.stringify(data)})
}
unsubscribe() {
return this.consumer.subscriptions.remove(this)
}
})
Cls.initClass()
return Cls
})()
|
