From 57aac1f1e7eb494575fba5c109c786fdee03a786 Mon Sep 17 00:00:00 2001
From: Beta-User <>
Date: Tue, 25 Jan 2022 05:26:36 +0000
Subject: [PATCH] 76_msgDialog: commandref to id format
git-svn-id: https://svn.fhem.de/fhem/trunk@25556 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
fhem/FHEM/76_msgDialog.pm | 89 ++++++++++++++++++++++++---------------
fhem/MAINTAINER.txt | 2 +-
2 files changed, 55 insertions(+), 36 deletions(-)
diff --git a/fhem/FHEM/76_msgDialog.pm b/fhem/FHEM/76_msgDialog.pm
index d51604481..320e6f79b 100644
--- a/fhem/FHEM/76_msgDialog.pm
+++ b/fhem/FHEM/76_msgDialog.pm
@@ -5,7 +5,7 @@
#
# 76_msgDialog.pm
#
-# Copyright by igami
+# Originally initiated by igami
#
# This file is part of FHEM.
#
@@ -86,8 +86,8 @@ sub msgDialog_Define($$) {
my $msgConfig = $modules{msgConfig}{defptr}{NAME};
- addToDevAttrList($msgConfig, "$TYPE\_evalSpecials:textField-long ");
- addToDevAttrList($msgConfig, "$TYPE\_msgCommand:textField ");
+ addToDevAttrList($msgConfig, "$TYPE\_evalSpecials:textField-long", 'msgDialog');
+ addToDevAttrList($msgConfig, "$TYPE\_msgCommand:textField", 'msgDialog');
$DEF = msgDialog_evalSpecials($hash, $DEF);
$DEF = eval{JSON->new->decode($DEF)};
@@ -432,15 +432,19 @@ sub msgDialog_update_msgCommand($) {
1;
+__END__
# commandref ##################################################################
=pod
+=encoding utf8
+
+
=item helper
=item summary dialogs for instant messaging
=item summary_DE Dialoge für Sofortnachrichten
=begin html
-
+
msgDialog
With msgDialog you can define dialogs for instant messages via TelegramBot, Jabber and yowsup (WhatsApp).
@@ -455,8 +459,8 @@ sub msgDialog_update_msgCommand($) {
-
- Define
+
+ Define
define <name> msgDialog <JSON>
Because of the complexity, it is easiest to define an empty dialog first.
@@ -549,14 +553,16 @@ sub msgDialog_update_msgCommand($) {
-
- Set
+
+ Set
+
-
reset
Resets the dialog for all users.
+
-
say [@<recipient1>[,<recipient2>,...]]
@@ -568,6 +574,7 @@ sub msgDialog_update_msgCommand($) {
recipients specified under the allowed attribute.
+
-
updateAllowed
Updates the selection for the allowed attribute.
@@ -575,9 +582,10 @@ sub msgDialog_update_msgCommand($) {
-
- Get
+
+ Get
+
-
trigger
Lists all TRIGGERs of the first level where setOnly is not specified.
@@ -585,14 +593,16 @@ sub msgDialog_update_msgCommand($) {
-
- Attribute
+
+ Attributes
+
-
allowed
List with all RESIDENTS and ROOMMATE that are authorized for this dialog.
+
-
disable 1
Dialog is deactivated.
@@ -604,6 +614,7 @@ sub msgDialog_update_msgCommand($) {
+
-
evalSpecials key1=value1 key2=value2 ...
Space Separate list of name=value pairs.
@@ -616,18 +627,19 @@ sub msgDialog_update_msgCommand($) {
from msgDialog is used.
+
-
msgCommand <command>
Command used to send a message.
The default is
"msg push \@$recipients $message".
- This attribute is available as "msgDialog_msgCommand" in the msgConfig device.
+ This attribute is available in the msgConfig device.
-
- Reading
+
+ Readings
-
$recipient_history
@@ -638,7 +650,7 @@ sub msgDialog_update_msgCommand($) {
-
+
Notes for use with TelegramBot:
It may be necessary to set the attribute "utf8specials" to 1 in the
@@ -649,7 +661,7 @@ sub msgDialog_update_msgCommand($) {
-
+
Notes for use with Jabber:
The msg command supports the TelegramBot_MTYPE. The default is empty. The
@@ -657,14 +669,14 @@ sub msgDialog_update_msgCommand($) {
-
+
Notes for use with yowsub (WhatsApp):
-
+
Examples:
@@ -853,7 +865,7 @@ plot=Waschkeller_washer_SVG
=begin html_DE
-
+
msgDialog
Mit msgDialog können Dialoge für Sofortnachrichten über
@@ -873,8 +885,8 @@ plot=Waschkeller_washer_SVG
-
- Define
+
+ Define
define <name> msgDialog <JSON>
Aufgrunder komplexität ist es am einfachsten erst einen leeren Dialog
@@ -976,14 +988,16 @@ plot=Waschkeller_washer_SVG
-
- Set
+
+ Set
+
-
reset
Setzt den Dialog für alle Benutzer zurück.
+
-
say [@<recipient1>[,<recipient2>,...]]
@@ -995,6 +1009,7 @@ plot=Waschkeller_washer_SVG
dem Attribut allowed angegebenen Empfänger fortgeführt.
+
-
updateAllowed
Aktualisiert die Auswahl für das Attribut allowed.
@@ -1002,8 +1017,8 @@ plot=Waschkeller_washer_SVG
-
- Get
+
+ Get
-
trigger
@@ -1013,15 +1028,17 @@ plot=Waschkeller_washer_SVG
-
- Attribute
+
+ Attribute
- -
+
+
-
allowed
Liste mit allen RESIDENTS und ROOMMATE die für diesen Dialog
berechtigt sind.
+
-
disable 1
Dialog ist deaktiviert.
@@ -1034,6 +1051,7 @@ plot=Waschkeller_washer_SVG
-
+
evalSpecials key1=value1 key2=value2 ...
Leerzeichen getrennte Liste von Name=Wert Paaren.
Wert kann Leerzeichen enthalten, falls es in "" oder {} eingeschlossen
@@ -1048,6 +1066,7 @@ plot=Waschkeller_washer_SVG
Wert aus msgDialog verwendet.
+
-
msgCommand <command>
Befehl der zum Versenden einer Nachricht verwendet wird.
@@ -1059,8 +1078,8 @@ plot=Waschkeller_washer_SVG
-
- Reading
+
+ Readings
-
$recipient_history
@@ -1072,7 +1091,7 @@ plot=Waschkeller_washer_SVG
-
+
Hinweise zur Benutzung mit Telegram:
Es kann notwendig sein, dass im TelegramBot das Attribut "utf8specials" auf
@@ -1084,7 +1103,7 @@ plot=Waschkeller_washer_SVG
-
+
Hinweise zur Benutzung mit Jabber:
Bei dem msg Befehl kann der Jabber_MTYPE angegeben werden. Die Vorgabe ist
@@ -1092,14 +1111,14 @@ plot=Waschkeller_washer_SVG
-
+
Hinweise zur Benutzung mit yowsub (WhatsApp):
Bisher noch keine Erfahungen.
-
+
Beispiele: