org.pircbotx.hooks.events

Class SetPrivateEvent

java.lang.Object

org.pircbotx.hooks.Event

org.pircbotx.hooks.events.SetPrivateEvent

All Implemented Interfaces:

Comparable<Event>, GenericChannelEvent, GenericChannelModeEvent, GenericChannelUserEvent, GenericEvent, GenericUserEvent

public class SetPrivateEvent
extends Event
implements GenericChannelModeEvent

Called when a channel is marked as being in private mode.

This is a type of mode change and therefor is also dispatched in a ModeEvent

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
SetPrivateEvent(PircBotX bot, Channel channel, UserHostmask userHostmask, User user)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Channel	getChannel() The source channel where this event took place.
User	getUser() The source user that generated the event.
UserHostmask	getUserHostmask() The source user hostmask that generated the event.
int	hashCode()
void	respond(String response) Respond by send a message in the channel to the user that set the mode in user: message format
String	toString()

Methods inherited from class org.pircbotx.hooks.Event

compareTo, getBot, getId, getTimestamp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pircbotx.hooks.types.GenericEvent

getBot, getTimestamp

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SetPrivateEvent

public SetPrivateEvent(PircBotX bot,
                       @NonNull
                       Channel channel,
                       @NonNull
                       UserHostmask userHostmask,
                       User user)

Method Detail

respond

public void respond(String response)

Respond by send a message in the channel to the user that set the mode in user: message format

Specified by:

respond in interface GenericEvent

Specified by:

respond in class Event

Parameters:

response - The response to send

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Event

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Event

getChannel

@Generated(value="lombok")
public Channel getChannel()

Description copied from interface: GenericChannelEvent

The source channel where this event took place.

Specified by:

getChannel in interface GenericChannelEvent

Returns:

A channel or null if no channel was involved

getUserHostmask

@Generated(value="lombok")
public UserHostmask getUserHostmask()

Description copied from interface: GenericUserEvent

The source user hostmask that generated the event.

Specified by:

getUserHostmask in interface GenericUserEvent

Returns:

The hostmask of the user

getUser

@Generated(value="lombok")
public User getUser()

Description copied from interface: GenericUserEvent

The source user that generated the event.

Specified by:

getUser in interface GenericUserEvent

Returns:

The user or null if the hostmask didn't match a user at creation time