Mercurial Mercurial > loudmouth / comparison
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs/reference/tmpl/lm-message.sgml
changeset 555 695c909d0c45
parent 349 3dafc8376e9b
equal deleted inserted replaced
552:137471c948ae 555:695c909d0c45 
    18 <!-- ##### SECTION Stability_Level ##### -->
 
    18 <!-- ##### SECTION Stability_Level ##### -->
 
    19 
    19 
    20 
    20 
    21 <!-- ##### STRUCT LmMessage ##### -->
 
    21 <!-- ##### STRUCT LmMessage ##### -->
 
    22 <para>
 
    22 <para>
 
    23 Struct 
    23 The LmMessage struct 
    24 </para>
 
    24 </para>
 
    25 
    25 
    26 @node: 
    26 @node: The root node of the message, you can also use lm_message_get_node() to retrieve this.
 
    27 @priv: 
    27 @priv: A pointer to message private data. Should never be touched from application code.
 
    28 
    28 
    29 <!-- ##### ENUM LmMessageType ##### -->
 
    29 <!-- ##### ENUM LmMessageType ##### -->
 
    30 <para>
 
    30 <para>
 
    31 Describes what type of message a message is. This maps directly to top level elements in the jabber protocol.
 
    31 Describes what type of message a message is. This maps directly to top level elements in the jabber protocol.
 
    32 </para>
 
    32 </para>
 
    34 @LM_MESSAGE_TYPE_MESSAGE: a message, <message/>
 
    34 @LM_MESSAGE_TYPE_MESSAGE: a message, <message/>
 
    35 @LM_MESSAGE_TYPE_PRESENCE: a presence element, <presence/>
 
    35 @LM_MESSAGE_TYPE_PRESENCE: a presence element, <presence/>
 
    36 @LM_MESSAGE_TYPE_IQ: an info/query element, <iq/>
 
    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.
 
    37 @LM_MESSAGE_TYPE_STREAM: the stream:stream element, you probably don't need to create a message of this type.
 
    38 @LM_MESSAGE_TYPE_STREAM_ERROR: a stream:error element
 
    38 @LM_MESSAGE_TYPE_STREAM_ERROR: a stream:error element
 
    39 @LM_MESSAGE_TYPE_STREAM_FEATURES: 
    39 @LM_MESSAGE_TYPE_STREAM_FEATURES: Internal
 
    40 @LM_MESSAGE_TYPE_AUTH: 
    40 @LM_MESSAGE_TYPE_AUTH: Internal
 
    41 @LM_MESSAGE_TYPE_CHALLENGE: 
    41 @LM_MESSAGE_TYPE_CHALLENGE: Internal
 
    42 @LM_MESSAGE_TYPE_RESPONSE: 
    42 @LM_MESSAGE_TYPE_RESPONSE: Internal
 
    43 @LM_MESSAGE_TYPE_SUCCESS: 
    43 @LM_MESSAGE_TYPE_SUCCESS: Internal
 
    44 @LM_MESSAGE_TYPE_FAILURE: 
    44 @LM_MESSAGE_TYPE_FAILURE: Internal
 
    45 @LM_MESSAGE_TYPE_PROCEED: 
    45 @LM_MESSAGE_TYPE_PROCEED: Internal
 
    46 @LM_MESSAGE_TYPE_STARTTLS: 
    46 @LM_MESSAGE_TYPE_STARTTLS: Internal
 
    47 @LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
 
    47 @LM_MESSAGE_TYPE_UNKNOWN: incoming message is of some unknown type.
 
    48 
    48 
    49 <!-- ##### ENUM LmMessageSubType ##### -->
 
    49 <!-- ##### ENUM LmMessageSubType ##### -->
 
    50 <para>
 
    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.
 
    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>
 
    52 </para>
 
    53 
    53 
    54 @LM_MESSAGE_SUB_TYPE_NOT_SET: the default. No "type" attribute will be sent.
 
    54 @LM_MESSAGE_SUB_TYPE_NOT_SET: the default. No "type" attribute will be sent.
 
    55 @LM_MESSAGE_SUB_TYPE_AVAILABLE: presence is available, applies to message type "presence"
 
    55 @LM_MESSAGE_SUB_TYPE_AVAILABLE: presence is available, applies to message type "presence"
 
    56 @LM_MESSAGE_SUB_TYPE_NORMAL: 
    56 @LM_MESSAGE_SUB_TYPE_NORMAL: a normal message.
 
    57 @LM_MESSAGE_SUB_TYPE_CHAT: message is a chat message, applies to message type "message"
 
    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"
 
    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"
 
    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"
 
    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"
 
    61 @LM_MESSAGE_SUB_TYPE_PROBE: a probe presence, applies to message type "presence"
loudmouth