JsDoc: Xmpp4Js.Packet.Base

Class Xmpp4Js.Packet.Base

Defined in Base.js

Constructor Summary
`Xmpp4Js.Packet.Base(node)` Default constructor that takes a node to be created from.

Method Summary
	`addExtension(extension)` There can only be one extension per namespace.
	`getChildElementContent(elemName, defaultVal)` Get the text content of a node.
	`getChildElementNode(elemName)` Get a child element node if it exists.
	`getDoc()` undocumented
	`getExtension(extensionNS)` undocumented
	`getExtensions()` undocumented
	`getFrom()` undocumented
	`getFromJid()` undocumented
	`getId()` undocumented
	`getNode()` undocumented
	`getTo()` undocumented
	`getToJid()` undocumented
	`getType()` undocumented
	`loadExtensions(provider)` FIXME If there are multiple with the same namespace, there will be trouble.
	`removeChildElement(elemName)` Removes a child element of given name.
	`removeExtension(extensionNS)` undocumented
	`setChildElementContent(elemName, content)` Set text content or a node to a child element.
	`setFrom(from)`
	`setFromJid(from)`
	`setId(id)` undocumented
	`setNode(node)` undocumented
	`setTo(to)`
	`setToJid(to)`
	`setType(type)` undocumented
	`toString()` undocumented

Constructor Detail

Xmpp4Js.Packet.Base

Xmpp4Js.Packet.Base(node)

Default constructor that takes a node to be created from.

Parameters:

Element node

Method Detail

addExtension

addExtension(extension)

There can only be one extension per namespace. Removes an existing extension of same namespace if there is one, and adds the new one.

Parameters:

extension

getChildElementContent

getChildElementContent(elemName, defaultVal)

Get the text content of a node.

Parameters:

elemName

defaultVal

getChildElementNode

getChildElementNode(elemName)

Get a child element node if it exists.

Parameters:

elemName

getDoc

getDoc()

undocumented

getExtension

getExtension(extensionNS)

undocumented

Parameters:

extensionNS

getExtensions

getExtensions()

undocumented

getFrom

getFrom()

undocumented

getFromJid

getFromJid()

undocumented

getId

getId()

undocumented

getNode

getNode()

undocumented

getTo

getTo()

undocumented

getToJid

getToJid()

undocumented

getType

getType()

undocumented

loadExtensions

loadExtensions(provider)

FIXME If there are multiple with the same namespace, there will be trouble.

Parameters:

provider

removeChildElement

removeChildElement(elemName)

Removes a child element of given name.

Parameters:

elemName

removeExtension

removeExtension(extensionNS)

undocumented

Parameters:

extensionNS

setChildElementContent

setChildElementContent(elemName, content)

Set text content or a node to a child element. Creates the element if it doesn't exist. FIXME if content is a node, it does not replace existing content by removing node of same name.

Parameters:

elemName

content

setFrom

setFrom(from)

Parameters:

String from

setFromJid

setFromJid(from)

Parameters:

Jid from

setId

setId(id)

undocumented

Parameters:

id

setNode

setNode(node)

undocumented

Parameters:

node

setTo

setTo(to)

Parameters:

String to

setToJid

setToJid(to)

Parameters:

Jid to

setType

setType(type)

undocumented

Parameters:

type

toString

toString()

undocumented

Documentation generated by JsDoc Toolkit 1.4.1 on Tue Aug 26 2008 14:35:54 GMT-0500 (CDT)