From 20b5cdb70d685c87b78e98acfafd140f2b106f4d Mon Sep 17 00:00:00 2001 From: titusfortner Date: Fri, 24 Sep 2021 10:54:52 -0500 Subject: [PATCH] [rb] add yardoc details for new driver extensions --- .../common/driver_extensions/has_casting.rb | 30 +++++++++++++++++++ .../common/driver_extensions/has_launching.rb | 6 ++++ 2 files changed, 36 insertions(+) diff --git a/rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb b/rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb index 4d1198a9c8b14..e4038d23f756f 100644 --- a/rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb +++ b/rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb @@ -22,22 +22,52 @@ module WebDriver module DriverExtensions module HasCasting + # + # What devices ("sinks") are available to be cast to. + # + # @return [Array] list of sinks available for casting with id and name values + # + def cast_sinks @bridge.cast_sinks end + # + # Sets a specific sink, using its name, as a Cast session receiver target. + # + # @param [String] name the sink to use as the target + # + def cast_sink_to_use=(name) @bridge.cast_sink_to_use = name end + # + # Starts a tab mirroring session on a specific receiver target. + # + # @param [String] name the sink to use as the target + # + def start_cast_tab_mirroring(name) @bridge.start_cast_tab_mirroring(name) end + # + # Gets error messages when there is any issue in a Cast session. + # + # @return [String] the error message + # + def cast_issue_message @bridge.cast_issue_message end + # + # Stops the existing Cast session on a specific receiver target. + # + # @param [String] name the sink to stop the Cast session + # + def stop_casting(name) @bridge.stop_casting(name) end diff --git a/rb/lib/selenium/webdriver/common/driver_extensions/has_launching.rb b/rb/lib/selenium/webdriver/common/driver_extensions/has_launching.rb index 9de796e0b872f..caff919168e4d 100644 --- a/rb/lib/selenium/webdriver/common/driver_extensions/has_launching.rb +++ b/rb/lib/selenium/webdriver/common/driver_extensions/has_launching.rb @@ -22,6 +22,12 @@ module WebDriver module DriverExtensions module HasLaunching + # + # Launches Chromium app specified by id. + # + # @param [String] id + # + def launch_app(id) @bridge.launch_app(id) end