macaca.client

Class MacacaClient

java.lang.Object

macaca.client.MacacaClient

public class MacacaClient
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MacacaClient.GesturePinchType

Field Summary

Fields

Modifier and Type	Field and Description
MacacaDriver	contexts
Element	element
int	waitElementTimeInterval time interval between finding an element ,valid for waitForElement() function paired with waitElementTimeout, if waitElementTimeout = 1000 & waitElementTimeInterval = 200,it means we will find given element per 200ms,until 1000ms passed, which means we will find for 5 times
int	waitElementTimeout timeout for finding an element ,valid for waitForElement() function paired with waitElementTimeInterval, if waitElementTimeout = 1000 & waitElementTimeInterval = 200,it means we will find given element per 200ms,until 1000ms passed, which means we will find for 5 times

Constructor Summary

Constructors

Constructor and Description
MacacaClient()

Method Summary

Modifier and Type	Method and Description
MacacaClient	acceptAlert() Accepts the currently displayed alert dialog. Support: Android iOS
MacacaClient	alertKeys(java.lang.String keys) Sends keystrokes to a JavaScript prompt() dialog. Support: iOS
java.lang.String	alertText() Gets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog. Support: iOS
java.lang.String	allCookies() Returns all cookies associated with the address of the current browsing context’s active document.
MacacaClient	back() press back. Support: Android Web(WebView)
MacacaClient	clear() Deprecated.
MacacaClient	click() Deprecated.
MacacaClient	context(java.lang.String contextRef) Set the current context. Support: Android iOS
JSONArray	contexts() Get a list of the available contexts. Support: Android iOS
int	countOfElements(GetElementWay wayToFind, java.lang.String value) get count of elements when there exist multiple elements Support: Android iOS Web(WebView)
java.lang.String	currentContext() Get the current context. Support: Android iOS
void	deleteAllCookies() Allows deletion of all cookies associated with the active document’s address.
void	deleteCookie(java.lang.String cookieName) Delete either a single cookie by parameter name, or all the cookies associated with the active document’s address if name is undefined.
MacacaClient	dismissAlert() Dismisses the currently displayed alert dialog. Support: Android iOS
void	doubleTap(double x, double y) double tap by coordinate Support: Android iOS
void	drag(double fromX, double fromY, double toX, double toY, double duration) drag Support: Android iOS
Element	element(java.lang.String name, java.lang.String value) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByClassName() Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByClassName(java.lang.String className) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByCss(java.lang.String selector) Search for an element on the page, starting from the document root. Support: Web(WebView)
Element	elementById(java.lang.String elementId) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByLinkText(java.lang.String linkText) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByName(java.lang.String name) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByPartialLinkText(java.lang.String partialLinkText) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByTagName(java.lang.String tagName) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	elementByXPath(java.lang.String xpath) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByClassName(java.lang.String className) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByCss(java.lang.String css) Search for multiple elements on the page, starting from the document root. Support: Web(WebView)
java.util.List<Element>	elementsById(java.lang.String elementId) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByLinkText(java.lang.String linkText) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByName(java.lang.String name) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByPartialLinkText(java.lang.String partialLinkText) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByTagName(java.lang.String tagName) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
java.util.List<Element>	elementsByXPath(java.lang.String xpath) Search for multiple elements on the page, starting from the document root. Support: Android iOS Web(WebView)
JSONObject	execute(java.lang.String code) Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame. Support: Web(WebView)
void	forward() Navigate forwards in the browser history, if possible.
MacacaClient	frame(java.lang.String locator)
MacacaClient	get(java.lang.String tmpUrl) Navigate to a new URL. Support: Web(WebView)
Element	getElement(GetElementWay wayToFind, java.lang.String value) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	getElement(GetElementWay wayToFind, java.lang.String value, int index) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
java.lang.Object	getProperty(java.lang.String name) Deprecated.
java.lang.Object	getRect() Deprecated.
int	getWaitElementTimeInterval()
int	getWaitElementTimeout()
JSONObject	getWindowSize() Get the size of the specified window. Support: Android iOS Web(WebView)
MacacaClient	initDriver(JSONObject jsonObject) Initial webdriver client and create a session. Support: Android iOS Web(WebView)
boolean	isElementExist(GetElementWay wayToFind, java.lang.String value) check if target element exist Support: Android iOS Web(WebView)
boolean	isElementExist(GetElementWay wayToFind, java.lang.String value, int index) check if target element exist Support: Android iOS Web(WebView)
boolean	isElementExist(java.lang.String using, java.lang.String value) check if target element exist Support: Android iOS Web(WebView)
MacacaClient	keys(java.lang.String tmpkeys) Send a sequence of key strokes to the active window. Support: Android iOS Web(Webview)
MacacaClient	maximize() set maximize size of the window. Support: Web(WebView)
void	pinch(double x, double y, double scale, double velocity, MacacaClient.GesturePinchType direction, double percent, int steps) pinch Support: Android iOS
void	press(double x, double y, double duration) long press Support: Android iOS
void	quit() Delete session. Support: Android iOS Web(WebView)
void	rotate(double rotation, double velocity) rotate Support: iOS
MacacaClient	saveScreenshot(java.lang.String fileName) Save screenshot of the current page. Support: Android iOS Web(WebView)
MacacaClient	sendKeys(java.lang.String keys) Deprecated.
java.lang.String	sessionId() Get the current sessionId. Support: Android iOS Web(WebView)
void	setCookie(JSONObject jsonObject) Adds a single cookie to the cookie store associated with the active document’s address.
void	setWaitElementTimeInterval(int waitElementTimeInterval)
void	setWaitElementTimeout(int waitElementTimeout)
MacacaClient	setWindowSize(int width, int height) Change the size of the specified window. Support: Web(WebView)
MacacaClient	sleep(int ms) Set the amount of time the driver should wait. Support: Android iOS Web(WebView)
java.lang.String	source() Get the current page source. Support: Android iOS Web(WebView)
java.lang.String	status() Query the server's current status. Support: Android iOS Web(WebView)
MacacaClient	takeScreenshot() Take a screenshot of the current page. Support: Android iOS Web(WebView)
void	tap(double x, double y) tap by coordinate Support: Android iOS
java.lang.String	text() Deprecated.
java.lang.String	title() Get the current page title. Support: Web(WebView)
MacacaClient	touch(java.lang.String action, JSONObject args) Apply touch actions on devices.
java.lang.String	url() Retrieve the URL of the current page. Support: Web(WebView)
Element	waitForElement(GetElementWay wayToFind, java.lang.String value) find target element,if it doesn't exist,keep finding during given time (property:waitElementTimeout) Support: Android iOS Web(WebView)
Element	waitForElement(GetElementWay wayToFind, java.lang.String value, int index) find target element,if it doesn't exist,keep finding during given time (property:waitElementTimeout) Support: Android iOS Web(WebView)
Element	waitForElement(java.lang.String using, java.lang.String value) Search for element at specific interval during given time Support: Android iOS Web(WebView)
Element	waitForElement(java.lang.String using, java.lang.String value, int timeout, int interval) Search for element at specific interval during given time Support: Android iOS Web(WebView)
Element	waitForElementByCss(java.lang.String selector) Search for an element on the page, starting from the document root. Support: Web(WebView)
Element	waitForElementById(java.lang.String elementId) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	waitForElementByLinkText(java.lang.String text) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	waitForElementByName(java.lang.String name) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	waitForElementByPartialLinkText(java.lang.String text) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	waitForElementByTagName(java.lang.String tagname) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)
Element	waitForElementByXPath(java.lang.String xpath) Search for an element on the page, starting from the document root. Support: Android iOS Web(WebView)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

contexts

public MacacaDriver contexts

element

public Element element

waitElementTimeout

public int waitElementTimeout

timeout for finding an element ,valid for waitForElement() function paired with waitElementTimeInterval, if waitElementTimeout = 1000 & waitElementTimeInterval = 200,it means we will find given element per 200ms,until 1000ms passed, which means we will find for 5 times

waitElementTimeInterval

public int waitElementTimeInterval

time interval between finding an element ,valid for waitForElement() function paired with waitElementTimeout, if waitElementTimeout = 1000 & waitElementTimeInterval = 200,it means we will find given element per 200ms,until 1000ms passed, which means we will find for 5 times

Constructor Detail

MacacaClient

public MacacaClient()

Method Detail

getWaitElementTimeout

public int getWaitElementTimeout()

setWaitElementTimeout

public void setWaitElementTimeout(int waitElementTimeout)

getWaitElementTimeInterval

public int getWaitElementTimeInterval()

setWaitElementTimeInterval

public void setWaitElementTimeInterval(int waitElementTimeInterval)

acceptAlert

public MacacaClient acceptAlert()
                         throws java.lang.Exception

Accepts the currently displayed alert dialog.
Support: Android iOS

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

dismissAlert

public MacacaClient dismissAlert()
                          throws java.lang.Exception

Dismisses the currently displayed alert dialog.
Support: Android iOS

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

alertText

public java.lang.String alertText()
                           throws java.lang.Exception

Gets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog.
Support: iOS

Returns:

The text of the currently displayed alert.

Throws:

java.lang.Exception

alertKeys

public MacacaClient alertKeys(java.lang.String keys)
                       throws java.lang.Exception

Sends keystrokes to a JavaScript prompt() dialog.
Support: iOS

Parameters:

keys - Keystrokes to send to the prompt() dialog.

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

contexts

public JSONArray contexts()
                   throws java.lang.Exception

Get a list of the available contexts.
Support: Android iOS

Returns:

The currently available contexts

Throws:

java.lang.Exception

context

public MacacaClient context(java.lang.String contextRef)
                     throws java.lang.Exception

Set the current context.
Support: Android iOS

Parameters:

contextRef - context reference from contexts

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

currentContext

public java.lang.String currentContext()
                                throws java.lang.Exception

Get the current context.
Support: Android iOS

Returns:

The currently context

Throws:

java.lang.Exception

element

public Element element(java.lang.String name,
                       java.lang.String value)
                throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

name - The name attribute of element

value - the value for target element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

elementById

public Element elementById(java.lang.String elementId)
                    throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

elementId - The ID attribute of element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

elementByCss

public Element elementByCss(java.lang.String selector)
                     throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Web(WebView)

Parameters:

selector - The css selector of element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

elementByXPath

public Element elementByXPath(java.lang.String xpath)
                       throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

xpath - The XPath expression of element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

elementByName

public Element elementByName(java.lang.String name)
                      throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

name - The name attribute of element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

getElement

public Element getElement(GetElementWay wayToFind,
                          java.lang.String value,
                          int index)
                   throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

wayToFind - way to find an element

value - target value for element,paired with wayToFind

index - index for target element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

getElement

public Element getElement(GetElementWay wayToFind,
                          java.lang.String value)
                   throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

wayToFind - the way to find an element,for example:ID,CSS,XPATH...

value - the value for target element,paired with wayToFind

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

countOfElements

public int countOfElements(GetElementWay wayToFind,
                           java.lang.String value)
                    throws java.lang.Exception

get count of elements when there exist multiple elements
Support: Android iOS Web(WebView)

Parameters:

wayToFind - the way to find an element,for example:ID,CSS,XPATH...

value - the value for target element,paired with wayToFind

Returns:

count of target element

Throws:

java.lang.Exception

waitForElement

public Element waitForElement(GetElementWay wayToFind,
                              java.lang.String value,
                              int index)
                       throws java.lang.Exception

find target element,if it doesn't exist,keep finding during given time (property:waitElementTimeout)
Support: Android iOS Web(WebView)

Parameters:

wayToFind - the way to find an element,for example:ID,CSS,XPATH...

value - the value for target element,paired with wayToFind

index - the index for target element

Returns:

return the element to find if it exists,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElement

public Element waitForElement(GetElementWay wayToFind,
                              java.lang.String value)
                       throws java.lang.Exception

find target element,if it doesn't exist,keep finding during given time (property:waitElementTimeout)
Support: Android iOS Web(WebView)

Parameters:

wayToFind - the way to find an element,for example:ID,CSS,XPATH...

value - the value for target element,paired with wayToFind

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementByClassName

public Element elementByClassName()
                           throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementByClassName

public Element elementByClassName(java.lang.String className)
                           throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

className - The className attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementByLinkText

public Element elementByLinkText(java.lang.String linkText)
                          throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

linkText - The linkText attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementByTagName

public Element elementByTagName(java.lang.String tagName)
                         throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

tagName - The tag name attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementByPartialLinkText

public Element elementByPartialLinkText(java.lang.String partialLinkText)
                                 throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

partialLinkText - The partial link text attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

elementsByXPath

public java.util.List<Element> elementsByXPath(java.lang.String xpath)
                                        throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

xpath - The XPath expression of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsByName

public java.util.List<Element> elementsByName(java.lang.String name)
                                       throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

name - The name attribute of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsById

public java.util.List<Element> elementsById(java.lang.String elementId)
                                     throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

elementId - The elementId attribute of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsByClassName

public java.util.List<Element> elementsByClassName(java.lang.String className)
                                            throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

className - The className attribute of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsByCss

public java.util.List<Element> elementsByCss(java.lang.String css)
                                      throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Web(WebView)

Parameters:

css - The selector selector of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsByLinkText

public java.util.List<Element> elementsByLinkText(java.lang.String linkText)
                                           throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

linkText - The link text attribute of elements

Returns:

List elements contains elements

Throws:

java.lang.Exception

elementsByPartialLinkText

public java.util.List<Element> elementsByPartialLinkText(java.lang.String partialLinkText)
                                                  throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

partialLinkText - The partial link text attribute of elements

Returns:

List elements

Throws:

java.lang.Exception

elementsByTagName

public java.util.List<Element> elementsByTagName(java.lang.String tagName)
                                          throws java.lang.Exception

Search for multiple elements on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

tagName - The tag name attribute of elements

Returns:

List elements

Throws:

java.lang.Exception

waitForElement

public Element waitForElement(java.lang.String using,
                              java.lang.String value,
                              int timeout,
                              int interval)
                       throws java.lang.Exception

Search for element at specific interval during given time
Support: Android iOS Web(WebView)

Parameters:

using - The way for find an element,eg:"name","xpath","css","id"

value - The value for the specific way

timeout - Total time for searching

interval - Time interval between searching

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElement

public Element waitForElement(java.lang.String using,
                              java.lang.String value)
                       throws java.lang.Exception

Search for element at specific interval during given time
Support: Android iOS Web(WebView)

Parameters:

using - The way for find an element,eg:"name","xpath","css","id"

value - The value for the specific way

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementById

public Element waitForElementById(java.lang.String elementId)
                           throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

elementId - The ID attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementByCss

public Element waitForElementByCss(java.lang.String selector)
                            throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Web(WebView)

Parameters:

selector - The css selector of element

Throws:

java.lang.Exception

waitForElementByXPath

public Element waitForElementByXPath(java.lang.String xpath)
                              throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

xpath - The XPath expression of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementByTagName

public Element waitForElementByTagName(java.lang.String tagname)
                                throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

tagname - The tagname expression of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementByName

public Element waitForElementByName(java.lang.String name)
                             throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

name - The name attribute of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementByLinkText

public Element waitForElementByLinkText(java.lang.String text)
                                 throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

text - The visible text of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

waitForElementByPartialLinkText

public Element waitForElementByPartialLinkText(java.lang.String text)
                                        throws java.lang.Exception

Search for an element on the page, starting from the document root.
Support: Android iOS Web(WebView)

Parameters:

text - The visible text of element

Returns:

return the element to find if it exist,if it does not exist ,return null

Throws:

java.lang.Exception

isElementExist

public boolean isElementExist(java.lang.String using,
                              java.lang.String value)
                       throws java.lang.Exception

check if target element exist
Support: Android iOS Web(WebView)

Parameters:

using - The way for find an element,eg:"name","xpath","css","id"

value - The value for the specific way

Returns:

true-exist ; false-do not exist

Throws:

java.lang.Exception

isElementExist

public boolean isElementExist(GetElementWay wayToFind,
                              java.lang.String value,
                              int index)
                       throws java.lang.Exception

check if target element exist
Support: Android iOS Web(WebView)

Parameters:

wayToFind - The way to find an element

value - The value for the specific way

index - The index of the target element

Returns:

Throws:

java.lang.Exception

isElementExist

public boolean isElementExist(GetElementWay wayToFind,
                              java.lang.String value)
                       throws java.lang.Exception

check if target element exist
Support: Android iOS Web(WebView)

Parameters:

wayToFind - The way to find an element

value - The value for the specific way

Returns:

boolean exist-true ; not exist-false

Throws:

java.lang.Exception

sendKeys

@Deprecated
public MacacaClient sendKeys(java.lang.String keys)
                                  throws java.lang.Exception

Deprecated.

Send a sequence of key strokes to the active element.
Support: Android iOS Web(WebView)

Parameters:

keys - The keys sequence to be sent.

Returns:

The currently instance of MacacaClient attention: if the textfiled has text already,you need clear it then sendkeys

Throws:

java.lang.Exception

click

@Deprecated
public MacacaClient click()
                               throws java.lang.Exception

Deprecated.

Click on an element.
Support: Android iOS Web(WebView)

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

clear

@Deprecated
public MacacaClient clear()
                               throws java.lang.Exception

Deprecated.

clear on an element.
Support: Android iOS Web(WebView)

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

back

public MacacaClient back()
                  throws java.lang.Exception

press back.
Support: Android Web(WebView)

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

getProperty

@Deprecated
public java.lang.Object getProperty(java.lang.String name)
                                         throws java.lang.Exception

Deprecated.

Get the result of a property of a element.
Support: Android iOS Web(WebView). iOS: 'isVisible', 'label', 'value', Android: 'selected', 'description', 'text'

Parameters:

name - The property name of element

Returns:

The property

Throws:

java.lang.Exception

getRect

@Deprecated
public java.lang.Object getRect()
                                     throws java.lang.Exception

Deprecated.

Get the dimensions and coordinates of the given element with a object including x/y/height/width.
Support: Android iOS

Returns:

The rect of element

Throws:

java.lang.Exception

execute

public JSONObject execute(java.lang.String code)
                   throws java.lang.Exception

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame.
Support: Web(WebView)

Parameters:

code - The script to execute

Returns:

The results of execution

Throws:

java.lang.Exception

keys

public MacacaClient keys(java.lang.String tmpkeys)
                  throws java.lang.Exception

Send a sequence of key strokes to the active window.
Support: Android iOS Web(Webview)

Parameters:

tmpkeys - The keys sequence to be sent.

Returns:

The currently instance of MacacaClient more info refer : https://github.com/alibaba/macaca/issues/487

Throws:

java.lang.Exception

takeScreenshot

public MacacaClient takeScreenshot()
                            throws java.lang.Exception

Take a screenshot of the current page.
Support: Android iOS Web(WebView)

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

saveScreenshot

public MacacaClient saveScreenshot(java.lang.String fileName)
                            throws java.lang.Exception

Save screenshot of the current page.
Support: Android iOS Web(WebView)

Parameters:

fileName - The absolute path of the image filename

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

initDriver

public MacacaClient initDriver(JSONObject jsonObject)
                        throws java.lang.Exception

Initial webdriver client and create a session.
Support: Android iOS Web(WebView)

Parameters:

jsonObject - The capabilities of session more params

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

sessionId

public java.lang.String sessionId()
                           throws java.lang.Exception

Get the current sessionId.
Support: Android iOS Web(WebView)

Returns:

The current sessionId.

Throws:

java.lang.Exception

quit

public void quit()
          throws java.lang.Exception

Delete session.
Support: Android iOS Web(WebView)

Throws:

java.lang.Exception

source

public java.lang.String source()
                        throws java.lang.Exception

Get the current page source.
Support: Android iOS Web(WebView)

Returns:

The current page source.

Throws:

java.lang.Exception

status

public java.lang.String status()
                        throws java.lang.Exception

Query the server's current status.
Support: Android iOS Web(WebView)

Throws:

java.lang.Exception

sleep

public MacacaClient sleep(int ms)
                   throws java.lang.Exception

Set the amount of time the driver should wait.
Support: Android iOS Web(WebView)

Parameters:

ms - The amount of sleep time, in milliseconds. This value has a lower bound of 0.

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

title

public java.lang.String title()
                       throws java.lang.Exception

Get the current page title.
Support: Web(WebView)

Returns:

The current page title.

Throws:

java.lang.Exception

url

public java.lang.String url()
                     throws java.lang.Exception

Retrieve the URL of the current page.
Support: Web(WebView)

Returns:

The current URL.

Throws:

java.lang.Exception

get

public MacacaClient get(java.lang.String tmpUrl)
                 throws java.lang.Exception

Navigate to a new URL.
Support: Web(WebView)

Parameters:

tmpUrl -

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

getWindowSize

public JSONObject getWindowSize()
                         throws java.lang.Exception

Get the size of the specified window.
Support: Android iOS Web(WebView)

Returns:

{width: number, height: number} The size of the window.

Throws:

java.lang.Exception

setWindowSize

public MacacaClient setWindowSize(int width,
                                  int height)
                           throws java.lang.Exception

Change the size of the specified window.
Support: Web(WebView)

Parameters:

width - The new window width.

height - The new window height.

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

maximize

public MacacaClient maximize()
                      throws java.lang.Exception

set maximize size of the window.
Support: Web(WebView)

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

frame

public MacacaClient frame(java.lang.String locator)
                   throws java.lang.Exception

Parameters:

locator - id, name, or xpath

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

text

@Deprecated
public java.lang.String text()
                                  throws java.lang.Exception

Deprecated.

Get text of the element
Support: Android iOS Web(WebView)

Returns:

The text of the element

Throws:

java.lang.Exception

touch

public MacacaClient touch(java.lang.String action,
                          JSONObject args)
                   throws java.lang.Exception

Apply touch actions on devices.
Support: Support: Android iOS

Parameters:

action - touch actions, such as, tap/doubleTap/press/pinch/rotate/drag , if you want to operate specific action,there is the same name API in this doc,like tap(x,y)

args - Parameters of the action:https://github.com/alibaba/macaca/issues/366

Returns:

The currently instance of MacacaClient

Throws:

java.lang.Exception

tap

public void tap(double x,
                double y)
         throws java.lang.Exception

tap by coordinate Support: Android iOS

Parameters:

x - coordinate - x

y - coordinate - y

Throws:

java.lang.Exception

doubleTap

public void doubleTap(double x,
                      double y)
               throws java.lang.Exception

double tap by coordinate Support: Android iOS

Parameters:

x - coordinate - x

y - coordinate - y

Throws:

java.lang.Exception

press

public void press(double x,
                  double y,
                  double duration)
           throws java.lang.Exception

long press Support: Android iOS

Parameters:

x - coordinate - x

y - coordinate - y

duration - time to press(valid for iOS and Android,time-unit:s)

Throws:

java.lang.Exception

pinch

public void pinch(double x,
                  double y,
                  double scale,
                  double velocity,
                  MacacaClient.GesturePinchType direction,
                  double percent,
                  int steps)
           throws java.lang.Exception

pinch Support: Android iOS

Parameters:

x - coordinate -x

y - coordinate -y

scale - valid for iOS, GesturePinchType.PINCH_IN: scale < 1;GesturePinchType.PINCH_OUT:scale > 1

velocity - valid for iOS

direction - GesturePinchType.PINCH_IN，GesturePinchType.PINCH_OUT

percent - valid for Android, percent to pinch

steps - valid for Android, unit for andriod pinch

Throws:

java.lang.Exception

rotate

public void rotate(double rotation,
                   double velocity)
            throws java.lang.Exception

rotate Support: iOS

Parameters:

rotation - 旋转弧度

velocity - 旋转速率

Throws:

java.lang.Exception

drag

public void drag(double fromX,
                 double fromY,
                 double toX,
                 double toY,
                 double duration)
          throws java.lang.Exception

drag Support: Android iOS

Parameters:

fromX - drag start x-coordinate

fromY - drag start y-coordinate

toX - drag end x-coordinate

toY - drag end y-coordinate

duration - drag duration (valid for iOS and Android,time-unit:s)

Throws:

java.lang.Exception

allCookies

public java.lang.String allCookies()
                            throws java.lang.Exception

Returns all cookies associated with the address of the current browsing context’s active document.

Returns:

String

Throws:

java.lang.Exception

setCookie

public void setCookie(JSONObject jsonObject)
               throws java.lang.Exception

Adds a single cookie to the cookie store associated with the active document’s address. {url: 'https://macacajs.github.io', name:'foo', value:'bar'} Optional cookie fields: secure, expiry

Parameters:

jsonObject -

Throws:

java.lang.Exception

deleteCookie

public void deleteCookie(java.lang.String cookieName)
                  throws java.lang.Exception

Delete either a single cookie by parameter name, or all the cookies associated with the active document’s address if name is undefined.

Parameters:

cookieName - cookie name to delete

Throws:

java.lang.Exception

deleteAllCookies

public void deleteAllCookies()
                      throws java.lang.Exception

Allows deletion of all cookies associated with the active document’s address.

Throws:

java.lang.Exception

forward

public void forward()
             throws java.lang.Exception

Navigate forwards in the browser history, if possible.

Throws:

java.lang.Exception