OccupantEvent (Babbler 0.9.1)

java.lang.Object
- java.util.EventObject
- - rocks.xmpp.extensions.muc.OccupantEvent

All Implemented Interfaces:

Serializable
```
public final class OccupantEvent
extends EventObject
```
An event which is triggered by an occupant in a chat room. Typical events are "joins" and "leaves", as well as "bans" or "kicks".

See Also:

ChatRoom.addOccupantListener(Consumer), Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OccupantEvent.Type
The type of the occupant event.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Actor`	`getActor()`	Gets the actor in case the occupant was kicked or banned from the room.
`Jid`	`getAlternativeRoom()`	Gets the alternative room address in case the old room has been destroyed.
`Occupant`	`getOccupant()`	Gets the occupant.
`String`	`getReason()`	Gets the reason for kicking or banning an occupant or for destroying the room.
`OccupantEvent.Type`	`getType()`	Gets the type of this event.

Methods inherited from class java.util.EventObject
getSource, toString

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

- Method Detail
  - getOccupant
```
public Occupant getOccupant()
```
    Gets the occupant.
    
    Returns:
    
    The occupant.
  - getType
```
public OccupantEvent.Type getType()
```
    Gets the type of this event.
    
    Returns:
    
    The type.
  - getActor
```
public Actor getActor()
```
    Gets the actor in case the occupant was kicked or banned from the room.
    
    Returns:
    
    The actor or null.
  - getReason
```
public String getReason()
```
    Gets the reason for kicking or banning an occupant or for destroying the room.
    
    Returns:
    
    The reason for kicking or banning an occupant or for destroying the room.
  - getAlternativeRoom
```
public Jid getAlternativeRoom()
```
    Gets the alternative room address in case the old room has been destroyed.
    
    Returns:
    
    The alternative room address.
    
    See Also:
    
    OccupantEvent.Type.ROOM_DESTROYED