author | Mikael Hallendal <micke@imendio.com> |
Tue, 04 Mar 2008 00:38:08 +0100 | |
changeset 349 | 3dafc8376e9b |
parent 285 | 7dee90bf5ee8 |
child 555 | 695c909d0c45 |
permissions | -rw-r--r-- |
1 | 1 |
<!-- ##### SECTION Title ##### --> |
2 |
LmMessage |
|
3 |
||
4 |
<!-- ##### SECTION Short_Description ##### --> |
|
5 |
A message is built up like a tree of message nodes. |
|
6 |
||
7 |
<!-- ##### SECTION Long_Description ##### --> |
|
8 |
<para> |
|
9 |
Represents a message that can be sent with lm_connection_send(), lm_connection_send_with_reply() or lm_connection_send_with_reply_and_block(). Either use lm_message_new() or lm_message_new_with_subtype() to create a message. You need to call lm_message_unref() when are finished with it. |
|
10 |
||
11 |
</para> |
|
12 |
||
13 |
<!-- ##### SECTION See_Also ##### --> |
|
14 |
<para> |
|
15 |
||
16 |
</para> |
|
17 |
||
140
103227122f45
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
51
diff
changeset
|
18 |
<!-- ##### SECTION Stability_Level ##### --> |
103227122f45
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
51
diff
changeset
|
19 |
|
103227122f45
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
51
diff
changeset
|
20 |
|
51 | 21 |
<!-- ##### STRUCT LmMessage ##### --> |
1 | 22 |
<para> |
23 |
Struct |
|
24 |
</para> |
|
25 |
||
51 | 26 |
@node: |
27 |
@priv: |
|
1 | 28 |
|
29 |
<!-- ##### ENUM LmMessageType ##### --> |
|
30 |
<para> |
|
31 |
Describes what type of message a message is. This maps directly to top level elements in the jabber protocol. |
|
32 |
</para> |
|
33 |
||
34 |
@LM_MESSAGE_TYPE_MESSAGE: a message, <message/> |
|
35 |
@LM_MESSAGE_TYPE_PRESENCE: a presence element, <presence/> |
|
36 |
@LM_MESSAGE_TYPE_IQ: an info/query element, <iq/> |
|
37 |
@LM_MESSAGE_TYPE_STREAM: the stream:stream element, you probably don't need to create a message of this type. |
|
349 | 38 |
@LM_MESSAGE_TYPE_STREAM_ERROR: a stream:error element |
236
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
39 |
@LM_MESSAGE_TYPE_STREAM_FEATURES: |
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
40 |
@LM_MESSAGE_TYPE_AUTH: |
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
41 |
@LM_MESSAGE_TYPE_CHALLENGE: |
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
42 |
@LM_MESSAGE_TYPE_RESPONSE: |
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
43 |
@LM_MESSAGE_TYPE_SUCCESS: |
b4e5c1cb114e
Some tweaks while trying to solve LM-52.
Mikael Hallendal <micke@imendio.com>
parents:
140
diff
changeset
|
44 |
@LM_MESSAGE_TYPE_FAILURE: |
285
7dee90bf5ee8
sync LmMessageType enum to docs
Dafydd Harries <daf@rhydd.org>
parents:
236
diff
changeset
|
45 |
@LM_MESSAGE_TYPE_PROCEED: |
7dee90bf5ee8
sync LmMessageType enum to docs
Dafydd Harries <daf@rhydd.org>
parents:
236
diff
changeset
|
46 |
@LM_MESSAGE_TYPE_STARTTLS: |
1 | 47 |
@LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type. |
48 |
||
49 |
<!-- ##### ENUM LmMessageSubType ##### --> |
|
50 |
<para> |
|
51 |
Describes the sub type of a message. This is equal to the "type" attribute in the jabber protocol. What sub type a message can have is depending on the type of the message. |
|
52 |
</para> |
|
53 |
||
54 |
@LM_MESSAGE_SUB_TYPE_NOT_SET: the default. No "type" attribute will be sent. |
|
51 | 55 |
@LM_MESSAGE_SUB_TYPE_AVAILABLE: presence is available, applies to message type "presence" |
1 | 56 |
@LM_MESSAGE_SUB_TYPE_NORMAL: |
57 |
@LM_MESSAGE_SUB_TYPE_CHAT: message is a chat message, applies to message type "message" |
|
58 |
@LM_MESSAGE_SUB_TYPE_GROUPCHAT: message is a group chat message, applies to message type "message" |
|
59 |
@LM_MESSAGE_SUB_TYPE_HEADLINE: message is a headline message, applies to message type "message" |
|
60 |
@LM_MESSAGE_SUB_TYPE_UNAVAILABLE: presence is unavailable, applies to message type "presence" |
|
61 |
@LM_MESSAGE_SUB_TYPE_PROBE: a probe presence, applies to message type "presence" |
|
62 |
@LM_MESSAGE_SUB_TYPE_SUBSCRIBE: try to subscribe to another jids presence, applies to message type "presence" |
|
63 |
@LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE: unsubscribes from another jids presence, applies to message type "presence" |
|
64 |
@LM_MESSAGE_SUB_TYPE_SUBSCRIBED: reply from a subscribe message, informs that the subscription was successful. Applies to message type "presence" |
|
65 |
@LM_MESSAGE_SUB_TYPE_UNSUBSCRIBED: reply from subscribe or unsubscribe message. If it's a reply from a subscribe message it notifies that the subscription failed. Applies to message type "presence" |
|
66 |
@LM_MESSAGE_SUB_TYPE_GET: used to get information from an IQ query, applies to message type "iq" |
|
67 |
@LM_MESSAGE_SUB_TYPE_SET: used to set information in a IQ call, applised to message type "iq" |
|
68 |
@LM_MESSAGE_SUB_TYPE_RESULT: message is an IQ reply, applies to message type "iq" |
|
69 |
@LM_MESSAGE_SUB_TYPE_ERROR: messages is an error, applies to all message types. |
|
70 |
||
71 |
<!-- ##### FUNCTION lm_message_new ##### --> |
|
72 |
<para> |
|
73 |
||
74 |
</para> |
|
75 |
||
76 |
@to: |
|
77 |
@type: |
|
78 |
@Returns: |
|
79 |
||
80 |
||
81 |
<!-- ##### FUNCTION lm_message_new_with_sub_type ##### --> |
|
82 |
<para> |
|
83 |
||
84 |
</para> |
|
85 |
||
86 |
@to: |
|
87 |
@type: |
|
88 |
@sub_type: |
|
89 |
@Returns: |
|
90 |
||
91 |
||
92 |
<!-- ##### FUNCTION lm_message_get_type ##### --> |
|
93 |
<para> |
|
94 |
||
95 |
</para> |
|
96 |
||
97 |
@message: |
|
98 |
@Returns: |
|
99 |
||
100 |
||
101 |
<!-- ##### FUNCTION lm_message_get_sub_type ##### --> |
|
102 |
<para> |
|
103 |
||
104 |
</para> |
|
105 |
||
106 |
@message: |
|
107 |
@Returns: |
|
108 |
||
109 |
||
110 |
<!-- ##### FUNCTION lm_message_get_node ##### --> |
|
111 |
<para> |
|
112 |
||
113 |
</para> |
|
114 |
||
115 |
@message: |
|
116 |
@Returns: |
|
117 |
||
118 |
||
119 |
<!-- ##### FUNCTION lm_message_ref ##### --> |
|
120 |
<para> |
|
121 |
||
122 |
</para> |
|
123 |
||
124 |
@message: |
|
125 |
@Returns: |
|
126 |
||
127 |
||
128 |
<!-- ##### FUNCTION lm_message_unref ##### --> |
|
129 |
<para> |
|
130 |
||
131 |
</para> |
|
132 |
||
133 |
@message: |
|
134 |
||
135 |