Class ConsoleFilter

Console filter tools

Inheritance

object

ConsoleFilter

Namespace: Terminaux.Base.Checks

Assembly: Terminaux.dll

Syntax

public static class ConsoleFilter

Methods

AddToFilter(string, ConsoleFilterType, ConsoleFilterSeverity, string)

Adds a match for the terminal type or emulator to the blacklist or the graylist

Declaration

public static void AddToFilter(string query, ConsoleFilterType type, ConsoleFilterSeverity severity, string justification)

Parameters

Type	Name	Description
string	query	The type query for the console type to match
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity
string	justification	Reason for the blacklist

AddToFilter(Regex, ConsoleFilterType, ConsoleFilterSeverity, string)

Adds a match for the terminal type or emulator to the blacklist or the graylist

Declaration

public static void AddToFilter(Regex query, ConsoleFilterType type, ConsoleFilterSeverity severity, string justification)

Parameters

Type	Name	Description
Regex	query	The type query for the console type to match
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity
string	justification	Reason for the blacklist

GetFilteredQueries()

Gets the filtered queries

Declaration

public static ConsoleFilterInfo[] GetFilteredQueries()

Returns

Type	Description
ConsoleFilterInfo[]	Terminal queries with their matches, their types, their severities, and their justifications

IsConsoleFiltered(ConsoleFilterType, ConsoleFilterSeverity)

Checks to see if the current console is filtered

Declaration

public static (bool filtered, string justification) IsConsoleFiltered(ConsoleFilterType type, ConsoleFilterSeverity severity)

Parameters

Type	Name	Description
ConsoleFilterType	type
ConsoleFilterSeverity	severity

Returns

Type	Description
(bool filtered, string justification)	True if filtered; false otherwise

IsInFilter(string, ConsoleFilterType, ConsoleFilterSeverity, out ConsoleFilterInfo?)

Is the query in the filter?

Declaration

public static bool IsInFilter(string query, ConsoleFilterType type, ConsoleFilterSeverity severity, out ConsoleFilterInfo? queryInfo)

Parameters

Type	Name	Description
string	query	The query to check
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity
ConsoleFilterInfo	queryInfo	Output query Info

Returns

Type	Description
bool	True if found; false otherwise.

Exceptions

Type	Condition
TerminauxException

IsInFilter(Regex, ConsoleFilterType, ConsoleFilterSeverity, out ConsoleFilterInfo?)

Is the query in the filter?

Declaration

public static bool IsInFilter(Regex query, ConsoleFilterType type, ConsoleFilterSeverity severity, out ConsoleFilterInfo? queryInfo)

Parameters

Type	Name	Description
Regex	query	The query to check
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity
ConsoleFilterInfo	queryInfo	Output query Info

Returns

Type	Description
bool	True if found; false otherwise.

Exceptions

Type	Condition
TerminauxException

RemoveFromFilter(string, ConsoleFilterType, ConsoleFilterSeverity)

Removes a match for the terminal type from the blacklist

Declaration

public static void RemoveFromFilter(string query, ConsoleFilterType type, ConsoleFilterSeverity severity)

Parameters

Type	Name	Description
string	query	The type query for the console type to match
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity

RemoveFromFilter(Regex, ConsoleFilterType, ConsoleFilterSeverity)

Removes a match for the terminal type from the blacklist

Declaration

public static void RemoveFromFilter(Regex query, ConsoleFilterType type, ConsoleFilterSeverity severity)

Parameters

Type	Name	Description
Regex	query	The type query for the console type to match
ConsoleFilterType	type	Filter type
ConsoleFilterSeverity	severity	Filter severity