references
library
Classes
AbsolutePath
AbstractDocument
AbstractDownloadable
AbstractDownloadable
has a download method
AbstractFile <T >
AbstractPassword
AbstractPath
AbstractPath
has a path property
AbstractSelector
AbstractUrl
Accessibility
The Accessibility class provides methods for inspecting Chromium's
accessibility tree. The accessibility tree is used by assistive technology
such as screen readers or
switches .
Ask
Attribute
Authable
AXNode
An Accessibility Node
BoxModel
Box model.
Browser
A Browser is created when Puppeteer connects to a Chromium instance, either
through puppeteer.launch or puppeteer.connect.
BrowserContext
BrowserContexts provide a way to operate multiple independent browser
sessions. When a browser is launched, it has a single BrowserContext used by
default. The method Browser.newPage creates a page in the default browser
context.
BrowserPath
Button
Button
appends button to the selector
ByIndex
BytesBuilder
Builds a list of bytes, allowing bytes and lists of bytes to be added at the
end.
ByText
Cell
Completer <T >
A way to produce Future objects and to complete them later
with a value or error.
CompressionOptions
Options controlling compression in a WebSocket .
ConnectionTask <S >
A cancelable connection attempt.
ConsoleMessage
ConsoleMessage objects are dispatched by page via the console event.
ConsoleMessageType
ContentType
A MIME/IANA media type used as the value of the
HttpHeaders.contentTypeHeader header.
Cookie
Representation of a cookie. For cookies received by the server as Cookie
header values only name and value properties will be set. When building a
cookie for the 'set-cookie' header in the server and when receiving cookies
in the client as 'set-cookie' headers all fields can be used.
CookieParam
Cookie parameter object
Coverage
Coverage gathers information about parts of JavaScript and CSS that were used by the page.
CoverageEntry
Css
Ctx
Datagram
A data packet received by a RawDatagramSocket .
Device
DeviceViewport
Dialog
Dialog objects are dispatched by page via the 'onDialog' event.
Directory
A reference to a directory (or folder ) on the file system.
Div
Div
DoUntil
DownloadableSapTable
DownloadableSapTable
DownloadableSapTable2
DownloadableSap Table by right click on table header and selecting "Spreadsheet..." on context menu
DownloadedBrowserInfo
ElementHandle
ElementHandle represents an in-page DOM element. ElementHandles can be
created with the page.$ method.
EventSink <T >
A Sink that supports adding errors.
ExcelFile
ExecutionContext
The class represents a context for JavaScript execution. A Page might have
many execution contexts:
File
A reference to a file on the file system.
FileChooser
FileChooser objects are returned via the 'page.waitForFileChooser' method.
FileLock
Type of lock when requesting a lock on a file.
FileMode
The modes in which a File can be opened.
FileStat
The result of calling the POSIX stat() function on a file system object.
FileSystemCreateEvent
File system event for newly created file system objects.
FileSystemDeleteEvent
File system event for deletion of file system objects.
FileSystemEntity
The common superclass of File , Directory , and Link .
FileSystemEntityType
The type of an entity on the file system,
such as a file, directory, or link.
FileSystemEvent
Base event class emitted by FileSystemEntity.watch .
FileSystemModifyEvent
File system event for modifications of file system objects.
FileSystemMoveEvent
File system event for moving of file system objects.
Frame
At every point of time, page exposes its current frame tree via the
page.mainFrame and frame.childFrames methods.
Future <T >
The result of an asynchronous computation.
FutureGenerator
FutureOr <T >
A type representing values that are either Future<T> or T.
GraphQuery
GraphServiceClient
GZipCodec
The GZipCodec encodes raw bytes to GZip compressed bytes and decodes GZip
compressed bytes to raw bytes.
Representation of a header value in the form:
HttpClient
An HTTP client for communicating with an HTTP server.
HttpClientBasicCredentials
Represents credentials for basic authentication.
HttpClientCredentials
HttpClientDigestCredentials
Represents credentials for digest authentication. Digest
authentication is only supported for servers using the MD5
algorithm and quality of protection (qop) of either "none" or
"auth".
HttpClientRequest
HTTP request for a client connection.
HttpClientResponse
HTTP response for a client connection.
HttpConnectionInfo
Information about an HttpRequest , HttpResponse , HttpClientRequest , or
HttpClientResponse connection.
HttpConnectionsInfo
Summary statistics about an HttpServer s current socket connections.
HttpDate
Utility functions for working with dates with HTTP specific date
formats.
Headers for HTTP requests and responses.
HttpOverrides
This class facilitates overriding HttpClient with a mock implementation.
It should be extended by another class in client code with overrides
that construct a mock implementation. The implementation in this base class
defaults to the actual HttpClient implementation. For example:
HttpRequest
A server-side object
that contains the content of and information about an HTTP request.
HttpResponse
An HTTP response, which returns the headers and data
from the server to the client in response to an HTTP request.
HttpServer
A server that delivers content, such as web pages, using the HTTP protocol.
HttpSession
The HttpRequest.session of an HttpRequest .
HttpStatus
HTTP status codes. Exported in dart:io and dart:html.
Input
Input
appends input to the selector
InternetAddress
An internet address or a Unix domain address.
InternetAddressType
The type, or address family, of an InternetAddress .
IOOverrides
Facilities for overriding various APIs of dart:io with mock
implementations.
IOSink
A combined byte and text output.
JsHandle
JSHandle represents an in-page JavaScript object. JSHandles can be created
with the page.evaluateHandle method.
Key
Link
References to filesystem links.
MailQuery
response:
MediaFeature
MediaType
Metrics
MetricsEvent
MultiForm
MultiStreamController <T >
An enhanced stream controller provided by Stream.multi .
NestedSelector
NetworkInterface
A NetworkInterface represents an active network interface on the current
system. It contains a list of InternetAddress es that are bound to the
interface.
Nobody
this is nobody
NoButton
NoForm
NoKeyboardShortcut
NoMaybeButton
NomoCode
NoSapGridElement
NoTextBox
Online
Page
Page provides methods to interact with a single tab or extension background
page in Chromium. One Browser instance might have multiple Page instances.
PaperFormat
Password
PdfMargins
Pipe
An anonymous pipe that can be used to send data in a single direction i.e.
data written to write can be read using read .
Platform
Information about the environment in which the current program is running.
Point <T extends num >
A utility class for representing two-dimensional positions.
Polling
Process
The means to execute a program.
ProcessInfo
Methods for retrieving information about the current process.
ProcessResult
The result of running a non-interactive
process started with Process.run or Process.runSync .
ProcessSignal
On Posix systems, ProcessSignal is used to send a specific signal
to a child process, see Process.kill.
ProcessStartMode
Modes for running a new process.
Puppeteer
Launch or connect to a chrome instance
RandomAccessFile
Random access to the data in a file.
Range
RawDatagramSocket
An unbuffered interface to a UDP socket.
RawSecureServerSocket
A server socket providing a stream of low-level RawSecureSocket s.
RawSecureSocket
RawSecureSocket provides a secure (SSL or TLS) network connection.
RawServerSocket
A listening socket.
RawSocket
A TCP connection.
RawSocketEvent
Events for the RawDatagramSocket , RawSecureSocket , and RawSocket .
RawSocketOption
The RawSocketOption is used as a parameter to Socket.setRawOption and
RawSocket.setRawOption to customize the behaviour of the underlying
socket.
RawSynchronousSocket
A low-level class for communicating synchronously over a TCP socket.
RawZLibFilter
The RawZLibFilter class provides a low-level interface to zlib.
ReadPipe
The "read" end of an Pipe created by Pipe.create .
Rectangle <T extends num >
A class for representing two-dimensional rectangles whose properties are
immutable.
RedirectInfo
Redirect information.
RelativePath
Path
has a path property
Request
Whenever the page sends a request, such as for a network resource, the
following events are emitted by puppeteer's page:
ResourceHandle
A wrapper around OS resource handle so it can be passed via Socket
as part of SocketMessage .
Response
Response class represents responses which are received by page.
Row
SameSite
Cookie cross-site availability configuration.
Sap
SapButton
SapButton
has role="button", class="lsButton and title="{label}"
SapDataField
for sap specific data fields
for example
if the field html is as follows
we can access the field using the following selector
SapDataField('wnd0/usr/subSUB0:SAPLMEGUI:0019/subSUB3:SAPLMEVIEWS:1100/subSUB2:SAPLMEVIEWS:1200/subSUB1:SAPLMEGUI:1301/subSUB2:SAPLMEGUI:3303/tabsREQ_ITEM_DETAIL/tabpTABREQDT1/ssubTABSTRIPCONTROL1SUB:SAPLMEGUI:1328/subSUB0:SAPLMLSP:0400/tblSAPLMLSPTC_VIEW/ctxtESLL-SRVPOS2,0')
it will automatically replace unsafe characters with escaped representation and build the selector from it that can be used to access the field in the browser
SapFiori
SapInput
SapInput
has name="InputField" and title="{label}""
SapInputWithData
SapInputWithinData
when the input field is nested within an element with lsdata attribute
this will match the first input field within the element with matching lsdata
even if the input field itself does not have lsdata attribute
SapPurchaseRequestUrl
For example.
the code for
Header release Service PR is ZPRS
Header release Rental PR is ZPRR
Header release Opex PR is ZPRO
SapTable
SapTable
role="grid" class="urSTCS lsSapTable--backgroundColor urHtmlTableReset lsSapTable--bs-disabled"
SapTableHead
SapTableRow
a span with title="{label}" inside role="row" aria-rowindex="{index}" inside a div with role="grid"
SapTransaction
SapTransactionUrl
SapUser
Score
ScreenshotFormat
SecureServerSocket
A server socket, providing a stream of high-level Socket s.
SecureSocket
A TCP socket using TLS and SSL.
SecurityContext
The object containing the certificates to trust when making
a secure client connection, and the certificate chain and
private key to serve from a secure server.
SelectionStrategy
ServerSocket
A listening socket.
Show
SimpleInput <T >
Socket
A TCP connection between two sockets.
SocketControlMessage
Control message part of the SocketMessage received by a call to
RawSocket.readMessage .
SocketDirection
The SocketDirection is used as a parameter to Socket.close and
RawSocket.close to close a socket in the specified direction(s).
SocketMessage
A socket message received by a RawDatagramSocket .
SocketOption
An option for a socket which is configured using Socket.setOption .
Spreadsheet
Stdin
The standard input stream of the process.
StdioType
The type of object a standard IO stream can be attached to.
Stdout
An IOSink connected to either the standard out or error of the process.
Store <T >
Stream <T >
A source of asynchronous data events.
StreamConsumer <S >
Abstract interface for a "sink" accepting multiple entire streams.
StreamController <T >
A controller with the stream it controls.
StreamIterator <T >
An Iterator -like interface for the values of a Stream .
StreamSink <S >
A object that accepts stream events both synchronously and asynchronously.
StreamSubscription <T >
A subscription on events from a Stream .
StreamTransformer <S , T >
Transforms a Stream.
StreamTransformerBase <S , T >
Base class for implementing StreamTransformer .
StreamView <T >
Stream wrapper that only exposes the Stream interface.
SynchronousStreamController <T >
A stream controller that delivers its events synchronously.
SystemEncoding
The system encoding is the current code page on Windows and UTF-8 on Linux
and Mac.
Target
Text
TextArea
TextArea
appends textarea to the selector
Timeout
Timer
A countdown timer that can be configured to fire once or repeatedly.
TlsProtocolVersion
A Transport Layer Security (TLS) version.
Tracing
You can use tracing.start and tracing.stop to create a trace file which
can be opened in Chrome DevTools or timeline viewer .
Until
Url
ValidationResponse
Waitable
WaitableDuration
WaitableEvent
WebSocket
A two-way HTTP communication object for client or server applications.
WebSocketStatus
WebSocket status codes used when closing a WebSocket connection.
WebSocketTransformer
The WebSocketTransformer provides the ability to upgrade a
HttpRequest to a WebSocket connection. It supports both
upgrading a single HttpRequest and upgrading a stream of
HttpRequest s.
WithClass
WithClass
appends class="{class}" to the selector
class can be a list of classes
WithId
WithId
appends id="{id}" to the selector
WithIdContains
WithName
WithName
appends name="{name}" to the selector
WithText
With Text
appends text="{text}" to the selector
Workbook
Worker
The Worker class represents a WebWorker .
The events workercreated and workerdestroyed are emitted on the page
object to signal the worker lifecycle.
WritePipe
The "write" end of an Pipe created by Pipe.create .
X509Certificate
X509Certificate represents an SSL certificate, with accessors to
get the fields of the certificate.
XPath
ZLibCodec
The ZLibCodec encodes raw bytes to ZLib compressed bytes and decodes ZLib
compressed bytes to raw bytes.
ZLibDecoder
The ZLibDecoder is used by ZLibCodec and GZipCodec to decompress data.
ZLibEncoder
The ZLibEncoder encoder is used by ZLibCodec and GZipCodec to compress
data.
ZLibOption
Exposes ZLib options for input parameters.
Zone
A zone represents an environment that remains stable across asynchronous
calls.
ZoneDelegate
An adapted view of the parent zone.
ZoneSpecification
A parameter object with custom zone function handlers for Zone.fork .
Extensions
DateExt DateTime
ElementExt ElementHandle ?
ElementFutureExt Future <ElementHandle ?
ExCell Future <Cell
GENERATED EXTENSION
ExDateTime DateTime
DateTime extensions
ExDownload Future <Online
ExDuration num
generic extensions for numbers that convert them to durations
e.g. 5.minutes
5.seconds
5.milliseconds
ExExcelFile Future <ExcelFile
GENERATED EXTENSION
ExGraphQuery Future <GraphQuery
GENERATED EXTENSION
ExGraphServiceClient Future <GraphServiceClient
GENERATED EXTENSION
ExIterable FutureOr <Iterable <T >
ExMailQuery Future <MailQuery
GENERATED EXTENSION
ExNumber num ?
Number extensions
ExOnline Future <Online
GENERATED EXTENSION
ExRow Future <Row
GENERATED EXTENSION
ExSpreadsheet Future <Spreadsheet
GENERATED EXTENSION
ExString String ?
String extensions
ExWorkbook Future <Workbook
GENERATED EXTENSION
FutureExtensions Future <T >
Convenience methods on futures.
FutureIterable Iterable <Future <T >
FutureMapExt Future <T >
FutureRecord2 Future <T1 > Future <T2 >
Parallel operations on a record of futures.
FutureRecord3 Future <T1 > Future <T2 > Future <T3 >
Parallel operations on a record of futures.
FutureRecord4 Future <T1 > Future <T2 > Future <T3 > Future <T4 >
Parallel operations on a record of futures.
FutureRecord5 Future <T1 > Future <T2 > Future <T3 > Future <T4 > Future <T5 >
Parallel operations on a record of futures.
FutureRecord6 Future <T1 > Future <T2 > Future <T3 > Future <T4 > Future <T5 > Future <T6 >
Parallel operations on a record of futures.
FutureRecord7 Future <T1 > Future <T2 > Future <T3 > Future <T4 > Future <T5 > Future <T6 > Future <T7 >
Parallel operations on a record of futures.
FutureRecord8 Future <T1 > Future <T2 > Future <T3 > Future <T4 > Future <T5 > Future <T6 > Future <T7 > Future <T8 >
Parallel operations on a record of futures.
FutureRecord9 Future <T1 > Future <T2 > Future <T3 > Future <T4 > Future <T5 > Future <T6 > Future <T7 > Future <T8 > Future <T9 >
Parallel operations on a record of futures.
StringEx String
Functions
aesDecrypt (String encryptedText , String key → String
aesEncrypt (String plainText , String key → String
ask_user_for_prefered_browser ()
→ Future <String
build_client (String token → Dio
build_graph (String username → Future <GraphServiceClient
downloadChrome ({String ?version , String ?cachePath , void onDownloadProgress (int received , int total BrowserPlatform? platform → Future <DownloadedBrowserInfo
Downloads the chrome revision specified by revision to the cachePath directory.
downloadFile (String url , String subdir → Future <bool
exit (int code → Never
Exit the Dart VM process immediately with the given exit code.
get_token (String username , {dynamic retry_count = 0 → Future <String ?
get_token_from_code (String code → Future <String
get_token_validity (String token → Future <DateTime
getBrowserPath ()
→ Future <String
getChromiumDownloadUrl ()
→ Future <String
launch (String url → Future <void >
prepare_local_chromium ()
→ Future <bool
Print (dynamic text → void
runZoned <R > (R body (), {Map <Object ?Object ? ?zoneValues , ZoneSpecification ?zoneSpecification , Function ?onError → R
Runs body in its own zone.
runZonedGuarded <R > (R body (), void onError (Object error , StackTrace stack Map <Object ?Object ? ?zoneValues , ZoneSpecification ?zoneSpecification → R?
Runs body in its own error zone.
scheduleMicrotask (void callback ()→ void
Runs a function asynchronously.
showBanner ()
→ void
sleep (Duration duration → void
Sleep for the duration specified in duration.
stdioType (dynamic object → StdioType
Whether a stream is attached to a file, pipe, terminal, or
something else.
unawaited (Future <void > ?future → void
Explicitly ignores a future.
UntilVisible (AbstractSelector selector → dynamic
unzipFile (String path , String subdir → Future <bool
Typedefs
AsyncMapFunc T , R >
= Future <R > Function(T
AsyncMapManyFunc T , R >
= Future <Iterable <R > Function(T
BadCertificateCallback
= bool Function(X509Certificate cr , String host , int port
Check T >
= FutureOr <bool Function(T browser
CollectData T >
= T? Function(Online browser
ControllerCallback
= void Function()
Type of a stream controller's onListen, onPause and onResume
callbacks.
ControllerCancelCallback
= FutureOr <void > Function()
Type of stream controller onCancel callbacks.
CreatePeriodicTimerHandler
= Timer Function(Zone self , ZoneDelegate parent , Zone zone , Duration period , void f (Timer timer
The type of a custom Zone.createPeriodicTimer implementation function.
CreateTimerHandler
= Timer Function(Zone self , ZoneDelegate parent , Zone zone , Duration duration , void f ()
The type of a custom Zone.createTimer implementation function.
Do T >
= FutureOr Function(T browser
ErrorCallbackHandler
= AsyncError ? Function(Zone self , ZoneDelegate parent , Zone zone , Object error , StackTrace ?stackTrace
The type of a custom Zone.errorCallback implementation function.
ForkHandler
= Zone Function(Zone self , ZoneDelegate parent , Zone zone , ZoneSpecification ?specification , Map <Object ?Object ? ?zoneValues
The type of a custom Zone.fork implementation function.
HandleUncaughtErrorHandler
= void Function(Zone self , ZoneDelegate parent , Zone zone , Object error , StackTrace stackTrace
The type of a custom Zone.handleUncaughtError implementation function.
MapFunc T , R >
= R Function(T
MapManyFunc T , R >
= Iterable <R > Function(T
OnlineAction
= FutureOr Function(Online browser
Predicate T >
= bool Function(T
PrintHandler
= void Function(Zone self , ZoneDelegate parent , Zone zone , String line
The type of a custom Zone.print implementation function.
RegisterBinaryCallbackHandler
= ZoneBinaryCallback <R , T1 , T2 > Function<R , T1 , T2 >(Zone self , ZoneDelegate parent , Zone zone , R f (T1 arg1 , T2 arg2
The type of a custom Zone.registerBinaryCallback implementation function.
RegisterCallbackHandler
= ZoneCallback <R > Function<R >(Zone self , ZoneDelegate parent , Zone zone , R f ()
The type of a custom Zone.registerCallback implementation function.
RegisterUnaryCallbackHandler
= ZoneUnaryCallback <R , T > Function<R , T >(Zone self , ZoneDelegate parent , Zone zone , R f (T arg
The type of a custom Zone.registerUnaryCallback implementation function.
Rows Iterable <Row
RunBinaryHandler
= R Function<R , T1 , T2 >(Zone self , ZoneDelegate parent , Zone zone , R f (T1 arg1 , T2 arg2 T1 arg1 , T2 arg2
The type of a custom Zone.runBinary implementation function.
RunHandler
= R Function<R >(Zone self , ZoneDelegate parent , Zone zone , R f ()
The type of a custom Zone.run implementation function.
RunUnaryHandler
= R Function<R , T >(Zone self , ZoneDelegate parent , Zone zone , R f (T arg T arg
The type of a custom Zone.runUnary implementation function.
ScheduleMicrotaskHandler
= void Function(Zone self , ZoneDelegate parent , Zone zone , void f ()
The type of a custom Zone.scheduleMicrotask implementation function.
SelectorBuilder
= AbstractSelector Function(int line , int column
SelectorFunc
= Future Function(AbstractSelector selector
Validation
= FutureOr <ValidationResponse Function(Online browser
ZoneBinaryCallback R , T1 , T2 >
= R Function(T1 , T2
ZoneCallback R >
= R Function()
ZoneUnaryCallback R , T >
= R Function(T
