Java-client updates

jonahss · September 10, 2014, 10:13pm

Just released v1.7.0

IMPORTANT CHANGE: The scrollTo() and scrollToExact() methods have been removed because they used the ComplexFind method, which is no longer part of appium. I wanted to release this update because new methods for appium that people want to use.

We will definitely re-add the scrolling methods, but first we have to implement another change:

PLANNED CHANGE TO JAVA-CLIENT: Some commands only work on iOS while others only work on Android. This is confusing and not well documented. We’re planning on making two new classes AndroidDriver and IOSDriver which will inherit from AppiumDriver. You can discuss your opinion of the change in this topic, or on github

Here’s rest of the changelog for the new release:

Removed scrollTo() and scrollToExact() methods because they relied on complexFind(). They will be added back in the next version!
Removed complexFind()
Added startActivity() method
Added isLocked() method
Added getSettings() and ignoreUnimportantViews() methods

RamS · September 11, 2014, 4:39am

Thanks for this update @Jonahss.
As you already mentioned scrollTo() is very useful utility and hope to have it integrated back with more stability very soon.

One observation I had this morning is - The formatting in the Javadoc @ http://appium.github.io/java-client/index.html?overview-summary.html is broken and making it little hard to use the documentation.

Neto18 · September 11, 2014, 5:00pm

Thanks for the info!

What will be the options to scroll to an specific element?

Also, is there any news about the swipe method?

jonahss · September 11, 2014, 5:37pm

@Neto18 are you referring to this issue: https://github.com/appium/java-client/issues/41 ?

What options would you like for scrollTo methods? Feel free to file a github issue on the project and we can discuss the implementation.

jonahss · September 11, 2014, 5:40pm

I’ll fix the javadoc. Not sure what happened there.

ScrollTo will definitely be back as soon as we do the refactor which splits it into two separate clients.

If you use scrollTo, you can just stay on the previous version, since the only additions are the commands mentioned above.

jonahss · September 11, 2014, 5:57pm

@RamS Javadoc fixed.

RamS · September 12, 2014, 11:37am

Thanks @jonahss … Its very neat now.

It will be great if the documentation is more descriptive. Currently I feel its very abstract.

As in the example below, its difficult to understand values “using” will take. If some explanation saying, String value having UISelector data will help.

public org.openqa.selenium.WebElement findElementByAndroidUIAutomator(String using)
Specified by:
findElementByAndroidUIAutomator in interface FindsByAndroidUIAutomator

saimadhu · September 12, 2014, 11:55am

i am trying to understand new APIs. From java doc, i am not getting clear info.
what is the usecase for these apis:
startactivity(), getSettings() and ignoreUnimportantViews().

jonahss · September 23, 2014, 10:47pm

Pull requests for documentation welcome!
The thing is, we usually add documentation to the main Appium project, and the clients aren’t documented as much. Maybe I’ll provide links there?

jonahss · September 23, 2014, 10:49pm

startActivity() - Used for starting a specific Android activity, with a specified intent.

getSettings() and ignoreUnimportantViews(): https://github.com/appium/appium/blob/master/docs%2Fen%2Fadvanced-concepts%2Fsettings.md

Jeffrey_Blaze · October 6, 2014, 8:11pm

scrollToBottom and scrollToTop (of table).

sanjit1walia · October 7, 2014, 6:17am

ScollTo(By id & xpath)

Jeffrey_Blaze · October 7, 2014, 6:14pm

Doesn’t work for me. It involves specifying an element that is not visible, which triggers an exception, which halts the tests and closes the simulator:

error: Unhandled error: TypeError: Cannot read property ‘status’ of undefined
at null. (/usr/local/share/npm/lib/node_modules/appium/lib/devices/ios/ios-controller.js:169:19)
at Object.cb [as callback] (/usr/local/share/npm/lib/node_modules/appium/lib/devices/ios/ios-controller.js:239:5)
at next (/usr/local/share/npm/lib/node_modules/appium/node_modules/async/lib/async.js:801:43)
at /usr/local/share/npm/lib/node_modules/appium/node_modules/async/lib/async.js:32:16
at null. (/usr/local/share/npm/lib/node_modules/appium/lib/devices/ios/ios.js:1273:36)
at Object.q.process [as _onImmediate] (/usr/local/share/npm/lib/node_modules/appium/node_modules/async/lib/async.js:809:21)

Neto18 · October 17, 2014, 9:33pm

Related to the ScrollTo, I was trying to use that as a work-around for Swipe, but it won’t work for me because I’m trying to swipe on a slider. I’ll need and option to trace all the way from one point to the other. Probably ScrollTo won’t work for that.

jonahss · October 17, 2014, 10:26pm

Those exist @Neto18. You can draw touch actions which follow a path drawn between arbitrary points. Check out this image appium drew on a multi-touch paint program

Neto18 · October 18, 2014, 3:00am

@jonahss I need that!
Is it part of the Appium/WebDriver lib?
could you please give me some extra info related to that?

pr4bh4sh · October 20, 2014, 6:59am

I think this is what you are looking for

github.com

Jonahss/appium-draws-its-logo/blob/master/main.js

var wd = require('wd');
var path = require('path');
var TouchAction = require('wd').TouchAction;
var MultiAction = require('wd').MultiAction;
var webviewApp = path.resolve(require.resolve('multi-touch-draw-app'), '..', require('multi-touch-draw-app')[1]);

var driver = wd.remote('localhost', 4723);
var pi = Math.PI;

var caps = {
  platformName: 'iOS',
  platformVersion: '8.4',
  deviceName: 'iPhone 6',
  app: webviewApp
}

var drawLine =function(x1, y1, x2, y2){
  var line = (new TouchAction(driver))
    .press({x:x1,y:y1})
    .moveTo({x:x2, y:y2})

This file has been truncated. show original

jonahss · October 21, 2014, 9:25pm

Yup. http://github.com/jonahss/appium-draws-its-logo I apologize in advance for the messy code

sanjit1walia · November 3, 2014, 7:39am

What is the roadmap for java-client ??

jonahss · November 3, 2014, 6:55pm

The roadmap right now is we will do another release as soon as this issue is resolved: https://github.com/appium/appium/issues/3960

Do you need it to be released sooner?

Are there features you need/want or bugs which are blocking you?