blob: 2e6c47450abe433679edd47e1de5cb1b5d0c999a [file] [log] [blame]
Tony Mak12fe4092018-07-26 15:08:53 +01001package androidx.textclassifier {
2
Tony Mak12fe4092018-07-26 15:08:53 +01003 public final class TextClassification {
4 method public static androidx.textclassifier.TextClassification createFromBundle(android.os.Bundle);
5 method public java.util.List<androidx.core.app.RemoteActionCompat> getActions();
Jeff Gaston3cf783a2018-09-20 16:16:48 -04006 method public float getConfidenceScore(java.lang.String);
7 method public java.lang.String getEntityType(int);
8 method public int getEntityTypeCount();
9 method public java.lang.String getId();
10 method public java.lang.CharSequence getText();
Tony Mak12fe4092018-07-26 15:08:53 +010011 method public android.os.Bundle toBundle();
12 }
13
14 public static final class TextClassification.Builder {
15 ctor public TextClassification.Builder();
16 method public androidx.textclassifier.TextClassification.Builder addAction(androidx.core.app.RemoteActionCompat);
17 method public androidx.textclassifier.TextClassification build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040018 method public androidx.textclassifier.TextClassification.Builder setEntityType(java.lang.String, float);
19 method public androidx.textclassifier.TextClassification.Builder setId(java.lang.String);
20 method public androidx.textclassifier.TextClassification.Builder setText(java.lang.CharSequence);
Tony Mak12fe4092018-07-26 15:08:53 +010021 }
22
23 public static final class TextClassification.Request {
Jeff Gaston3cf783a2018-09-20 16:16:48 -040024 method public static androidx.textclassifier.TextClassification.Request createFromBundle(android.os.Bundle);
25 method public androidx.core.os.LocaleListCompat getDefaultLocales();
26 method public int getEndIndex();
27 method public java.lang.Long getReferenceTime();
28 method public int getStartIndex();
29 method public java.lang.CharSequence getText();
Tony Mak12fe4092018-07-26 15:08:53 +010030 method public android.os.Bundle toBundle();
31 }
32
33 public static final class TextClassification.Request.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -040034 ctor public TextClassification.Request.Builder(java.lang.CharSequence, int, int);
Tony Mak12fe4092018-07-26 15:08:53 +010035 method public androidx.textclassifier.TextClassification.Request build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040036 method public androidx.textclassifier.TextClassification.Request.Builder setDefaultLocales(androidx.core.os.LocaleListCompat);
37 method public androidx.textclassifier.TextClassification.Request.Builder setReferenceTime(java.lang.Long);
Tony Mak12fe4092018-07-26 15:08:53 +010038 }
39
40 public final class TextClassificationContext {
41 method public static androidx.textclassifier.TextClassificationContext createFromBundle(android.os.Bundle);
Jeff Gaston3cf783a2018-09-20 16:16:48 -040042 method public java.lang.String getPackageName();
43 method public java.lang.String getWidgetType();
44 method public java.lang.String getWidgetVersion();
Tony Mak12fe4092018-07-26 15:08:53 +010045 method public android.os.Bundle toBundle();
46 }
47
48 public static final class TextClassificationContext.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -040049 ctor public TextClassificationContext.Builder(java.lang.String, java.lang.String);
Tony Mak12fe4092018-07-26 15:08:53 +010050 method public androidx.textclassifier.TextClassificationContext build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040051 method public androidx.textclassifier.TextClassificationContext.Builder setWidgetVersion(java.lang.String);
Tony Mak12fe4092018-07-26 15:08:53 +010052 }
53
54 public final class TextClassificationManager {
Tony Mak07c53432018-08-08 11:45:52 +010055 method public androidx.textclassifier.TextClassifier getTextClassifier();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040056 method public static androidx.textclassifier.TextClassificationManager of(android.content.Context);
57 method public void setTextClassifier(androidx.textclassifier.TextClassifier);
Tony Mak12fe4092018-07-26 15:08:53 +010058 }
59
60 public final class TextClassificationSessionId {
61 method public static androidx.textclassifier.TextClassificationSessionId createFromBundle(android.os.Bundle);
62 method public android.os.Bundle toBundle();
63 }
64
65 public abstract class TextClassifier {
Tony Mak07c53432018-08-08 11:45:52 +010066 ctor public TextClassifier();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040067 method public androidx.textclassifier.TextClassification classifyText(androidx.textclassifier.TextClassification.Request);
68 method public androidx.textclassifier.TextLinks generateLinks(androidx.textclassifier.TextLinks.Request);
Tony Mak12fe4092018-07-26 15:08:53 +010069 method public int getMaxGenerateLinksTextLength();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040070 method public androidx.textclassifier.TextSelection suggestSelection(androidx.textclassifier.TextSelection.Request);
71 field public static final java.lang.String HINT_TEXT_IS_EDITABLE = "android.text_is_editable";
72 field public static final java.lang.String HINT_TEXT_IS_NOT_EDITABLE = "android.text_is_not_editable";
73 field public static final androidx.textclassifier.TextClassifier NO_OP;
74 field public static final java.lang.String TYPE_ADDRESS = "address";
75 field public static final java.lang.String TYPE_DATE = "date";
76 field public static final java.lang.String TYPE_DATE_TIME = "datetime";
77 field public static final java.lang.String TYPE_EMAIL = "email";
78 field public static final java.lang.String TYPE_FLIGHT_NUMBER = "flight";
79 field public static final java.lang.String TYPE_OTHER = "other";
80 field public static final java.lang.String TYPE_PHONE = "phone";
81 field public static final java.lang.String TYPE_UNKNOWN = "";
82 field public static final java.lang.String TYPE_URL = "url";
83 field public static final java.lang.String WIDGET_TYPE_CUSTOM_EDITTEXT = "customedit";
84 field public static final java.lang.String WIDGET_TYPE_CUSTOM_TEXTVIEW = "customview";
85 field public static final java.lang.String WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW = "nosel-customview";
86 field public static final java.lang.String WIDGET_TYPE_EDITTEXT = "edittext";
87 field public static final java.lang.String WIDGET_TYPE_EDIT_WEBVIEW = "edit-webview";
88 field public static final java.lang.String WIDGET_TYPE_TEXTVIEW = "textview";
89 field public static final java.lang.String WIDGET_TYPE_UNKNOWN = "unknown";
90 field public static final java.lang.String WIDGET_TYPE_UNSELECTABLE_TEXTVIEW = "nosel-textview";
91 field public static final java.lang.String WIDGET_TYPE_WEBVIEW = "webview";
Tony Mak12fe4092018-07-26 15:08:53 +010092 }
93
94 public static final class TextClassifier.EntityConfig {
95 method public static androidx.textclassifier.TextClassifier.EntityConfig createFromBundle(android.os.Bundle);
96 method public java.util.Collection<java.lang.String> getHints();
Jeff Gaston3cf783a2018-09-20 16:16:48 -040097 method public java.util.Collection<java.lang.String> resolveEntityTypes(java.util.Collection<java.lang.String>);
Tony Mak12fe4092018-07-26 15:08:53 +010098 method public boolean shouldIncludeDefaultEntityTypes();
99 method public android.os.Bundle toBundle();
100 }
101
102 public static final class TextClassifier.EntityConfig.Builder {
103 ctor public TextClassifier.EntityConfig.Builder();
104 method public androidx.textclassifier.TextClassifier.EntityConfig build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400105 method public androidx.textclassifier.TextClassifier.EntityConfig.Builder setExcludedEntityTypes(java.util.Collection<java.lang.String>);
106 method public androidx.textclassifier.TextClassifier.EntityConfig.Builder setHints(java.util.Collection<java.lang.String>);
107 method public androidx.textclassifier.TextClassifier.EntityConfig.Builder setIncludeDefaultEntityTypes(boolean);
108 method public androidx.textclassifier.TextClassifier.EntityConfig.Builder setIncludedEntityTypes(java.util.Collection<java.lang.String>);
Tony Mak12fe4092018-07-26 15:08:53 +0100109 }
110
Tony Mak12fe4092018-07-26 15:08:53 +0100111 public final class TextLinks {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400112 method public int apply(android.widget.TextView, androidx.textclassifier.TextLinksParams);
Tony Mak51af3ce2018-08-28 17:53:05 +0100113 method public int apply(android.content.Context, android.text.Spannable, androidx.textclassifier.TextLinksParams);
Tony Mak12fe4092018-07-26 15:08:53 +0100114 method public static androidx.textclassifier.TextLinks createFromBundle(android.os.Bundle);
115 method public java.util.Collection<androidx.textclassifier.TextLinks.TextLink> getLinks();
116 method public android.os.Bundle toBundle();
117 field public static final int APPLY_STRATEGY_IGNORE = 0; // 0x0
118 field public static final int APPLY_STRATEGY_REPLACE = 1; // 0x1
119 field public static final int STATUS_DIFFERENT_TEXT = 3; // 0x3
120 field public static final int STATUS_LINKS_APPLIED = 0; // 0x0
121 field public static final int STATUS_NO_LINKS_APPLIED = 2; // 0x2
122 field public static final int STATUS_NO_LINKS_FOUND = 1; // 0x1
123 field public static final int STATUS_UNKNOWN = -1; // 0xffffffff
124 }
125
126 public static final class TextLinks.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400127 ctor public TextLinks.Builder(java.lang.CharSequence);
128 method public androidx.textclassifier.TextLinks.Builder addLink(int, int, java.util.Map<java.lang.String, java.lang.Float>);
Tony Mak12fe4092018-07-26 15:08:53 +0100129 method public androidx.textclassifier.TextLinks build();
130 method public androidx.textclassifier.TextLinks.Builder clearTextLinks();
131 }
132
133 public static final class TextLinks.Request {
134 method public static androidx.textclassifier.TextLinks.Request createFromBundle(android.os.Bundle);
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400135 method public androidx.core.os.LocaleListCompat getDefaultLocales();
Tony Mak12fe4092018-07-26 15:08:53 +0100136 method public androidx.textclassifier.TextClassifier.EntityConfig getEntityConfig();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400137 method public java.lang.Long getReferenceTime();
138 method public java.lang.CharSequence getText();
Tony Mak12fe4092018-07-26 15:08:53 +0100139 method public android.os.Bundle toBundle();
140 }
141
142 public static final class TextLinks.Request.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400143 ctor public TextLinks.Request.Builder(java.lang.CharSequence);
Tony Mak12fe4092018-07-26 15:08:53 +0100144 method public androidx.textclassifier.TextLinks.Request build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400145 method public androidx.textclassifier.TextLinks.Request.Builder setDefaultLocales(androidx.core.os.LocaleListCompat);
146 method public androidx.textclassifier.TextLinks.Request.Builder setEntityConfig(androidx.textclassifier.TextClassifier.EntityConfig);
147 method public androidx.textclassifier.TextLinks.Request.Builder setReferenceTime(java.lang.Long);
Tony Mak12fe4092018-07-26 15:08:53 +0100148 }
149
150 public static final class TextLinks.TextLink {
151 method public static androidx.textclassifier.TextLinks.TextLink createFromBundle(android.os.Bundle);
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400152 method public float getConfidenceScore(java.lang.String);
Tony Mak12fe4092018-07-26 15:08:53 +0100153 method public int getEnd();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400154 method public java.lang.String getEntity(int);
Tony Mak12fe4092018-07-26 15:08:53 +0100155 method public int getEntityCount();
156 method public int getStart();
157 method public android.os.Bundle toBundle();
158 }
159
160 public static class TextLinks.TextLinkSpan extends android.text.style.ClickableSpan {
Tony Mak07c53432018-08-08 11:45:52 +0100161 ctor public TextLinks.TextLinkSpan(androidx.textclassifier.TextLinks.TextLinkSpanData);
162 method public final androidx.textclassifier.TextLinks.TextLinkSpanData getTextLinkSpanData();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400163 method public void onClick(android.view.View);
Tony Mak12fe4092018-07-26 15:08:53 +0100164 }
165
Tony Mak07c53432018-08-08 11:45:52 +0100166 public static class TextLinks.TextLinkSpanData {
167 method public androidx.textclassifier.TextLinks.TextLink getTextLink();
Tony Mak12fe4092018-07-26 15:08:53 +0100168 }
169
Tony Mak51af3ce2018-08-28 17:53:05 +0100170 public final class TextLinksParams {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400171 field public static final androidx.textclassifier.TextLinksParams DEFAULT_PARAMS;
Tony Mak51af3ce2018-08-28 17:53:05 +0100172 }
173
174 public static final class TextLinksParams.Builder {
175 ctor public TextLinksParams.Builder();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400176 method public androidx.textclassifier.TextLinksParams build();
177 method public androidx.textclassifier.TextLinksParams.Builder setApplyStrategy(int);
178 method public androidx.textclassifier.TextLinksParams.Builder setDefaultLocales(androidx.core.os.LocaleListCompat);
179 method public androidx.textclassifier.TextLinksParams.Builder setEntityConfig(androidx.textclassifier.TextClassifier.EntityConfig);
180 method public androidx.textclassifier.TextLinksParams.Builder setReferenceTime(java.lang.Long);
Tony Mak51af3ce2018-08-28 17:53:05 +0100181 }
182
Tony Mak12fe4092018-07-26 15:08:53 +0100183 public final class TextSelection {
184 method public static androidx.textclassifier.TextSelection createFromBundle(android.os.Bundle);
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400185 method public float getConfidenceScore(java.lang.String);
186 method public java.lang.String getEntity(int);
187 method public int getEntityCount();
188 method public java.lang.String getId();
Tony Mak12fe4092018-07-26 15:08:53 +0100189 method public int getSelectionEndIndex();
190 method public int getSelectionStartIndex();
191 method public android.os.Bundle toBundle();
192 }
193
194 public static final class TextSelection.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400195 ctor public TextSelection.Builder(int, int);
Tony Mak12fe4092018-07-26 15:08:53 +0100196 method public androidx.textclassifier.TextSelection build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400197 method public androidx.textclassifier.TextSelection.Builder setEntityType(java.lang.String, float);
198 method public androidx.textclassifier.TextSelection.Builder setId(java.lang.String);
Tony Mak12fe4092018-07-26 15:08:53 +0100199 }
200
201 public static final class TextSelection.Request {
202 method public static androidx.textclassifier.TextSelection.Request createFromBundle(android.os.Bundle);
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400203 method public androidx.core.os.LocaleListCompat getDefaultLocales();
204 method public int getEndIndex();
205 method public int getStartIndex();
206 method public java.lang.CharSequence getText();
Tony Mak12fe4092018-07-26 15:08:53 +0100207 method public android.os.Bundle toBundle();
208 }
209
210 public static final class TextSelection.Request.Builder {
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400211 ctor public TextSelection.Request.Builder(java.lang.CharSequence, int, int);
Tony Mak12fe4092018-07-26 15:08:53 +0100212 method public androidx.textclassifier.TextSelection.Request build();
Jeff Gaston3cf783a2018-09-20 16:16:48 -0400213 method public androidx.textclassifier.TextSelection.Request.Builder setDefaultLocales(androidx.core.os.LocaleListCompat);
Tony Mak12fe4092018-07-26 15:08:53 +0100214 }
215
216}
217