### Method: setup()

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/api/BuildReportWithoutAttachedReportersTests.html

A public method named `setup` that returns `void` and takes no parameters. This method is typically used for initializing resources or setting up the test environment before other test methods are executed.

```APIDOC
void setup()
public void setup()
```

--------------------------------

### Setup Method in AuthorViewVisibilityTests (Java ExtentReports)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Initializes the setup for testing the visibility of the author view in ExtentHtmlReporter. This method prepares the test environment to verify how author-related information is displayed or hidden.

```APIDOC
com.aventstack.extentreports.view.extenthtml.AuthorViewVisibilityTests.setup()
```

--------------------------------

### Start ExtentXReporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/ExtentXReporter.html

This method initiates the reporter, allowing it to start processing and passing run information. It should be called before any test execution begins.

```APIDOC
start()
Returns: void
```

--------------------------------

### Setup Method in ParallelClassesBase (Java ExtentReports)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Executes setup routines specifically designed for parallel test execution classes. This method ensures that the environment is correctly configured to handle tests running concurrently.

```APIDOC
com.aventstack.extentreports.ParallelClassesBase.setup()
```

--------------------------------

### Setup Method in Base Class (Java ExtentReports)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Performs common setup operations for base classes in ExtentReports. This method is typically used to initialize shared resources or configurations required by multiple test classes or components.

```APIDOC
com.aventstack.extentreports.Base.setup()
```

--------------------------------

### onStart(ITestContext) Method in ExtentTestNGITestListener

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-14.html

Invoked when a test context starts, as part of the TestNG listener lifecycle. This method allows for setup or logging at the beginning of a test suite's execution.

```APIDOC
Class: com.aventstack.extentreports.common.ExtentTestNGITestListener
Method: onStart(org.testng.ITestContext context)
```

--------------------------------

### Setup Method in BuildReportWithoutAttachedReportersTests (Java ExtentReports)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Initializes the test environment for scenarios involving report generation without any attached reporters. This setup method prepares the necessary conditions for such specific test cases.

```APIDOC
com.aventstack.extentreports.api.BuildReportWithoutAttachedReportersTests.setup()
```

--------------------------------

### Handle Test Started Event in ExtentXReporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/ExtentXReporter.html

This method is invoked when a new test is started using the createTest(args) method. It allows the reporter to perform initialization or tracking for each new test created.

```APIDOC
onTestStarted(Test test)
  test: class in com.aventstack.extentreports.model.Test
Returns: void
```

--------------------------------

### onTestStart(ITestResult) Method in ExtentTestNGITestListener

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-14.html

Invoked before a test method starts, as part of the TestNG listener lifecycle. This method can be used for pre-test setup or logging.

```APIDOC
Class: com.aventstack.extentreports.common.ExtentTestNGITestListener
Method: onTestStart(org.testng.ITestResult result)
```

--------------------------------

### Set System Information in ExtentReports Java

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReports.html

API method and example to add custom system information (e.g., HostName, OS) to the report, which will be visible in all started reporters.

```Java
extent.setSystemInfo("HostName", "AventStack-PC");
```

```APIDOC
setSystemInfo(java.lang.String k, java.lang.String v)
  Adds any applicable system information to all started reporters
  Parameters:
    k: Name of system variable
    v: Value of system variable
```

--------------------------------

### setup Method for AuthorViewVisibilityTests

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/view/extenthtml/AuthorViewVisibilityTests.html

Initializes the test environment for `AuthorViewVisibilityTests`. This method is typically called before each test to set up necessary conditions.

```APIDOC
Method: setup()
  Return Type: void
  Declaration: public void setup()
```

--------------------------------

### API: onTestStarted

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/TestListener.html

Invoked when a test is started using `createTest(args)`.

```APIDOC
void onTestStarted(Test test)
  Parameters:
    test: Test object
```

--------------------------------

### Java Method: beforeClass()

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/view/extenthtml/SystemAttributeTests.html

A setup method, likely executed before tests in the class, as indicated by its name. It is a public method returning void.

```APIDOC
public void beforeClass()
```

--------------------------------

### Java Inherited Methods from Base Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/view/extenthtml/SystemAttributeTests.html

Methods inherited from the `com.aventstack.extentreports.Base` class, including `setup()` and `tearDown()` which are likely used for test environment initialization and cleanup.

```APIDOC
setup()
tearDown()
```

--------------------------------

### onTestStarted(Test) Method in TestListener Interface

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-14.html

Invoked when a test is started using `createTest(args)`. This method is part of the TestListener interface, defining the contract for test start events across different reporters.

```APIDOC
Interface: com.aventstack.extentreports.TestListener
Method: onTestStarted(com.aventstack.extentreports.model.Test test)
```

--------------------------------

### API: ExtentHtmlReporter start() method

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/ExtentHtmlReporter.html

Initiates the ExtentHtmlReporter, preparing it to receive and process run information. This method is specified by the ExtentReporter interface.

```APIDOC
Method Detail:
  start()
    public void start()
    Description:
      Starts passing run information to the reporter.
    Specified by:
      com.aventstack.extentreports.ExtentReporter.start()
```

--------------------------------

### Initialize ExtentReports Reporters

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Methods to start the reporting process for various ExtentReports reporter implementations.

```APIDOC
method com.aventstack.extentreports.reporter.ExtentHtmlReporter.start()
```

```APIDOC
method com.aventstack.extentreports.reporter.ExtentXReporter.start()
```

--------------------------------

### onTestStarted Method API Documentation

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/BasicFileReporter.html

Invoked when a test is started using `createTest(args)`. This callback allows listeners to perform actions or record information at the beginning of a test's lifecycle.

```APIDOC
TestListener interface method:
  onTestStarted(test: Test)
    test: Test object representing the started test.
```

--------------------------------

### Java API: Get All Theme Enum Constants

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/Theme.html

Documents the `values()` method of the `Theme` enum, which returns an array of all declared enum constants. Includes an example of iterating through the constants.

```APIDOC
public static Theme[] values()
  Returns: an array containing the constants of this enum type, in the order they are declared
```

```Java
for (Theme c : Theme.values())
    System.out.println(c);
```

--------------------------------

### API Method: get in AbstractStructure

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documentation for the get method, which is part of the AbstractStructure class. This method retrieves an element by its integer index.

```APIDOC
com.aventstack.extentreports.model.AbstractStructure.get(int)
```

--------------------------------

### ConfigLoader(File) constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-3.html

This constructor for the `ConfigLoader` class initializes the configuration loader using a `java.io.File` object, enabling configuration to be loaded from a local file.

```APIDOC
Constructor: com.aventstack.extentreports.configuration.ConfigLoader(java.io.File file)
```

--------------------------------

### Verify Test Start Time With Logs in ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-19.html

This API method verifies the start time of a test, taking into account associated logs, within ExtentReports. It ensures that the test's start time is accurately reflected, even when considering log entries.

```APIDOC
Method: verifyStartTimeWithLogs(java.lang.reflect.Method)
Class: com.aventstack.extentreports.api.TestStartEndDateTimeTests
```

--------------------------------

### ConfigLoader(URL) constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-3.html

This constructor for the `ConfigLoader` class initializes the configuration loader using a `java.net.URL` object, allowing configuration to be loaded from a URL source.

```APIDOC
Constructor: com.aventstack.extentreports.configuration.ConfigLoader(java.net.URL url)
```

--------------------------------

### Constructor Summary for ListenerTestsITestListener

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/listenertests/ListenerTestsITestListener.html

Lists the available constructors for the `ListenerTestsITestListener` class.

```APIDOC
ListenerTestsITestListener()
```

--------------------------------

### Verify Test Start Time in ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-19.html

This API method verifies the start time of a test within ExtentReports. It is used to ensure that test execution timestamps are accurately recorded and reported.

```APIDOC
Method: verifyStartTime(java.lang.reflect.Method)
Class: com.aventstack.extentreports.api.TestStartEndDateTimeTests
```

--------------------------------

### API Documentation for com.aventstack.extentreports.mediastorage Package

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/mediastorage/package-summary.html

Provides an overview of the interfaces and classes within the `com.aventstack.extentreports.mediastorage` package, part of the ExtentReports Java library. This package is responsible for handling media storage functionalities.

```APIDOC
Package: com.aventstack.extentreports.mediastorage
Description: This package contains interfaces and classes related to media storage within ExtentReports.

Interface Summary:
  - MediaStorage
    Description: Interface for managing media storage within ExtentReports.

Class Summary:
  - MediaStorageManagerFactory
    Description: Factory class for creating and managing instances of media storage implementations.
```

--------------------------------

### ConfigLoader Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/configuration/ConfigLoader.html

Detailed API documentation for the `ConfigLoader` class, including its constructors for initialization with a file or URL, and the `getConfigurationHash` method for retrieving the loaded configuration as a `ConfigMap`.

```APIDOC
Class: ConfigLoader
  Package: com.aventstack.extentreports.configuration
  Extends: java.lang.Object

  Constructors:
    ConfigLoader(java.io.File file)
    ConfigLoader(java.net.URL url)

  Methods:
    getConfigurationHash(): ConfigMap
```

--------------------------------

### TestListener: onTestStarted Callback

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/class-use/Test.html

Invoked when a test is started using `createTest(args)`. This callback provides the `Test` object representing the started test, enabling custom actions or logging at the beginning of a test's execution.

```APIDOC
TestListener.onTestStarted(Test test)
  Description: Invoked when a test is started using `createTest(args)`
  Parameters:
    test: Test - The Test object representing the started test.
  Returns: void
```

--------------------------------

### Java Method: beforeSuite() in ExtentTestNGReportBuilder

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-2.html

Documents the `beforeSuite()` method, which is part of the `ExtentTestNGReportBuilder` class in the `com.aventstack.extentreports.testng.components` package. This method is typically invoked for setup operations before the entire test suite begins.

```APIDOC
com.aventstack.extentreports.testng.components.ExtentTestNGReportBuilder.beforeSuite()
```

--------------------------------

### onTestStarted(Test) Method in BasicFileReporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-14.html

Invoked when a test is started using `createTest(args)` within the BasicFileReporter context. This method handles the initial state of a test for file-based reporting.

```APIDOC
Class: com.aventstack.extentreports.reporter.BasicFileReporter
Method: onTestStarted(com.aventstack.extentreports.model.Test test)
```

--------------------------------

### onTestStarted(Test) Method in ExtentXReporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-14.html

Invoked when a test is started using `createTest(args)` within the ExtentXReporter context. This method handles the initial state of a test for ExtentX database reporting.

```APIDOC
Class: com.aventstack.extentreports.reporter.ExtentXReporter
Method: onTestStarted(com.aventstack.extentreports.model.Test test)
```

--------------------------------

### API: Handle Test Node Start in ExtentReports Reporters

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/class-use/Test.html

Documents the `onNodeStarted` method in `ExtentXReporter` and `BasicFileReporter`. This method is invoked when a new test node (or test) starts, allowing reporters to initialize or track test execution.

```APIDOC
ExtentXReporter.onNodeStarted(Test node)
  Parameters:
    node: com.aventstack.extentreports.model.Test - The test node object.
  Returns: void

BasicFileReporter.onNodeStarted(Test node)
  Parameters:
    node: com.aventstack.extentreports.model.Test - The test node object.
  Returns: void
```

--------------------------------

### BasicFileReporter Constructor and Methods

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/BasicFileReporter.html

Details the constructor for `BasicFileReporter` and its `onTestStarted` method. The constructor initializes the reporter, while `onTestStarted` is a callback method invoked when a new test begins, allowing the reporter to process test start events.

```APIDOC
BasicFileReporter()
public void onTestStarted(com.aventstack.extentreports.model.Test test)
```

--------------------------------

### TestListener: onNodeStarted Callback

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/class-use/Test.html

Invoked when a node is started using `createNode(args)`. This callback provides the `Test` object representing the newly started node, allowing custom actions to be performed at the beginning of a node's execution.

```APIDOC
TestListener.onNodeStarted(Test node)
  Description: Invoked when a node is started using `createNode(args)`
  Parameters:
    node: Test - The Test object representing the started node.
  Returns: void
```

--------------------------------

### API for AbstractReporter Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents methods for retrieving reporter start time, status counts, and system attribute context from the `AbstractReporter` class.

```APIDOC
Class: com.aventstack.extentreports.reporter.AbstractReporter
  getStartTime(): long
    Description: Retrieves the start time of the reporter.
  getStatusCount(): int
    Description: Retrieves the count of tests by status.
  getSystemAttributeContext(): Object
    Description: Retrieves the system attribute context.
```

--------------------------------

### Screencast Class Constructor API Documentation

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Screencast.html

API documentation for the default constructor of the `com.aventstack.extentreports.model.Screencast` class. This constructor is used to instantiate a new Screencast object.

```APIDOC
com.aventstack.extentreports.model.Screencast:
  Constructors:
    public Screencast()
```

--------------------------------

### Set Start Time for Report Elements

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Defines the start time for various report elements, including the overall report, individual tests, or abstract reporters. This is crucial for accurate duration calculations and timeline representation in reports.

```APIDOC
Method: setStartTime(java.util.Date startTime)
  Interface: com.aventstack.extentreports.ExtentReporter
  Parameters:
    java.util.Date: The start time to set.
```

```APIDOC
Method: setStartTime(java.util.Date startTime)
  Class: com.aventstack.extentreports.model.Test
  Parameters:
    java.util.Date: The start time to set.
```

```APIDOC
Method: setStartTime(java.util.Date startTime)
  Class: com.aventstack.extentreports.reporter.AbstractReporter
  Parameters:
    java.util.Date: The start time to set.
```

--------------------------------

### ExtentReporter Core Method Details

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReporter.html

Detailed descriptions of the primary methods implemented by the ExtentReporter interface. These methods control the lifecycle of the report, including starting and stopping the reporting process, flushing data, and setting specific start and end times for the report run.

```APIDOC
ExtentReporter Methods:
  start(): void
    Starts passing run information to the reporter.
  stop(): void
    Stops the reporter. Ensures no information is passed to the reporter.
  flush(): void
  setStartTime(java.util.Date d): void
  setEndTime(java.util.Date d): void
```

--------------------------------

### Java Method: beforeMethod(Method) in ExtentTestNGReportBuilder

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-2.html

Documents the `beforeMethod(Method)` method, found in the `ExtentTestNGReportBuilder` class within the `com.aventstack.extentreports.testng.components` package. This method likely performs setup operations before the execution of a test method, taking a `Method` object as input.

```APIDOC
com.aventstack.extentreports.testng.components.ExtentTestNGReportBuilder.beforeMethod(java.lang.reflect.Method)
```

--------------------------------

### BasicFileConfiguration Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Comprehensive API documentation for the BasicFileConfiguration class, outlining its constructor and various methods to manage and customize the output report file settings in ExtentReports.

```APIDOC
Class: BasicFileConfiguration

  Constructor:
    public BasicFileConfiguration()

  Methods:
    Theme getTheme()

    java.lang.String getTimeStampFormat()
      Description: Gets the timestamp format

    void setCSS(java.lang.String css)
      Description: Sets CSS to be used to customize the look and feel of your report
      Parameters:
        css: java.lang.String - CSS string

    void setDocumentTitle(java.lang.String docTitle)
      Description: Sets the document title denoted by the `title` tag
      Parameters:
        docTitle: java.lang.String - Document title string

    void setEncoding(java.lang.String encoding)
      Description: Sets file encoding, eg: UTF-8
      Parameters:
        encoding: java.lang.String - Encoding string

    void setExtentXUrl(java.lang.String url)
      Description: Informs the file reporters of the ExtentX url, so the server can be accessed directly from the report itself
      Parameters:
        url: java.lang.String - ExtentX URL string

    void setFilePath(java.io.File file)

    void setFilePath(java.lang.String filePath)
      Description: Sets file-path of the report file
      Parameters:
        filePath: java.lang.String - Path where the results file will be saved

    java.lang.String getFilePath()

    void setJS(java.lang.String js)
      Description: Adds custom JavaScript
      Parameters:
        js: java.lang.String - JavaScript string

    void setLevel(Status... level)

    void setReportName(java.lang.String reportName)

    void setTheme(Theme theme)
      Description: Sets the `Theme` of the report
      Parameters:
        theme: Theme - Theme enum value

    void setTimeStampFormat(java.lang.String timeStampFormat)
      Description: Sets the timestamp format
      Parameters:
        timeStampFormat: java.lang.String - Timestamp format string
```

--------------------------------

### API: onNodeStarted

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/TestListener.html

Invoked when a node is started using `createNode(args)`.

```APIDOC
void onNodeStarted(Test node)
  Parameters:
    node: Test object
```

--------------------------------

### Load XML Configuration by File Object

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/AbstractReporter.html

Loads configuration settings from an XML file specified by a `java.io.File` object.

```APIDOC
public void loadXMLConfig(java.io.File file)
```

--------------------------------

### Get Media Sequence

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the sequence number of the media instance.

```APIDOC
public int getSequence()
```

--------------------------------

### localSetup() Method in ExtentReports Java Test Classes

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-11.html

The localSetup() method is a common setup method found in various test classes within the com.aventstack.extentreports.view.extenthtml package, such as TestAttributesTest and TestWithoutLogsHasPassStatus. It is typically used for initializing test-specific configurations or resources before test execution.

```APIDOC
Method in class com.aventstack.extentreports.view.extenthtml.TestAttributesTest
Method in class com.aventstack.extentreports.view.extenthtml.TestWithoutLogsHasPassStatus
```

--------------------------------

### Initialize and Use ExtentReports in Java

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReports.html

This snippet demonstrates how to initialize the ExtentReports client, attach different reporters like ExtentHtmlReporter and ExtentXReporter, create a test, and flush the report to ensure all information is written. It highlights the basic workflow for generating reports.

```Java
 ExtentHtmlReporter html = new ExtentHtmlReporter("Extent.html");
 ExtentXReporter extentx = new ExtentXReporter("localhost");
 
 ExtentReports extent = new ExtentReports();
 extent.attachReporter(html, extentx);
 
 extent.createTest("TestName").pass("Test Passed");
 
 extent.flush();
```

--------------------------------

### Get Media Type

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the type of media associated with this instance.

```APIDOC
public com.aventstack.extentreports.model.MediaType getMediaType()
```

--------------------------------

### Load Configuration by File Path (General)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/AbstractReporter.html

Loads general configuration settings from a file specified by its file path. This method might handle various configuration formats beyond XML.

```APIDOC
public void loadConfig(java.lang.String filePath)
```

--------------------------------

### Get Media Name

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the name assigned to the media instance.

```APIDOC
public java.lang.String getName()
```

--------------------------------

### Get Value from Config API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getValue()' method in the 'com.aventstack.extentreports.configuration.Config' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.configuration.Config
Method: getValue()
```

--------------------------------

### API Documentation for com.aventstack.extentreports.reporter.configuration Package

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/package-summary.html

This section provides an overview of the `com.aventstack.extentreports.reporter.configuration` package, detailing its interfaces, classes, and enums that are used for configuring various ExtentReports reporters.

```APIDOC
Package: com.aventstack.extentreports.reporter.configuration

Interface Summary:
  IReporterConfiguration
    Description: Interface for reporter configuration.

Class Summary:
  BasicFileConfiguration
    Description: Common configuration for file reporters: ExtentHtmlReporter.
  ExtentHtmlReporterConfiguration
    Description: Defines configuration settings for the HTML reporter.
  ExtentXReporterConfiguration
    Description: Defines configuration settings for the ExtentX reporter.

Enum Summary:
  ChartLocation
    Description: For ExtentHtmlReporter, sets the location of charts.
  Protocol
    Description: Protocol used to download CDN css/js resources for HTML reports.
  Theme
    Description: Available themes for the HTML reporter.
```

--------------------------------

### Get Timestamp from Log API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTimestamp()' method in the 'com.aventstack.extentreports.model.Log' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.model.Log
Method: getTimestamp()
```

--------------------------------

### Add System Information to ExtentReports

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReports.html

Adds key-value pair system information that will be included in all started reporters, providing context about the test environment.

```APIDOC
setSystemInfo(java.lang.String k, java.lang.String v)
  k: The key for the system information.
  v: The value associated with the key.
  Returns: void
```

--------------------------------

### BasicFileConfiguration Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Detailed API reference for the `BasicFileConfiguration` class, including its constructor and methods for managing file reporter configurations such as CSS, JavaScript, encoding, document title, ExtentX URL, file path, log level, and report name.

```APIDOC
Class: com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration
Extends: java.lang.Object
Direct Known Subclasses: ExtentHtmlReporterConfiguration

Description: Common configuration for file reporters: ExtentHtmlReporter

Constructor Summary:
  BasicFileConfiguration()

Method Summary:
  Modifier and Type: java.util.Map<java.lang.String,java.lang.String>
  Method: getConfigMap()

  Modifier and Type: java.lang.String
  Method: getCSS()

  Modifier and Type: java.lang.String
  Method: getDocumentTitle()

  Modifier and Type: java.lang.String
  Method: getEncoding()

  Modifier and Type: java.lang.String
  Method: getExtentXUrl()

  Modifier and Type: java.lang.String
  Method: getFilePath()

  Modifier and Type: java.lang.String
  Method: getJS()

  Modifier and Type: java.util.List<com.aventstack.extentreports.Status>
  Method: getLevel()

  Modifier and Type: java.lang.String
  Method: getReportName()
```

--------------------------------

### Get Theme from BasicFileConfiguration API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTheme()' method in the 'com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration
Method: getTheme()
```

--------------------------------

### Load XML Configuration by File Path

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/AbstractReporter.html

Loads configuration settings from an XML file specified by its file path.

```APIDOC
public void loadXMLConfig(java.lang.String filePath)
```

--------------------------------

### Get Exception Name in ExceptionInfo Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the name of an exception. This method belongs to the `com.aventstack.extentreports.model.ExceptionInfo` class.

```APIDOC
com.aventstack.extentreports.model.ExceptionInfo.getExceptionName()
```

--------------------------------

### Get Media Path

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the file path or URL of the media content.

```APIDOC
public java.lang.String getPath()
```

--------------------------------

### Load Configuration from InputStream

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/AbstractReporter.html

Loads configuration settings from a `java.io.InputStream`.

```APIDOC
public void loadConfig(java.io.InputStream stream)
```

--------------------------------

### API Method: MediaStorage.init(String)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-9.html

Initializes the MediaStorage interface with a given string parameter. This method is part of the `com.aventstack.extentreports.mediastorage.MediaStorage` interface and is typically used to set up the media storage mechanism.

```APIDOC
void com.aventstack.extentreports.mediastorage.MediaStorage.init(java.lang.String)
```

--------------------------------

### API for Test Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents methods for retrieving test start time and status from the `Test` class.

```APIDOC
Class: com.aventstack.extentreports.model.Test
  getStartTime(): long
    Description: Retrieves the start time of the test.
  getStatus(): com.aventstack.extentreports.Status
    Description: Retrieves the current status of the test.
```

--------------------------------

### Get Test List from ExtentXReporter API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestList()' method in the 'com.aventstack.extentreports.reporter.ExtentXReporter' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.reporter.ExtentXReporter
Method: getTestList()
```

--------------------------------

### ExtentReports Constructor API Summary

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReports.html

Summary of the constructors available for the `ExtentReports` class, detailing how instances of the report client can be created.

```APIDOC
### Constructor Summary

Constructors:
- ExtentReports()
```

--------------------------------

### Get Test List from ExtentHtmlReporter API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestList()' method in the 'com.aventstack.extentreports.reporter.ExtentHtmlReporter' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.reporter.ExtentHtmlReporter
Method: getTestList()
```

--------------------------------

### Java Method: TestAndNodeAttributesTest.localSetup

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-11.html

Documents the localSetup method within the TestAndNodeAttributesTest class, likely used for local test environment initialization.

```APIDOC
Method: com.aventstack.extentreports.view.extenthtml.TestAndNodeAttributesTest.localSetup()
```

--------------------------------

### Java Inherited Methods: ParallelClass1

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ParallelClass1.html

Lists methods inherited by `ParallelClass1` from its superclasses, `com.aventstack.extentreports.ParallelClassesBase` and `java.lang.Object`. These methods provide foundational functionalities like setup, teardown, object comparison, and thread synchronization.

```APIDOC
Methods inherited from class com.aventstack.extentreports.ParallelClassesBase:
  setup()
  tearDown()

Methods inherited from class java.lang.Object:
  equals(Object obj)
  getClass()
  hashCode()
  notify()
  notifyAll()
  toString()
  wait()
  wait(long timeout)
  wait(long timeout, int nanos)
```

--------------------------------

### Get Test List from TestAttributeTestContext API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestList()' method in the 'com.aventstack.extentreports.model.TestAttributeTestContext' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.model.TestAttributeTestContext
Method: getTestList()
```

--------------------------------

### Get Test List from ExceptionTestContext API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestList()' method in the 'com.aventstack.extentreports.model.ExceptionTestContext' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.model.ExceptionTestContext
Method: getTestList()
```

--------------------------------

### ExtentReporter.start Method

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-17.html

Initiates the process of passing run information and test results to the reporter, marking the beginning of the reporting cycle.

```APIDOC
com.aventstack.extentreports.ExtentReporter.start(): void
```

--------------------------------

### Get Test from ExtentTestManager API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the static 'getTest()' method in the 'com.aventstack.extentreports.common.ExtentTestManager' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.common.ExtentTestManager
Static Method: getTest()
```

--------------------------------

### API: MediaStorageManagerFactory Class and Constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-12.html

Represents the MediaStorageManagerFactory class in the com.aventstack.extentreports.mediastorage package, responsible for creating and managing media storage instances. The constructor MediaStorageManagerFactory() initializes a new factory instance.

```APIDOC
Class: com.aventstack.extentreports.mediastorage.MediaStorageManagerFactory
Constructor: MediaStorageManagerFactory()
```

--------------------------------

### Overview of Standard API Documentation Sections

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/help-doc.html

This section provides an overview of key pages and their content within API documentation generated by the standard doclet, including 'All Classes', 'Serialized Form', and 'Constant Field Values'. It clarifies the purpose and target audience for each section, along with a list of common navigation links.

```APIDOC
The [All Classes](allclasses-noframe.html) link shows all classes and interfaces except non-static nested types.

Serialized Form
---------------
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

Constant Field Values
---------------------
The [Constant Field Values](constant-values.html) page lists the static final fields and their values.

This help file applies to API documentation generated using the standard doclet.

Navigation Bar Links:
- [Overview](overview-summary.html)
- Package
- Class
- Use
- [Tree](overview-tree.html)
- [Deprecated](deprecated-list.html)
- [Index](index-files/index-1.html)
- Help

Navigation Controls:
- Prev
- Next

Frame Options:
- [Frames](index.html?help-doc.html)
- [No Frames](help-doc.html)

All Classes Link:
- [All Classes](allclasses-noframe.html)
```

--------------------------------

### Get File Path in BasicFileConfiguration Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the configured file path. This method belongs to the `com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration` class.

```APIDOC
com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration.getFilePath()
```

--------------------------------

### Handle Test Started Event in ExtentReports Reporters

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/class-use/Test.html

Documents the `onTestStarted` method in `ExtentXReporter` and `BasicFileReporter`, which are called when a test execution begins. Both methods take a `Test` object as input and return void.

```APIDOC
ExtentXReporter.onTestStarted(Test test)
  Returns: void
```

```APIDOC
BasicFileReporter.onTestStarted(Test test)
  Returns: void
```

--------------------------------

### ExtentXReporter Constructor Overloads

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/ExtentXReporter.html

This section provides a summary of the various constructors available for ExtentXReporter. These constructors allow for flexible instantiation of the reporter, supporting different MongoDB connection configurations including single server addresses, lists of server addresses (seeds), and options for credentials and client options, or a MongoDB connection URI.

```APIDOC
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, java.util.List<com.mongodb.MongoCredential> credentialsList, com.mongodb.MongoClientOptions options)
ExtentXReporter(java.util.List<com.mongodb.ServerAddress> seeds, com.mongodb.MongoClientOptions options)
ExtentXReporter(com.mongodb.MongoClientURI uri)
ExtentXReporter(com.mongodb.ServerAddress addr)
```

--------------------------------

### Get ExtentX URL in BasicFileConfiguration Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the configured ExtentX URL. This method belongs to the `com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration` class.

```APIDOC
com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration.getExtentXUrl()
```

--------------------------------

### API: onTestStarted method for ExtentReports BasicFileReporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/BasicFileReporter.html

This method is invoked when a new test is initiated using the `createTest(args)` method. It serves as a callback for actions to be performed at the start of a test's execution.

```APIDOC
onTestStarted(Test test)
  test: Test
Returns: void
```

--------------------------------

### Get Config Context for Extent HTML Reporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the configuration context for the Extent HTML Reporter instance.

```APIDOC
com.aventstack.extentreports.reporter.ExtentHtmlReporter.getConfigContext()
```

--------------------------------

### API Documentation for TestMediaTests Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/api/TestMediaTests.html

Detailed API documentation for the `TestMediaTests` class, including its constructors and methods for verifying screen capture functionalities in ExtentReports. This class extends `com.aventstack.extentreports.Base` and contains test methods for media handling.

```APIDOC
Class: com.aventstack.extentreports.api.TestMediaTests
  Inherits from:
    - java.lang.Object
    - com.aventstack.extentreports.Base

  Constructors:
    TestMediaTests():
      Description: Default constructor for the TestMediaTests class.

  Methods:
    verifyIfScreenCaptureAdded(method: java.lang.reflect.Method): void
      Description: Verifies if a screen capture was successfully added to the test report.
      Parameters:
        method: The Method object representing the test method.
      Throws:
        java.io.IOException

    verifyScreenCaptureTitle(method: java.lang.reflect.Method): void
      Description: Verifies the title associated with a screen capture.
      Parameters:
        method: The Method object representing the test method.
      Throws:
        java.io.IOException

    verifyMultipleScreenCaptures(method: java.lang.reflect.Method): void
      Description: Verifies the successful addition of multiple screen captures to the test report.
      Parameters:
        method: The Method object representing the test method.
      Throws:
        java.io.IOException

  Inherited Methods from com.aventstack.extentreports.Base:
    setup(): void
    tearDown(): void

  Inherited Methods from java.lang.Object:
    equals(obj: java.lang.Object): boolean
    getClass(): java.lang.Class<?>
    hashCode(): int
    notify(): void
    notifyAll(): void
    toString(): java.lang.String
    wait(): void
    wait(timeout: long): void
    wait(timeout: long, nanos: int): void
```

--------------------------------

### Get Base64 String

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the Base64 encoded string representation of the media content.

```APIDOC
public java.lang.String getBase64String()
```

--------------------------------

### API: MarkupHelper Class and Constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-12.html

Represents the MarkupHelper class within the com.aventstack.extentreports.markuputils package, providing utility methods for creating markup. The constructor MarkupHelper() initializes a new instance of this class.

```APIDOC
Class: com.aventstack.extentreports.markuputils.MarkupHelper
Constructor: MarkupHelper()
```

--------------------------------

### LogStructure: Get LogIterator

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/LogStructure.html

Returns a `com.aventstack.extentreports.model.LogStructure.LogIterator` instance, allowing iteration over the `Log` objects.

```Java
public com.aventstack.extentreports.model.LogStructure.LogIterator getIterator()
```

--------------------------------

### LogStructure: Get All Logs

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/LogStructure.html

Returns a `java.util.List` containing all `Log` objects stored in the `LogStructure`.

```Java
public java.util.List<Log> getAll()
```

--------------------------------

### Load Configuration from Properties

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/AbstractReporter.html

Loads configuration settings from a `java.util.Properties` object.

```APIDOC
public void loadConfig(java.util.Properties properties)
```

--------------------------------

### Get Test Runner Logs from AbstractReporter API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestRunnerLogs()' method in the 'com.aventstack.extentreports.reporter.AbstractReporter' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.reporter.AbstractReporter
Method: getTestRunnerLogs()
```

--------------------------------

### API Documentation for ExtentReports Classes

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/package-summary.html

Provides an overview of the core classes within the `com.aventstack.extentreports` package. This includes the main `ExtentReports` client, `ExtentTest` for test definitions, and utility classes for media and Gherkin keyword handling.

```APIDOC
Class Summary:
  Class Base
    Description: 
  Class ExceptionTestContextImpl
    Description: 
  Class ExtentReports
    Description: The ExtentReports report client for starting reporters and building reports.
  Class ExtentTest
    Description: Defines a test.
  Class GherkinKeyword
    Description: Allows IGherkinFormatterModel to be returned by using a name, from the below gherkin model classes: Feature Background Scenario Given When Then And
  Class MediaEntityBuilder
    Description: 
  Class MediaEntityModelProvider
    Description: 
  Class ParallelClass1
    Description: 
  Class ParallelClass2
    Description: 
  Class ParallelClassesBase
    Description: 
```

--------------------------------

### Get Test Object ID from Media API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestObjectId()' method in the 'com.aventstack.extentreports.model.Media' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.model.Media
Method: getTestObjectId()
```

--------------------------------

### Get System Attribute List from SystemAttributeContext API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getSystemAttributeList()' method in the 'com.aventstack.extentreports.SystemAttributeContext' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.SystemAttributeContext
Method: getSystemAttributeList()
```

--------------------------------

### SystemAttributeContext Constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/SystemAttributeContext.html

Initializes a new instance of the `SystemAttributeContext` class. This default constructor creates an empty context for system attributes.

```APIDOC
Constructor: SystemAttributeContext()
  Definition:
    public SystemAttributeContext()
```

--------------------------------

### Screencast Class Methods API Documentation

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Screencast.html

API documentation for methods of the `com.aventstack.extentreports.model.Screencast` class. These methods provide access to the source path and source path with an icon for a screencast.

```APIDOC
com.aventstack.extentreports.model.Screencast:
  Methods:
    public java.lang.String getSource()
    public java.lang.String getSourceWithIcon()
```

--------------------------------

### Get Extent Instance in Test Class

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the Extent instance associated with a test. This method belongs to the `com.aventstack.extentreports.model.Test` class.

```APIDOC
com.aventstack.extentreports.model.Test.getExtentInstance()
```

--------------------------------

### Create ExtentReports Instance

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ExtentReports.html

Initializes a new instance of the ExtentReports class. This constructor is used to create the primary entry point for ExtentReports.

```APIDOC
ExtentReports()
  Returns: ExtentReports
```

--------------------------------

### Get Category Context Info from Abstract Reporter

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Obtains category context information from an abstract reporter instance in ExtentReports.

```APIDOC
com.aventstack.extentreports.reporter.AbstractReporter.getCategoryContextInfo()
```

--------------------------------

### Get Category Context for Test Model

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Retrieves the category context associated with a specific test instance in the ExtentReports model.

```APIDOC
com.aventstack.extentreports.model.Test.getCategoryContext()
```

--------------------------------

### ExceptionInfo Class Constructor Summary

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/ExceptionInfo.html

Lists the available constructors for the `ExceptionInfo` class.

```APIDOC
Constructor Summary:
  ExceptionInfo()
```

--------------------------------

### Java Constructor Summary: ParallelClass2

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/ParallelClass2.html

Summarizes the constructors available for the `ParallelClass2` class, providing a quick overview of how instances can be created.

```APIDOC
Constructors:
  ParallelClass2()
```

--------------------------------

### Get Report Name - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the custom name assigned to the report.

```APIDOC
Method: getReportName
  Signature: public java.lang.String getReportName()
  Description: Retrieves the name of the report.
```

--------------------------------

### Screencast Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Screencast.html

Provides a detailed reference for the `Screencast` class, including its inheritance from `com.aventstack.extentreports.model.Media` and implementation of `java.io.Serializable`. It lists the default constructor and methods to retrieve screencast source information.

```APIDOC
Class: com.aventstack.extentreports.model.Screencast
  Extends: com.aventstack.extentreports.model.Media
  Implements: java.io.Serializable

  Constructor Summary:
    Screencast()
      Description: Default constructor.

  Method Summary:
    getSource(): java.lang.String
      Description: Retrieves the source of the screencast.
    getSourceWithIcon(): java.lang.String
      Description: Retrieves the source of the screencast with an icon.

  Methods inherited from class com.aventstack.extentreports.model.Media
```

--------------------------------

### Get Configuration Map - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves a map containing all configuration settings.

```APIDOC
Method: getConfigMap
  Signature: public java.util.Map<java.lang.String,java.lang.String> getConfigMap()
  Description: Retrieves the configuration map.
```

--------------------------------

### Get ExtentX URL - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the configured URL for the ExtentX server.

```APIDOC
Method: getExtentXUrl
  Signature: public java.lang.String getExtentXUrl()
  Description: Retrieves the ExtentX URL.
```

--------------------------------

### ConfigMap Constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/configuration/ConfigMap.html

Provides the default constructor for creating an instance of the `ConfigMap` class.

```Java
public ConfigMap()
```

--------------------------------

### Get Test Object ID

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the object identifier of the test to which this media instance is associated.

```APIDOC
public org.bson.types.ObjectId getTestObjectId()
```

--------------------------------

### Get Report Object ID

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the object identifier of the report to which this media instance is associated.

```APIDOC
public org.bson.types.ObjectId getReportObjectId()
```

--------------------------------

### Constructor: TestMediaTests()

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-18.html

Initializes a new instance of the TestMediaTests class in the com.aventstack.extentreports.api package.

```APIDOC
com.aventstack.extentreports.api.TestMediaTests()
```

--------------------------------

### Java Constructor Summary: ExtentTestNGIReporterListener

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/common/ExtentTestNGIReporterListener.html

Summarizes the constructors available for the `ExtentTestNGIReporterListener` class.

```APIDOC
ExtentTestNGIReporterListener()
```

--------------------------------

### Get Media Object ID

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/Media.html

Retrieves the unique object identifier assigned to the media instance.

```APIDOC
public org.bson.types.ObjectId getObjectId()
```

--------------------------------

### NodeMediaTests Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/api/NodeMediaTests.html

Comprehensive API documentation for the `NodeMediaTests` class, including its inheritance, constructors, and methods for handling screen captures in ExtentReports. This class extends `com.aventstack.extentreports.Base`.

```APIDOC
Class: com.aventstack.extentreports.api.NodeMediaTests
  Extends: com.aventstack.extentreports.Base

  Constructors:
    NodeMediaTests()

  Methods:
    verifyIfScreenCaptureAdded(java.lang.reflect.Method method)
      Description: Verifies if a screen capture was successfully added to a node.
      Parameters:
        method: java.lang.reflect.Method - The test method context.
      Returns: void
      Throws: java.io.IOException

    verifyMultipleScreenCaptures(java.lang.reflect.Method method)
      Description: Verifies the addition of multiple screen captures to a node.
      Parameters:
        method: java.lang.reflect.Method - The test method context.
      Returns: void
      Throws: java.io.IOException

    verifyScreenCaptureTitle(java.lang.reflect.Method method)
      Description: Verifies the title associated with a screen capture.
      Parameters:
        method: java.lang.reflect.Method - The test method context.
      Returns: void
      Throws: java.io.IOException

  Inherited Methods from com.aventstack.extentreports.Base:
    setup()
    tearDown()

  Inherited Methods from java.lang.Object:
    equals(Object obj)
    getClass()
    hashCode()
    notify()
    notifyAll()
    toString()
    wait()
    wait(long timeout)
    wait(long timeout, int nanos)
```

--------------------------------

### ConfigMap() constructor

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-3.html

The default constructor for the `ConfigMap` class, used to create an empty configuration map.

```APIDOC
Constructor: com.aventstack.extentreports.configuration.ConfigMap()
```

--------------------------------

### Get Value with String Parameter from ConfigMap API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getValue(String)' method in the 'com.aventstack.extentreports.configuration.ConfigMap' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.configuration.ConfigMap
Method: getValue(String)
```

--------------------------------

### ExceptionInfo Class Constructor Detail

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/ExceptionInfo.html

Detailed documentation for the `ExceptionInfo` class constructor.

```APIDOC
Constructor Detail:
  ExceptionInfo()
    public ExceptionInfo()
```

--------------------------------

### Get Test View Chart Location from ExtentHtmlReporterConfiguration API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-7.html

Documents the 'getTestViewChartLocation()' method in the 'com.aventstack.extentreports.reporter.configuration.ExtentHtmlReporterConfiguration' class of the ExtentReports Java API.

```APIDOC
Class: com.aventstack.extentreports.reporter.configuration.ExtentHtmlReporterConfiguration
Method: getTestViewChartLocation()
```

--------------------------------

### Constructor Detail: ListenerTestsITestListener()

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/listenertests/ListenerTestsITestListener.html

Provides detailed information for the default constructor of `ListenerTestsITestListener`.

```APIDOC
public ListenerTestsITestListener()
```

--------------------------------

### Get Timestamp Format - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the format string used for timestamps in the report.

```APIDOC
Method: getTimeStampFormat
  Signature: public java.lang.String getTimeStampFormat()
  Description: Gets the timestamp format.
  Returns: java.lang.String - The time stamp format.
```

--------------------------------

### ScreenCapture Class API Reference

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/model/ScreenCapture.html

Detailed API reference for the `com.aventstack.extentreports.model.ScreenCapture` class, including its inheritance hierarchy, available constructors, and public methods for interacting with screen capture data.

```APIDOC
Class: com.aventstack.extentreports.model.ScreenCapture
  Extends: com.aventstack.extentreports.model.Media
  Implements: java.io.Serializable

  Constructors:
    ScreenCapture()
      Description: Default constructor for ScreenCapture.

  Methods:
    getSource(): java.lang.String
      Description: Retrieves the source of the screen capture.
    getSourceWithIcon(): java.lang.String
      Description: Retrieves the source of the screen capture with an associated icon.

  Inherited Methods:
    Methods inherited from class com.aventstack.extentreports.model.Media
```

--------------------------------

### Get Report Status Level - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the configured status levels for the report.

```APIDOC
Method: getLevel
  Signature: public java.util.List<Status> getLevel()
  Description: Retrieves the status levels for the report.
```

--------------------------------

### Method: config() (com.aventstack.extentreports.ExtentReports)

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/index-files/index-3.html

This method is part of the com.aventstack.extentreports.ExtentReports class. It provides access to common report configurations, allowing users to modify global settings for the ExtentReports instance.

```APIDOC
com.aventstack.extentreports.ExtentReports.config()
```

--------------------------------

### Get Custom JavaScript - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the custom JavaScript string added to the report.

```APIDOC
Method: getJS
  Signature: public java.lang.String getJS()
  Description: Retrieves the custom JavaScript.
```

--------------------------------

### Get Custom CSS - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the custom CSS string applied to the report.

```APIDOC
Method: getCSS
  Signature: public java.lang.String getCSS()
  Description: Retrieves the custom CSS.
```

--------------------------------

### Get Report Document Title - ExtentReports Java API

Source: https://github.com/anshooarora/extentreports-java/blob/master/doc/com/aventstack/extentreports/reporter/configuration/BasicFileConfiguration.html

Retrieves the document title set for the report.

```APIDOC
Method: getDocumentTitle
  Signature: public java.lang.String getDocumentTitle()
  Description: Retrieves the document title.
```