Erebot\Interfaces\Event\Base\Chan Interface Reference

Interface for an event which applies to a channel. More...

Inherits Erebot\Interfaces\Event\Base\Generic.

Inherited by Erebot\Event\WithChanSourceAbstract, Erebot\Event\WithChanSourceTargetAbstract, Erebot\Interfaces\Event\Ban, Erebot\Interfaces\Event\ChanAction, Erebot\Interfaces\Event\ChanCtcp, Erebot\Interfaces\Event\ChanCtcpReply, Erebot\Interfaces\Event\ChanNotice, Erebot\Interfaces\Event\ChanText, Erebot\Interfaces\Event\DeHalfop, Erebot\Interfaces\Event\DeOp, Erebot\Interfaces\Event\DeOwner, Erebot\Interfaces\Event\DeProtect, Erebot\Interfaces\Event\DeVoice, Erebot\Interfaces\Event\Except, Erebot\Interfaces\Event\Halfop, Erebot\Interfaces\Event\Invite, Erebot\Interfaces\Event\Join, Erebot\Interfaces\Event\Kick, Erebot\Interfaces\Event\Op, Erebot\Interfaces\Event\Owner, Erebot\Interfaces\Event\Part, Erebot\Interfaces\Event\Protect, Erebot\Interfaces\Event\RawMode, Erebot\Interfaces\Event\Topic, Erebot\Interfaces\Event\UnBan, Erebot\Interfaces\Event\UnExcept, and Erebot\Interfaces\Event\Voice.

Public Member Functions
	getChan ()
Public Member Functions inherited from Erebot\Interfaces\Event\Base\Generic
	getConnection ()
	preventDefault ($prevent=null)

Detailed Description

Interface for an event which applies to a channel.

Definition at line 27 of file Chan.php.

Member Function Documentation

Erebot\Interfaces\Event\Base\Chan::getChan

(

)

Returns the name of the channel this event relates to.

Return values

string

Name of the channel affected by the event.

Implemented in Erebot\Event\WithChanSourceAbstract, and Erebot\Event\WithChanSourceTargetAbstract.

---

The documentation for this interface was generated from the following file:

• vendor/erebot/api/src/Interfaces/Event/Base/Chan.php