class Marionette::Session

• Marionette::Session
• Reference
• Object

Included Modules

• Marionette::Logger

Defined in:

marionette/session.cr

Constant Summary

Log = ::Log.for("marionette.session")

Class Method Summary

• .start(driver : WebDriver, type : Type, capabilities = {} of String => String, service = nil)

  Start a new Session using the given #driver and #type.

Instance Method Summary

• #accept_alert

  Accept an active alert.

• #actions(&)

  Creates a new ActionBuilder instance and passes it to the block.

• #active_element

  Returns the element with focus, or the page Body if nothing has focus.

• #alert_text

  Returns the text of the active alert dialog.

• #alert_value=(value)

  Sets the text box content for alert dialogs that have one.

• #all_cookies

  Return all cookies collected so far as an Array(HTTP::Cookie).

• #back

  Go back in history.

• #capabilities : Hash(String, JSON::Any)
• #clear_actions

  Clears actions that are already stored on the remote end.

• #close

  Close the current session.

• #close_current_window

  Close the current Window.

• #close_window(window : Window)

  Close the given Window.

• #context

  Get the current browser context.

• #context=(context : String)

  Set the current browser context.

• #current_url

  Get the URL of the current page.

• #current_window

  Return the current Window.

• #debug

  Enable and attach the Safari debugger.

• #delete_all_cookies

  Delete all collected cookies

• #delete_cookie(name : String)

  Delete the cookie with the specified name.

• #dismiss_alert

  Dismiss an active alert.

• #driver : WebDriver
• #execute(command, params = {} of String => String)

  Execute an arbitrary command with the given permissions.

• #execute_cdp_command(cmd : String, args = {} of String => String)

  Execute a CDP (Chrome DevTools Protocol) command.

• #execute_script(script, args = nil)

  Execute arbitrary JavaScript in the context of the given document.

• #execute_script_async(script, args = nil)

  Execute arbitrary JavaScript in the context of the given document.

• #find_element(selector, strategy : LocationStrategy = :css)

  Find an element using the given selector.

• #find_element!(selector, strategy : LocationStrategy = :css)

  Find an element using the given selector.

• #find_element_child(element, selector, strategy : LocationStrategy = :css)

  Find a child of the given element.

• #find_element_child!(element, selector, strategy : LocationStrategy = :css)

  Find a child of the given element.

• #find_element_children(element, selector, strategy : LocationStrategy = :css)

  Find multiple children of the given element with the given selector and return them as an array.

• #find_elements(selector, strategy : LocationStrategy = :css)

  Find multiple elements with the given selector and return them as an array.

• #forward

  Go forward in history.

• #full_page_screenshot

  Takes a full screen screenshot and return it as a Base64 encoded PNG string.

• #get_cookie(cookie : HTTP::Cookie)

  Get a browser cookie using an HTTP::Cookie instance.

• #get_cookie(name : String)

  Get the cookie with the specified name.

• #id : String
• #implicit_wait(time : Time::Span)

  Add an implicit wait that will occur before calls are made in a newly opened page.

• #install_addon(path : String, temporary = false)

  Install an addon from the given path.

• #issue_message

  Get the issue message for the current cast context.

• #launch_app(app_id : String)

  Launch a Chrome app using its #id.

• #leave_frame

  Leave the current frame context and return to the default context.

• #local?

  Returns true if this is a local session.

• #log(log_type : String)
• #log_types
• #navigate(to url : String | URI)

  Go to the given URL.

• #network_conditions

  Return the set network conditions as a NetworkConditions object.

• #network_conditions=(conditions : NetworkConditions)

  Set the network conditions.

• #new_window(type : Window::Type = :window)

  Create a new Window.

• #orientation

  Get the orientation of the current driver.

• #orientation=(origination : Orientation)

  Set the orientation of the current driver.

• #page_load_timeout(time : Time::Span)

  Add a timeout for page loads.

• #page_source

  Return the source of the given page.

• #perform_actions(debug_mouse_move = false, &)

  Creates a new ActionBuilder instance and passes it to the block.

• #permissions

  Get the currently set Safari permisisons.

• #permissions=(perms : Hash(String, Bool))

  Set Safari permissions.

• #refresh

  Refresh the current page.

• #remote?

  Returns true if this is a remote session.

• #save_full_page_screenshot(path : String)

  Take a fullscreen screenshot and save it to the given path as a PNG image.

• #save_screenshot(path, element_id = nil, scroll = true)

  Take a screenshot and save it as a PNG at the given path.

• #script_timeout(time : Time::Span)

  Add a timeout for script execution.

• #service : Service | Nil
• #service=(service : Service | Nil)
• #service? : Service | Nil | Nil
• #set_permission(key : String, value : Bool)

  Set a single Safari permission.

• #sink=(sink_name : String)

  Set the current casting sink.

• #sinks

  Get a list of sinks for casting.

• #start_tab_mirroring(sink_name : String)

  Start mirroring the current tab using the given sink.

• #status

  Return the status of the current driver as a JSON object.

• #stop

  Stops the current session by closing it and then closing the WebDriver process.

• #stop_casting(sink_name : String)

  Stop casting to the current sink.

• #switch_to_frame(frame : Element)

  Switch the context to the given frame or iframe element.

• #switch_to_parent_frame

  Switch the context to the parent of the given frame or iframe element.

• #switch_to_window(handle : String)

  Switch to a given Window using its handle.

• #switch_to_window(window : Window)

  Switch to a given Window.

• #take_screenshot(element_id : String, scroll = true)

  Take a screenshot of the element with the given element_id.

• #take_screenshot

  Take a screenshot of the current visible portion of the screen.

• #title

  Return the title of the current page.

• #type : Type
• #uninstall_addon(id : String)

  Uninstall an addon using its #id.

• #w3c? : Bool
• #wait_for_element(selector : String, strategy : LocationStrategy = :css, timeout = 3.seconds, poll_time = 50.milliseconds, &)

  Wait the given amount of time for an element to be available.

• #wait_for_element(selector : String, strategy : LocationStrategy = :css, timeout = 3.seconds, poll_time = 50.milliseconds)

  Wait the given amount of time for an element to be available.

• #wait_for_elements(selector : String, strategy : LocationStrategy = :css, timeout = 3.seconds, poll_time = 50.milliseconds, &)

  Wait the given amount of time for elements to be available.

• #windows

  Return an array of all opened Windows.

Class Method Detail

Instance Method Detail