C# Class wmib.Channel

Inheritance: libirc.Target
Mostrar archivo Open project: benapetr/wikimedia-bot Class Usage Examples

Public Properties

Property Type Description
DefaultInstance string
ExtensionObjects object>.Dictionary
HasFreshUserList bool
IgnoreUnknown bool
Infobot_IgnoredNames List
IrcChannel libirc.Channel
Language string
Name string
Password string
RespondMessage bool
RespondWait int
SharedChans List
SharedDB string
SharedLinkedChan List
Suppress bool
SuppressWarnings bool
SystemUsers Security
TimeOfLastMsg System.DateTime

Public Methods

Method Description
Channel ( string name ) : System

Initializes a new instance of the wmib.Channel class.
ConfigExists ( string _Channel ) : bool

Returns true if this channel is already existing in memory
ContainsUser ( string name ) : bool

Return true if user is present in channel
Extension_GetConfig ( string key, string missing = null ) : string

Retrieve a config
Extension_SetConfig ( string name, string data ) : void

Change the config
GetChannel ( ) : libirc.Channel
GetConfigFilePath ( ) : string
GetConfigFilePath ( string _Channel ) : string
InitializeShares ( ) : int

Return number of channels that infobot share db with
LoadConfig ( ) : void
RegisterObject ( object Ob, string Nm ) : bool

Register a new object in memory
Remove ( ) : void

Remove all refs
RetrieveObject ( string name ) : object

Get an object created by extension of name
RetrieveUser ( string nick ) : libirc.User
SaveConfig ( ) : void

Save config
UnregisterObject ( string Nm ) : bool

Remove object from memory

Protected Methods

Method Description
RefetchChannel ( ) : void

Private Methods

Method Description
InsertData ( string key, string value, XmlDocument &document, XmlNode &node, string Name = "local" ) : void

Method Details

Channel() public method

Initializes a new instance of the wmib.Channel class.
public Channel ( string name ) : System
name string /// Name. ///
return System

ConfigExists() public static method

Returns true if this channel is already existing in memory
public static ConfigExists ( string _Channel ) : bool
_Channel string
return bool

ContainsUser() public method

Return true if user is present in channel
public ContainsUser ( string name ) : bool
name string
return bool

Extension_GetConfig() public method

Retrieve a config
public Extension_GetConfig ( string key, string missing = null ) : string
key string
missing string
return string

Extension_SetConfig() public method

Change the config
public Extension_SetConfig ( string name, string data ) : void
name string
data string
return void

GetChannel() public method

public GetChannel ( ) : libirc.Channel
return libirc.Channel

GetConfigFilePath() public method

public GetConfigFilePath ( ) : string
return string

GetConfigFilePath() public static method

public static GetConfigFilePath ( string _Channel ) : string
_Channel string
return string

InitializeShares() public method

Return number of channels that infobot share db with
public InitializeShares ( ) : int
return int

LoadConfig() public method

public LoadConfig ( ) : void
return void

RefetchChannel() protected method

protected RefetchChannel ( ) : void
return void

RegisterObject() public method

Register a new object in memory
public RegisterObject ( object Ob, string Nm ) : bool
Ob object Data
Nm string Name
return bool

Remove() public method

Remove all refs
public Remove ( ) : void
return void

RetrieveObject() public method

Get an object created by extension of name
public RetrieveObject ( string name ) : object
name string
return object

RetrieveUser() public method

public RetrieveUser ( string nick ) : libirc.User
nick string
return libirc.User

SaveConfig() public method

Save config
public SaveConfig ( ) : void
return void

UnregisterObject() public method

Remove object from memory
public UnregisterObject ( string Nm ) : bool
Nm string Name of object
return bool

Property Details

DefaultInstance public_oe property

Default instance this channel belongs to
public string DefaultInstance
return string

ExtensionObjects public_oe property

Objects created by extensions
public Dictionary ExtensionObjects
return object>.Dictionary

HasFreshUserList public_oe property

Whether the channel contains a fresh user list (in case it doesn't bot will auto reparse it from ircd)
public bool HasFreshUserList
return bool

IgnoreUnknown public_oe property

Whether unknown users should be ignored or not
public bool IgnoreUnknown
return bool

Infobot_IgnoredNames public_oe property

List of ignored names for infobot
public List Infobot_IgnoredNames
return List

IrcChannel public_oe property

The irc channel as maintained by IRC library, this is the linked irc channel that is handled by the instance which is servicing that
public libirc.Channel IrcChannel
return libirc.Channel

Language public_oe property

Language used in this channel
public string Language
return string

Name public_oe property

Channel name
public string Name
return string

Password public_oe property

public string Password
return string

RespondMessage public_oe property

Whether bot should respond to users who think that the bot is user and speak to him
public bool RespondMessage
return bool

RespondWait public_oe property

Wait time between responses to users who try to speak to the bot
public int RespondWait
return int

SharedChans public_oe property

List of channels that have shared infobot db
public List SharedChans
return List

SharedDB public_oe property

Target db of shared infobot
public string SharedDB
return string

SharedLinkedChan public_oe property

List of channels we share db with
public List SharedLinkedChan
return List

Suppress public_oe property

If this is true, no messages are sent to this channel
public bool Suppress
return bool

SuppressWarnings public_oe property

Doesn't send any warnings on error
public bool SuppressWarnings
return bool

SystemUsers public_oe property

Users
public Security,wmib SystemUsers
return Security

TimeOfLastMsg public_oe property

Time of last message received in channel
public DateTime,System TimeOfLastMsg
return System.DateTime