com.github.kklisura.cdt.protocol.commands

Interface Audits

public interface Audits

Audits domain allows investigation of page violations and possible improvements.

Method Summary

Modifier and Type	Method and Description
void	checkContrast() Runs the contrast check for the target page.
void	checkContrast(Boolean reportAAA) Runs the contrast check for the target page.
void	disable() Disables issues domain, prevents further issues from being reported to the client.
void	enable() Enables issues domain, sends the issues collected so far to the client by means of the `issueAdded` event.
EncodedResponse	getEncodedResponse(String requestId, GetEncodedResponseEncoding encoding) Returns the response body and size if it were re-encoded with the specified settings.
EncodedResponse	getEncodedResponse(String requestId, GetEncodedResponseEncoding encoding, Double quality, Boolean sizeOnly) Returns the response body and size if it were re-encoded with the specified settings.
EventListener	onIssueAdded(EventHandler<IssueAdded> eventListener)

Method Detail

getEncodedResponse

EncodedResponse getEncodedResponse(String requestId,
                                   GetEncodedResponseEncoding encoding)

Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.

Parameters:

requestId - Identifier of the network request to get content for.

encoding - The encoding to use.

getEncodedResponse

EncodedResponse getEncodedResponse(String requestId,
                                   GetEncodedResponseEncoding encoding,
                                   Double quality,
                                   Boolean sizeOnly)

Returns the response body and size if it were re-encoded with the specified settings. Only applies to images.

Parameters:

requestId - Identifier of the network request to get content for.

encoding - The encoding to use.

quality - The quality of the encoding (0-1). (defaults to 1)

sizeOnly - Whether to only return the size information (defaults to false).

disable

void disable()

Disables issues domain, prevents further issues from being reported to the client.

enable

void enable()

Enables issues domain, sends the issues collected so far to the client by means of the `issueAdded` event.

checkContrast

void checkContrast()

Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.

checkContrast

void checkContrast(Boolean reportAAA)

Runs the contrast check for the target page. Found issues are reported using Audits.issueAdded event.

Parameters:

reportAAA - Whether to report WCAG AAA level issues. Default is false.

onIssueAdded

EventListener onIssueAdded(EventHandler<IssueAdded> eventListener)