API Docs for: 0.0.6
Show:

File: lib/commands/marionette/page.js

  1. /*!
  2.  *
  3.  * Copyright (c) 2013 Sebastian Golasch
  4.  *
  5.  * Permission is hereby granted, free of charge, to any person obtaining a
  6.  * copy of this software and associated documentation files (the "Software"),
  7.  * to deal in the Software without restriction, including without limitation
  8.  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  9.  * and/or sell copies of the Software, and to permit persons to whom the
  10.  * Software is furnished to do so, subject to the following conditions:
  11.  *
  12.  * The above copyright notice and this permission notice shall be included
  13.  * in all copies or substantial portions of the Software.
  14.  *
  15.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16.  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17.  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  18.  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19.  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20.  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21.  * DEALINGS IN THE SOFTWARE.
  22.  *
  23.  */
  24.  
  25. 'use strict';
  26.  
  27. /**
  28.  * Page related Marionette commands
  29.  * see [JsonProtocol](https://wiki.mozilla.org/Auto-tools/Projects/Marionette/JSON_Protocol)
  30.  *
  31.  * @module FirefoxDriver
  32.  * @class Page
  33.  * @namespace FirefoxDriver.Commands.Marionette
  34.  */
  35.  
  36. module.exports = function (Marionette) {
  37.  
  38.   /**
  39.    * Get the current page source
  40.    *
  41.    * @method source
  42.    */
  43.  
  44.   Marionette.addCommand({
  45.     name: 'source',
  46.     request: {
  47.       to: ':marionetteId',
  48.       session: ':sessionId',
  49.       type: 'getPageSource'
  50.     }
  51.   });
  52.  
  53.   /**
  54.    * Get the current page title
  55.    *
  56.    * @method title
  57.    */
  58.  
  59.   Marionette.addCommand({
  60.     name: 'title',
  61.     request: {
  62.       to: ':marionetteId',
  63.       session: ':sessionId',
  64.       type: 'getTitle'
  65.     }
  66.   });
  67.  
  68.   /**
  69.    * Get the current geo location
  70.    *
  71.    * @method geoLocation
  72.    */
  73.  
  74.   Marionette.addCommand({
  75.     name: 'geoLocation',
  76.     implemented: false
  77.   });
  78.  
  79.   /**
  80.    * Set the geo location
  81.    *
  82.    * @method setGeoLocation
  83.    */
  84.  
  85.   Marionette.addCommand({
  86.     name: 'setGeoLocation',
  87.     implemented: false
  88.   });
  89.  
  90. };
  91.  
  92.