Skip to content

Commit

Permalink
[rb] add yardoc details for new driver extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
titusfortner committed Sep 24, 2021
1 parent fc05f3a commit 20b5cdb
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
30 changes: 30 additions & 0 deletions rb/lib/selenium/webdriver/common/driver_extensions/has_casting.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 20b5cdb

Please sign in to comment.