Wiki source code of b. Chats and Messaging

Version 2.1 by teamwire001 on 2021/12/06 07:52

Show last authors
1 Starting Teamwire, the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-tabmessages.png||height="20"]] **Messages** tab is shown by default. It shows all chats you are involved in.
2
3 As you receive new messages, you will find a badge counter on the Messages tab indicating the amount of unread texts.
4
5
6 {{id name="02-inbox"/}}
7
8 = Inbox =
9
10 When receiving new messages, the chat concerned is also provided with a badge on the number of unread texts. This badge will disappear after you have visited the chat. Inside the chat, new messages are visually indicated from already read content by a separator.
11
12
13 {{id name="02-search"/}}
14
15 == Search ==
16
17 Atop your messages you will find a search bar. The search will look up for chat titles, contacts, groups, and message content. Results are separated into said categories.
18
19 * Clicking on a search result will take you to the original message or chat.
20 * Clicking on a contact in the search results opens the chat with this contact or, if no chat exists with the contact yet, creates one.
21 ## ##
22
23 {{id name="02-createnewchat"/}}
24
25 = Create a chat =
26
27 To create a new chat, click [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-newchat.png||height="20"]] atop your messages. You can choose from the following options.
28
29 * 1:1 Chat
30 * Group Chat
31 * Broadcast
32 * Federated Chat
33 ## ##
34
35 {{id name="02-onetoonechat"/}}
36
37 == 1:1 chat ==
38
39 Select a [[participant>>doc:||anchor="02-selectparticipants"]]. You will enter the new chat automatically and will be able to compose your first message. For 1:1 Chats Teamwire will show the name of the user you are talking to as title. Read here to find out which [[chat content and actions>>doc:||anchor="02-chatcontentsandactions"]] can be used.
40
41 If you want to have topic-based 1:1 chats, use the option [[Group Chat>>doc:||anchor="02-groupchat"]] when creating the chat. It is possible to create a group chat with only one other user (see [[Group Chat>>doc:||anchor="02-groupchat"]]).
42
43 (% class="box warningmessage" %)
44 (((
45 1:1 chats cannot be subsequently extended with additional users to form a group chat.
46 )))
47
48 {{id name="02-groupchat"/}}
49
50 == Group chat ==
51
52 Select one or more [[participants>>doc:||anchor="02-selectparticipants"]], set a [[chat title>>doc:||anchor="02-definechattitle"]] and define [[further settings>>doc:||anchor="02-definefurthersettings"]]. You will enter the new chat automatically and will be able to compose your first message.
53
54 More information about chat content and actions are available [[here>>doc:||anchor="02-chatcontentsandactions"]].
55
56
57 {{id name="02-broadcastchat"/}}
58
59 == Broadcast chat ==
60
61 A broadcast chat is a group chat with the [[broadcast mode>>doc:||anchor="02-chatmode"]] enabled. This mode is very useful for sharing announcements or briefings in your organisation.
62
63 Select one or more [[participants>>doc:||anchor="02-selectparticipants"]], set a [[chat title>>doc:||anchor="02-definechattitle"]] and define [[further settings>>doc:||anchor="02-definefurthersettings"]]. You will enter the new chat automatically and will be able to compose your first message.
64
65 More information about the broadcast chat mode are available [[here>>doc:||anchor="02-chatmode"]].
66
67
68 {{id name="02-federatedchat"/}}
69
70 == Federated chat ==
71
72 Federated chats allow communicating with users from other Teamwire Servers.
73
74 Select one or more [[participants>>doc:||anchor="02-selectparticipants"]], set a [[chat title>>doc:||anchor="02-definechattitle"]] and define [[further settings>>doc:||anchor="02-definefurthersettings"]]. You will enter the new chat automatically and will be able to compose your first message.
75
76
77 {{id name="02-federatedchat-contacts"/}}
78
79 === Available contacts ===
80
81 The availability of chat participants is limited to contacts and circles that have been enabled for federated usage. Therefore, you cannot create a chat from your organisation's federated and non-federated contacts. In case an important user is not available in your contacts when creating a federated chat, please approach your Teamwire admin.
82
83 Currently it is currently not possible to add more chat members to the chat later.
84
85
86 {{id name="02-federatedchat-content"/}}
87
88 === Available chat content ===
89
90 The range of [[chat content>>doc:||anchor="02-chatcontentsandactions"]] is limited.
91
92 Currently, the following attachment types are supported: photos, (gallery), videos (gallery), files. Attention messages are not supported at the moment.
93
94
95 {{id name="02-federatedchat-removed"/}}
96
97 === Removed federations ===
98
99 If the federation with one or more Teamwire Servers is ended, federated chats are automatically closed. The participants cannot send new content. Unlike [[closed chats>>doc:||anchor="02-closechat"]], the chat history remains available for all members and can still be read.
100
101
102 {{id name="02-definechattitle"/}}
103
104 == Define chat title ==
105
106 Set a title for your conversation. This title is not final and can be changed at any time via [[Chat Settings>>doc:||anchor="02-chatsettings"]]. **For group chats,** setting a title is mandatory.
107
108
109 {{id name="02-selectparticipants"/}}
110
111 == Select participants ==
112
113 Select one or more users from your list of contacts by selecting the checkbox next to the user's name.
114
115 Already selected contacts are indicated with an [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-checked.png||height="20"]] and can be deselected by clicking again.
116
117 You can combine contacts, lists, circles and bots as recipients for a chat. On the right-hand side you can see an overview of all selected recipients and also remove them there.
118
119 Please note the **maximum of members** that can be added to a chat, which will be shown above the overview (Members X / 500) during the creation. The default maximum for a chat is 500 members, but it may have been adjusted by your Teamwire administrator.
120
121 ## ##
122 [[image:Public.Applications.Desktop.User-Manual.WebHome@EN__CreateChat.png||height="442" width="600"]]
123 ## ##
124
125 Your contacts are split into four types and are listed per section.
126
127 * [[Contacts>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-contacts"]]
128 * [[Lists>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-lists"]]
129 * [[Circles>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-circles"]]
130 * [[Bots>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-bots"]]
131 ## ##
132
133 Although all contacts are arranged in alphabetical order (by their last name), in a large organisation it can become challenging to find the right user quickly. Therefore, make use of the **search bar,** to find your contacts, lists, circles and bots per section. The search bar is located above the left-side list of contacts.
134
135
136 {{id name="02-definefurthersettings"/}}
137
138 == Define further settings ==
139
140 * **Allow to mute notifications**
141 Decide whether chat members are allowed to mute this conversation so they will no longer receive push notifications.
142
143 * **Alert Chat**
144 This feature is meant for emergencies. An alert chat will always stay on top of its members inbox until its messages has been read. Beside alert chats, you can also create alert messages. More information about alert messages are available at the [[Attention messages>>doc:||anchor="02-attentionmessages"]] chapter.
145 ## ##
146
147 After defining all further settings, click **OK** to enter the new chat automatically and you will be able to compose your first message.
148
149
150 {{id name="02-chatcontentsandactions"/}}
151
152 = Chat content and actions =
153
154
155 {{id name="02-attachments"/}}
156
157 == Attachments and functions ==
158
159 In addition to texts and emojis, you can send various attachments via Teamwire.
160
161 If you want to attach a photo, video, audio file, appointment, presentation, PDF or the like to your current conversation, click [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-attachments-desktop.png||height="20"]] to select your file, or just drag and drop it onto the Teamwire app to share it with the chat. For most photo files, a preview is displayed directly in the chat.
162
163 Via the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-attachments.png||height="20"]] button next to the text input field, Teamwire also provides additional features like [[attention messages>>doc:||anchor="02-attentionmessages"]] and [[polls>>doc:||anchor="02-polls"]].
164
165 With the button [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-microphone.png||height="20"]] , you can record voice messages, provided you have connected a microphone. Define your input and output devices in the [[General settings>>doc:Public.Applications.Desktop.User-Manual.Profile-and-Settings.WebHome||anchor="04-generalsettings"]].
166
167 (% class="box infomessage" %)
168 (((
169 Your Teamwire admin is able to prohibit sending certain attachment types. If one or more options are not available to you, they may have been disabled by your Teamwire administrator.
170 )))
171
172 {{id name="02-attentionmessages"/}} {{id name="02-alertmessages"/}}
173
174 == Attention messages ==
175
176 Via [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-attachments.png||height="20"]] next to the text input field, various types of attention message are available in Teamwire.
177
178 Chat members can respond to your status messages with a predefined selection of reactions without disrupting the flow of an active conversation. Reactions can also be sent by members of a broadcast chat.
179
180 * [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-alert.png||height="20"]] **Alert**
181 Label your message as an alert (text input turns red). Alerts cause a special ringtone and will create a different icon on the notification screen for its participants. A chat containing an alert message will be visually highlighted in its participants inbox, and will always stay on top until all new content has been read.
182 The alert notification sound can be configured via [[Settings > Notifications>>doc:Public.Applications.Desktop.User-Manual.Profile-and-Settings.WebHome||anchor="04-notifications"]].
183
184 * [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-annoucement.png||height="20"]] **Announcement**
185 Label your message as an announcement (text input turns green). Chat members can react to your message via [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-emptyActivities.png||height="20"]] with a range of reactions.
186
187 * [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-note.png||height="20"]] **Note**
188 Label your message as an note (text input turns yellow). Chat members can react to your message via [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-emptyActivities.png||height="20"]] with a range of reactions.
189 ## ##
190
191 All message types above can be removed before sending by clicking the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-messagetype.png||height="20"]] icon. Your message will be sent as normal text then.
192
193 (% class="box infomessage" %)
194 (((
195 If attention messages are not available to you, the feature may have been disabled by your Teamwire administrator.
196 )))
197
198 {{id name="02-ownattentionmessages"/}}
199
200 === Activity / Reactions ===
201
202 You can view the **reactions** to one of your attention messages via the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-report.png||height="20"]] **report.**
203
204 You can find a chronological list of all reactions to your attention messages via the icon [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-bell.png||height="20"]] in the upper right corner of the chat.
205
206
207 {{id name="02-polls"/}}
208
209 == Polls ==
210
211 Via [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-attachments.png||height="20"]] next to the text input field, you can create polls in Teamwire.
212
213 Click [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-poll.png||height="20"]] to create a poll and let your chat members vote to make decisions more quickly.
214
215
216 {{id name="02-readreceipts"/}}
217
218 == Read receipts ==
219
220 The [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-readeye.png||height="15"]] read receipts of chat members are represented by their user avatars and can be found at the bottom of the conversation. Please note, that these read receipts **only apply to the latest message** of the chat and cannot be viewed for previous messages.
221
222 If you are looking for a detailed view of the current read receipts, tap the line of user avatars to receive a complete list of members.
223
224 (% class="box infomessage" %)
225 (((
226 Your Teamwire administrator may disable read receipts for all users.
227 )))
228
229 {{id name="02-replytomessage"/}}
230
231 == Reply to a message ==
232
233 Move your cursor at the respective message or attachment and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu. Select **Reply** to add a quote of the original message when sending your answer. This is especially useful in conversations with a lot of users so you won't lose context.
234
235
236 {{id name="02-copymessage"/}}
237
238 == Copy a message ==
239
240 Move your cursor at the respective message or attachment and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu. Select **Copy** to copy the entire message content to your clipboard.
241
242 You can also mark a part of the message with your cursor and perform a right click to open the context menu. Select **Copy** (or use the shortcut //Ctrl+C// resp. //Cmd+C//) to copy the content to your clipboard.
243
244 You can paste the text to another chat or an external app.
245
246 (% class="box infomessage" %)
247 (((
248 If you cannot copy a message, the feature may have been disabled by your Teamwire administrator.
249 )))
250
251 {{id name="02-forwardmessage"/}}
252
253 == Forward a message ==
254
255 Move your cursor at the respective message or attachment and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu and select **Forward.** A list of all existing chats to which you can forward the content to will be displayed. If you want to use a new chat to forward the content to, click on **New Chat** atop the listed chats and continue selecting your participants.
256
257
258 {{id name="02-deletemessage"/}}
259
260 == Delete a message ==
261
262 You can delete your own messages and attachments in Teamwire, even if they have already been read. Move your cursor at the respective message or attachment and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu and select **Delete** to remove it.
263
264 (% class="box infomessage" %)
265 (((
266 If you cannot delete a message, the feature may have been disabled by your Teamwire administrator.
267 )))
268
269 {{id name="02-chatmenu"/}}
270
271 = Chat menu =
272
273 In your current chat view, click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon in the right upper corner to open the chat menu.
274
275 Here you can make different adjustments to the chat like adding further users, view attachments and attention messages, or leave the conversation.
276
277
278 {{id name="02-chatsettings"/}}
279
280 == Chat settings ==
281
282 Select **Chat Settings** from the chat menu. Among other things, here you can edit the title.
283
284 (% class="box infomessage" %)
285 (((
286 Only [[chat administrators>>doc:||anchor="02-chatadministrators"]] are authorised to make changes to chat settings.
287 )))
288
289 ## ##
290 [[image:Public.Applications.Desktop.User-Manual.WebHome@EN__ChatMenu.png||height="450" width="600"]]
291 ## ##
292
293 {{id name="02-chatavatar"/}}
294
295 === Chat avatar ===
296
297 Click on the current chat avatar to search your file explorer for an image or photo and select it. The new avatar will be shown to all members of the conversation.
298
299 Click the avatar again to **change** or **remove** the image.
300
301
302 {{id name="02-chattitle"/}}
303
304 === Chat title ===
305
306 Click the text below the chat avatar to edit the chat title. Confirm your changes via Enter.
307
308 If you want to reset a chat title, remove the current text and confirm via Enter. The title will adopt the automatically generated name. But remember that defining a title is mandatory for group chats.
309
310
311 {{id name="02-chatmode"/}}
312
313 === Chat mode ===
314
315 Teamwire supports two chat modes. Change the current mode by enabling or disabling the **Allow to send messages** feature.
316
317 * **Normal**
318 //Allow to send messages// enabled
319 By default, the Chat Settings suggest to create a conversation with the //Normal// chat mode enabled. This mode allows all members to compose and send messages / attachments to the chat.
320
321 * **Broadcast**
322 //Allow to send messages// disabled
323 The //Broadcast// mode will only allow [[chat administrators>>doc:||anchor="02-chatadministrators"]] to compose and send messages / attachments to the chat. This mode is very useful for sharing announcements or briefings in your organisation.
324 ## ##
325
326 {{id name="02-mediaoverview"/}}
327
328 == Media overview ==
329
330 Select **Media overview **from the chat menu. It allows you to look up for all attachments that have been shared in the current chat. The media is filtered by its file type, but can also be viewed unfiltered via //All.//
331
332
333 {{id name="02-allattentionmessages"/}}
334
335 == Alerts, announcements and notes ==
336
337 Select **Alerts, Announcements** or **Notes **from the chat menu. You will find a summary of all attention messages that have been shared in the current chat.
338
339
340 {{id name="02-chatadministrators"/}}
341
342 == Chat administrators ==
343
344 Select **Admins **from the chat menu. This section lists all administrators of the current chat.
345
346 Chat administrators are able to make changes in the Chat Settings, e.g. editing the chat title and chat mode, allowing to mute the chat, or promote other members to become chat administrator.
347
348 In a 1:1 chat, both members become chat administrator by default.
349
350 **In a group chat, the creator of the chat is automatically promoted to chat administrator.** This applies to all ways of group chats; whether the chat was created by selecting several individual users, by adding [[circles>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-circles"]] or [[lists>>doc:Public.Applications.Desktop.User-Manual.Contacts.WebHome||anchor="03-lists"]], or by a mix of all options mentioned.
351
352
353 {{id name="02-promotetoadmin"/}}
354
355 === Promote to admin ===
356
357 Select **Members** from the chat menu to see a complete list of the current chat's participants. If the chat was created via circle, click on its name to view the list of members. Move your cursor at the user of concern and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu. Select **Make chat admin.**
358
359 (% class="box infomessage" %)
360 (((
361 The admin promotion cannot be revoked.
362 )))
363
364 === Demote admin ===
365
366 The admin promotion cannot be revoked.
367
368 You may use the following workaround: Remove the user from the current chat and add them again afterwards. Thus, the user is being removed from both the list of members and administrators, and will become a regular chat member after adding them again.
369
370
371 {{id name="02-members"/}}
372
373 == Members ==
374
375 Select **Members **from the chat menu. This section lists all members of the current chat incl. chat administrators.
376
377 If the chat was created by adding a circle, its name will be shown. The members of the circle can be viewed by clicking the circle name.
378
379
380 {{id name="02-addmoremembers"/}}
381
382 === Add more members ===
383
384 In order to add further members to the chat, select **Add colleagues to chat** in the list of chat members. You will be forwarded to your directory from which you can add further users and/or circles and lists. Confirm your selection by clicking **OK.**
385
386
387 {{id name="02-removemembers"/}}
388
389 === Remove members ===
390
391 Move your cursor at the user of concern and click on the [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] icon to open the context menu. Select **Remove from chat.** You cannot remove individual users which have been added via circle. You have to remove the complete circle from the chat instead.
392
393
394 {{id name="02-chatadministration"/}}
395
396 == Chat administration ==
397
398 In the chat menu, you will find multiple options to manage the current conversation, like muting, archiving, leaving or closing the chat.
399
400
401 {{id name="02-archivechat"/}}
402
403 === Archive chat ===
404
405 This is a personal setting and will only affect your own user account.
406
407 Archive a chat when the conversation is no longer active or when a topic-based discussion is completed. Archived chats are not displayed in your message inbox by default.
408
409 There are two options to archive a chat
410
411 * Open the respective chat and select the **Archive** option from the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] in the right upper corner of the screen.
412 * In your **inbox,** perform a right click on the respective chat to open the context menu and select **Archive.**
413 ## ##
414
415 To display archived chats in your inbox, make use of the app's menu bar (or use the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] next to your name and avatar) and select **Teamwire > Chat > Show archived chats.** The archived chats now become visible in your inbox. You are able to **unarchive** a conversation again in the same way as you have archived them.
416
417
418 {{id name="02-mutechat"/}}
419
420 === Mute chat ===
421
422 This is a personal setting and will only affect your own user account.
423
424 Mute a chat to stop receiving notifications. When muted, the notification sound, vibration and push notifications will not be triggered **for this chat.** The app icon on your home screen will keep showing the number of unread messages.
425
426 There are two options to mute a chat
427
428 * Open the respective chat and select the **Mute** option from the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] in the right upper corner of the screen.
429 * In your **inbox,** perform a right click on the respective chat to open the context menu and select **Mute.**
430 ## ##
431
432 You can re-enable notifications for a chat in the same way.
433
434 (% class="box infomessage" %)
435 (((
436 If you cannot mute a chat, the feature may have been disabled by your Teamwire administrator or by a chat admin.
437 )))
438
439 {{id name="02-closechat"/}}
440
441 === Close chat ===
442
443 This is an administrative setting and will affect all members of the chat. Only chat administrators can close a chat.
444
445 Close a chat when the conversation is over and no longer needed.
446 After it has been closed, the chat will show an according info message and the chat history can no longer be read by its members.
447
448 There are two options to close a chat
449
450 * Open the respective chat and select the **Close chat** option from the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] in the right upper corner of the screen.
451 * In your **inbox,** perform a right click on the respective chat to open the context menu and select **Close Chat.**
452 ## ##
453
454 If you are a chat admin, you can right-click the chat in your inbox to **Reopen** it. This option is also available in the chat view.
455
456 (% class="box infomessage" %)
457 (((
458 If the "Close chat" option is not available to you, the feature may have been disabled by your Teamwire administrator.
459 )))
460
461 {{id name="02-leavechat"/}}
462
463 === Leave chat ===
464
465 Leave a chat when you no longer want to be part of the conversation or your participation is no longer needed.
466
467 There are two options to leave a chat
468
469 * Open the respective chat and select the **Leave chat **option from the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] in the right upper corner of the screen.
470 * In your **inbox,** perform a right click on the respective chat to open the context menu and select **Leave Chat.**
471
472 (% class="box infomessage" %)
473 (((
474 If the "Leave chat" option is not available to you, the feature may have been disabled by your Teamwire administrator.
475
476 Please note that you cannot leave chats in which you have been added as part of a [[circle>>doc:Public.Applications.Desktop.User-Manual.WebHome||anchor="03-circles"]].
477 )))
478
479 {{id name="02-chattoPDF"/}}
480
481 === Save chat history ===
482
483 To save the content of a chat in a PDF file, make use of the app's menu bar (or use the menu [[image:Public.Applications.Desktop.User-Manual.WebHome@icon-menu.png||height="4"]] next to your name and avatar) and select **Teamwire > Chat > Save as PDF.** In the following mask, define the period to be saved. Click again on **Save as PDF** and select a destination using your file explorer.
484
485 Please note that some attachments may not be listed in PDF format.
486
487 ## ##