PEPEvent (Smack Parent POM 4.1.5 API)

java.lang.Object
- org.jivesoftware.smackx.pep.packet.PEPEvent

All Implemented Interfaces:

Element, ExtensionElement, NamedElement
```
public class PEPEvent
extends Object
implements ExtensionElement
```
Represents XMPP Personal Event Protocol packets.
The 'http://jabber.org/protocol/pubsub#event' namespace is used to publish personal events items from one client to subscribed clients (See XEP-163).

Author:

Jeff Williams

Constructor Summary

Constructors
Constructor and Description

PEPEvent()
Creates a new empty roster exchange package.

PEPEvent(PEPItem item)
Creates a new empty roster exchange package.

Constructors
Constructor and Description
`PEPEvent()` Creates a new empty roster exchange package.
`PEPEvent(PEPItem item)` Creates a new empty roster exchange package.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPEPItem(PEPItem item)`
`String`	`getElementName()` Returns the XML element name of the extension sub-packet root element.
`String`	`getNamespace()` Returns the XML namespace of the extension sub-packet root element.
`String`	`toXML()` Returns the XML representation of a Personal Event Publish according the specification.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PEPEvent
```
public PEPEvent()
```
    Creates a new empty roster exchange package.
  - PEPEvent
```
public PEPEvent(PEPItem item)
```
    Creates a new empty roster exchange package.
- Method Detail
  - addPEPItem
```
public void addPEPItem(PEPItem item)
```
  - getElementName
```
public String getElementName()
```
    Returns the XML element name of the extension sub-packet root element. Always returns "x"
    
    Specified by:
    
    getElementName in interface NamedElement
    
    Returns:
    
    the XML element name of the stanza(/packet) extension.
  - getNamespace
```
public String getNamespace()
```
    Returns the XML namespace of the extension sub-packet root element. According the specification the namespace is always "jabber:x:roster" (which is not to be confused with the 'jabber:iq:roster' namespace
    
    Specified by:
    
    getNamespace in interface ExtensionElement
    
    Returns:
    
    the XML namespace of the stanza(/packet) extension.
  - toXML
```
public String toXML()
```
    Returns the XML representation of a Personal Event Publish according the specification. Usually the XML representation will be inside of a Message XML representation like in the following example:
```
 <message id="MlIpV-4" to="gato1@gato.home" from="gato3@gato.home/Smack">
     <subject>Any subject you want</subject>
     <body>This message contains roster items.</body>
     <x xmlns="jabber:x:roster">
         <item jid="gato1@gato.home"/>
         <item jid="gato2@gato.home"/>
     </x>
 </message>
 
```
    Specified by:
    
    toXML in interface Element
    
    Returns:
    
    the stanza(/packet) extension as XML.

Class PEPEvent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PEPEvent

PEPEvent

Method Detail

addPEPItem

getElementName

getNamespace

toXML