C# Class Plugin.Debug

Provides functionality for logging information
Show file Open project: Silveryard/SmartHome

Public Methods

Method Description
AddChannel ( string name ) : int

Registers a new channel for use

DeleteChannel ( int channel ) : void

Deletes a channel

DisableCaching ( ) : void

Disables Caching. This will clear the cache. Cached messaged will be stored in Cache

DisableChannel ( int channel ) : void

Disables a channel. Disabled channels messages will not get logged

EnableCaching ( ) : void

Enabled Caching. This will clear the cache. Cached messaged will be stored in Cache

EnableChannel ( int channel ) : void

Enabled a channel. Enabled channels messages will get logged

GetChannelId ( string name ) : int

Returns the assigned channel id of a registered channel

GetChannelName ( int channel ) : string

Returns to corresponding channel name of a identifier

Log ( int channel, string message ) : void

Loggs a message. The message will only cause the MessageListened event to occur if the calling channel is enabled

Method Details

AddChannel() public static method

Registers a new channel for use
public static AddChannel ( string name ) : int
name string The name of the channel
return int

DeleteChannel() public static method

Deletes a channel
public static DeleteChannel ( int channel ) : void
channel int The int identifier of the channel
return void

DisableCaching() public static method

Disables Caching. This will clear the cache. Cached messaged will be stored in Cache
public static DisableCaching ( ) : void
return void

DisableChannel() public static method

Disables a channel. Disabled channels messages will not get logged
public static DisableChannel ( int channel ) : void
channel int The channel identifier
return void

EnableCaching() public static method

Enabled Caching. This will clear the cache. Cached messaged will be stored in Cache
public static EnableCaching ( ) : void
return void

EnableChannel() public static method

Enabled a channel. Enabled channels messages will get logged
public static EnableChannel ( int channel ) : void
channel int The channel identifier
return void

GetChannelId() public static method

Returns the assigned channel id of a registered channel
public static GetChannelId ( string name ) : int
name string The channels name
return int

GetChannelName() public static method

Returns to corresponding channel name of a identifier
public static GetChannelName ( int channel ) : string
channel int The channels identifier
return string

Log() public static method

Loggs a message. The message will only cause the MessageListened event to occur if the calling channel is enabled
public static Log ( int channel, string message ) : void
channel int The calling channel
message string The channels message
return void