ContentCaptureManager

public final class ContentCaptureManager
extends Object

Content capture is mechanism used to let apps notify the Android system of events associated with views.

Before using this manager, you should check if it's available. Example:

  ContentCaptureManager mgr = context.getSystemService(ContentCaptureManager.class);
  if (mgr != null && mgr.isContentCaptureEnabled()) {
    // ...
  }
  

To support content capture, you must notifiy the Android system of the following events:

• When a visible view is laid out, call ContentCaptureSession#notifyViewAppeared(ViewStructure).
• When a view becomes invisible or is removed from the view hierarchy, call ContentCaptureSession#notifyViewDisappeared(android.view.autofill.AutofillId).
• When the view represents text and the text value changed, call ContentCaptureSession#notifyViewTextChanged(android.view.autofill.AutofillId, CharSequence).

You can get a blank content capture structure using ContentCaptureSession#newViewStructure(View), then populate its relevant fields. Here's an example of the relevant methods for an EditText-like view:

 public class MyEditText extends View {

 private void populateContentCaptureStructure(@NonNull ViewStructure structure) {
   structure.setText(getText(), getSelectionStart(), getSelectionEnd());
   structure.setHint(getHint());
   structure.setInputType(getInputType());
   // set other properties like setTextIdEntry(), setTextLines(), setTextStyle(),
   // setMinTextEms(), setMaxTextEms(), setMaxTextLength()
 }

 private void onTextChanged() {
   if (isLaidOut() && isTextEditable()) {
     ContentCaptureManager mgr = mContext.getSystemService(ContentCaptureManager.class);
     if (cm != null && cm.isContentCaptureEnabled()) {
        ContentCaptureSession session = getContentCaptureSession();
        if (session != null) {
          session.notifyViewTextChanged(getAutofillId(), getText());
        }
   }
 }
 

The main integration point with content capture is the ContentCaptureSession. A "main" session is automatically created by the Android system when content capture is enabled for the activity. The session could have a ContentCaptureContext to provide more contextual info about it, such as the locus associated with the view hierarchy (see LocusId for more info about locus). By default, the main session doesn't have a ContentCaptureContext, but you can change it after its created. Example:

 protected void onCreate(Bundle savedInstanceState) {
   // Initialize view structure
   ContentCaptureSession session = rootView.getContentCaptureSession();
   if (session != null) {
     session.setContentCaptureContext(ContentCaptureContext.forLocusId("chat_UserA_UserB"));
   }
 }
 

If your activity contains view hierarchies with a different contextual meaning, you should created child sessions for each view hierarchy root. For example, if your activity is a browser, you could use the main session for the main URL being rendered, then child sessions for each IFRAME:

 ContentCaptureSession mMainSession;

 protected void onCreate(Bundle savedInstanceState) {
    // Initialize view structure...
    mMainSession = rootView.getContentCaptureSession();
    if (mMainSession != null) {
      mMainSession.setContentCaptureContext(
          ContentCaptureContext.forLocusId("https://example.com"));
    }
 }

 private void loadIFrame(View iframeRootView, String url) {
   if (mMainSession != null) {
      ContentCaptureSession iFrameSession = mMainSession.newChild(
          ContentCaptureContext.forLocusId(url));
      }
      iframeRootView.setContentCaptureSession(iFrameSession);
   }
   // Load iframe...
 }
 

Summary

Public methods

public Set<ContentCaptureCondition> getContentCaptureConditions ()

public ComponentName getServiceComponentName ()

public boolean isContentCaptureEnabled ()

public void removeData (DataRemovalRequest request)

public void setContentCaptureEnabled (boolean enabled)