Tungsten v0.1.0 Tungsten.CDP.Browser View Source
The Browser domain defines methods and events for browser managing.
Link to this section Summary
Link to this section Types
cdp_bounds_type()
View Source
cdp_bounds_type() :: %{
optional(:left) => integer(),
optional(:top) => integer(),
optional(:width) => integer(),
optional(:height) => integer(),
optional(:window_state) => cdp_window_state_type()
}
cdp_bounds_type() :: %{
optional(:left) => integer(),
optional(:top) => integer(),
optional(:width) => integer(),
optional(:height) => integer(),
optional(:window_state) => cdp_window_state_type()
}
Browser window bounds information
cdp_bucket_type() View Source
Chrome histogram bucket.
cdp_histogram_type()
View Source
cdp_histogram_type() :: %{
name: String.t(),
sum: integer(),
count: integer(),
buckets: [cdp_bucket_type()]
}
cdp_histogram_type() :: %{
name: String.t(),
sum: integer(),
count: integer(),
buckets: [cdp_bucket_type()]
}
Chrome histogram.
cdp_permission_type_type()
View Source
cdp_permission_type_type() ::
:idle_detection
| :video_capture
| :sensors
| :protected_media_identifier
| :payment_handler
| :notifications
| :midi_sysex
| :midi
| :geolocation
| :flash
| :durable_storage
| :clipboard_write
| :clipboard_read
| :background_fetch
| :background_sync
| :audio_capture
| :accessibility_events
cdp_permission_type_type() :: :idle_detection | :video_capture | :sensors | :protected_media_identifier | :payment_handler | :notifications | :midi_sysex | :midi | :geolocation | :flash | :durable_storage | :clipboard_write | :clipboard_read | :background_fetch | :background_sync | :audio_capture | :accessibility_events
This type has no documentation
cdp_window_id_type()
View Source
cdp_window_id_type() :: integer()
cdp_window_id_type() :: integer()
This type has no documentation
cdp_window_state_type()
View Source
cdp_window_state_type() :: :fullscreen | :maximized | :minimized | :normal
cdp_window_state_type() :: :fullscreen | :maximized | :minimized | :normal
The state of the browser window.
Link to this section Functions
close(session, parameters \\ %{}, options \\ [])
View Source
close(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
{:ok, map()} | {:error, term()}
close(GenServer.server(), map(), Tungsten.Connection.exec_options()) :: {:ok, map()} | {:error, term()}
Close browser gracefully.
crash(session, parameters \\ %{}, options \\ [])
View Source
crash(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
{:ok, map()} | {:error, term()}
crash(GenServer.server(), map(), Tungsten.Connection.exec_options()) :: {:ok, map()} | {:error, term()}
Crashes browser on the main thread.
crash_gpu_process(session, parameters \\ %{}, options \\ [])
View Source
crash_gpu_process(
GenServer.server(),
map(),
Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}
crash_gpu_process( GenServer.server(), map(), Tungsten.Connection.exec_options() ) :: {:ok, map()} | {:error, term()}
Crashes GPU process.
get_browser_command_line(session, parameters \\ %{}, options \\ [])
View Source
get_browser_command_line(
GenServer.server(),
map(),
Tungsten.Connection.exec_options()
) :: {:ok, %{arguments: [String.t()]}} | {:error, term()}
get_browser_command_line( GenServer.server(), map(), Tungsten.Connection.exec_options() ) :: {:ok, %{arguments: [String.t()]}} | {:error, term()}
Returns the command line switches for the browser process if, and only if --enable-automation is on the commandline.
get_histogram(session, parameters, options \\ [])
View Source
get_histogram(
GenServer.server(),
%{:name => String.t(), optional(:delta) => boolean()},
Tungsten.Connection.exec_options()
) :: {:ok, %{histogram: cdp_histogram_type()}} | {:error, term()}
get_histogram( GenServer.server(), %{:name => String.t(), optional(:delta) => boolean()}, Tungsten.Connection.exec_options() ) :: {:ok, %{histogram: cdp_histogram_type()}} | {:error, term()}
Get a Chrome histogram by name.
get_histograms(session, parameters \\ %{}, options \\ [])
View Source
get_histograms(
GenServer.server(),
%{optional(:query) => String.t(), optional(:delta) => boolean()},
Tungsten.Connection.exec_options()
) :: {:ok, %{histograms: [cdp_histogram_type()]}} | {:error, term()}
get_histograms( GenServer.server(), %{optional(:query) => String.t(), optional(:delta) => boolean()}, Tungsten.Connection.exec_options() ) :: {:ok, %{histograms: [cdp_histogram_type()]}} | {:error, term()}
Get Chrome histograms.
get_version(session, parameters \\ %{}, options \\ [])
View Source
get_version(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
{:ok,
%{
protocol_version: String.t(),
product: String.t(),
revision: String.t(),
user_agent: String.t(),
js_version: String.t()
}}
| {:error, term()}
get_version(GenServer.server(), map(), Tungsten.Connection.exec_options()) :: {:ok, %{ protocol_version: String.t(), product: String.t(), revision: String.t(), user_agent: String.t(), js_version: String.t() }} | {:error, term()}
Returns version information.
get_window_bounds(session, parameters, options \\ [])
View Source
get_window_bounds(
GenServer.server(),
%{window_id: cdp_window_id_type()},
Tungsten.Connection.exec_options()
) :: {:ok, %{bounds: cdp_bounds_type()}} | {:error, term()}
get_window_bounds( GenServer.server(), %{window_id: cdp_window_id_type()}, Tungsten.Connection.exec_options() ) :: {:ok, %{bounds: cdp_bounds_type()}} | {:error, term()}
Get position and size of the browser window.
get_window_for_target(session, parameters \\ %{}, options \\ [])
View Source
get_window_for_target(
GenServer.server(),
%{optional(:target_id) => Tungsten.CDP.Target.cdp_target_id_type()},
Tungsten.Connection.exec_options()
) ::
{:ok, %{window_id: cdp_window_id_type(), bounds: cdp_bounds_type()}}
| {:error, term()}
get_window_for_target( GenServer.server(), %{optional(:target_id) => Tungsten.CDP.Target.cdp_target_id_type()}, Tungsten.Connection.exec_options() ) :: {:ok, %{window_id: cdp_window_id_type(), bounds: cdp_bounds_type()}} | {:error, term()}
Get the browser window that contains the devtools target.
grant_permissions(session, parameters, options \\ [])
View Source
grant_permissions(
GenServer.server(),
%{
:origin => String.t(),
:permissions => [cdp_permission_type_type()],
optional(:browser_context_id) =>
Tungsten.CDP.Target.cdp_browser_context_id_type()
},
Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}
grant_permissions( GenServer.server(), %{ :origin => String.t(), :permissions => [cdp_permission_type_type()], optional(:browser_context_id) => Tungsten.CDP.Target.cdp_browser_context_id_type() }, Tungsten.Connection.exec_options() ) :: {:ok, map()} | {:error, term()}
Grant specific permissions to the given origin and reject all others.
reset_permissions(session, parameters \\ %{}, options \\ [])
View Source
reset_permissions(
GenServer.server(),
%{
optional(:browser_context_id) =>
Tungsten.CDP.Target.cdp_browser_context_id_type()
},
Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}
reset_permissions( GenServer.server(), %{ optional(:browser_context_id) => Tungsten.CDP.Target.cdp_browser_context_id_type() }, Tungsten.Connection.exec_options() ) :: {:ok, map()} | {:error, term()}
Reset all permission management for all origins.
set_dock_tile(session, parameters \\ %{}, options \\ [])
View Source
set_dock_tile(
GenServer.server(),
%{optional(:badge_label) => String.t(), optional(:image) => String.t()},
Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}
set_dock_tile( GenServer.server(), %{optional(:badge_label) => String.t(), optional(:image) => String.t()}, Tungsten.Connection.exec_options() ) :: {:ok, map()} | {:error, term()}
Set dock tile details, platform-specific.
set_window_bounds(session, parameters, options \\ [])
View Source
set_window_bounds(
GenServer.server(),
%{window_id: cdp_window_id_type(), bounds: cdp_bounds_type()},
Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}
set_window_bounds( GenServer.server(), %{window_id: cdp_window_id_type(), bounds: cdp_bounds_type()}, Tungsten.Connection.exec_options() ) :: {:ok, map()} | {:error, term()}
Set position and/or size of the browser window.