New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 843928 link

Starred by 3 users

Issue metadata

Status: Assigned
Owner:
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: Chrome
Pri: 2
Type: Feature
Launch-Privacy: NotReviewed
Launch-Security: NotReviewed
Launch-UI: NotReviewed



Sign in to add a comment

Extension API Modification: support extra data with chrome.automation.AutomationNode

Project Member Reported by yawano@chromium.org, May 17 2018

Issue description

Platform App API Modification Proposal

API Namespace: chrome.automation
API Owners: chromeos-a11y-eng@
The following documents may not be necessary depending on the scope of your proposal:
API Overview Doc: N/A
Design Doc: N/A
Supplementary Resources: Add AutomationNode.refreshWithExtraData. This is basically similar to AccessibilityNodeInfo.refreshWithExtraData in Android.

https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo.html#refreshWithExtraData(java.lang.String,%20android.os.Bundle)

idl file change would look like the following.

[FROM HERE - This is not the final]
automation.idl

enum RefreshWithExtraDataKey {
  // Refresh AutomationNode with extra data for |AutomationNode.boundsForRange|.
  // On some platform, those necessary data is not provided by default as it costs high.
  boundsForRange
}

// Called when |refreshWithExtraData| is succeeded or failed.
callback RefreshWithExtraDataCallback = void(boolean success);

... dictionary AutomationNode {
  ...
  // Refresh node with extra data for |key|.
  // This is used to prepare or get data which costs high.
  // |callback| is called once data is obtained or it has failed.
  void refreshWithExtraData(RefreshWithExtraDataKey key, RefreshWithExtraDataCallback callback);
  
  // Returns available extra data keys.
  // Available extra data keys can be different depending on source of AutomationNode.
  RefreshWithExtraDataKey getAvailableExtraDataKeys();
  ...
}
[TO HERE]

I want to first ask whether we need to write API overview doc and design doc for this modification. If necessary, I'm happy to write them. Thank you!
 

Comment 1 by yawano@chromium.org, May 22 2018

Owner: benwells@chromium.org
benwells@: PTAL. Do we need to write overview and design docs? While I've filed this as platform API modification, would this be extension API modification? https://developer.chrome.com/extensions/automation
Cc: benwells@chromium.org
Components: -Platform>Apps>API Platform>Extensions>API
Owner: rdevlin....@chromium.org
Status: Assigned (was: Untriaged)
Summary: Extension API Modification: support extra data with chrome.automation.AutomationNode (was: Platform App API Modification: support extra data with chrome.automation.AutomationNode)
Yes this should be an extension API modification. I've adjusted the bug accordingly and added the extensions TL. I'll leave it up to Devlin to decide if you need more information.

Comment 3 by yawano@chromium.org, May 25 2018

Cc: yawano@chromium.org
Thank you!

rdevlin.cronin@: ping. Do you need more information?
Cc: rdevlin....@chromium.org
Owner: yawano@chromium.org
For automation in particular, I'm comfortable deferring to dtseng, dmazzoni, and aboxhall, who own the API.  Since this is a private, well-established, internal API and this isn't a massive change, I don't think this requires a full doc.

It looks like dtseng@ is on this bug, so as long as he's comfortable with this, I think you're good to move forward.  Thank you for running this by us!
Owner: dtseng@chromium.org
Thank you!

dtseng@: While we've already talked about this at different place, are we good to go with this?
Lgtm on the addition of this binding.

Comment 7 by dtseng@chromium.org, Jun 15 2018

Owner: yawano@chromium.org
Owner: sarakato@chromium.org
Labels: -Launch-API-NotReviewed Launch-API-Yes
(Flipping API bit since dtseng lg'd)

Sign in to add a comment