doc/stanza.txt
author Matthew Wild <mwild1@gmail.com>
Wed, 27 Mar 2024 15:35:15 +0000
branch0.12
changeset 13469 54a936345aaa
parent 55 4edb942e9dff
permissions -rw-r--r--
prosodyctl check: Warn about invalid domain names in the config file This ensures that domain names of virtual hosts and components are valid in XMPP, and that they are encoded correctly.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     1
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     2
Structure of a stanza:
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     3
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     4
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     5
stanza {
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     6
	--- properties ---
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     7
	tags -- array of tags
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     8
	
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     9
	--- static methods ---
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    10
	iq(attrs) -- 
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    11
	
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    12
	--- read-only methods ---
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    13
	reply -- return new stanza with attributes of current stanza
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    14
	child_with_name(string name) -- return the first child of the current tag with the matching name
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    15
	
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    16
	--- write methods ---
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    17
	tag(name, sttrs) -- create a new child of the current tag, and set the child as current
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    18
	up() -- move to the parent of the current tag
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    19
	text(string) -- append a new text node to the current tag
4edb942e9dff Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    20
}