docs/reference/tmpl/lm-message.sgml
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--
Release 1.3.4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     1
<!-- ##### SECTION Title ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     2
LmMessage
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     3
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     4
<!-- ##### SECTION Short_Description ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     5
A message is built up like a tree of message nodes.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     6
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     7
<!-- ##### SECTION Long_Description ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     8
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     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.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    10
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    11
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    12
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    13
<!-- ##### SECTION See_Also ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    14
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    15
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    16
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    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
0d00219be016 updated
hallski <hallski>
parents: 1
diff changeset
    21
<!-- ##### STRUCT LmMessage ##### -->
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    22
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    23
Struct 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    24
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    25
51
0d00219be016 updated
hallski <hallski>
parents: 1
diff changeset
    26
@node: 
0d00219be016 updated
hallski <hallski>
parents: 1
diff changeset
    27
@priv: 
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    28
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    29
<!-- ##### ENUM LmMessageType ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    30
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    31
Describes what type of message a message is. This maps directly to top level elements in the jabber protocol.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    32
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    33
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    34
@LM_MESSAGE_TYPE_MESSAGE: a message, <message/>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    35
@LM_MESSAGE_TYPE_PRESENCE: a presence element, <presence/>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    36
@LM_MESSAGE_TYPE_IQ: an info/query element, <iq/>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    37
@LM_MESSAGE_TYPE_STREAM: the stream:stream element, you probably don't need to create a message of this type.
349
3dafc8376e9b Release 1.3.4
Mikael Hallendal <micke@imendio.com>
parents: 285
diff changeset
    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
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    47
@LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    48
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    49
<!-- ##### ENUM LmMessageSubType ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    50
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    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.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    52
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    53
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    54
@LM_MESSAGE_SUB_TYPE_NOT_SET: the default. No "type" attribute will be sent.
51
0d00219be016 updated
hallski <hallski>
parents: 1
diff changeset
    55
@LM_MESSAGE_SUB_TYPE_AVAILABLE: presence is available, applies to message type "presence"
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    56
@LM_MESSAGE_SUB_TYPE_NORMAL: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    57
@LM_MESSAGE_SUB_TYPE_CHAT: message is a chat message, applies to message type "message"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    58
@LM_MESSAGE_SUB_TYPE_GROUPCHAT: message is a group chat message, applies to message type "message"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    59
@LM_MESSAGE_SUB_TYPE_HEADLINE: message is a headline message, applies to message type "message"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    60
@LM_MESSAGE_SUB_TYPE_UNAVAILABLE: presence is unavailable, applies to message type "presence"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    61
@LM_MESSAGE_SUB_TYPE_PROBE: a probe presence, applies to message type "presence"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    62
@LM_MESSAGE_SUB_TYPE_SUBSCRIBE: try to subscribe to another jids presence, applies to message type "presence"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    63
@LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE: unsubscribes from another jids presence, applies to message type "presence"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    64
@LM_MESSAGE_SUB_TYPE_SUBSCRIBED: reply from a subscribe message, informs that the subscription was successful. Applies to message type "presence"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    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"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    66
@LM_MESSAGE_SUB_TYPE_GET: used to get information from an IQ query, applies to message type "iq"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    67
@LM_MESSAGE_SUB_TYPE_SET: used to set information in a IQ call, applised to message type "iq"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    68
@LM_MESSAGE_SUB_TYPE_RESULT: message is an IQ reply, applies to message type "iq"
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    69
@LM_MESSAGE_SUB_TYPE_ERROR: messages is an error, applies to all message types.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    70
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    71
<!-- ##### FUNCTION lm_message_new ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    72
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    73
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    74
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    75
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    76
@to: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    77
@type: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    78
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    79
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    80
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    81
<!-- ##### FUNCTION lm_message_new_with_sub_type ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    82
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    83
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    84
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    85
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    86
@to: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    87
@type: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    88
@sub_type: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    89
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    90
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    91
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    92
<!-- ##### FUNCTION lm_message_get_type ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    93
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    94
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    95
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    96
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    97
@message: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    98
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    99
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   100
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   101
<!-- ##### FUNCTION lm_message_get_sub_type ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   102
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   103
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   104
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   105
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   106
@message: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   107
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   108
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   109
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   110
<!-- ##### FUNCTION lm_message_get_node ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   111
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   112
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   113
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   114
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   115
@message: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   116
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   117
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   118
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   119
<!-- ##### FUNCTION lm_message_ref ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   120
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   121
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   122
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   123
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   124
@message: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   125
@Returns: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   126
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   127
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   128
<!-- ##### FUNCTION lm_message_unref ##### -->
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   129
<para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   130
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   131
</para>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   132
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   133
@message: 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   134
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
   135