C# Class RohBot.Rooms.Room

Show file Open project: Rohansi/RohBot Class Usage Examples

Public Properties

Property	Type	Description
DisableBanning	bool
IsHidden	bool
IsLogging	bool
IsPrivate	bool
IsWhitelisted	bool
RoomInfo	RoomInfo
ShowWebStates	bool

Public Methods

Method	Description
Ban ( string name ) : void
Demod ( string name ) : void
GetHistoryLines ( Connection connection ) : List	Called by SendHistory.
IsBanned ( string name ) : bool
IsMod ( string name ) : bool
Leave ( ) : void	Called when leaving the room. Must call base.
Mod ( string name ) : void
Room ( RoomInfo roomInfo ) : System
Send ( string str ) : void	Send a message as the bot. Should call base.
SendHistory ( Connection connection ) : void	Called when somebody joins the room. Should call base.
SendLine ( HistoryLine line ) : void	Called when a message is being sent to the room. Should call base.
SendLineFilter ( HistoryLine line, IEnumerable sessions ) : IEnumerable	Filter sessions which receive lines from SendLine.
SendMessage ( Connection connection, string message ) : void	Called when somebody sends a message.
SessionDisconnect ( Session session ) : void
SessionEnter ( Session session ) : void
SessionLeft ( Session session ) : void
Unban ( string name ) : void
Update ( ) : void

Private Methods

Method	Description
AddHistory ( HistoryLine line ) : void
ClearScrollbackFor ( Connection connection ) : void

Method Details

Ban() public method

public Ban ( string name ) : void
name	string
return	void

Demod() public method

public Demod ( string name ) : void
name	string
return	void

GetHistoryLines() public method

Called by SendHistory.

public GetHistoryLines ( Connection connection ) : List
connection	Connection
return	List

IsBanned() public method

public IsBanned ( string name ) : bool
name	string
return	bool

IsMod() public method

public IsMod ( string name ) : bool
name	string
return	bool

Leave() public method

Called when leaving the room. Must call base.

public Leave ( ) : void
return	void

Mod() public method

public Mod ( string name ) : void
name	string
return	void

Room() public method

public Room ( RoomInfo roomInfo ) : System
roomInfo	RoomInfo
return	System

Send() public method

Send a message as the bot. Should call base.

public Send ( string str ) : void
str	string
return	void

SendHistory() public method

Called when somebody joins the room. Should call base.

public SendHistory ( Connection connection ) : void
connection	Connection
return	void

SendLine() public method

Called when a message is being sent to the room. Should call base.

public SendLine ( HistoryLine line ) : void
line	HistoryLine
return	void

SendLineFilter() public method

Filter sessions which receive lines from SendLine.

public SendLineFilter ( HistoryLine line, IEnumerable sessions ) : IEnumerable
line	HistoryLine
sessions	IEnumerable
return	IEnumerable

SendMessage() public method

Called when somebody sends a message.

public SendMessage ( Connection connection, string message ) : void
connection	Connection
message	string
return	void

SessionDisconnect() public method

public SessionDisconnect ( Session session ) : void
session	Session
return	void

SessionEnter() public method

public SessionEnter ( Session session ) : void
session	Session
return	void

SessionLeft() public method

public SessionLeft ( Session session ) : void
session	Session
return	void

Unban() public method

public Unban ( string name ) : void
name	string
return	void

Update() public method

public Update ( ) : void
return	void

Property Details

DisableBanning public property

public bool DisableBanning
return	bool

IsHidden public property

public bool IsHidden
return	bool

IsLogging public property

public bool IsLogging
return	bool

IsPrivate public property

public bool IsPrivate
return	bool

IsWhitelisted public property

public bool IsWhitelisted
return	bool

RoomInfo public property

public RoomInfo RoomInfo
return	RoomInfo

ShowWebStates public property

public bool ShowWebStates
return	bool