testing/marionette/client/docs/index.rst@b8a032363ba2 (annotated)
testing/marionette/client/docs/index.rst
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | .. Marionette Python Client documentation master file, created by |
| michael@0 | 2 | sphinx-quickstart on Tue Aug 6 13:54:46 2013. |
| michael@0 | 3 | You can adapt this file completely to your liking, but it should at least |
| michael@0 | 4 | contain the root `toctree` directive. |
| michael@0 | 5 | |
| michael@0 | 6 | Marionette Python Client |
| michael@0 | 7 | ======================== |
| michael@0 | 8 | |
| michael@0 | 9 | The Marionette python client library allows you to remotely control a |
| michael@0 | 10 | Gecko-based browser or device which is running a Marionette_ |
| michael@0 | 11 | server. |
| michael@0 | 12 | |
| michael@0 | 13 | .. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette |
| michael@0 | 14 | |
| michael@0 | 15 | You can install this library from pypi. The package name is |
| michael@0 | 16 | marionette_client_. |
| michael@0 | 17 | |
| michael@0 | 18 | .. _marionette_client: https://pypi.python.org/pypi/marionette_client |
| michael@0 | 19 | |
| michael@0 | 20 | .. automodule:: marionette |
| michael@0 | 21 | |
| michael@0 | 22 | Marionette Objects |
| michael@0 | 23 | ------------------ |
| michael@0 | 24 | .. autoclass:: Marionette |
| michael@0 | 25 | |
| michael@0 | 26 | Session Management |
| michael@0 | 27 | `````````````````` |
| michael@0 | 28 | .. automethod:: Marionette.start_session |
| michael@0 | 29 | .. autoattribute:: Marionette.session_capabilities |
| michael@0 | 30 | .. automethod:: Marionette.get_cookie |
| michael@0 | 31 | .. automethod:: Marionette.get_cookies |
| michael@0 | 32 | .. automethod:: Marionette.add_cookie |
| michael@0 | 33 | .. automethod:: Marionette.delete_all_cookies |
| michael@0 | 34 | |
| michael@0 | 35 | Context Management |
| michael@0 | 36 | `````````````````` |
| michael@0 | 37 | .. autoattribute:: Marionette.current_window_handle |
| michael@0 | 38 | .. autoattribute:: Marionette.window_handles |
| michael@0 | 39 | .. automethod:: Marionette.set_context |
| michael@0 | 40 | .. automethod:: Marionette.switch_to_frame |
| michael@0 | 41 | .. automethod:: Marionette.switch_to_window |
| michael@0 | 42 | .. automethod:: Marionette.get_active_frame |
| michael@0 | 43 | .. automethod:: Marionette.close |
| michael@0 | 44 | |
| michael@0 | 45 | Navigation Methods |
| michael@0 | 46 | `````````````````` |
| michael@0 | 47 | .. autoattribute:: Marionette.title |
| michael@0 | 48 | .. automethod:: Marionette.navigate |
| michael@0 | 49 | .. automethod:: Marionette.get_url |
| michael@0 | 50 | .. automethod:: Marionette.go_back |
| michael@0 | 51 | .. automethod:: Marionette.go_forward |
| michael@0 | 52 | .. automethod:: Marionette.refresh |
| michael@0 | 53 | .. automethod:: Marionette.absolute_url |
| michael@0 | 54 | .. automethod:: Marionette.get_window_type |
| michael@0 | 55 | |
| michael@0 | 56 | DOM Element Methods |
| michael@0 | 57 | ``````````````````` |
| michael@0 | 58 | .. automethod:: Marionette.set_search_timeout |
| michael@0 | 59 | .. automethod:: Marionette.find_element |
| michael@0 | 60 | .. automethod:: Marionette.find_elements |
| michael@0 | 61 | |
| michael@0 | 62 | Script Execution |
| michael@0 | 63 | ```````````````` |
| michael@0 | 64 | .. automethod:: Marionette.execute_script |
| michael@0 | 65 | .. automethod:: Marionette.execute_async_script |
| michael@0 | 66 | .. automethod:: Marionette.set_script_timeout |
| michael@0 | 67 | |
| michael@0 | 68 | Debugging |
| michael@0 | 69 | ````````` |
| michael@0 | 70 | .. autoattribute:: Marionette.page_source |
| michael@0 | 71 | .. automethod:: Marionette.log |
| michael@0 | 72 | .. automethod:: Marionette.get_logs |
| michael@0 | 73 | .. automethod:: Marionette.screenshot |
| michael@0 | 74 | |
| michael@0 | 75 | Querying and Modifying Document Content |
| michael@0 | 76 | --------------------------------------- |
| michael@0 | 77 | .. autoclass:: HTMLElement |
| michael@0 | 78 | |
| michael@0 | 79 | .. autoattribute:: HTMLElement.text |
| michael@0 | 80 | .. autoattribute:: HTMLElement.location |
| michael@0 | 81 | .. autoattribute:: HTMLElement.size |
| michael@0 | 82 | .. autoattribute:: HTMLElement.tag_name |
| michael@0 | 83 | .. automethod:: HTMLElement.send_keys |
| michael@0 | 84 | .. automethod:: HTMLElement.clear |
| michael@0 | 85 | .. automethod:: HTMLElement.click |
| michael@0 | 86 | .. automethod:: HTMLElement.is_selected |
| michael@0 | 87 | .. automethod:: HTMLElement.is_enabled |
| michael@0 | 88 | .. automethod:: HTMLElement.is_displayed |
| michael@0 | 89 | .. automethod:: HTMLElement.value_of_css_property |
| michael@0 | 90 | |
| michael@0 | 91 | .. autoclass:: DateTimeValue |
| michael@0 | 92 | |
| michael@0 | 93 | .. autoattribute:: DateTimeValue.date |
| michael@0 | 94 | .. autoattribute:: DateTimeValue.time |
| michael@0 | 95 | |
| michael@0 | 96 | Action Objects |
| michael@0 | 97 | -------------- |
| michael@0 | 98 | |
| michael@0 | 99 | Action Sequences |
| michael@0 | 100 | ```````````````` |
| michael@0 | 101 | .. autoclass:: Actions |
| michael@0 | 102 | |
| michael@0 | 103 | .. automethod:: Actions.press |
| michael@0 | 104 | .. automethod:: Actions.release |
| michael@0 | 105 | .. automethod:: Actions.move |
| michael@0 | 106 | .. automethod:: Actions.move_by_offset |
| michael@0 | 107 | .. automethod:: Actions.wait |
| michael@0 | 108 | .. automethod:: Actions.cancel |
| michael@0 | 109 | .. automethod:: Actions.long_press |
| michael@0 | 110 | .. automethod:: Actions.flick |
| michael@0 | 111 | .. automethod:: Actions.tap |
| michael@0 | 112 | .. automethod:: Actions.double_tap |
| michael@0 | 113 | .. automethod:: Actions.perform |
| michael@0 | 114 | |
| michael@0 | 115 | Multi-action Sequences |
| michael@0 | 116 | `````````````````````` |
| michael@0 | 117 | .. autoclass:: MultiActions |
| michael@0 | 118 | |
| michael@0 | 119 | .. automethod:: MultiActions.add |
| michael@0 | 120 | .. automethod:: MultiActions.perform |
| michael@0 | 121 | |
| michael@0 | 122 | |
| michael@0 | 123 | Indices and tables |
| michael@0 | 124 | ================== |
| michael@0 | 125 | |
| michael@0 | 126 | * :ref:`genindex` |
| michael@0 | 127 | * :ref:`modindex` |
| michael@0 | 128 | * :ref:`search` |
| michael@0 | 129 |
