Msg.execute
From Yate Documentation
(Difference between revisions)
| Line 3: | Line 3: | ||
===Parameters=== | ===Parameters=== | ||
| − | |||
| − | |||
'''called''' | '''called''' | ||
:::the number of the called | :::the number of the called | ||
| − | |||
| − | |||
'''caller''' | '''caller''' | ||
:::the number of the caller | :::the number of the caller | ||
| + | '''called_instance''' | ||
| + | :::the called instance | ||
'''caller_instance''' | '''caller_instance''' | ||
:::he caller instance | :::he caller instance | ||
| + | |||
| + | Other parameters that may appear, specific to the module used: | ||
| + | |||
| + | '''subject''' | ||
| + | :::the subject of the message | ||
| + | '''body''' | ||
| + | :::the body of the message | ||
| + | '''time''' | ||
| + | :::the time of the message | ||
===How it works?=== | ===How it works?=== | ||
| − | The module that handles msg.execute will check the | + | The module that handles msg.execute will check the called parameter to not be empty and if a full JID is obtain with a resource, a [[chan.text]] is emitted from the channel. The return value is true if the chan.text has been emitted, false otherwise. |
'''See also''' | '''See also''' | ||
* [[contact.info]] | * [[contact.info]] | ||
Latest revision as of 11:32, 23 January 2013
msg.execute is emitted by a module that wants to send a chat message.
[edit] Parameters
called
- the number of the called
caller
- the number of the caller
called_instance
- the called instance
caller_instance
- he caller instance
Other parameters that may appear, specific to the module used:
subject
- the subject of the message
body
- the body of the message
time
- the time of the message
[edit] How it works?
The module that handles msg.execute will check the called parameter to not be empty and if a full JID is obtain with a resource, a chan.text is emitted from the channel. The return value is true if the chan.text has been emitted, false otherwise.
See also
