C# Class Microsoft.Protocols.TestSuites.MS_WOPI.LogsRecorder

A class is used to record the logs information.
Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method Description
AddLogs ( string logRecordName, string logMessage ) : void

A method is used to add a log record item.
CleanUpLogs ( ) : void

A method is used to clean up the existed logs .
GetAllLogs ( string logRecordName ) : string

A method is used to get all log record items' information.
LogsRecorder ( ) : System

Initializes a new instance of the LogsRecorder class.

Protected Methods

Method Description
GetLogValueForSpecifiedLogRecord ( string logRecordName ) : StringBuilder

A method is used to get log values for specified log record. If the expected log record does not exist for specified log record name, this method will return null.

Method Details

AddLogs() public method

A method is used to add a log record item.
public AddLogs ( string logRecordName, string logMessage ) : void
logRecordName string A parameter represents the log record name, it is the unique identifier for the log record. If the left this parameter as empty, the log string will be added into the record named "DefaultLogRecord".
logMessage string A parameter represents the log information will be added.
return void

CleanUpLogs() public method

A method is used to clean up the existed logs .
public CleanUpLogs ( ) : void
return void

GetAllLogs() public method

A method is used to get all log record items' information.
public GetAllLogs ( string logRecordName ) : string
logRecordName string A parameter represents the log record name, it is the unique identifier for the log record. If the left this parameter as empty, the log string of log record named "DefaultLogRecord" will be return.
return string

GetLogValueForSpecifiedLogRecord() protected method

A method is used to get log values for specified log record. If the expected log record does not exist for specified log record name, this method will return null.
protected GetLogValueForSpecifiedLogRecord ( string logRecordName ) : StringBuilder
logRecordName string A parameter represents the log record name, it is the unique identifier for the log record. If the left this parameter as empty, the log string of log record named "DefaultLogRecord" will be return.
return StringBuilder

LogsRecorder() public method

Initializes a new instance of the LogsRecorder class.
public LogsRecorder ( ) : System
return System