Msg.route
(Created page with "'''msg.route''' message is used to route a chat.<br> This message must be explicitly installed.<br> The message has been designed for synchronous processing.<br>") |
|||
| Line 1: | Line 1: | ||
| − | '''msg.route''' message is used to route a chat.<br> | + | '''msg.route''' message is used to route a chat message.<br> |
This message must be explicitly installed.<br> | This message must be explicitly installed.<br> | ||
The message has been designed for synchronous processing.<br> | The message has been designed for synchronous processing.<br> | ||
| + | |||
| + | ===Parameters=== | ||
| + | |||
| + | '''caller''' | ||
| + | :::The caller number. | ||
| + | '''called''' | ||
| + | :::The called number. | ||
| + | '''called_instance''' | ||
| + | :::The called instance that means the connection data of the called to the server also called resource. | ||
| + | '''caller_instance''' | ||
| + | :::The caller instance that means the connection data of the caller to the server. | ||
| + | |||
| + | ===How it works?=== | ||
| + | |||
| + | A Module (let's say jabberserver module) emits message msg.route and is cought by another module (let's say subscription module) then the destination is searched. | ||
| + | If the destination is a unknown user false is returned. | ||
| + | If the destination is a known user the resource is checked. | ||
| + | If all requirements are fulfilled and the user is offline the server will try to store the chat. That means if the user is subscribed to presence, an error will be send saying the user is offline, or the item was not found. Else the error will be something like service unavailable. | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[msg.execute]] | ||
Latest revision as of 17:35, 22 January 2013
msg.route message is used to route a chat message.
This message must be explicitly installed.
The message has been designed for synchronous processing.
[edit] Parameters
caller
- The caller number.
called
- The called number.
called_instance
- The called instance that means the connection data of the called to the server also called resource.
caller_instance
- The caller instance that means the connection data of the caller to the server.
[edit] How it works?
A Module (let's say jabberserver module) emits message msg.route and is cought by another module (let's say subscription module) then the destination is searched. If the destination is a unknown user false is returned. If the destination is a known user the resource is checked. If all requirements are fulfilled and the user is offline the server will try to store the chat. That means if the user is subscribed to presence, an error will be send saying the user is offline, or the item was not found. Else the error will be something like service unavailable.
See also
