Wiki source code of User Status Event

Last modified by michaely on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.2+**.
10 {{/info}}
11
12 {{note}}
13 (% class="confluence-information-macro-body" %)
14 (((
15 This event will only be fired when a license is installed on the core server, and only for extensions that are bound to licensed/full users.
16 )))
17 {{/note}}
18
19 = (% style="color: rgb(0,0,0);" %)Description(%%) =
20
21 The user status event signifies that the status of a user has changed.
22 {{/layout-cell}}
23
24 {{layout-cell}}
25 {{panel title="On this page:"}}
26
27
28 {{toc maxLevel="2" indent="1"/}}
29 {{/panel}}
30 {{/layout-cell}}
31 {{/layout-section}}
32
33 {{layout-section ac:type="single"}}
34 {{layout-cell}}
35
36
37 = JSON Representation =
38
39 {{code language="js"}}
40 {
41 "type": "userStatus",
42 "time": 1436892834943,
43 "coreServerId": "e5c01703-3c6d-429a-8712-66c826064e65",
44 "userId": "e7577c7b-5d58-46a5-a834-386f52401c19",
45 "username": "4224",
46 "name": "Out of Office",
47 "statusType": "xa",
48 "note": "",
49 "returnTime": -1,
50 "userCreated": false
51 }
52 {{/code}}
53
54 |=(((
55 Property
56 )))|=(((
57 Type
58 )))|=(((
59 Description
60 )))
61 |(% colspan="1" %)(% colspan="1" %)
62 (((
63 userId
64 )))|(% colspan="1" %)(% colspan="1" %)
65 (((
66 String
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 The id of the user the status was set on.
70 )))
71 |(% colspan="1" %)(% colspan="1" %)
72 (((
73 username
74 )))|(% colspan="1" %)(% colspan="1" %)
75 (((
76 String
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 The username of the user the status was set on.
80 )))
81 |(% colspan="1" %)(% colspan="1" %)
82 (((
83 name
84 )))|(% colspan="1" %)(% colspan="1" %)
85 (((
86 String
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 The name of the status.
90 )))
91 |(% colspan="1" %)(% colspan="1" %)
92 (((
93 statusType
94 )))|(% colspan="1" %)(% colspan="1" %)
95 (((
96 String
97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
99 The status type. See Status Types below for the values of this property.
100 )))
101 |(% colspan="1" %)(% colspan="1" %)
102 (((
103 note
104 )))|(% colspan="1" %)(% colspan="1" %)
105 (((
106 String
107 )))|(% colspan="1" %)(% colspan="1" %)
108 (((
109 The note set for the user's status.
110 )))
111 |(% colspan="1" %)(% colspan="1" %)
112 (((
113 returnTime
114 )))|(% colspan="1" %)(% colspan="1" %)
115 (((
116 Long
117 )))|(% colspan="1" %)(% colspan="1" %)
118 (((
119 The time the user has set to return, or -1 if no return time has been set. Represented as a unix timestamp, in milliseconds.
120 )))
121 |(% colspan="1" %)(% colspan="1" %)
122 (((
123 userCreated
124 )))|(% colspan="1" %)(% colspan="1" %)
125 (((
126 Boolean
127 )))|(% colspan="1" %)(% colspan="1" %)
128 (((
129 True, if the status is a custom status set by the user; false, if the status is a pre-configured status.
130 )))
131
132 = (% style="color: rgb(0,0,0);" %)Status Types(%%) =
133
134 The following is a list of status types that could be reported by the user status event.
135
136 {{info}}
137 The current status type set on a user does not effect call flow or any other actions in the panel. The status is simply used for informational purposes.
138 {{/info}}
139
140
141
142 * available
143 * unavailable
144 * away
145 * xa
146 * dnd
147 * chat
148 * altblue
149 * altgreen
150 * altpink
151 * altpurple
152 * altred
153
154 \\
155 {{/layout-cell}}
156 {{/layout-section}}
157 {{/layout}}

Search

Navigation

iSymphony