diff --git a/docs/xml/Android.Views.TextClassifiers/ApplyStatusCode.xml b/docs/xml/Android.Views.TextClassifiers/ApplyStatusCode.xml index 67144a022..03826ccc2 100644 --- a/docs/xml/Android.Views.TextClassifiers/ApplyStatusCode.xml +++ b/docs/xml/Android.Views.TextClassifiers/ApplyStatusCode.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 3 - To be added. + The specified text does not match the text used to generate the links. + + The specified text does not match the text used to generate the links. + Android reference for android.view.textclassifier.TextLinks.STATUS_DIFFERENT_TEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 0 - To be added. + Links were successfully applied to the text. + + Links were successfully applied to the text. + Android reference for android.view.textclassifier.TextLinks.STATUS_LINKS_APPLIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +106,12 @@ 2 - To be added. + No links applied to text. + + No links applied to text. The links were filtered out. + Android reference for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_APPLIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -124,7 +139,12 @@ 1 - To be added. + No links exist to apply to text. + + No links exist to apply to text. Links count is zero. + Android reference for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_FOUND. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -152,7 +172,12 @@ 4 - To be added. + The specified text contains unsupported characters. + + The specified text contains unsupported characters. + Android reference for android.view.textclassifier.TextLinks.STATUS_UNSUPPORTED_CHARACTER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ApplyStrategy.xml b/docs/xml/Android.Views.TextClassifiers/ApplyStrategy.xml index 058c51e69..349584bb6 100644 --- a/docs/xml/Android.Views.TextClassifiers/ApplyStrategy.xml +++ b/docs/xml/Android.Views.TextClassifiers/ApplyStrategy.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 0 - To be added. + Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to. + + Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to. Do not apply the TextLinkSpan. + Android reference for android.view.textclassifier.TextLinks.APPLY_STRATEGY_IGNORE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 1 - To be added. + Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to. + + Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to. + Android reference for android.view.textclassifier.TextLinks.APPLY_STRATEGY_REPLACE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationAction+Builder.xml b/docs/xml/Android.Views.TextClassifiers/ConversationAction+Builder.xml index b76035a2c..950913466 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationAction+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationAction+Builder.xml @@ -26,19 +26,11 @@ - Builder class to construct ConversationAction. + Builder class to construct ConversationAction. - Builder class to construct ConversationAction. - - - Java documentation for android.view.textclassifier.ConversationAction.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builder class to construct ConversationAction. + Android reference for android.view.textclassifier.ConversationAction.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -96,20 +88,12 @@ - Builds the ConversationAction object. - To be added. + Builds the ConversationAction object. + This value cannot be null. - Builds the ConversationAction object. - - - Java documentation for android.view.textclassifier.ConversationAction.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builds the ConversationAction object. + Android reference for android.view.textclassifier.ConversationAction.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -136,7 +120,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -176,10 +160,14 @@ - To be added. - To be added. - To be added. - To be added. + RemoteAction: This value may be null. + Sets an action that may be performed on the given conversation. + This value cannot be null. + + Sets an action that may be performed on the given conversation. + Android reference for android.view.textclassifier.ConversationAction.Builder.setAction. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -209,10 +197,14 @@ - To be added. - To be added. - To be added. - To be added. + float: Value is between 0.0f and 1.0f inclusive + Sets the confidence score. + This value cannot be null. + + Sets the confidence score. + Android reference for android.view.textclassifier.ConversationAction.Builder.setConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -249,10 +241,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data for the conversation action object. + This value cannot be null. + + Sets the extended data for the conversation action object. + Android reference for android.view.textclassifier.ConversationAction.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -289,10 +285,14 @@ - To be added. - To be added. - To be added. - To be added. + This value may be null. + Sets a text reply that may be performed on the given conversation. + This value cannot be null. + + Sets a text reply that may be performed on the given conversation. + Android reference for android.view.textclassifier.ConversationAction.Builder.setTextReply. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -325,10 +325,14 @@ - To be added. - To be added. - To be added. - To be added. + This value may be null. + Sets a text reply that may be performed on the given conversation. + This value cannot be null. + + Sets a text reply that may be performed on the given conversation. + Android reference for android.view.textclassifier.ConversationAction.Builder.setTextReply. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -354,7 +358,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -383,7 +387,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationAction+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/ConversationAction+InterfaceConsts.xml index 8b88718b0..629e9dbd1 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationAction+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationAction+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationAction.xml b/docs/xml/Android.Views.TextClassifiers/ConversationAction.xml index 283a530f7..e4a7eb05a 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationAction.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationAction.xml @@ -39,19 +39,11 @@ - Represents the action suggested by a TextClassifier on a given conversation. + Represents the action suggested by a TextClassifier on a given conversation. - Represents the action suggested by a TextClassifier on a given conversation. - - - Java documentation for android.view.textclassifier.ConversationAction. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Represents the action suggested by a TextClassifier on a given conversation. + Android reference for android.view.textclassifier.ConversationAction. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -83,22 +75,12 @@ Android.App.RemoteAction - Returns a RemoteAction object, which contains the icon, label and a PendingIntent, for - the specified action type. - To be added. + Returns a RemoteAction object, which contains the icon, label and a PendingIntent, for the specified action type. + This value may be null. - Returns a RemoteAction object, which contains the icon, label and a PendingIntent, for - the specified action type. - - - Java documentation for android.view.textclassifier.ConversationAction.getAction(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns a RemoteAction object, which contains the icon, label and a PendingIntent, for the specified action type. + Android reference for android.view.textclassifier.ConversationAction.getAction. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -127,20 +109,11 @@ Returns the confidence score for the specified action. - To be added. + Value is between 0.0f and 1.0f inclusive - Returns the confidence score for the specified action. The value ranges from 0 (low - confidence) to 1 (high confidence). - - - Java documentation for android.view.textclassifier.ConversationAction.getConfidenceScore(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the confidence score for the specified action. The value ranges from 0 (low confidence) to 1 (high confidence). + Android reference for android.view.textclassifier.ConversationAction.getConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -201,9 +174,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.ConversationAction.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -231,20 +208,11 @@ Returns the extended data related to this conversation action. - To be added. + This value cannot be null. - Returns the extended data related to this conversation action. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.ConversationAction.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data related to this conversation action. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.ConversationAction.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -274,7 +242,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -303,7 +271,7 @@ System.String - + To be added. To be added. To be added. @@ -338,20 +306,11 @@ Returns the text reply that could be sent as a reply to the given conversation. - To be added. + This value may be null. - Returns the text reply that could be sent as a reply to the given conversation. - This is only available when the type of the action is #TYPE_TEXT_REPLY. - - - Java documentation for android.view.textclassifier.ConversationAction.getTextReply(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the text reply that could be sent as a reply to the given conversation. This is only available when the type of the action is TYPE_TEXT_REPLY. + Android reference for android.view.textclassifier.ConversationAction.getTextReply. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -378,7 +337,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -407,7 +366,7 @@ System.Type - + To be added. To be added. To be added. @@ -441,20 +400,12 @@ System.String - Returns the type of this action, for example, #TYPE_VIEW_CALENDAR. - To be added. + Returns the type of this action, for example, TYPE_VIEW_CALENDAR. + This value cannot be null. Value is one of the following: TYPE_VIEW_CALENDAR TYPE_VIEW_MAP TYPE_TRACK_FLIGHT TYPE_OPEN_URL TYPE_SEND_SMS TYPE_CALL_PHONE TYPE_SEND_EMAIL TYPE_TEXT_REPLY TYPE_CREATE_REMINDER TYPE_SHARE_LOCATION - Returns the type of this action, for example, #TYPE_VIEW_CALENDAR. - - - Java documentation for android.view.textclassifier.ConversationAction.getType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the type of this action, for example, TYPE_VIEW_CALENDAR. + Android reference for android.view.textclassifier.ConversationAction.getType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -488,16 +439,8 @@ Indicates an action to call a phone number. Indicates an action to call a phone number. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_CALL_PHONE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_CALL_PHONE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -531,16 +474,8 @@ Indicates an action to create a reminder. Indicates an action to create a reminder. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_CREATE_REMINDER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_CREATE_REMINDER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -574,16 +509,8 @@ Indicates an action to open an URL. Indicates an action to open an URL. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_OPEN_URL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_OPEN_URL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -617,16 +544,8 @@ Indicates an action to send an email. Indicates an action to send an email. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_SEND_EMAIL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_SEND_EMAIL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -660,16 +579,8 @@ Indicates an action to send a SMS. Indicates an action to send a SMS. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_SEND_SMS. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_SEND_SMS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -703,16 +614,8 @@ Indicates an action to reply with a location. Indicates an action to reply with a location. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_SHARE_LOCATION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_SHARE_LOCATION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -746,16 +649,8 @@ Indicates an action to reply with a text message. Indicates an action to reply with a text message. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_TEXT_REPLY. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_TEXT_REPLY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -789,16 +684,8 @@ Indicates an action to track a flight. Indicates an action to track a flight. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_TRACK_FLIGHT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_TRACK_FLIGHT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -832,16 +719,8 @@ Indicates an action to view a calendar at a specified time. Indicates an action to view a calendar at a specified time. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_VIEW_CALENDAR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_VIEW_CALENDAR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -875,16 +754,8 @@ Indicates an action to view the map at a specified location. Indicates an action to view the map at a specified location. - - - Java documentation for android.view.textclassifier.ConversationAction.TYPE_VIEW_MAP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationAction.TYPE_VIEW_MAP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -926,10 +797,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.ConversationAction.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+InterfaceConsts.xml index 4f891aac9..2edb4686d 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+Builder.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+Builder.xml index f9f52b3df..e97777b3f 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class to construct a Message + + Builder class to construct a Message + Android reference for android.view.textclassifier.ConversationActions.Message.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -54,9 +58,13 @@ - To be added. - To be added. - To be added. + Person: the person that composed the message, use ConversationActions.Message.PERSON_USER_SELF to represent the local user. If it is not possible to identify the remote user that the local user is conversing with, use ConversationActions.Message.PERSON_USER_OTHERS to represent a remote user. This value cannot be null. + Constructs a builder. + + Constructs a builder. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -84,9 +92,13 @@ - To be added. - To be added. - To be added. + Builds the Message object. + This value cannot be null. + + Builds the Message object. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -112,7 +124,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -152,10 +164,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets a set of extended data to the message. + This value cannot be null. + + Sets a set of extended data to the message. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -192,10 +208,14 @@ - To be added. - To be added. - To be added. - To be added. + ZonedDateTime: This value may be null. + Sets the reference time of this message, for example it could be the compose or send time of this message. + This value cannot be null. + + Sets the reference time of this message, for example it could be the compose or send time of this message. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.setReferenceTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -232,10 +252,14 @@ - To be added. - To be added. - To be added. - To be added. + This value may be null. + Sets the text of this message. + This value cannot be null. + + Sets the text of this message. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.setText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -268,10 +292,14 @@ - To be added. - To be added. - To be added. - To be added. + This value may be null. + Sets the text of this message. + This value cannot be null. + + Sets the text of this message. + Android reference for android.view.textclassifier.ConversationActions.Message.Builder.setText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -297,7 +325,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -326,7 +354,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+InterfaceConsts.xml index b0462ae6b..aa713abf5 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message.xml index d1f8917b3..f102891b2 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Message.xml @@ -42,16 +42,8 @@ Represents a message in the conversation. Represents a message in the conversation. - - - Java documentation for android.view.textclassifier.ConversationActions.Message. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Message. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,19 +72,11 @@ Returns the person that composed the message. - To be added. + This value cannot be null. Returns the person that composed the message. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.getAuthor(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Message.getAuthor. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -153,9 +137,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.ConversationActions.Message.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -183,20 +171,11 @@ Returns the extended data related to this conversation action. - To be added. + This value cannot be null. - Returns the extended data related to this conversation action. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data related to this conversation action. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.ConversationActions.Message.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -226,7 +205,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -257,22 +236,11 @@ Represents the remote user. - To be added. - Represents the remote user. - If possible, you are suggested to create a Person object that can identify - the remote user better, so that the underlying model could differentiate between - different remote users. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.PERSON_USER_OTHERS. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Represents the remote user. If possible, you are suggested to create a Person object that can identify the remote user better, so that the underlying model could differentiate between different remote users. + See also: + Android reference for android.view.textclassifier.ConversationActions.Message.PERSON_USER_OTHERS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -301,19 +269,11 @@ Represents the local user. - To be added. Represents the local user. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.PERSON_USER_SELF. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.ConversationActions.Message.PERSON_USER_SELF. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -345,22 +305,12 @@ Java.Time.ZonedDateTime - Returns the reference time of the message, for example it could be the compose or send - time of this message. - To be added. + Returns the reference time of the message, for example it could be the compose or send time of this message. + This value may be null. - Returns the reference time of the message, for example it could be the compose or send - time of this message. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.getReferenceTime(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the reference time of the message, for example it could be the compose or send time of this message. + Android reference for android.view.textclassifier.ConversationActions.Message.getReferenceTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -387,7 +337,7 @@ System.String - + To be added. To be added. To be added. @@ -422,19 +372,11 @@ Returns the text of the message. - To be added. + This value may be null. Returns the text of the message. - - - Java documentation for android.view.textclassifier.ConversationActions.Message.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Message.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -461,7 +403,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -490,7 +432,7 @@ System.Type - + To be added. To be added. To be added. @@ -534,10 +476,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.ConversationActions.Message.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+Builder.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+Builder.xml index 8f47e6018..69dd608eb 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder object to construct the Request object. + + Builder object to construct the Request object. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -54,9 +58,13 @@ - To be added. - To be added. - To be added. + List: the conversation that the text classifier is going to generate actions for. This value cannot be null. + Constructs a builder. + + Constructs a builder. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -84,9 +92,13 @@ - To be added. - To be added. - To be added. + Builds the Request object. + This value cannot be null. + + Builds the Request object. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -112,7 +124,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -152,10 +164,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets a set of extended data to the request. + This value cannot be null. + + Sets a set of extended data to the request. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -192,10 +208,14 @@ - To be added. - To be added. - To be added. - To be added. + List: This value may be null. Value is one of the following: ConversationActions.Request.HINT_FOR_NOTIFICATION ConversationActions.Request.HINT_FOR_IN_APP + Sets the hints to help text classifier to generate actions. + This value cannot be null. + + Sets the hints to help text classifier to generate actions. It could be used to help text classifier to infer what types of actions the caller may be interested in. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.setHints. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -225,10 +245,14 @@ - To be added. - To be added. - To be added. - To be added. + int: Value is -1 or greater + Sets the maximum number of suggestions you want. + This value cannot be null. + + Sets the maximum number of suggestions you want. Value -1 means no restriction and this is the default. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.setMaxSuggestions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -265,10 +289,14 @@ - To be added. - To be added. - To be added. - To be added. + TextClassifier.EntityConfig: This value may be null. + Sets the type config. + This value cannot be null. + + Sets the type config. + Android reference for android.view.textclassifier.ConversationActions.Request.Builder.setTypeConfig. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -294,7 +322,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -323,7 +351,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+InterfaceConsts.xml index 3f4bb69b2..4a113ef72 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request.xml index 9c0ee5323..c3bf96ff9 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions+Request.xml @@ -42,16 +42,8 @@ A request object for generating conversation action suggestions. A request object for generating conversation action suggestions. - - - Java documentation for android.view.textclassifier.ConversationActions.Request. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Request. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -84,20 +76,10 @@ Returns the name of the package that sent this request. - To be added. - Returns the name of the package that sent this request. - This returns null if no calling package name is set. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.getCallingPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the name of the package that sent this request. This returns null if no calling package name is set. + Android reference for android.view.textclassifier.ConversationActions.Request.getCallingPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -126,19 +108,11 @@ Returns an immutable list of messages that make up the conversation. - To be added. + This value cannot be null. Returns an immutable list of messages that make up the conversation. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.getConversation(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Request.getConversation. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -199,9 +173,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.ConversationActions.Request.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -229,20 +207,11 @@ Returns the extended data related to this request. - To be added. + This value cannot be null. - Returns the extended data related to this request. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data related to this request. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.ConversationActions.Request.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -276,16 +245,8 @@ To indicate the generated actions will be used within the app. To indicate the generated actions will be used within the app. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.HINT_FOR_IN_APP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Request.HINT_FOR_IN_APP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -319,16 +280,8 @@ To indicate the generated actions will be used for notification. To indicate the generated actions will be used for notification. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.HINT_FOR_NOTIFICATION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Request.HINT_FOR_NOTIFICATION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -357,19 +310,11 @@ Returns an immutable list of hints - To be added. + This value cannot be null. Value is one of the following: HINT_FOR_NOTIFICATION HINT_FOR_IN_APP Returns an immutable list of hints - - - Java documentation for android.view.textclassifier.ConversationActions.Request.getHints(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.Request.getHints. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -399,7 +344,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -429,22 +374,12 @@ System.Int32 - Return the maximal number of suggestions the caller wants, value -1 means no restriction - and this is the default. - To be added. + Return the maximal number of suggestions the caller wants, value -1 means no restriction and this is the default. + Value is -1 or greater - Return the maximal number of suggestions the caller wants, value -1 means no restriction - and this is the default. - - - Java documentation for android.view.textclassifier.ConversationActions.Request.getMaxSuggestions(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Return the maximal number of suggestions the caller wants, value -1 means no restriction and this is the default. + Android reference for android.view.textclassifier.ConversationActions.Request.getMaxSuggestions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -471,7 +406,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -500,7 +435,7 @@ System.Type - + To be added. To be added. To be added. @@ -530,9 +465,13 @@ Android.Views.TextClassifiers.TextClassifierEntityConfig - To be added. - To be added. - To be added. + Returns the type config. + This value cannot be null. + + Returns the type config. + Android reference for android.view.textclassifier.ConversationActions.Request.getTypeConfig. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -573,10 +512,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.ConversationActions.Request.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ConversationActions.xml b/docs/xml/Android.Views.TextClassifiers/ConversationActions.xml index 96a28cc8c..3bcac7c09 100644 --- a/docs/xml/Android.Views.TextClassifiers/ConversationActions.xml +++ b/docs/xml/Android.Views.TextClassifiers/ConversationActions.xml @@ -39,19 +39,11 @@ - Represents a list of actions suggested by a TextClassifier on a given conversation. + Represents a list of actions suggested by a TextClassifier on a given conversation. - Represents a list of actions suggested by a TextClassifier on a given conversation. - - - Java documentation for android.view.textclassifier.ConversationActions. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Represents a list of actions suggested by a TextClassifier on a given conversation. + Android reference for android.view.textclassifier.ConversationActions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -87,21 +79,13 @@ - To be added. - To be added. - Constructs a ConversationActions object. + List: This value cannot be null. + String: This value may be null. + Constructs a ConversationActions object. - Constructs a ConversationActions object. - - - Java documentation for android.view.textclassifier.ConversationActions.ConversationActions(java.util.List<android.view.textclassifier.ConversationAction>, java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Constructs a ConversationActions object. + Android reference for android.view.textclassifier.ConversationActions.ConversationActions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -162,9 +146,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.ConversationActions.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -192,22 +180,12 @@ - Returns an immutable list of ConversationAction objects, which are ordered from high - confidence to low confidence. - To be added. + Returns an immutable list of ConversationAction objects, which are ordered from high confidence to low confidence. + This value cannot be null. - Returns an immutable list of ConversationAction objects, which are ordered from high - confidence to low confidence. - - - Java documentation for android.view.textclassifier.ConversationActions.getConversationActions(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns an immutable list of ConversationAction objects, which are ordered from high confidence to low confidence. + Android reference for android.view.textclassifier.ConversationActions.getConversationActions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -240,19 +218,11 @@ Returns the id, if one exists, for this object. - To be added. + This value may be null. Returns the id, if one exists, for this object. - - - Java documentation for android.view.textclassifier.ConversationActions.getId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.ConversationActions.getId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -282,7 +252,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -311,7 +281,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -340,7 +310,7 @@ System.Type - + To be added. To be added. To be added. @@ -384,10 +354,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.ConversationActions.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/ITextClassificationSessionFactory.xml b/docs/xml/Android.Views.TextClassifiers/ITextClassificationSessionFactory.xml index 5a3797a8b..b02b87755 100644 --- a/docs/xml/Android.Views.TextClassifiers/ITextClassificationSessionFactory.xml +++ b/docs/xml/Android.Views.TextClassifiers/ITextClassificationSessionFactory.xml @@ -28,16 +28,8 @@ An interface for creating a session-aware TextClassifier. An interface for creating a session-aware TextClassifier. - - - Java documentation for android.view.textclassifier.TextClassificationSessionFactory. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationSessionFactory. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -68,21 +60,13 @@ - the classification context + TextClassificationContext: the classification context. This value cannot be null. Creates and returns a session-aware TextClassifier. - To be added. + This value cannot be null. Creates and returns a session-aware TextClassifier. - - - Java documentation for android.view.textclassifier.TextClassificationSessionFactory.createTextClassificationSession(android.view.textclassifier.TextClassificationContext). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationSessionFactory.createTextClassificationSession. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ITextClassifier.xml b/docs/xml/Android.Views.TextClassifiers/ITextClassifier.xml index 03ff3c10f..ec29690bb 100644 --- a/docs/xml/Android.Views.TextClassifiers/ITextClassifier.xml +++ b/docs/xml/Android.Views.TextClassifiers/ITextClassifier.xml @@ -27,21 +27,9 @@ Interface for providing text classification related features. - Interface for providing text classification related features. - The TextClassifier may be used to understand the meaning of text, as well as generating predicted - next actions based on the text. - <strong>NOTE: </strong>Unless otherwise stated, methods of this interface are blocking - operations. Call on a worker thread. - - - Java documentation for android.view.textclassifier.TextClassifier. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Interface for providing text classification related features. The TextClassifier may be used to understand the meaning of text, as well as generating predicted next actions based on the text. NOTE: Unless otherwise stated, methods of this interface are blocking operations. Call on a worker thread. + Android reference for android.view.textclassifier.TextClassifier. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -72,21 +60,13 @@ - the text classification request - Classifies the specified text and returns a TextClassification object that can be - used to generate a widget for handling the classified text. - To be added. + TextClassification.Request: the text classification request. This value cannot be null. + Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text. + This value cannot be null. - - - Java documentation for android.view.textclassifier.TextClassifier.classifyText(android.view.textclassifier.Request). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text. NOTE: Call on a worker thread. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + Android reference for android.view.textclassifier.TextClassifier.classifyText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -127,35 +107,18 @@ - text providing context for the text to classify (which is specified - by the sub sequence starting at startIndex and ending at endIndex) - start index of the text to classify - end index of the text to classify - ordered list of locale preferences that may be used to - disambiguate the provided text. If no locale preferences exist, set this to null - or an empty locale list. - Classifies the specified text and returns a TextClassification object that can be - used to generate a widget for handling the classified text. - To be added. + CharSequence: text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex). This value cannot be null. + int: start index of the text to classify. Value is 0 or greater + int: end index of the text to classify. Value is 0 or greater + LocaleList: ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list. + Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text. + This value cannot be null. - Classifies the specified text and returns a TextClassification object that can be - used to generate a widget for handling the classified text. - <strong>NOTE: </strong>Call on a worker thread. - <b>NOTE:</b> Do not implement. The default implementation of this method calls - #classifyText(TextClassification.Request). If that method calls this method, - a stack overflow error will happen. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, calls to this method should - throw an IllegalStateException. See #isDestroyed(). - - - Java documentation for android.view.textclassifier.TextClassifier.classifyText(java.lang.CharSequence, int, int, android.os.LocaleList). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text. NOTE: Call on a worker thread. NOTE: Do not implement. The default implementation of this method calls classifyText(TextClassification.Request). If that method calls this method, a stack overflow error will happen. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + See also: + Throws: IllegalArgumentException if text is null; startIndex is negative; endIndex is greater than text.length() or not greater than startIndex + Android reference for android.view.textclassifier.TextClassifier.classifyText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -186,20 +149,9 @@ Destroys this TextClassifier. - Destroys this TextClassifier. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, calls to its methods should - throw an IllegalStateException. See #isDestroyed(). - Subsequent calls to this method are no-ops. - - - Java documentation for android.view.textclassifier.TextClassifier.destroy(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Destroys this TextClassifier. NOTE: If a TextClassifier has been destroyed, calls to its methods should throw an IllegalStateException. See isDestroyed(). Subsequent calls to this method are no-ops. + Android reference for android.view.textclassifier.TextClassifier.destroy. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -230,20 +182,13 @@ - the TextLanguage request. + TextLanguage.Request: the TextLanguage request. This value cannot be null. Detects the language of the text in the given request. - the TextLanguage result. + the TextLanguage result. This value cannot be null. - - - Java documentation for android.view.textclassifier.TextClassifier.detectLanguage(android.view.textclassifier.Request). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Detects the language of the text in the given request. NOTE: Call on a worker thread. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + Android reference for android.view.textclassifier.TextClassifier.detectLanguage. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -271,23 +216,11 @@ System.String - Extra that is included on activity intents coming from a TextClassifier when - it suggests actions to its caller. + Extra that is included on activity intents coming from a TextClassifier when it suggests actions to its caller. - Extra that is included on activity intents coming from a TextClassifier when - it suggests actions to its caller. - All TextClassifier implementations should make sure this extra exists in their - generated intents. - - - Java documentation for android.view.textclassifier.TextClassifier.EXTRA_FROM_TEXT_CLASSIFIER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Extra that is included on activity intents coming from a TextClassifier when it suggests actions to its caller. All TextClassifier implementations should make sure this extra exists in their generated intents. + Android reference for android.view.textclassifier.TextClassifier.EXTRA_FROM_TEXT_CLASSIFIER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -317,20 +250,9 @@ Extra specifying the package name of the app from which the text to be classified originated. - Extra specifying the package name of the app from which the text to be classified originated. - For example, a notification assistant might use TextClassifier, but the notification - content could originate from a different app. This key allows you to provide - the package name of that source app. - - - Java documentation for android.view.textclassifier.TextClassifier.EXTRA_TEXT_ORIGIN_PACKAGE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Extra specifying the package name of the app from which the text to be classified originated. For example, a notification assistant might use TextClassifier, but the notification content could originate from a different app. This key allows you to provide the package name of that source app. + Android reference for android.view.textclassifier.TextClassifier.EXTRA_TEXT_ORIGIN_PACKAGE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -361,21 +283,14 @@ - the text links request - Generates and returns a TextLinks that may be applied to the text to annotate it with - links information. - To be added. + TextLinks.Request: the text links request. This value cannot be null. + Generates and returns a TextLinks that may be applied to the text to annotate it with links information. + This value cannot be null. - - - Java documentation for android.view.textclassifier.TextClassifier.generateLinks(android.view.textclassifier.Request). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Generates and returns a TextLinks that may be applied to the text to annotate it with links information. NOTE: Call on a worker thread. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + See also: + Android reference for android.view.textclassifier.TextClassifier.generateLinks. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -406,16 +321,8 @@ Designates that the text in question is editable. Designates that the text in question is editable. * - - - Java documentation for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_EDITABLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_EDITABLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -446,16 +353,8 @@ Designates that the text in question is not editable. Designates that the text in question is not editable. * - - - Java documentation for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_NOT_EDITABLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_NOT_EDITABLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -484,22 +383,11 @@ Returns whether or not this TextClassifier has been destroyed. - To be added. - Returns whether or not this TextClassifier has been destroyed. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, caller should not interact - with the classifier and an attempt to do so would throw an IllegalStateException. - However, this method should never throw an IllegalStateException. - - - Java documentation for android.view.textclassifier.TextClassifier.isDestroyed(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns whether or not this TextClassifier has been destroyed. NOTE: If a TextClassifier has been destroyed, caller should not interact with the classifier and an attempt to do so would throw an IllegalStateException. However, this method should never throw an IllegalStateException. + See also: + Android reference for android.view.textclassifier.TextClassifier.isDestroyed. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -528,21 +416,11 @@ Returns the maximal length of text that can be processed by generateLinks. - To be added. - Returns the maximal length of text that can be processed by generateLinks. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, calls to this method should - throw an IllegalStateException. See #isDestroyed(). - - - Java documentation for android.view.textclassifier.TextClassifier.getMaxGenerateLinksTextLength(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the maximal length of text that can be processed by generateLinks. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + See also: + Android reference for android.view.textclassifier.TextClassifier.getMaxGenerateLinksTextLength. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -575,20 +453,10 @@ No-op TextClassifier. - To be added. - No-op TextClassifier. - This may be used to turn off TextClassifier features. - - - Java documentation for android.view.textclassifier.TextClassifier.NO_OP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + No-op TextClassifier. This may be used to turn off TextClassifier features. + Android reference for android.view.textclassifier.TextClassifier.NO_OP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -619,23 +487,11 @@ - To be added. - <strong>NOTE: </strong>Use #onTextClassifierEvent(TextClassifierEvent) instead. + NOTE: Use onTextClassifierEvent(TextClassifierEvent) instead. - <strong>NOTE: </strong>Use #onTextClassifierEvent(TextClassifierEvent) instead. - Reports a selection event. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, calls to this method should - throw an IllegalStateException. See #isDestroyed(). - - - Java documentation for android.view.textclassifier.TextClassifier.onSelectionEvent(android.view.textclassifier.SelectionEvent). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + NOTE: Use onTextClassifierEvent(TextClassifierEvent) instead. Reports a selection event. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). + Android reference for android.view.textclassifier.TextClassifier.onSelectionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -666,21 +522,13 @@ - To be added. Reports a text classifier event. - Reports a text classifier event. - <strong>NOTE: </strong>Call on a worker thread. - - - Java documentation for android.view.textclassifier.TextClassifier.onTextClassifierEvent(android.view.textclassifier.TextClassifierEvent). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Reports a text classifier event. NOTE: Call on a worker thread. + See also: + Throws: IllegalStateException if this TextClassifier has been destroyed. + Android reference for android.view.textclassifier.TextClassifier.onTextClassifierEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -711,20 +559,13 @@ - To be added. + ConversationActions.Request: This value cannot be null. Suggests and returns a list of actions according to the given conversation. - To be added. + This value cannot be null. - - - Java documentation for android.view.textclassifier.TextClassifier.suggestConversationActions(android.view.textclassifier.Request). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Suggests and returns a list of actions according to the given conversation. This method may take several seconds to complete, so it should only be called from a worker thread. + Android reference for android.view.textclassifier.TextClassifier.suggestConversationActions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -755,21 +596,13 @@ - the text selection request - Returns suggested text selection start and end indices, recognized entity types, and their - associated confidence scores. - To be added. + TextSelection.Request: the text selection request. This value cannot be null. + Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. + This value cannot be null. - - - Java documentation for android.view.textclassifier.TextClassifier.suggestSelection(android.view.textclassifier.Request). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. The entity types are ordered from highest to lowest scoring. NOTE: Call on a worker thread. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). This method may take several seconds to complete, so it should only be called from a worker thread. + Android reference for android.view.textclassifier.TextClassifier.suggestSelection. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -810,35 +643,18 @@ - text providing context for the selected text (which is specified - by the sub sequence starting at selectionStartIndex and ending at selectionEndIndex) - start index of the selected part of text - end index of the selected part of text - ordered list of locale preferences that may be used to - disambiguate the provided text. If no locale preferences exist, set this to null - or an empty locale list. - Returns suggested text selection start and end indices, recognized entity types, and their - associated confidence scores. - To be added. + CharSequence: text providing context for the selected text (which is specified by the sub sequence starting at selectionStartIndex and ending at selectionEndIndex). This value cannot be null. + int: start index of the selected part of text. Value is 0 or greater + int: end index of the selected part of text. Value is 0 or greater + LocaleList: ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list. + Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. + This value cannot be null. - Returns suggested text selection start and end indices, recognized entity types, and their - associated confidence scores. The entity types are ordered from highest to lowest scoring. - <strong>NOTE: </strong>Call on a worker thread. - <strong>NOTE: </strong>If a TextClassifier has been destroyed, calls to this method should - throw an IllegalStateException. See #isDestroyed(). - <b>NOTE:</b> Do not implement. The default implementation of this method calls - #suggestSelection(TextSelection.Request). If that method calls this method, - a stack overflow error will happen. - - - Java documentation for android.view.textclassifier.TextClassifier.suggestSelection(java.lang.CharSequence, int, int, android.os.LocaleList). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. The entity types are ordered from highest to lowest scoring. NOTE: Call on a worker thread. NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed(). NOTE: Do not implement. The default implementation of this method calls suggestSelection(TextSelection.Request). If that method calls this method, a stack overflow error will happen. This method may take several seconds to complete, so it should only be called from a worker thread. + See also: + Throws: IllegalArgumentException if text is null; selectionStartIndex is negative; selectionEndIndex is greater than text.length() or not greater than selectionStartIndex + Android reference for android.view.textclassifier.TextClassifier.suggestSelection. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -869,16 +685,8 @@ Physical address. Physical address. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_ADDRESS. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_ADDRESS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -908,18 +716,9 @@ Time reference that is no more specific than a date. - Time reference that is no more specific than a date. May be absolute such as "01/01/2000" or - relative like "tomorrow". * - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_DATE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Time reference that is no more specific than a date. May be absolute such as "01/01/2000" or relative like "tomorrow". * + Android reference for android.view.textclassifier.TextClassifier.TYPE_DATE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -949,18 +748,9 @@ Time reference that includes a specific time. - Time reference that includes a specific time. May be absolute such as "01/01/2000 5:30pm" or - relative like "tomorrow at 5:30pm". * - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_DATE_TIME. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Time reference that includes a specific time. May be absolute such as "01/01/2000 5:30pm" or relative like "tomorrow at 5:30pm". * + Android reference for android.view.textclassifier.TextClassifier.TYPE_DATE_TIME. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -988,19 +778,11 @@ System.String - E-mail address (e. + E-mail address (e.g. - E-mail address (e.g. "noreply - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_EMAIL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + E-mail address (e.g. "noreply.com"). + Android reference for android.view.textclassifier.TextClassifier.TYPE_EMAIL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1031,16 +813,8 @@ Flight number in IATA format. Flight number in IATA format. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_FLIGHT_NUMBER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_FLIGHT_NUMBER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1071,16 +845,8 @@ The classifier ran, but didn't recognize a known entity. The classifier ran, but didn't recognize a known entity. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_OTHER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_OTHER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1111,16 +877,8 @@ Onetime password. Onetime password. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_OTP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_OTP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1148,19 +906,11 @@ System.String - Phone number (e. + Phone number (e.g. Phone number (e.g. "555-123 456"). - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_PHONE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_PHONE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1191,16 +941,8 @@ The TextClassifier failed to run. The TextClassifier failed to run. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_UNKNOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1231,16 +973,8 @@ Web URL. Web URL. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_URL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_URL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1271,16 +1005,8 @@ The text classification context is for use with the system clipboard. The text classification context is for use with the system clipboard. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CLIPBOARD. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CLIPBOARD. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1311,16 +1037,8 @@ The widget involved in the text classification context is a custom editable text widget. The widget involved in the text classification context is a custom editable text widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1351,16 +1069,8 @@ The widget involved in the text classification context is a custom text widget. The widget involved in the text classification context is a custom text widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1388,21 +1098,11 @@ System.String - The widget involved in the text classification context is a custom non-selectable text - widget. + The widget involved in the text classification context is a custom non-selectable text widget. - The widget involved in the text classification context is a custom non-selectable text - widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a custom non-selectable text widget. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1430,21 +1130,11 @@ System.String - The widget involved in the text classification context is a standard - android.widget.EditText. + The widget involved in the text classification context is a standard EditText. - The widget involved in the text classification context is a standard - android.widget.EditText. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDITTEXT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard EditText. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDITTEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1472,21 +1162,11 @@ System.String - The widget involved in the text classification context is a standard editable - android.webkit.WebView. + The widget involved in the text classification context is a standard editable WebView. - The widget involved in the text classification context is a standard editable - android.webkit.WebView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard editable WebView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1517,16 +1197,8 @@ The widget involved in the text classification context is a notification The widget involved in the text classification context is a notification - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_NOTIFICATION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_NOTIFICATION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1554,21 +1226,11 @@ System.String - The widget involved in the text classification context is a standard - android.widget.TextView. + The widget involved in the text classification context is a standard TextView. - The widget involved in the text classification context is a standard - android.widget.TextView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard TextView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1599,16 +1261,8 @@ The widget involved in the text classification context is of an unknown/unspecified type. The widget involved in the text classification context is of an unknown/unspecified type. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNKNOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1636,21 +1290,11 @@ System.String - The widget involved in the text classification context is a standard non-selectable - android.widget.TextView. + The widget involved in the text classification context is a standard non-selectable TextView. - The widget involved in the text classification context is a standard non-selectable - android.widget.TextView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard non-selectable TextView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1678,21 +1322,11 @@ System.String - The widget involved in the text classification context is a standard - android.webkit.WebView. + The widget involved in the text classification context is a standard WebView. - The widget involved in the text classification context is a standard - android.webkit.WebView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_WEBVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard WebView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_WEBVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/ITextClassifierExtensions.xml b/docs/xml/Android.Views.TextClassifiers/ITextClassifierExtensions.xml index 7f259599b..a20b156b9 100644 --- a/docs/xml/Android.Views.TextClassifiers/ITextClassifierExtensions.xml +++ b/docs/xml/Android.Views.TextClassifiers/ITextClassifierExtensions.xml @@ -17,7 +17,7 @@ [<System.Runtime.CompilerServices.Nullable(0)>] - + To be added. Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -57,7 +57,7 @@ - + To be added. To be added. To be added. @@ -103,7 +103,7 @@ - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/SelectionAction.xml b/docs/xml/Android.Views.TextClassifiers/SelectionAction.xml index a197e1884..3332165c7 100644 --- a/docs/xml/Android.Views.TextClassifiers/SelectionAction.xml +++ b/docs/xml/Android.Views.TextClassifiers/SelectionAction.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 107 - To be added. + User abandoned the selection. + + User abandoned the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_ABANDON. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 101 - To be added. + User copied the selection. + + User copied the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_COPY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +106,12 @@ 103 - To be added. + User cut the selection. + + User cut the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_CUT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -124,7 +139,12 @@ 106 - To be added. + User dragged+dropped the selection. + + User dragged+dropped the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_DRAG. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -152,7 +172,12 @@ 108 - To be added. + User performed an action on the selection. + + User performed an action on the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_OTHER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -180,7 +205,12 @@ 100 - To be added. + User typed over the selection. + + User typed over the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_OVERTYPE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -208,7 +238,12 @@ 102 - To be added. + User pasted over the selection. + + User pasted over the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_PASTE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -236,7 +271,12 @@ 201 - To be added. + User reset the smart selection. + + User reset the smart selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_RESET. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -264,7 +304,12 @@ 200 - To be added. + User activated Select All + + User activated Select All + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SELECT_ALL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -292,7 +337,12 @@ 104 - To be added. + User shared the selection. + + User shared the selection. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SHARE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -320,7 +370,12 @@ 105 - To be added. + User clicked the textAssist menu item. + + User clicked the textAssist menu item. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SMART_SHARE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/SelectionEvent+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/SelectionEvent+InterfaceConsts.xml index 61c57668e..86569d6a4 100644 --- a/docs/xml/Android.Views.TextClassifiers/SelectionEvent+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/SelectionEvent+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/SelectionEvent.xml b/docs/xml/Android.Views.TextClassifiers/SelectionEvent.xml index 784d05143..78cceada4 100644 --- a/docs/xml/Android.Views.TextClassifiers/SelectionEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/SelectionEvent.xml @@ -41,18 +41,9 @@ A selection event. - A selection event. - Specify index parameters as word token indices. - - - Java documentation for android.view.textclassifier.SelectionEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + A selection event. Specify index parameters as word token indices. + Android reference for android.view.textclassifier.SelectionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -91,16 +82,8 @@ User abandoned the selection. User abandoned the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_ABANDON. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_ABANDON. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -139,16 +122,8 @@ User copied the selection. User copied the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_COPY. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_COPY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -187,16 +162,8 @@ User cut the selection. User cut the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_CUT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_CUT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -235,16 +202,8 @@ User dragged+dropped the selection. User dragged+dropped the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_DRAG. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_DRAG. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -283,16 +242,8 @@ User performed an action on the selection. User performed an action on the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_OTHER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_OTHER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -331,16 +282,8 @@ User typed over the selection. User typed over the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_OVERTYPE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_OVERTYPE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -379,16 +322,8 @@ User pasted over the selection. User pasted over the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_PASTE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_PASTE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -427,16 +362,8 @@ User reset the smart selection. User reset the smart selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_RESET. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_RESET. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -475,16 +402,8 @@ User activated Select All User activated Select All - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_SELECT_ALL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SELECT_ALL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -523,16 +442,8 @@ User shared the selection. User shared the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_SHARE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SHARE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -571,16 +482,8 @@ User clicked the textAssist menu item. User clicked the textAssist menu item. - - - Java documentation for android.view.textclassifier.SelectionEvent.ACTION_SMART_SHARE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.ACTION_SMART_SHARE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -620,24 +523,16 @@ - the start (inclusive) index of the selection - the end (exclusive) index of the selection - the action that was performed on the selection + int: the start (inclusive) index of the selection + int: the end (exclusive) index of the selection + int: the action that was performed on the selection. Value is one of the following: ACTION_OVERTYPE ACTION_COPY ACTION_PASTE ACTION_CUT ACTION_SHARE ACTION_SMART_SHARE ACTION_DRAG ACTION_ABANDON ACTION_OTHER ACTION_SELECT_ALL ACTION_RESET Creates an event specifying an action taken on a selection. - To be added. + This value cannot be null. - Creates an event specifying an action taken on a selection. - Use when the user clicks on an action to act on the selected text. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionActionEvent(int, int, int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates an event specifying an action taken on a selection. Use when the user clicks on an action to act on the selected text. + Throws: IllegalArgumentException if end is less than start + Android reference for android.view.textclassifier.SelectionEvent.createSelectionActionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -678,27 +573,18 @@ - the start (inclusive) index of the selection - the end (exclusive) index of the selection - the action that was performed on the selection - the TextClassification object returned by the TextClassifier that - classified the selected text + int: the start (inclusive) index of the selection + int: the end (exclusive) index of the selection + int: the action that was performed on the selection. Value is one of the following: ACTION_OVERTYPE ACTION_COPY ACTION_PASTE ACTION_CUT ACTION_SHARE ACTION_SMART_SHARE ACTION_DRAG ACTION_ABANDON ACTION_OTHER ACTION_SELECT_ALL ACTION_RESET + TextClassification: the TextClassification object returned by the TextClassifier that classified the selected text. This value cannot be null. Creates an event specifying an action taken on a selection. - To be added. + This value cannot be null. - Creates an event specifying an action taken on a selection. - Use when the user clicks on an action to act on the selected text and the selection's - entity type is known. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionActionEvent(int, int, int, android.view.textclassifier.TextClassification). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates an event specifying an action taken on a selection. Use when the user clicks on an action to act on the selected text and the selection's entity type is known. + Throws: IllegalArgumentException if end is less than start + Throws: IllegalArgumentException If actionType is not a valid SelectionEvent actionType + Android reference for android.view.textclassifier.SelectionEvent.createSelectionActionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -730,23 +616,15 @@ - the start (inclusive) index of the selection - the end (exclusive) index of the selection + int: the start (inclusive) index of the selection + int: the end (exclusive) index of the selection Creates a "selection modified" event. - To be added. + This value cannot be null. - Creates a "selection modified" event. - Use when the user modifies the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent(int, int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates a "selection modified" event. Use when the user modifies the selection. + Throws: IllegalArgumentException if end is less than start + Android reference for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -779,25 +657,16 @@ - the start (inclusive) index of the selection - the end (exclusive) index of the selection - the TextClassification object returned by the TextClassifier that - classified the selected text + int: the start (inclusive) index of the selection + int: the end (exclusive) index of the selection + TextClassification: the TextClassification object returned by the TextClassifier that classified the selected text. This value cannot be null. Creates a "selection modified" event. - To be added. + This value cannot be null. - Creates a "selection modified" event. - Use when the user modifies the selection and the selection's entity type is known. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent(int, int, android.view.textclassifier.TextClassification). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates a "selection modified" event. Use when the user modifies the selection and the selection's entity type is known. + Throws: IllegalArgumentException if end is less than start + Android reference for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -830,25 +699,16 @@ - the start (inclusive) index of the selection - the end (exclusive) index of the selection - the TextSelection object returned by the TextClassifier for the - specified selection + int: the start (inclusive) index of the selection + int: the end (exclusive) index of the selection + TextSelection: the TextSelection object returned by the TextClassifier for the specified selection. This value cannot be null. Creates a "selection modified" event. - To be added. + This value cannot be null. - Creates a "selection modified" event. - Use when a TextClassifier modifies the selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent(int, int, android.view.textclassifier.TextSelection). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates a "selection modified" event. Use when a TextClassifier modifies the selection. + Throws: IllegalArgumentException if end is less than start + Android reference for android.view.textclassifier.SelectionEvent.createSelectionModifiedEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -887,22 +747,14 @@ - the way the selection was triggered - the index of the selected text + int: the way the selection was triggered. Value is one of the following: INVOCATION_MANUAL INVOCATION_LINK INVOCATION_UNKNOWN + int: the index of the selected text Creates a "selection started" event. - To be added. + This value cannot be null. Creates a "selection started" event. - - - Java documentation for android.view.textclassifier.SelectionEvent.createSelectionStartedEvent(int, int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.createSelectionStartedEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -967,9 +819,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.SelectionEvent.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -996,22 +852,11 @@ System.Int64 - Returns the duration in ms between when this event was triggered and when the previous event - in the selection session was triggered. - To be added. + Returns the duration in ms between when this event was triggered and when the previous event in the selection session was triggered. - Returns the duration in ms between when this event was triggered and when the previous event - in the selection session was triggered. - - - Java documentation for android.view.textclassifier.SelectionEvent.getDurationSincePreviousEvent(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the duration in ms between when this event was triggered and when the previous event in the selection session was triggered. + Android reference for android.view.textclassifier.SelectionEvent.getDurationSincePreviousEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1039,22 +884,11 @@ System.Int64 - Returns the duration in ms between when this event was triggered and when the first event in - the selection session was triggered. - To be added. + Returns the duration in ms between when this event was triggered and when the first event in the selection session was triggered. - Returns the duration in ms between when this event was triggered and when the first event in - the selection session was triggered. - - - Java documentation for android.view.textclassifier.SelectionEvent.getDurationSinceSessionStart(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the duration in ms between when this event was triggered and when the first event in the selection session was triggered. + Android reference for android.view.textclassifier.SelectionEvent.getDurationSinceSessionStart. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1082,22 +916,11 @@ System.Int32 - Returns the end index of this events relative to the index of the start selection - event in the selection session. - To be added. + Returns the end index of this events relative to the index of the start selection event in the selection session. - Returns the end index of this events relative to the index of the start selection - event in the selection session. - - - Java documentation for android.view.textclassifier.SelectionEvent.getEnd(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the end index of this events relative to the index of the start selection event in the selection session. + Android reference for android.view.textclassifier.SelectionEvent.getEnd. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1134,20 +957,11 @@ Returns the type of entity that is associated with this event. - To be added. + Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP . This value cannot be null. - Returns the type of entity that is associated with this event. e.g. - android.view.textclassifier.TextClassifier#TYPE_EMAIL. - - - Java documentation for android.view.textclassifier.SelectionEvent.getEntityType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the type of entity that is associated with this event. e.g. TextClassifier.TYPE_EMAIL. + Android reference for android.view.textclassifier.SelectionEvent.getEntityType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1186,16 +1000,8 @@ Something else other than User or the default TextClassifier triggered a selection. Something else other than User or the default TextClassifier triggered a selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.EVENT_AUTO_SELECTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_AUTO_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1223,20 +1029,11 @@ System.Int32 - Returns the index (e. - To be added. + Returns the index (e.g. Returns the index (e.g. 1st event, 2nd event, etc.) of this event in the selection session. - - - Java documentation for android.view.textclassifier.SelectionEvent.getEventIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getEventIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1275,16 +1072,8 @@ User modified an existing selection. User modified an existing selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_MODIFIED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_MODIFIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1323,16 +1112,8 @@ User started a new selection. User started a new selection. - - - Java documentation for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_STARTED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_STARTED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1371,16 +1152,8 @@ Smart selection triggered spanning multiple tokens (words). Smart selection triggered spanning multiple tokens (words). - - - Java documentation for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_MULTI. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_MULTI. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1419,16 +1192,8 @@ Smart selection triggered for a single token (word). Smart selection triggered for a single token (word). - - - Java documentation for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_SINGLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_SINGLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1457,19 +1222,10 @@ Returns the time this event was triggered. - To be added. Returns the time this event was triggered. - - - Java documentation for android.view.textclassifier.SelectionEvent.getEventTime(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getEventTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1498,19 +1254,11 @@ Returns the type of event that was triggered. - To be added. + Value is one of the following: ACTION_OVERTYPE ACTION_COPY ACTION_PASTE ACTION_CUT ACTION_SHARE ACTION_SMART_SHARE ACTION_DRAG ACTION_ABANDON ACTION_OTHER ACTION_SELECT_ALL ACTION_RESET EVENT_SELECTION_STARTED EVENT_SELECTION_MODIFIED EVENT_SMART_SELECTION_SINGLE EVENT_SMART_SELECTION_MULTI EVENT_AUTO_SELECTION - Returns the type of event that was triggered. e.g. #ACTION_COPY. - - - Java documentation for android.view.textclassifier.SelectionEvent.getEventType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the type of event that was triggered. e.g. ACTION_COPY. + Android reference for android.view.textclassifier.SelectionEvent.getEventType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1549,16 +1297,8 @@ Selection was invoked by the user tapping on a link. Selection was invoked by the user tapping on a link. - - - Java documentation for android.view.textclassifier.SelectionEvent.INVOCATION_LINK. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_LINK. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1597,16 +1337,8 @@ Selection was invoked by the user long pressing, double tapping, or dragging to select. Selection was invoked by the user long pressing, double tapping, or dragging to select. - - - Java documentation for android.view.textclassifier.SelectionEvent.INVOCATION_MANUAL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_MANUAL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1635,19 +1367,11 @@ Returns the way the selection mode was invoked. - To be added. + Value is one of the following: INVOCATION_MANUAL INVOCATION_LINK INVOCATION_UNKNOWN Returns the way the selection mode was invoked. - - - Java documentation for android.view.textclassifier.SelectionEvent.getInvocationMethod(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getInvocationMethod. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1686,16 +1410,8 @@ Unknown invocation method Unknown invocation method - - - Java documentation for android.view.textclassifier.SelectionEvent.INVOCATION_UNKNOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1733,22 +1449,12 @@ - To be added. + int: Value is one of the following: ACTION_OVERTYPE ACTION_COPY ACTION_PASTE ACTION_CUT ACTION_SHARE ACTION_SMART_SHARE ACTION_DRAG ACTION_ABANDON ACTION_OTHER ACTION_SELECT_ALL ACTION_RESET EVENT_SELECTION_STARTED EVENT_SELECTION_MODIFIED EVENT_SMART_SELECTION_SINGLE EVENT_SMART_SELECTION_MULTI EVENT_AUTO_SELECTION Returns true if the eventType is a terminal event type. - To be added. - Returns true if the eventType is a terminal event type. Otherwise returns false. - A terminal event is an event that ends a selection interaction. - - - Java documentation for android.view.textclassifier.SelectionEvent.isTerminal(int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns true if the eventType is a terminal event type. Otherwise returns false. A terminal event is an event that ends a selection interaction. + Android reference for android.view.textclassifier.SelectionEvent.isTerminal. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1778,7 +1484,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -1809,19 +1515,11 @@ Returns the package name of the app that this event originated in. - To be added. + This value cannot be null. Returns the package name of the app that this event originated in. - - - Java documentation for android.view.textclassifier.SelectionEvent.getPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1854,19 +1552,11 @@ Returns the id of the text classifier result associated with this event. - To be added. + This value may be null. Returns the id of the text classifier result associated with this event. - - - Java documentation for android.view.textclassifier.SelectionEvent.getResultId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getResultId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1899,19 +1589,11 @@ Returns the selection session id. - To be added. + This value may be null. Returns the selection session id. - - - Java documentation for android.view.textclassifier.SelectionEvent.getSessionId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getSessionId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1939,22 +1621,11 @@ System.Int32 - Returns the end index of this events relative to the index of the smart selection - event in the selection session. - To be added. + Returns the end index of this events relative to the index of the smart selection event in the selection session. - Returns the end index of this events relative to the index of the smart selection - event in the selection session. - - - Java documentation for android.view.textclassifier.SelectionEvent.getSmartEnd(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the end index of this events relative to the index of the smart selection event in the selection session. + Android reference for android.view.textclassifier.SelectionEvent.getSmartEnd. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1982,22 +1653,11 @@ System.Int32 - Returns the start index of this events relative to the index of the smart selection - event in the selection session. - To be added. + Returns the start index of this events relative to the index of the smart selection event in the selection session. - Returns the start index of this events relative to the index of the smart selection - event in the selection session. - - - Java documentation for android.view.textclassifier.SelectionEvent.getSmartStart(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the start index of this events relative to the index of the smart selection event in the selection session. + Android reference for android.view.textclassifier.SelectionEvent.getSmartStart. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -2025,22 +1685,11 @@ System.Int32 - Returns the start index of this events relative to the index of the start selection - event in the selection session. - To be added. + Returns the start index of this events relative to the index of the start selection event in the selection session. - Returns the start index of this events relative to the index of the start selection - event in the selection session. - - - Java documentation for android.view.textclassifier.SelectionEvent.getStart(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the start index of this events relative to the index of the start selection event in the selection session. + Android reference for android.view.textclassifier.SelectionEvent.getStart. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -2067,7 +1716,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -2096,7 +1745,7 @@ System.Type - + To be added. To be added. To be added. @@ -2131,19 +1780,11 @@ Returns the type of widget that was involved in triggering this event. - To be added. + Value is one of the following: TextClassifier.WIDGET_TYPE_TEXTVIEW TextClassifier.WIDGET_TYPE_EDITTEXT TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_WEBVIEW TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_NOTIFICATION TextClassifier.WIDGET_TYPE_CLIPBOARD TextClassifier.WIDGET_TYPE_UNKNOWN . This value cannot be null. Returns the type of widget that was involved in triggering this event. - - - Java documentation for android.view.textclassifier.SelectionEvent.getWidgetType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getWidgetType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -2176,19 +1817,11 @@ Returns a string version info for the widget this event was triggered in. - To be added. + This value may be null. Returns a string version info for the widget this event was triggered in. - - - Java documentation for android.view.textclassifier.SelectionEvent.getWidgetVersion(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.SelectionEvent.getWidgetVersion. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -2230,10 +1863,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.SelectionEvent.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/SelectionEventType.xml b/docs/xml/Android.Views.TextClassifiers/SelectionEventType.xml index 51dac26d0..253cba553 100644 --- a/docs/xml/Android.Views.TextClassifiers/SelectionEventType.xml +++ b/docs/xml/Android.Views.TextClassifiers/SelectionEventType.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 5 - To be added. + Something else other than User or the default TextClassifier triggered a selection. + + Something else other than User or the default TextClassifier triggered a selection. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_AUTO_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 2 - To be added. + User modified an existing selection. + + User modified an existing selection. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_MODIFIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +106,12 @@ 1 - To be added. + User started a new selection. + + User started a new selection. + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SELECTION_STARTED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -124,7 +139,12 @@ 4 - To be added. + Smart selection triggered spanning multiple tokens (words). + + Smart selection triggered spanning multiple tokens (words). + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_MULTI. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -152,7 +172,12 @@ 3 - To be added. + Smart selection triggered for a single token (word). + + Smart selection triggered for a single token (word). + Android reference for android.view.textclassifier.SelectionEvent.EVENT_SMART_SELECTION_SINGLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/SelectionInvocationMethod.xml b/docs/xml/Android.Views.TextClassifiers/SelectionInvocationMethod.xml index 8068c2b7b..bfdc7e621 100644 --- a/docs/xml/Android.Views.TextClassifiers/SelectionInvocationMethod.xml +++ b/docs/xml/Android.Views.TextClassifiers/SelectionInvocationMethod.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 2 - To be added. + Selection was invoked by the user tapping on a link. + + Selection was invoked by the user tapping on a link. + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_LINK. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 1 - To be added. + Selection was invoked by the user long pressing, double tapping, or dragging to select. + + Selection was invoked by the user long pressing, double tapping, or dragging to select. + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_MANUAL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +106,12 @@ 0 - To be added. + Unknown invocation method + + Unknown invocation method + Android reference for android.view.textclassifier.SelectionEvent.INVOCATION_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification+Builder.xml index 8842d3230..ddce922a0 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification+Builder.xml @@ -26,29 +26,11 @@ - Builder for building TextClassification objects. + Builder for building TextClassification objects. - Builder for building TextClassification objects. - e.g. - {@code - TextClassification classification = new TextClassification.Builder() - .setText(classifiedText) - .setEntityType(TextClassifier.TYPE_EMAIL, 0.9) - .setEntityType(TextClassifier.TYPE_OTHER, 0.1) - .addAction(remoteAction1) - .addAction(remoteAction2) - .build(); - } - - - Java documentation for android.view.textclassifier.TextClassification.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builder for building TextClassification objects. e.g. + Android reference for android.view.textclassifier.TextClassification.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -106,10 +88,14 @@ - To be added. - To be added. - To be added. - To be added. + RemoteAction: This value cannot be null. + Adds an action that may be performed on the classified text. + This value cannot be null. + + Adds an action that may be performed on the classified text. Actions should be added in order of likelihood that the user will use them, with the most likely action being added first. + Android reference for android.view.textclassifier.TextClassification.Builder.addAction. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -137,20 +123,12 @@ - Builds and returns a TextClassification object. - To be added. + Builds and returns a TextClassification object. + This value cannot be null. - Builds and returns a TextClassification object. - - - Java documentation for android.view.textclassifier.TextClassification.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builds and returns a TextClassification object. + Android reference for android.view.textclassifier.TextClassification.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -177,7 +155,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. @@ -213,12 +191,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value cannot be null. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP + float: a value from 0 (low confidence) to 1 (high confidence). 0 implies the entity does not exist for the classified text. Values greater than 1 are clamped to 1. Value is between 0.0f and 1.0f inclusive + Sets an entity type for the classification result and assigns a confidence score. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + Sets an entity type for the classification result and assigns a confidence score. If a confidence score had already been set for the specified entity type, this will override that score. + Android reference for android.view.textclassifier.TextClassification.Builder.setEntityType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -256,10 +236,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + This value cannot be null. + + Sets the extended data. + Android reference for android.view.textclassifier.TextClassification.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -300,11 +284,14 @@ - To be added. - To be added. - To be added. + Drawable: This value may be null. + This method was deprecated in API level 28. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use addAction(RemoteAction) instead. + Sets the icon for the primary action that may be rendered on a widget used to act on the classified text. NOTE: This field is not parcelled. If read from a parcel, the returned icon represents the icon of the first RemoteAction (if one exists). + Android reference for android.view.textclassifier.TextClassification.Builder.setIcon. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -342,10 +329,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets an id for the TextClassification object. + This value cannot be null. + + Sets an id for the TextClassification object. + Android reference for android.view.textclassifier.TextClassification.Builder.setId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -386,11 +377,14 @@ - To be added. - To be added. - To be added. + Intent: This value may be null. + This method was deprecated in API level 28. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use addAction(RemoteAction) instead. + Sets the intent for the primary action that may be fired to act on the classified text. NOTE: This field is not parcelled. + Android reference for android.view.textclassifier.TextClassification.Builder.setIntent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -432,11 +426,14 @@ - To be added. - To be added. - To be added. + String: This value may be null. + This method was deprecated in API level 28. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use addAction(RemoteAction) instead. + Sets the label for the primary action that may be rendered on a widget used to act on the classified text. NOTE: This field is not parcelled. If read from a parcel, the returned label represents the label of the first RemoteAction (if one exists). + Android reference for android.view.textclassifier.TextClassification.Builder.setLabel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -478,11 +475,14 @@ - To be added. - To be added. - To be added. + View.OnClickListener: This value may be null. + This method was deprecated in API level 28. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use addAction(RemoteAction) instead. + Sets the OnClickListener for the primary action that may be triggered to act on the classified text. NOTE: This field is not parcelable. If read from a parcel, the returned OnClickListener represents the first RemoteAction (if one exists). + Android reference for android.view.textclassifier.TextClassification.Builder.setOnClickListener. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -520,11 +520,13 @@ - To be added. - To be added. - To be added. + String: This value may be null. + Sets the classified text. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + Sets the classified text. + Android reference for android.view.textclassifier.TextClassification.Builder.setText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -551,7 +553,7 @@ System.IntPtr - + To be added. To be added. @@ -582,7 +584,7 @@ System.Type - + To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification+InterfaceConsts.xml index 482efa989..5f272d238 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+Builder.xml index d18cba292..7fca639b1 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + A builder for building TextClassification requests. + + A builder for building TextClassification requests. + Android reference for android.view.textclassifier.TextClassification.Request.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -121,9 +125,13 @@ - To be added. - To be added. - To be added. + Builds and returns the request object. + This value cannot be null. + + Builds and returns the request object. + Android reference for android.view.textclassifier.TextClassification.Request.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -149,7 +157,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -229,10 +237,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + this builder. This value cannot be null. + + Sets the extended data. + Android reference for android.view.textclassifier.TextClassification.Request.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -269,10 +281,14 @@ - To be added. - To be added. - To be added. - To be added. + The reference time used to interpret relative dates. This should usually be the time when the text was originally composed. If it is not set, the current time is used. + Sets the reference time used to interpret relative dates. + This builder. + + Relative dates, such as "tomorrow," are interpreted using this reference time. + Android reference for android.view.textclassifier.TextClassification.Request.Builder.setReferenceTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -298,7 +314,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -327,7 +343,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+InterfaceConsts.xml index c4e725879..5f9f0d4a9 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request.xml index 73a0af325..da5afdad2 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification+Request.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification+Request.xml @@ -42,16 +42,8 @@ A request object for generating TextClassification. A request object for generating TextClassification. - - - Java documentation for android.view.textclassifier.TextClassification.Request. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.Request. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,20 +72,10 @@ Returns the name of the package that sent this request. - To be added. - Returns the name of the package that sent this request. - This returns null if no calling package name is set. - - - Java documentation for android.view.textclassifier.TextClassification.Request.getCallingPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the name of the package that sent this request. This returns null if no calling package name is set. + Android reference for android.view.textclassifier.TextClassification.Request.getCallingPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -195,9 +177,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassification.Request.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -225,19 +211,11 @@ Returns end index of the text to classify. - To be added. + Value is 0 or greater Returns end index of the text to classify. - - - Java documentation for android.view.textclassifier.TextClassification.Request.getEndIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.Request.getEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -270,20 +248,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextClassification.Request.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextClassification.Request.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -317,7 +286,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -389,19 +358,11 @@ Returns start index of the text to classify. - To be added. + Value is 0 or greater Returns start index of the text to classify. - - - Java documentation for android.view.textclassifier.TextClassification.Request.getStartIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.Request.getStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -424,7 +385,7 @@ System.String - + To be added. To be added. To be added. @@ -458,22 +419,12 @@ Java.Lang.ICharSequence - Returns the text providing context for the text to classify (which is specified - by the sub sequence starting at startIndex and ending at endIndex) - To be added. + Returns the text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex) + This value cannot be null. - Returns the text providing context for the text to classify (which is specified - by the sub sequence starting at startIndex and ending at endIndex) - - - Java documentation for android.view.textclassifier.TextClassification.Request.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex) + Android reference for android.view.textclassifier.TextClassification.Request.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -500,7 +451,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -533,7 +484,7 @@ System.Type - + To be added. To be added. To be added. @@ -577,10 +528,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassification.Request.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassification.xml b/docs/xml/Android.Views.TextClassifiers/TextClassification.xml index 343a5b195..4f6ac808a 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassification.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassification.xml @@ -41,56 +41,9 @@ Information for generating a widget to handle classified text. - Information for generating a widget to handle classified text. - A TextClassification object contains icons, labels, onClickListeners and intents that may - be used to build a widget that can be used to act on classified text. There is the concept of a - primary action and other secondary actions. - e.g. building a view that, when clicked, shares the classified text with the preferred app: - {@code - // Called preferably outside the UiThread. - TextClassification classification = textClassifier.classifyText(allText, 10, 25); - - // Called on the UiThread. - Button button = new Button(context); - button.setCompoundDrawablesWithIntrinsicBounds(classification.getIcon(), null, null, null); - button.setText(classification.getLabel()); - button.setOnClickListener(v -> classification.getActions().get(0).getActionIntent().send()); - } - e.g. starting an action mode with menu items that can handle the classified text: - {@code - // Called preferably outside the UiThread. - final TextClassification classification = textClassifier.classifyText(allText, 10, 25); - - // Called on the UiThread. - view.startActionMode(new ActionMode.Callback() { - - public boolean onCreateActionMode(ActionMode mode, Menu menu) { - for (int i = 0; i < classification.getActions().size(); ++i) { - RemoteAction action = classification.getActions().get(i); - menu.add(Menu.NONE, i, 20, action.getTitle()) - .setIcon(action.getIcon()); - } - return true; - } - - public boolean onActionItemClicked(ActionMode mode, MenuItem item) { - classification.getActions().get(item.getItemId()).getActionIntent().send(); - return true; - } - - ... - }); - } - - - Java documentation for android.view.textclassifier.TextClassification. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Information for generating a widget to handle classified text. A TextClassification object contains icons, labels, onClickListeners and intents that may be used to build a widget that can be used to act on classified text. There is the concept of a primary action and other secondary actions. e.g. building a view that, when clicked, shares the classified text with the preferred app: e.g. starting an action mode with menu items that can handle the classified text: + Android reference for android.view.textclassifier.TextClassification. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -123,20 +76,10 @@ Returns a list of actions that may be performed on the text. - To be added. - Returns a list of actions that may be performed on the text. The list is ordered based on - the likelihood that a user will use the action, with the most likely action appearing first. - - - Java documentation for android.view.textclassifier.TextClassification.getActions(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns a list of actions that may be performed on the text. The list is ordered based on the likelihood that a user will use the action, with the most likely action appearing first. + Android reference for android.view.textclassifier.TextClassification.getActions. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -197,9 +140,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassification.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -227,19 +174,11 @@ Returns the number of entities found in the classified text. - To be added. + Value is 0 or greater Returns the number of entities found in the classified text. - - - Java documentation for android.view.textclassifier.TextClassification.getEntityCount(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.getEntityCount. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -272,20 +211,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextClassification.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextClassification.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -327,23 +257,13 @@ - To be added. + String: Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP Returns the confidence score for the specified entity. - To be added. + Value is between 0.0f and 1.0f inclusive - Returns the confidence score for the specified entity. The value ranges from - 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the - classified text. - - - Java documentation for android.view.textclassifier.TextClassification.getConfidenceScore(java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the confidence score for the specified entity. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the classified text. + Android reference for android.view.textclassifier.TextClassification.getConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -382,22 +302,15 @@ - To be added. + int Returns the entity at the specified index. - To be added. + This value cannot be null. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP - Returns the entity at the specified index. Entities are ordered from high confidence - to low confidence. - - - Java documentation for android.view.textclassifier.TextClassification.getEntity(int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the entity at the specified index. Entities are ordered from high confidence to low confidence. + See also: + Throws: IndexOutOfBoundsException if the specified index is out of range. + Android reference for android.view.textclassifier.TextClassification.getEntity. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -429,23 +342,13 @@ Android.Graphics.Drawables.Drawable - Returns an icon that may be rendered on a widget used to act on the classified text. - To be added. + This method was deprecated in API level 28. + This value may be null. - Returns an icon that may be rendered on a widget used to act on the classified text. - <strong>NOTE: </strong>This field is not parcelable and only represents the icon of the - first RemoteAction (if one exists) when this object is read from a parcel. - This member is deprecated. Use #getActions() instead. - - - Java documentation for android.view.textclassifier.TextClassification.getIcon(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use getActions() instead. + Returns an icon that may be rendered on a widget used to act on the classified text. NOTE: This field is not parcelable and only represents the icon of the first RemoteAction (if one exists) when this object is read from a parcel. + Android reference for android.view.textclassifier.TextClassification.getIcon. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -474,19 +377,11 @@ Returns the id, if one exists, for this object. - To be added. + This value may be null. Returns the id, if one exists, for this object. - - - Java documentation for android.view.textclassifier.TextClassification.getId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.getId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -518,23 +413,12 @@ Android.Content.Intent - Returns an intent that may be fired to act on the classified text. - To be added. + This method was deprecated in API level 28. - Returns an intent that may be fired to act on the classified text. - <strong>NOTE: </strong>This field is not parcelled and will always return null when this - object is read from a parcel. - This member is deprecated. Use #getActions() instead. - - - Java documentation for android.view.textclassifier.TextClassification.getIntent(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use getActions() instead. + Returns an intent that may be fired to act on the classified text. NOTE: This field is not parcelled and will always return null when this object is read from a parcel. + Android reference for android.view.textclassifier.TextClassification.getIntent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -568,7 +452,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. @@ -595,7 +479,7 @@ System.String - + To be added. To be added. @@ -631,23 +515,13 @@ Java.Lang.ICharSequence - Returns a label that may be rendered on a widget used to act on the classified text. - To be added. + This method was deprecated in API level 28. + This value may be null. - Returns a label that may be rendered on a widget used to act on the classified text. - <strong>NOTE: </strong>This field is not parcelable and only represents the label of the - first RemoteAction (if one exists) when this object is read from a parcel. - This member is deprecated. Use #getActions() instead. - - - Java documentation for android.view.textclassifier.TextClassification.getLabel(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use getActions() instead. + Returns a label that may be rendered on a widget used to act on the classified text. NOTE: This field is not parcelable and only represents the label of the first RemoteAction (if one exists) when this object is read from a parcel. + Android reference for android.view.textclassifier.TextClassification.getLabel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -679,19 +553,13 @@ Android.Views.View+IOnClickListener - Returns the OnClickListener that may be triggered to act on the classified text. - To be added. + This method was deprecated in API level 28. + This value may be null. - - - Java documentation for android.view.textclassifier.TextClassification.getOnClickListener(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + This method was deprecated in API level 28. Use getActions() instead. + Returns the OnClickListener that may be triggered to act on the classified text. NOTE: This field is not parcelable and only represents the first RemoteAction (if one exists) when this object is read from a parcel. + Android reference for android.view.textclassifier.TextClassification.getOnClickListener. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -720,19 +588,11 @@ Gets the classified text. - To be added. + This value may be null. Gets the classified text. - - - Java documentation for android.view.textclassifier.TextClassification.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassification.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -759,7 +619,7 @@ System.IntPtr - + To be added. To be added. @@ -794,7 +654,7 @@ System.Type - + To be added. To be added. @@ -840,10 +700,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassification.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+Builder.xml index 0572167da..076cd8568 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+Builder.xml @@ -29,16 +29,8 @@ A builder for building a TextClassification context. A builder for building a TextClassification context. - - - Java documentation for android.view.textclassifier.TextClassificationContext.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -67,22 +59,13 @@ - the name of the calling package - the type of widget e.g. TextClassifier#WIDGET_TYPE_TEXTVIEW + String: the name of the calling package. This value cannot be null. + String: the type of widget e.g. TextClassifier.WIDGET_TYPE_TEXTVIEW This value cannot be null. Value is one of the following: TextClassifier.WIDGET_TYPE_TEXTVIEW TextClassifier.WIDGET_TYPE_EDITTEXT TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_WEBVIEW TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_NOTIFICATION TextClassifier.WIDGET_TYPE_CLIPBOARD TextClassifier.WIDGET_TYPE_UNKNOWN Initializes a new builder for text classification context objects. - this builder Initializes a new builder for text classification context objects. - - - Java documentation for android.view.textclassifier.TextClassificationContext.Builder.TextClassificationContext$Builder(java.lang.String, java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -112,19 +95,11 @@ Builds the text classification context object. - the built TextClassificationContext object + the built TextClassificationContext object. This value cannot be null. Builds the text classification context object. - - - Java documentation for android.view.textclassifier.TextClassificationContext.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -151,7 +126,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -184,10 +159,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets an optional custom version string for the widget type. + this builder + + Sets an optional custom version string for the widget type. + Android reference for android.view.textclassifier.TextClassificationContext.Builder.setWidgetVersion. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -213,7 +192,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -242,7 +221,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+InterfaceConsts.xml index 419183e73..85978419e 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext.xml index 2a7f8f9e5..d55c3a42a 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationContext.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationContext.xml @@ -42,16 +42,8 @@ A representation of the context in which text classification would be performed. A representation of the context in which text classification would be performed. - - - Java documentation for android.view.textclassifier.TextClassificationContext. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -116,9 +108,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassificationContext.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -147,7 +143,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -178,19 +174,11 @@ Returns the package name of the app that this context originated in. - To be added. + This value cannot be null. Returns the package name of the app that this context originated in. - - - Java documentation for android.view.textclassifier.TextClassificationContext.getPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext.getPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -217,7 +205,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -246,7 +234,7 @@ System.Type - + To be added. To be added. To be added. @@ -281,19 +269,11 @@ Returns the widget type for this classification context. - To be added. + This value cannot be null. Value is one of the following: TextClassifier.WIDGET_TYPE_TEXTVIEW TextClassifier.WIDGET_TYPE_EDITTEXT TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_WEBVIEW TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW TextClassifier.WIDGET_TYPE_NOTIFICATION TextClassifier.WIDGET_TYPE_CLIPBOARD TextClassifier.WIDGET_TYPE_UNKNOWN Returns the widget type for this classification context. - - - Java documentation for android.view.textclassifier.TextClassificationContext.getWidgetType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationContext.getWidgetType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -326,19 +306,12 @@ Returns a custom version string for the widget type. - To be added. + This value may be null. Returns a custom version string for the widget type. - - - Java documentation for android.view.textclassifier.TextClassificationContext.getWidgetVersion(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.TextClassificationContext.getWidgetVersion. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -380,10 +353,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassificationContext.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationManager.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationManager.xml index ca337bd46..4245ad5ed 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationManager.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationManager.xml @@ -29,16 +29,8 @@ Interface to the text classification service. Interface to the text classification service. - - - Java documentation for android.view.textclassifier.TextClassificationManager. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationManager. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -69,30 +61,13 @@ - The context in which classification would occur + TextClassificationContext: The context in which classification would occur. This value cannot be null. Call this method to start a text classification session with the given context. - An instance to perform classification in the given context + An instance to perform classification in the given context. This value cannot be null. - Call this method to start a text classification session with the given context. - A session is created with a context helping the classifier better understand - what the user needs and consists of queries and feedback events. The queries - are directly related to providing useful functionality to the user and the events - are a feedback loop back to the classifier helping it learn and better serve - future queries. - All interactions with the returned classifier are considered part of a single - session and are logically grouped. For example, when a text widget is focused - all user interactions around text editing (selection, editing, etc) can be - grouped together to allow the classifier get better. - - - Java documentation for android.view.textclassifier.TextClassificationManager.createTextClassificationSession(android.view.textclassifier.TextClassificationContext). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Call this method to start a text classification session with the given context. A session is created with a context helping the classifier better understand what the user needs and consists of queries and feedback events. The queries are directly related to providing useful functionality to the user and the events are a feedback loop back to the classifier helping it learn and better serve future queries. All interactions with the returned classifier are considered part of a single session and are logically grouped. For example, when a text widget is focused all user interactions around text editing (selection, editing, etc) can be grouped together to allow the classifier get better. + Android reference for android.view.textclassifier.TextClassificationManager.createTextClassificationSession. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -119,7 +94,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. @@ -154,21 +129,12 @@ - the textClassification session factory. If this is null, the default factory - will be used. + TextClassificationSessionFactory: the textClassification session factory. If this is null, the default factory will be used. Sets a TextClassificationSessionFactory to be used to create session-aware TextClassifiers. Sets a TextClassificationSessionFactory to be used to create session-aware TextClassifiers. - - - Java documentation for android.view.textclassifier.TextClassificationManager.setTextClassificationSessionFactory(android.view.textclassifier.TextClassificationSessionFactory). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationManager.setTextClassificationSessionFactory. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -204,34 +170,13 @@ Android.Views.TextClassifiers.ITextClassifier - Returns the text classifier that was set via #setTextClassifier(TextClassifier). -or- Sets the text classifier. - To be added. + Gets or sets the text classifier. - Property getter documentation: - Returns the text classifier that was set via #setTextClassifier(TextClassifier). - If this is null, this method returns a default text classifier (i.e. either the system text - classifier if one exists, or a local text classifier running in this process.) - Note that requests to the TextClassifier may be handled in an OEM-provided process rather - than in the calling app's process. - - - Java documentation for android.view.textclassifier.TextClassificationManager.getTextClassifier(). - - - Property setter documentation: - Sets the text classifier. - Set to null to use the system default text classifier. - Set to TextClassifier#NO_OP to disable text classifier features. - - - Java documentation for android.view.textclassifier.TextClassificationManager.setTextClassifier(android.view.textclassifier.TextClassifier). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the text classifier that was set via setTextClassifier(TextClassifier). If this is null, this method returns a default text classifier (i.e. either the system text classifier if one exists, or a local text classifier running in this process.) Note that requests to the TextClassifier may be handled in an OEM-provided process rather than in the calling app's process. + Sets the text classifier to use. + Android reference for android.view.textclassifier.TextClassificationManager.getTextClassifier. + Android reference for android.view.textclassifier.TextClassificationManager.setTextClassifier. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -258,7 +203,7 @@ System.IntPtr - + To be added. To be added. @@ -289,7 +234,7 @@ System.Type - + To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId+InterfaceConsts.xml index 656c1d160..bf03b1eee 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId.xml b/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId.xml index 8515af682..2d4009447 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassificationSessionId.xml @@ -42,16 +42,8 @@ This class represents the id of a text classification session. This class represents the id of a text classification session. - - - Java documentation for android.view.textclassifier.TextClassificationSessionId. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationSessionId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -116,9 +108,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassificationSessionId.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -147,7 +143,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -176,7 +172,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -205,7 +201,7 @@ System.Type - + To be added. To be added. To be added. @@ -236,19 +232,11 @@ Returns the value of this ID. - To be added. + This value cannot be null. Returns the value of this ID. - - - Java documentation for android.view.textclassifier.TextClassificationSessionId.getValue(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassificationSessionId.getValue. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -290,10 +278,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassificationSessionId.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifier.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifier.xml index 4d050414d..ee5bd4bf2 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifier.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifier.xml @@ -34,14 +34,11 @@ - To be added. + Interface for providing text classification related features. - - - Android platform documentation - - - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + Interface for providing text classification related features. The TextClassifier may be used to understand the meaning of text, as well as generating predicted next actions based on the text. NOTE: Unless otherwise stated, methods of this interface are blocking operations. Call on a worker thread. + Android reference for android.view.textclassifier.TextClassifier. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -73,23 +70,11 @@ System.String - Extra that is included on activity intents coming from a TextClassifier when - it suggests actions to its caller. + Extra that is included on activity intents coming from a TextClassifier when it suggests actions to its caller. - Extra that is included on activity intents coming from a TextClassifier when - it suggests actions to its caller. - All TextClassifier implementations should make sure this extra exists in their - generated intents. - - - Java documentation for android.view.textclassifier.TextClassifier.EXTRA_FROM_TEXT_CLASSIFIER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Extra that is included on activity intents coming from a TextClassifier when it suggests actions to its caller. All TextClassifier implementations should make sure this extra exists in their generated intents. + Android reference for android.view.textclassifier.TextClassifier.EXTRA_FROM_TEXT_CLASSIFIER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -123,20 +108,9 @@ Extra specifying the package name of the app from which the text to be classified originated. - Extra specifying the package name of the app from which the text to be classified originated. - For example, a notification assistant might use TextClassifier, but the notification - content could originate from a different app. This key allows you to provide - the package name of that source app. - - - Java documentation for android.view.textclassifier.TextClassifier.EXTRA_TEXT_ORIGIN_PACKAGE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Extra specifying the package name of the app from which the text to be classified originated. For example, a notification assistant might use TextClassifier, but the notification content could originate from a different app. This key allows you to provide the package name of that source app. + Android reference for android.view.textclassifier.TextClassifier.EXTRA_TEXT_ORIGIN_PACKAGE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -171,16 +145,8 @@ Designates that the text in question is editable. Designates that the text in question is editable. * - - - Java documentation for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_EDITABLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_EDITABLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -215,16 +181,8 @@ Designates that the text in question is not editable. Designates that the text in question is not editable. * - - - Java documentation for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_NOT_EDITABLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.HINT_TEXT_IS_NOT_EDITABLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -261,20 +219,10 @@ No-op TextClassifier. - To be added. - No-op TextClassifier. - This may be used to turn off TextClassifier features. - - - Java documentation for android.view.textclassifier.TextClassifier.NO_OP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + No-op TextClassifier. This may be used to turn off TextClassifier features. + Android reference for android.view.textclassifier.TextClassifier.NO_OP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -309,16 +257,8 @@ Physical address. Physical address. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_ADDRESS. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_ADDRESS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -352,18 +292,9 @@ Time reference that is no more specific than a date. - Time reference that is no more specific than a date. May be absolute such as "01/01/2000" or - relative like "tomorrow". * - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_DATE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Time reference that is no more specific than a date. May be absolute such as "01/01/2000" or relative like "tomorrow". * + Android reference for android.view.textclassifier.TextClassifier.TYPE_DATE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -397,18 +328,9 @@ Time reference that includes a specific time. - Time reference that includes a specific time. May be absolute such as "01/01/2000 5:30pm" or - relative like "tomorrow at 5:30pm". * - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_DATE_TIME. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Time reference that includes a specific time. May be absolute such as "01/01/2000 5:30pm" or relative like "tomorrow at 5:30pm". * + Android reference for android.view.textclassifier.TextClassifier.TYPE_DATE_TIME. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -440,19 +362,11 @@ System.String - E-mail address (e. + E-mail address (e.g. - E-mail address (e.g. "noreply - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_EMAIL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + E-mail address (e.g. "noreply.com"). + Android reference for android.view.textclassifier.TextClassifier.TYPE_EMAIL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -487,16 +401,8 @@ Flight number in IATA format. Flight number in IATA format. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_FLIGHT_NUMBER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_FLIGHT_NUMBER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -531,16 +437,8 @@ The classifier ran, but didn't recognize a known entity. The classifier ran, but didn't recognize a known entity. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_OTHER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_OTHER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -575,16 +473,8 @@ Onetime password. Onetime password. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_OTP. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_OTP. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -616,19 +506,11 @@ System.String - Phone number (e. + Phone number (e.g. Phone number (e.g. "555-123 456"). - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_PHONE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_PHONE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -663,16 +545,8 @@ The TextClassifier failed to run. The TextClassifier failed to run. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_UNKNOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -707,16 +581,8 @@ Web URL. Web URL. - - - Java documentation for android.view.textclassifier.TextClassifier.TYPE_URL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.TYPE_URL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -751,16 +617,8 @@ The text classification context is for use with the system clipboard. The text classification context is for use with the system clipboard. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CLIPBOARD. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CLIPBOARD. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -795,16 +653,8 @@ The widget involved in the text classification context is a custom editable text widget. The widget involved in the text classification context is a custom editable text widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_EDITTEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -839,16 +689,8 @@ The widget involved in the text classification context is a custom text widget. The widget involved in the text classification context is a custom text widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -880,21 +722,11 @@ System.String - The widget involved in the text classification context is a custom non-selectable text - widget. + The widget involved in the text classification context is a custom non-selectable text widget. - The widget involved in the text classification context is a custom non-selectable text - widget. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a custom non-selectable text widget. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -926,21 +758,11 @@ System.String - The widget involved in the text classification context is a standard - android.widget.EditText. + The widget involved in the text classification context is a standard EditText. - The widget involved in the text classification context is a standard - android.widget.EditText. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDITTEXT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard EditText. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDITTEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -972,21 +794,11 @@ System.String - The widget involved in the text classification context is a standard editable - android.webkit.WebView. + The widget involved in the text classification context is a standard editable WebView. - The widget involved in the text classification context is a standard editable - android.webkit.WebView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard editable WebView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_EDIT_WEBVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1021,16 +833,8 @@ The widget involved in the text classification context is a notification The widget involved in the text classification context is a notification - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_NOTIFICATION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_NOTIFICATION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1062,21 +866,11 @@ System.String - The widget involved in the text classification context is a standard - android.widget.TextView. + The widget involved in the text classification context is a standard TextView. - The widget involved in the text classification context is a standard - android.widget.TextView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard TextView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1111,16 +905,8 @@ The widget involved in the text classification context is of an unknown/unspecified type. The widget involved in the text classification context is of an unknown/unspecified type. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNKNOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNKNOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1152,21 +938,11 @@ System.String - The widget involved in the text classification context is a standard non-selectable - android.widget.TextView. + The widget involved in the text classification context is a standard non-selectable TextView. - The widget involved in the text classification context is a standard non-selectable - android.widget.TextView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard non-selectable TextView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_UNSELECTABLE_TEXTVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1198,21 +974,11 @@ System.String - The widget involved in the text classification context is a standard - android.webkit.WebView. + The widget involved in the text classification context is a standard WebView. - The widget involved in the text classification context is a standard - android.webkit.WebView. - - - Java documentation for android.view.textclassifier.TextClassifier.WIDGET_TYPE_WEBVIEW. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + The widget involved in the text classification context is a standard WebView. + Android reference for android.view.textclassifier.TextClassifier.WIDGET_TYPE_WEBVIEW. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+Builder.xml index e41c14197..3fc332a2f 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class to construct the EntityConfig object. + + Builder class to construct the EntityConfig object. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -80,9 +84,13 @@ - To be added. - To be added. - To be added. + Combines all of the options that have been set and returns a new EntityConfig object. + This value cannot be null. + + Combines all of the options that have been set and returns a new EntityConfig object. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -112,10 +120,14 @@ - To be added. - To be added. - To be added. - To be added. + boolean + Specifies whether or not to include the types suggested by the text classifier. + This value cannot be null. + + Specifies whether or not to include the types suggested by the text classifier. By default, it is included. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder.includeTypesFromTextClassifier. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -141,7 +153,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -181,10 +193,14 @@ - To be added. - To be added. - To be added. - To be added. + Collection: This value may be null. + Sets a collection of types that are explicitly excluded. + This value cannot be null. + + Sets a collection of types that are explicitly excluded. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder.setExcludedTypes. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -221,10 +237,14 @@ - To be added. - To be added. - To be added. - To be added. + Collection: This value may be null. + Sets the hints for the TextClassifier to determine what types of entities to find. + This value cannot be null. + + Sets the hints for the TextClassifier to determine what types of entities to find. These hints will only be used if includeTypesFromTextClassifier(boolean) is set to be true. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder.setHints. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -261,10 +281,14 @@ - To be added. - To be added. - To be added. - To be added. + Collection: This value may be null. + Sets a collection of types that are explicitly included. + This value cannot be null. + + Sets a collection of types that are explicitly included. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.Builder.setIncludedTypes. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -290,7 +314,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -319,7 +343,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+InterfaceConsts.xml index 9f952b725..a480382d4 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig.xml index e473b2303..617057410 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEntityConfig.xml @@ -41,18 +41,9 @@ Configuration object for specifying what entity types to identify. - Configuration object for specifying what entity types to identify. - Configs are initially based on a predefined preset, and can be modified from there. - - - Java documentation for android.view.textclassifier.TextClassifier.EntityConfig. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Configuration object for specifying what entity types to identify. Configs are initially based on a predefined preset, and can be modified from there. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -110,12 +101,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Collection: Hints for the TextClassifier to determine what types of entities to find. This value may be null. + Collection: Entity types, e.g. TextClassifier.TYPE_EMAIL, to explicitly include. This value may be null. + Collection: Entity types, e.g. TextClassifier.TYPE_PHONE, to explicitly exclude Note that if an entity has been excluded, the exclusion will take precedence. This value may be null. + This method was deprecated in API level 29. + + This method was deprecated in API level 29. Use Builder instead. + Creates an EntityConfig. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.create. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -156,10 +151,14 @@ - To be added. - To be added. - To be added. - To be added. + Collection: Complete set of entities, e.g. TextClassifier.TYPE_URL to find. This value may be null. + This method was deprecated in API level 29. + + This method was deprecated in API level 29. Use Builder instead. + Creates an EntityConfig with an explicit entity list. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.createWithExplicitEntityList. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -200,10 +199,14 @@ - To be added. - To be added. - To be added. - To be added. + Collection: Hints for the TextClassifier to determine what types of entities to find. This value may be null. + This method was deprecated in API level 29. + + This method was deprecated in API level 29. Use Builder instead. + Creates an EntityConfig. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.createWithHints. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -267,9 +270,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -304,16 +311,8 @@ An unmodifiable collection of the hints. Retrieves the list of hints. - - - Java documentation for android.view.textclassifier.TextClassifier.EntityConfig.getHints(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.getHints. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -343,7 +342,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -382,24 +381,12 @@ - Entity types we think should be found before factoring in - includes/excludes - - This method is intended for use by TextClassifier implementations. + Collection: Entity types we think should be found before factoring in includes/excludes This method is intended for use by TextClassifier implementations. This value cannot be null. Returns a final list of entity types to find. - To be added. Returns a final list of entity types to find. - - - Java documentation for android.view.textclassifier.TextClassifier.EntityConfig.resolveEntityListModifications(java.util.Collection<java.lang.String>). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.resolveEntityListModifications. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -428,24 +415,12 @@ - Return whether the client allows the text classifier to include its own list of - default types. - To be added. + Return whether the client allows the text classifier to include its own list of default types. - Return whether the client allows the text classifier to include its own list of - default types. If this function returns true, a default list of types suggested - from a text classifier will be taking into account. - NOTE: This method is intended for use by a text classifier. - - - Java documentation for android.view.textclassifier.TextClassifier.EntityConfig.shouldIncludeTypesFromTextClassifier(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Return whether the client allows the text classifier to include its own list of default types. If this function returns true, a default list of types suggested from a text classifier will be taking into account. NOTE: This method is intended for use by a text classifier. + See also: + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.shouldIncludeTypesFromTextClassifier. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -472,7 +447,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -501,7 +476,7 @@ System.Type - + To be added. To be added. To be added. @@ -545,10 +520,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassifier.EntityConfig.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+Builder.xml index de452ee29..12e1c09aa 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+Builder.xml @@ -30,20 +30,11 @@ - The subclass to be built. Builder to build a text classifier event. Builder to build a text classifier event. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -61,7 +52,7 @@ - + To be added. To be added. To be added. @@ -91,7 +82,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -131,10 +122,15 @@ - To be added. - To be added. - To be added. - To be added. + int: This value cannot be null. + Sets the indices of the actions involved in this event. + This value cannot be null. + + Sets the indices of the actions involved in this event. Actions are usually returned by the text classifier in priority order with the most preferred action at index 0. These indices give an indication of the position of the actions that are being reported. E.g. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setActionIndices. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -171,10 +167,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value cannot be null. + Sets the entity types. + This value cannot be null. + + Sets the entity types. e.g. TextClassifier.TYPE_ADDRESS. Supported types: See TextClassifier types See ConversationAction types See ULocale.toLanguageTag() + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setEntityTypes. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -211,10 +211,14 @@ - To be added. - To be added. - To be added. - To be added. + TextClassificationContext: This value may be null. + Sets the event context. + This value cannot be null. + + Sets the event context. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setEventContext. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -244,10 +248,14 @@ - To be added. - To be added. - To be added. - To be added. + int + Sets the index of this event in the series of events it belongs to. + This value cannot be null. + + Sets the index of this event in the series of events it belongs to. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setEventIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -277,10 +285,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value cannot be null. + Sets a bundle containing non-structured extra information about the event. + This value cannot be null. + + Sets a bundle containing non-structured extra information about the event. NOTE: Prefer to set only immutable values on the bundle otherwise, avoid updating the internals of this bundle as it may have unexpected consequences on the clients of the built event object. For similar reasons, avoid depending on mutable objects in this bundle. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -317,10 +329,14 @@ - To be added. - To be added. - To be added. - To be added. + ULocale: This value may be null. + Sets the detected locale. + This value cannot be null. + + Sets the detected locale. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setLocale. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -357,10 +373,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets the model name string. + This value cannot be null. + + Sets the model name string. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setModelName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -397,10 +417,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets the id of the text classifier result related to this event. + This value cannot be null. + + Sets the id of the text classifier result related to this event. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setResultId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -437,10 +461,14 @@ - To be added. - To be added. - To be added. - To be added. + float: This value cannot be null. + Sets the scores of the suggestions. + This value cannot be null. + + Sets the scores of the suggestions. + Android reference for android.view.textclassifier.TextClassifierEvent.Builder.setScores. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -466,7 +494,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -495,7 +523,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent+Builder.xml index edab221af..feb2af8bc 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class for ConversationActionsEvent. + + Builder class for ConversationActionsEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.ConversationActionsEvent.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -61,9 +65,13 @@ - To be added. - To be added. - To be added. + int: The event type. e.g. TextClassifierEvent.TYPE_SMART_ACTION Value is one of the following: TextClassifierEvent.TYPE_SELECTION_STARTED TextClassifierEvent.TYPE_SELECTION_MODIFIED TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE TextClassifierEvent.TYPE_SMART_SELECTION_MULTI TextClassifierEvent.TYPE_AUTO_SELECTION TextClassifierEvent.TYPE_ACTIONS_SHOWN TextClassifierEvent.TYPE_LINK_CLICKED TextClassifierEvent.TYPE_OVERTYPE TextClassifierEvent.TYPE_COPY_ACTION TextClassifierEvent.TYPE_PASTE_ACTION TextClassifierEvent.TYPE_CUT_ACTION TextClassifierEvent.TYPE_SHARE_ACTION TextClassifierEvent.TYPE_SMART_ACTION TextClassifierEvent.TYPE_SELECTION_DRAG TextClassifierEvent.TYPE_SELECTION_DESTROYED TextClassifierEvent.TYPE_OTHER_ACTION TextClassifierEvent.TYPE_SELECT_ALL TextClassifierEvent.TYPE_SELECTION_RESET TextClassifierEvent.TYPE_MANUAL_REPLY TextClassifierEvent.TYPE_ACTIONS_GENERATED TextClassifierEvent.TYPE_LINKS_GENERATED + Creates a builder for building TextSelectionEvents. + + Creates a builder for building TextSelectionEvents. + Android reference for android.view.textclassifier.TextClassifierEvent.ConversationActionsEvent.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -91,9 +99,13 @@ - To be added. - To be added. - To be added. + Builds and returns a ConversationActionsEvent. + This value cannot be null. + + Builds and returns a ConversationActionsEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.ConversationActionsEvent.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -119,7 +131,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -148,7 +160,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -177,7 +189,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent.xml index 715d3a525..719c6969e 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+ConversationActionsEvent.xml @@ -42,52 +42,8 @@ This class represents events that are related to the conversation actions feature. This class represents events that are related to the conversation actions feature. - - // Conversation (contextual) actions/replies generated. - new ConversationActionsEvent.Builder(TYPE_ACTIONS_GENERATED) - .setEventContext(classificationContext) - .setResultId(conversationActions.getId()) - .setEntityTypes(getTypes(conversationActions)) - .setActionIndices(range(conversationActions.getActions().size())) - .setEventIndex(0) - .build(); - - // Conversation actions/replies presented to user. - new ConversationActionsEvent.Builder(TYPE_ACTIONS_SHOWN) - .setEventContext(classificationContext) - .setResultId(conversationActions.getId()) - .setEntityTypes(getTypes(conversationActions)) - .setActionIndices(range(conversationActions.getActions().size())) - .setEventIndex(1) - .build(); - - // User clicked the "Reply" button to compose their custom reply. - new ConversationActionsEvent.Builder(TYPE_MANUAL_REPLY) - .setEventContext(classificationContext) - .setResultId(conversationActions.getId()) - .setEventIndex(2) - .build(); - - // User selected a smart (contextual) action/reply. - new ConversationActionsEvent.Builder(TYPE_SMART_ACTION) - .setEventContext(classificationContext) - .setResultId(conversationActions.getId()) - .setEntityTypes(conversationActions.get(1).getType()) - .setScore(conversationAction.get(1).getConfidenceScore()) - .setActionIndices(1) - .setEventIndex(2) - .build(); - - - - Java documentation for android.view.textclassifier.TextClassifierEvent.ConversationActionsEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.ConversationActionsEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -146,7 +102,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -175,7 +131,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -204,7 +160,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+InterfaceConsts.xml index e8072fed4..c5d3aafb0 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent+Builder.xml index 7dcf1401b..0641cd3e4 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class for LanguageDetectionEvent. + + Builder class for LanguageDetectionEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.LanguageDetectionEvent.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -61,9 +65,13 @@ - To be added. - To be added. - To be added. + int: The event type. e.g. TextClassifierEvent.TYPE_SMART_ACTION Value is one of the following: TextClassifierEvent.TYPE_SELECTION_STARTED TextClassifierEvent.TYPE_SELECTION_MODIFIED TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE TextClassifierEvent.TYPE_SMART_SELECTION_MULTI TextClassifierEvent.TYPE_AUTO_SELECTION TextClassifierEvent.TYPE_ACTIONS_SHOWN TextClassifierEvent.TYPE_LINK_CLICKED TextClassifierEvent.TYPE_OVERTYPE TextClassifierEvent.TYPE_COPY_ACTION TextClassifierEvent.TYPE_PASTE_ACTION TextClassifierEvent.TYPE_CUT_ACTION TextClassifierEvent.TYPE_SHARE_ACTION TextClassifierEvent.TYPE_SMART_ACTION TextClassifierEvent.TYPE_SELECTION_DRAG TextClassifierEvent.TYPE_SELECTION_DESTROYED TextClassifierEvent.TYPE_OTHER_ACTION TextClassifierEvent.TYPE_SELECT_ALL TextClassifierEvent.TYPE_SELECTION_RESET TextClassifierEvent.TYPE_MANUAL_REPLY TextClassifierEvent.TYPE_ACTIONS_GENERATED TextClassifierEvent.TYPE_LINKS_GENERATED + Creates a builder for building TextSelectionEvents. + + Creates a builder for building TextSelectionEvents. + Android reference for android.view.textclassifier.TextClassifierEvent.LanguageDetectionEvent.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -91,9 +99,13 @@ - To be added. - To be added. - To be added. + Builds and returns a LanguageDetectionEvent. + This value cannot be null. + + Builds and returns a LanguageDetectionEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.LanguageDetectionEvent.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -119,7 +131,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -148,7 +160,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -177,7 +189,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent.xml index 7ac3cf55d..77dd2a73a 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+LanguageDetectionEvent.xml @@ -42,36 +42,8 @@ This class represents events that are related to the language detection feature. This class represents events that are related to the language detection feature. - - // Translate action shown for foreign text. - new LanguageDetectionEvent.Builder(TYPE_ACTIONS_SHOWN) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(language) - .setScore(score) - .setActionIndices(textClassification.getActions().indexOf(translateAction)) - .setEventIndex(0) - .build(); - - // Translate action selected. - new LanguageDetectionEvent.Builder(TYPE_SMART_ACTION) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(language) - .setScore(score) - .setActionIndices(textClassification.getActions().indexOf(translateAction)) - .setEventIndex(1) - .build(); - - - Java documentation for android.view.textclassifier.TextClassifierEvent.LanguageDetectionEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.LanguageDetectionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -130,7 +102,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -159,7 +131,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -188,7 +160,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent+Builder.xml index e3ee320d4..ef67aedb6 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class for TextLinkifyEvent. + + Builder class for TextLinkifyEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.TextLinkifyEvent.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -61,9 +65,13 @@ - To be added. - To be added. - To be added. + int: The event type. e.g. TextClassifierEvent.TYPE_SMART_ACTION Value is one of the following: TextClassifierEvent.TYPE_SELECTION_STARTED TextClassifierEvent.TYPE_SELECTION_MODIFIED TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE TextClassifierEvent.TYPE_SMART_SELECTION_MULTI TextClassifierEvent.TYPE_AUTO_SELECTION TextClassifierEvent.TYPE_ACTIONS_SHOWN TextClassifierEvent.TYPE_LINK_CLICKED TextClassifierEvent.TYPE_OVERTYPE TextClassifierEvent.TYPE_COPY_ACTION TextClassifierEvent.TYPE_PASTE_ACTION TextClassifierEvent.TYPE_CUT_ACTION TextClassifierEvent.TYPE_SHARE_ACTION TextClassifierEvent.TYPE_SMART_ACTION TextClassifierEvent.TYPE_SELECTION_DRAG TextClassifierEvent.TYPE_SELECTION_DESTROYED TextClassifierEvent.TYPE_OTHER_ACTION TextClassifierEvent.TYPE_SELECT_ALL TextClassifierEvent.TYPE_SELECTION_RESET TextClassifierEvent.TYPE_MANUAL_REPLY TextClassifierEvent.TYPE_ACTIONS_GENERATED TextClassifierEvent.TYPE_LINKS_GENERATED + Creates a builder for building TextLinkifyEvents. + + Creates a builder for building TextLinkifyEvents. + Android reference for android.view.textclassifier.TextClassifierEvent.TextLinkifyEvent.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -91,9 +99,13 @@ - To be added. - To be added. - To be added. + Builds and returns a TextLinkifyEvent. + This value cannot be null. + + Builds and returns a TextLinkifyEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.TextLinkifyEvent.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -119,7 +131,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -148,7 +160,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -177,7 +189,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent.xml index b60df5636..04ac8c7a6 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextLinkifyEvent.xml @@ -42,46 +42,8 @@ This class represents events that are related to the smart linkify feature. This class represents events that are related to the smart linkify feature. - - // User clicked on a link. - new TextLinkifyEvent.Builder(TYPE_LINK_CLICKED) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(0) - .build(); - - // Smart (contextual) actions presented to the user in response to a link click. - new TextLinkifyEvent.Builder(TYPE_ACTIONS_SHOWN) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setActionIndices(range(textClassification.getActions().size())) - .setEventIndex(1) - .build(); - - // User chooses smart action at index 0. - new TextLinkifyEvent.Builder(TYPE_SMART_ACTION) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setActionIndices(0) - .setEventIndex(2) - .build(); - - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextLinkifyEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TextLinkifyEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -140,7 +102,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -169,7 +131,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -198,7 +160,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent+Builder.xml index a1f832a67..925949e94 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + Builder class for TextSelectionEvent. + + Builder class for TextSelectionEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -61,9 +65,13 @@ - To be added. - To be added. - To be added. + int: The event type. e.g. TextClassifierEvent.TYPE_SELECTION_STARTED Value is one of the following: TextClassifierEvent.TYPE_SELECTION_STARTED TextClassifierEvent.TYPE_SELECTION_MODIFIED TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE TextClassifierEvent.TYPE_SMART_SELECTION_MULTI TextClassifierEvent.TYPE_AUTO_SELECTION TextClassifierEvent.TYPE_ACTIONS_SHOWN TextClassifierEvent.TYPE_LINK_CLICKED TextClassifierEvent.TYPE_OVERTYPE TextClassifierEvent.TYPE_COPY_ACTION TextClassifierEvent.TYPE_PASTE_ACTION TextClassifierEvent.TYPE_CUT_ACTION TextClassifierEvent.TYPE_SHARE_ACTION TextClassifierEvent.TYPE_SMART_ACTION TextClassifierEvent.TYPE_SELECTION_DRAG TextClassifierEvent.TYPE_SELECTION_DESTROYED TextClassifierEvent.TYPE_OTHER_ACTION TextClassifierEvent.TYPE_SELECT_ALL TextClassifierEvent.TYPE_SELECTION_RESET TextClassifierEvent.TYPE_MANUAL_REPLY TextClassifierEvent.TYPE_ACTIONS_GENERATED TextClassifierEvent.TYPE_LINKS_GENERATED + Creates a builder for building TextSelectionEvents. + + Creates a builder for building TextSelectionEvents. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -91,9 +99,13 @@ - To be added. - To be added. - To be added. + Builds and returns a TextSelectionEvent. + This value cannot be null. + + Builds and returns a TextSelectionEvent. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -119,7 +131,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -152,10 +164,14 @@ - To be added. - To be added. - To be added. - To be added. + int + Sets the relative word (exclusive) index of the end of the smart selection. + This value cannot be null. + + Sets the relative word (exclusive) index of the end of the smart selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.setRelativeSuggestedWordEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -185,10 +201,14 @@ - To be added. - To be added. - To be added. - To be added. + int + Sets the relative word index of the start of the smart selection. + This value cannot be null. + + Sets the relative word index of the start of the smart selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.setRelativeSuggestedWordStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -218,10 +238,14 @@ - To be added. - To be added. - To be added. - To be added. + int + Sets the relative word (exclusive) index of the end of the selection. + This value cannot be null. + + Sets the relative word (exclusive) index of the end of the selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.setRelativeWordEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -251,10 +275,14 @@ - To be added. - To be added. - To be added. - To be added. + int + Sets the relative word index of the start of the selection. + This value cannot be null. + + Sets the relative word index of the start of the selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.Builder.setRelativeWordStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -280,7 +308,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -309,7 +337,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent.xml index ab0236df3..eeee002e3 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent+TextSelectionEvent.xml @@ -42,101 +42,8 @@ This class represents events that are related to the smart text selection feature. This class represents events that are related to the smart text selection feature. - - // User started a selection. e.g. "York" in text "New York City, NY". - new TextSelectionEvent.Builder(TYPE_SELECTION_STARTED) - .setEventContext(classificationContext) - .setEventIndex(0) - .build(); - - // System smart-selects a recognized entity. e.g. "New York City". - new TextSelectionEvent.Builder(TYPE_SMART_SELECTION_MULTI) - .setEventContext(classificationContext) - .setResultId(textSelection.getId()) - .setRelativeWordStartIndex(-1) // Goes back one word to "New" from "York". - .setRelativeWordEndIndex(2) // Goes forward 2 words from "York" to start of ",". - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(1) - .build(); - - // User resets the selection to the original selection. i.e. "York". - new TextSelectionEvent.Builder(TYPE_SELECTION_RESET) - .setEventContext(classificationContext) - .setResultId(textSelection.getId()) - .setRelativeSuggestedWordStartIndex(-1) // Repeated from above. - .setRelativeSuggestedWordEndIndex(2) // Repeated from above. - .setRelativeWordStartIndex(0) // Original selection is always at (0, 1]. - .setRelativeWordEndIndex(1) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(2) - .build(); - - // User modified the selection. e.g. "New". - new TextSelectionEvent.Builder(TYPE_SELECTION_MODIFIED) - .setEventContext(classificationContext) - .setResultId(textSelection.getId()) - .setRelativeSuggestedWordStartIndex(-1) // Repeated from above. - .setRelativeSuggestedWordEndIndex(2) // Repeated from above. - .setRelativeWordStartIndex(-1) // Goes backward one word from "York" to - "New". - .setRelativeWordEndIndex(0) // Goes backward one word to exclude "York". - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(3) - .build(); - - // Smart (contextual) actions (at indices, 0, 1, 2) presented to the user. - // e.g. "Map", "Ride share", "Explore". - new TextSelectionEvent.Builder(TYPE_ACTIONS_SHOWN) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setActionIndices(0, 1, 2) - .setEventIndex(4) - .build(); - - // User chooses the "Copy" action. - new TextSelectionEvent.Builder(TYPE_COPY_ACTION) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(5) - .build(); - - // User chooses smart action at index 1. i.e. "Ride share". - new TextSelectionEvent.Builder(TYPE_SMART_ACTION) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setActionIndices(1) - .setEventIndex(5) - .build(); - - // Selection dismissed. - new TextSelectionEvent.Builder(TYPE_SELECTION_DESTROYED) - .setEventContext(classificationContext) - .setResultId(textClassification.getId()) - .setEntityTypes(textClassification.getEntity(0)) - .setScore(textClassification.getConfidenceScore(entityType)) - .setEventIndex(6) - .build(); - - - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -195,7 +102,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -225,22 +132,11 @@ System.Int32 - Returns the relative word (exclusive) index of the end of the - smart selection. - To be added. + Returns the relative word (exclusive) index of the end of the smart selection. - Returns the relative word (exclusive) index of the end of the - smart selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeSuggestedWordEndIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the relative word (exclusive) index of the end of the smart selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeSuggestedWordEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -269,19 +165,10 @@ Returns the relative word index of the start of the smart selection. - To be added. Returns the relative word index of the start of the smart selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeSuggestedWordStartIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeSuggestedWordStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -310,19 +197,10 @@ Returns the relative word (exclusive) index of the end of the selection. - To be added. Returns the relative word (exclusive) index of the end of the selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeWordEndIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeWordEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -351,19 +229,10 @@ Returns the relative word index of the start of the selection. - To be added. Returns the relative word index of the start of the selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeWordStartIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TextSelectionEvent.getRelativeWordStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -390,7 +259,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -419,7 +288,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent.xml index b3a4a495e..3b5cc89d9 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEvent.xml @@ -39,24 +39,11 @@ - This class represents events that are sent by components to the TextClassifier to report - something of note that relates to a feature powered by the TextClassifier. + This class represents events that are sent by components to the TextClassifier to report something of note that relates to a feature powered by the TextClassifier. - This class represents events that are sent by components to the TextClassifier to report - something of note that relates to a feature powered by the TextClassifier. The TextClassifier may - log these events or use them to improve future responses to queries. - Each category of events has its their own subclass. Events of each type have an associated - set of related properties. You can find their specification in the subclasses. - - - Java documentation for android.view.textclassifier.TextClassifierEvent. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + This class represents events that are sent by components to the TextClassifier to report something of note that relates to a feature powered by the TextClassifier. The TextClassifier may log these events or use them to improve future responses to queries. Each category of events has its their own subclass. Events of each type have an associated set of related properties. You can find their specification in the subclasses. + Android reference for android.view.textclassifier.TextClassifierEvent. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -74,7 +61,7 @@ - + To be added. To be added. To be added. @@ -116,16 +103,9 @@ Conversation actions Conversation actions - - - Java documentation for android.view.textclassifier.TextClassifierEvent.CATEGORY_CONVERSATION_ACTIONS. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_CONVERSATION_ACTIONS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -164,16 +144,9 @@ Language detection Language detection - - - Java documentation for android.view.textclassifier.TextClassifierEvent.CATEGORY_LANGUAGE_DETECTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_LANGUAGE_DETECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -212,16 +185,9 @@ Linkify Linkify - - - Java documentation for android.view.textclassifier.TextClassifierEvent.CATEGORY_LINKIFY. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_LINKIFY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -260,16 +226,9 @@ Smart selection Smart selection - - - Java documentation for android.view.textclassifier.TextClassifierEvent.CATEGORY_SELECTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -330,9 +289,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextClassifierEvent.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -360,19 +323,11 @@ Returns the event category. - To be added. + Value is one of the following: CATEGORY_SELECTION CATEGORY_LINKIFY CATEGORY_CONVERSATION_ACTIONS CATEGORY_LANGUAGE_DETECTION - Returns the event category. e.g. #CATEGORY_SELECTION. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getEventCategory(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the event category. e.g. CATEGORY_SELECTION. + Android reference for android.view.textclassifier.TextClassifierEvent.getEventCategory. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -405,19 +360,11 @@ Returns the event context. - To be added. + This value may be null. Returns the event context. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getEventContext(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getEventContext. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -446,19 +393,10 @@ Returns the index of this event in the series of event it belongs to. - To be added. Returns the index of this event in the series of event it belongs to. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getEventIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getEventIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -487,19 +425,11 @@ Returns the event type. - To be added. + Value is one of the following: TYPE_SELECTION_STARTED TYPE_SELECTION_MODIFIED TYPE_SMART_SELECTION_SINGLE TYPE_SMART_SELECTION_MULTI TYPE_AUTO_SELECTION TYPE_ACTIONS_SHOWN TYPE_LINK_CLICKED TYPE_OVERTYPE TYPE_COPY_ACTION TYPE_PASTE_ACTION TYPE_CUT_ACTION TYPE_SHARE_ACTION TYPE_SMART_ACTION TYPE_SELECTION_DRAG TYPE_SELECTION_DESTROYED TYPE_OTHER_ACTION TYPE_SELECT_ALL TYPE_SELECTION_RESET TYPE_MANUAL_REPLY TYPE_ACTIONS_GENERATED TYPE_LINKS_GENERATED - Returns the event type. e.g. #TYPE_SELECTION_STARTED. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getEventType(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the event type. e.g. TYPE_SELECTION_STARTED. + Android reference for android.view.textclassifier.TextClassifierEvent.getEventType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -528,20 +458,11 @@ Returns a bundle containing non-structured extra information about this event. - To be added. + This value cannot be null. - Returns a bundle containing non-structured extra information about this event. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns a bundle containing non-structured extra information about this event. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextClassifierEvent.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -571,22 +492,12 @@ Returns the indices of the actions relating to this event. - To be added. + This value cannot be null. - Returns the indices of the actions relating to this event. - Actions are usually returned by the text classifier in priority order with the most - preferred action at index 0. This list gives an indication of the position of the actions - that are being reported. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getActionIndices(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the indices of the actions relating to this event. Actions are usually returned by the text classifier in priority order with the most preferred action at index 0. This list gives an indication of the position of the actions that are being reported. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.getActionIndices. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -616,19 +527,12 @@ Returns an array of entity types. - To be added. + This value cannot be null. - Returns an array of entity types. e.g. TextClassifier#TYPE_ADDRESS. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getEntityTypes(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns an array of entity types. e.g. TextClassifier.TYPE_ADDRESS. + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.getEntityTypes. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -658,19 +562,11 @@ Returns the scores of the suggestions. - To be added. + This value cannot be null. Returns the scores of the suggestions. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getScores(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getScores. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -700,7 +596,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -735,19 +631,11 @@ Returns the detected locale. - To be added. + This value may be null. Returns the detected locale. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getLocale(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getLocale. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -780,19 +668,11 @@ Returns the model name. - To be added. + This value may be null. Returns the model name. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getModelName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getModelName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -825,19 +705,11 @@ Returns the id of the text classifier result related to this event. - To be added. + This value may be null. Returns the id of the text classifier result related to this event. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.getResultId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.getResultId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -864,7 +736,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -893,7 +765,7 @@ System.Type - + To be added. To be added. To be added. @@ -934,16 +806,8 @@ TextClassifier generated some actions TextClassifier generated some actions - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_GENERATED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_GENERATED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -982,16 +846,8 @@ Smart actions shown to the user. Smart actions shown to the user. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_SHOWN. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_SHOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1030,16 +886,8 @@ Something else other than user or the default TextClassifier triggered a selection. Something else other than user or the default TextClassifier triggered a selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_AUTO_SELECTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_AUTO_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1078,16 +926,8 @@ User clicked on Copy action. User clicked on Copy action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_COPY_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_COPY_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1126,16 +966,8 @@ User clicked on Cut action. User clicked on Cut action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_CUT_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_CUT_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1174,16 +1006,8 @@ User clicked a link. User clicked a link. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_LINK_CLICKED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_LINK_CLICKED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1222,16 +1046,8 @@ Some text links were generated. Some text links were generated. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_LINKS_GENERATED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_LINKS_GENERATED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1270,16 +1086,8 @@ User composed a reply. User composed a reply. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_MANUAL_REPLY. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_MANUAL_REPLY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1318,16 +1126,8 @@ User clicked on a custom action. User clicked on a custom action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_OTHER_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_OTHER_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1366,16 +1166,8 @@ User typed over the selection. User typed over the selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_OVERTYPE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_OVERTYPE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1414,16 +1206,8 @@ User clicked on Paste action. User clicked on Paste action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_PASTE_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_PASTE_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1462,16 +1246,8 @@ User clicked on Select All action User clicked on Select All action - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECT_ALL. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECT_ALL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1510,16 +1286,8 @@ Selection is destroyed. Selection is destroyed. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DESTROYED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DESTROYED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1558,16 +1326,8 @@ User dragged+dropped the selection. User dragged+dropped the selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DRAG. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DRAG. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1606,16 +1366,8 @@ User modified an existing selection. User modified an existing selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_MODIFIED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_MODIFIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1654,16 +1406,8 @@ User reset the smart selection. User reset the smart selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_RESET. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_RESET. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1702,16 +1446,8 @@ User started a new selection. User started a new selection. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_STARTED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_STARTED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1750,16 +1486,8 @@ User clicked on Share action. User clicked on Share action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SHARE_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SHARE_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1798,16 +1526,8 @@ User clicked on a Smart action. User clicked on a Smart action. - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_ACTION. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1846,16 +1566,8 @@ Smart selection triggered spanning multiple tokens (words). Smart selection triggered spanning multiple tokens (words). - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_MULTI. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_MULTI. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1894,16 +1606,8 @@ Smart selection triggered for a single token (word). Smart selection triggered for a single token (word). - - - Java documentation for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -1945,10 +1649,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextClassifierEvent.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEventCategory.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEventCategory.xml index f9e1bd97f..c20a5e346 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEventCategory.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEventCategory.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,13 @@ 3 - To be added. + Conversation actions + + Conversation actions + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_CONVERSATION_ACTIONS. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +74,13 @@ 4 - To be added. + Language detection + + Language detection + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_LANGUAGE_DETECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +108,13 @@ 2 - To be added. + Linkify + + Linkify + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_LINKIFY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -124,7 +142,13 @@ 1 - To be added. + Smart selection + + Smart selection + See also: + Android reference for android.view.textclassifier.TextClassifierEvent.CATEGORY_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextClassifierEventType.xml b/docs/xml/Android.Views.TextClassifiers/TextClassifierEventType.xml index 1607efed0..2e4a10b32 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextClassifierEventType.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextClassifierEventType.xml @@ -10,7 +10,7 @@ System.Enum - + To be added. To be added. @@ -40,7 +40,12 @@ 20 - To be added. + TextClassifier generated some actions + + TextClassifier generated some actions + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_GENERATED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -68,7 +73,12 @@ 6 - To be added. + Smart actions shown to the user. + + Smart actions shown to the user. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_ACTIONS_SHOWN. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -96,7 +106,12 @@ 5 - To be added. + Something else other than user or the default TextClassifier triggered a selection. + + Something else other than user or the default TextClassifier triggered a selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_AUTO_SELECTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -124,7 +139,12 @@ 9 - To be added. + User clicked on Copy action. + + User clicked on Copy action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_COPY_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -152,7 +172,12 @@ 11 - To be added. + User clicked on Cut action. + + User clicked on Cut action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_CUT_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -180,7 +205,12 @@ 7 - To be added. + User clicked a link. + + User clicked a link. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_LINK_CLICKED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -208,7 +238,12 @@ 21 - To be added. + Some text links were generated. + + Some text links were generated. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_LINKS_GENERATED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -236,7 +271,12 @@ 19 - To be added. + User composed a reply. + + User composed a reply. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_MANUAL_REPLY. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -264,7 +304,12 @@ 16 - To be added. + User clicked on a custom action. + + User clicked on a custom action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_OTHER_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -292,7 +337,12 @@ 8 - To be added. + User typed over the selection. + + User typed over the selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_OVERTYPE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -320,7 +370,12 @@ 10 - To be added. + User clicked on Paste action. + + User clicked on Paste action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_PASTE_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -348,7 +403,12 @@ 17 - To be added. + User clicked on Select All action + + User clicked on Select All action + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECT_ALL. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -376,7 +436,12 @@ 15 - To be added. + Selection is destroyed. + + Selection is destroyed. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DESTROYED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -404,7 +469,12 @@ 14 - To be added. + User dragged+dropped the selection. + + User dragged+dropped the selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_DRAG. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -432,7 +502,12 @@ 2 - To be added. + User modified an existing selection. + + User modified an existing selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_MODIFIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -460,7 +535,12 @@ 18 - To be added. + User reset the smart selection. + + User reset the smart selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_RESET. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -488,7 +568,12 @@ 1 - To be added. + User started a new selection. + + User started a new selection. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SELECTION_STARTED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -516,7 +601,12 @@ 12 - To be added. + User clicked on Share action. + + User clicked on Share action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SHARE_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -544,7 +634,12 @@ 13 - To be added. + User clicked on a Smart action. + + User clicked on a Smart action. + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_ACTION. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -572,7 +667,12 @@ 4 - To be added. + Smart selection triggered spanning multiple tokens (words). + + Smart selection triggered spanning multiple tokens (words). + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_MULTI. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -600,7 +700,12 @@ 3 - To be added. + Smart selection triggered for a single token (word). + + Smart selection triggered for a single token (word). + Android reference for android.view.textclassifier.TextClassifierEvent.TYPE_SMART_SELECTION_SINGLE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Builder.xml index 274bd5773..3477bee36 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Builder.xml @@ -29,16 +29,8 @@ Builder used to build TextLanguage objects. Builder used to build TextLanguage objects. - - - Java documentation for android.view.textclassifier.TextLanguage.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLanguage.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -93,20 +85,11 @@ Builds and returns a new TextLanguage object. - To be added. + This value cannot be null. - Builds and returns a new TextLanguage object. - If necessary, this method will verify fields, clamp them, and make them immutable. - - - Java documentation for android.view.textclassifier.TextLanguage.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builds and returns a new TextLanguage object. If necessary, this method will verify fields, clamp them, and make them immutable. + Android reference for android.view.textclassifier.TextLanguage.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -133,7 +116,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -167,11 +150,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + ULocale: This value cannot be null. + float: a value from 0 (low confidence) to 1 (high confidence). 0 implies the locale does not exist for the processed text. Values greater than 1 are clamped to 1. Value is between 0.0f and 1.0f inclusive + Sets a language locale for the processed text and assigns a confidence score. + This value cannot be null. + + Sets a language locale for the processed text and assigns a confidence score. If the locale has already been set, this updates it. + Android reference for android.view.textclassifier.TextLanguage.Builder.putLocale. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -201,10 +188,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value cannot be null. + Sets a bundle containing non-structured extra information about the TextLanguage object. + This value cannot be null. + + Sets a bundle containing non-structured extra information about the TextLanguage object. + Android reference for android.view.textclassifier.TextLanguage.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -241,10 +232,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets an optional id for the TextLanguage object. + This value cannot be null. + + Sets an optional id for the TextLanguage object. + Android reference for android.view.textclassifier.TextLanguage.Builder.setId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -270,7 +265,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -299,7 +294,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage+InterfaceConsts.xml index 3d7675a3b..d584b511a 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+Builder.xml index f9da61d79..528bfe1b2 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + A builder for building TextLanguage requests. + + A builder for building TextLanguage requests. + Android reference for android.view.textclassifier.TextLanguage.Request.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -54,9 +58,13 @@ - To be added. - To be added. - To be added. + The text to process. This value cannot be null. + Creates a builder to build TextLanguage requests. + + Creates a builder to build TextLanguage requests. + Android reference for android.view.textclassifier.TextLanguage.Request.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -83,9 +91,13 @@ - To be added. - To be added. - To be added. + The text to process. This value cannot be null. + Creates a builder to build TextLanguage requests. + + Creates a builder to build TextLanguage requests. + Android reference for android.view.textclassifier.TextLanguage.Request.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -113,9 +125,13 @@ - To be added. - To be added. - To be added. + Builds and returns a new TextLanguage request object. + This value cannot be null. + + Builds and returns a new TextLanguage request object. If necessary, this method will verify fields, clamp them, and make them immutable. + Android reference for android.view.textclassifier.TextLanguage.Request.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -141,7 +157,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -174,10 +190,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value cannot be null. + Sets a bundle containing non-structured extra information about the request. + This value cannot be null. + + Sets a bundle containing non-structured extra information about the request. + Android reference for android.view.textclassifier.TextLanguage.Request.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -203,7 +223,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -232,7 +252,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+InterfaceConsts.xml index 76a3fdb02..5547b32ef 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request.xml index b756403e7..0e2acf7f9 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage+Request.xml @@ -42,16 +42,8 @@ A request object for detecting the language of a piece of text. A request object for detecting the language of a piece of text. - - - Java documentation for android.view.textclassifier.TextLanguage.Request. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLanguage.Request. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -84,20 +76,10 @@ Returns the name of the package that sent this request. - To be added. - Returns the name of the package that sent this request. - This returns null if no calling package name is set. - - - Java documentation for android.view.textclassifier.TextLanguage.Request.getCallingPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the name of the package that sent this request. This returns null if no calling package name is set. + Android reference for android.view.textclassifier.TextLanguage.Request.getCallingPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -158,9 +140,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextLanguage.Request.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -188,20 +174,11 @@ Returns a bundle containing non-structured extra information about this request. - To be added. + This value cannot be null. - Returns a bundle containing non-structured extra information about this request. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextLanguage.Request.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns a bundle containing non-structured extra information about this request. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextLanguage.Request.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -231,7 +208,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -260,7 +237,7 @@ System.String - + To be added. To be added. To be added. @@ -291,19 +268,11 @@ Returns the text to process. - To be added. + This value cannot be null. Returns the text to process. - - - Java documentation for android.view.textclassifier.TextLanguage.Request.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLanguage.Request.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -330,7 +299,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -359,7 +328,7 @@ System.Type - + To be added. To be added. To be added. @@ -403,10 +372,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextLanguage.Request.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextLanguage.xml b/docs/xml/Android.Views.TextClassifiers/TextLanguage.xml index 5fc29d53b..b636397f8 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLanguage.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLanguage.xml @@ -41,22 +41,9 @@ Represents the result of language detection of a piece of text. - Represents the result of language detection of a piece of text. - This contains a list of locales, each paired with a confidence score, sorted in decreasing - order of those scores. E.g., for a given input text, the model may return - [<"en", 0.85>, <"fr", 0.15>]. This sample result means the model reports that it is - 85% likely that the entire text is in English and 15% likely that the entire text is in French, - etc. It does not mean that 85% of the input is in English and 15% is in French. - - - Java documentation for android.view.textclassifier.TextLanguage. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Represents the result of language detection of a piece of text. This contains a list of locales, each paired with a confidence score, sorted in decreasing order of those scores. E.g., for a given input text, the model may return [<"en", 0.85>, <"fr", 0.15>]. This sample result means the model reports that it is 85% likely that the entire text is in English and 15% likely that the entire text is in French, etc. It does not mean that 85% of the input is in English and 15% is in French. + Android reference for android.view.textclassifier.TextLanguage. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -117,9 +104,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextLanguage.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -147,21 +138,11 @@ Returns a bundle containing non-structured extra information about this result. - To be added. + This value cannot be null. - Returns a bundle containing non-structured extra information about this result. What is - returned in the extras is specific to the TextClassifier implementation. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextLanguage.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns a bundle containing non-structured extra information about this result. What is returned in the extras is specific to the TextClassifier implementation. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextLanguage.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -192,23 +173,13 @@ - To be added. + ULocale: This value cannot be null. Returns the confidence score for the specified language locale. - To be added. + Value is between 0.0f and 1.0f inclusive - Returns the confidence score for the specified language locale. The value ranges from - 0 (low confidence) to 1 (high confidence). 0 indicates that the locale was not found for - the processed text. - - - Java documentation for android.view.textclassifier.TextLanguage.getConfidenceScore(android.icu.util.ULocale). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the confidence score for the specified language locale. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the locale was not found for the processed text. + Android reference for android.view.textclassifier.TextLanguage.getConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -239,23 +210,14 @@ - To be added. + int Returns the language locale at the specified index. - To be added. + This value cannot be null. - Returns the language locale at the specified index. Locales are ordered from high - confidence to low confidence. - See #getLocaleHypothesisCount() for the number of locales available. - - - Java documentation for android.view.textclassifier.TextLanguage.getLocale(int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the language locale at the specified index. Locales are ordered from high confidence to low confidence. See getLocaleHypothesisCount() for the number of locales available. + Throws: IndexOutOfBoundsException if the specified index is out of range. + Android reference for android.view.textclassifier.TextLanguage.getLocale. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -288,19 +250,11 @@ Returns the id, if one exists, for this object. - To be added. + This value may be null. Returns the id, if one exists, for this object. - - - Java documentation for android.view.textclassifier.TextLanguage.getId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLanguage.getId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -330,7 +284,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -361,19 +315,11 @@ Returns the number of possible locales for the processed text. - To be added. + Value is 0 or greater Returns the number of possible locales for the processed text. - - - Java documentation for android.view.textclassifier.TextLanguage.getLocaleHypothesisCount(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLanguage.getLocaleHypothesisCount. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -400,7 +346,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -429,7 +375,7 @@ System.Type - + To be added. To be added. To be added. @@ -473,10 +419,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextLanguage.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+Builder.xml index 81831ee27..308506764 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+Builder.xml @@ -29,16 +29,8 @@ A builder to construct a TextLinks instance. A builder to construct a TextLinks instance. - - - Java documentation for android.view.textclassifier.TextLinks.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -66,20 +58,12 @@ - The full text to annotate with links - Create a new TextLinks. + String: The full text to annotate with links. This value cannot be null. + Create a new TextLinks.Builder. Create a new TextLinks.Builder. - - - Java documentation for android.view.textclassifier.TextLinks.Builder.TextLinks$Builder(java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -112,12 +96,17 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + int: The start index of the identified subsequence + int: The end index of the identified subsequence + Map: A mapping of entity type to confidence score. This value cannot be null. + Adds a TextLink. + This value cannot be null. + + Adds a TextLink. + Throws: IllegalArgumentException if entityScores is null or empty. + Android reference for android.view.textclassifier.TextLinks.Builder.addLink. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -150,13 +139,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + int + int + Map: This value cannot be null. + Bundle: An optional bundle containing custom data related to this TextLink. This value cannot be null. + Adds a TextLink. + This value cannot be null. + + Adds a TextLink. + See also: + Android reference for android.view.textclassifier.TextLinks.Builder.addLink. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -185,19 +179,11 @@ Constructs a TextLinks instance. - the constructed TextLinks + the constructed TextLinks. This value cannot be null. Constructs a TextLinks instance. - - - Java documentation for android.view.textclassifier.TextLinks.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -226,9 +212,13 @@ - To be added. - To be added. - To be added. + Removes all TextLinks. + This value cannot be null. + + Removes all TextLinks. + Android reference for android.view.textclassifier.TextLinks.Builder.clearTextLinks. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -254,7 +244,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -294,10 +284,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + this builder. This value cannot be null. + + Sets the extended data. + Android reference for android.view.textclassifier.TextLinks.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -323,7 +317,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -352,7 +346,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+InterfaceConsts.xml index ed20d6c03..b3a134e4d 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+Builder.xml index 135b3fb44..6a0d7bf27 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + A builder for building TextLinks requests. + + A builder for building TextLinks requests. + Android reference for android.view.textclassifier.TextLinks.Request.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -113,9 +117,13 @@ - To be added. - To be added. - To be added. + Builds and returns the request object. + This value cannot be null. + + Builds and returns the request object. + Android reference for android.view.textclassifier.TextLinks.Request.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -141,7 +149,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -181,10 +189,14 @@ - To be added. - To be added. - To be added. - To be added. + LocaleList: ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list. + Sets ordered list of locale preferences that may be used to disambiguate the provided text. + this builder. This value cannot be null. + + Sets ordered list of locale preferences that may be used to disambiguate the provided text. + Android reference for android.view.textclassifier.TextLinks.Request.Builder.setDefaultLocales. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -221,10 +233,14 @@ - To be added. - To be added. - To be added. - To be added. + TextClassifier.EntityConfig: This value may be null. + Sets the entity configuration to use. + this builder + + Sets the entity configuration to use. This determines what types of entities the TextClassifier will look for. Set to null for the default entity config and the TextClassifier will automatically determine what links to generate. + Android reference for android.view.textclassifier.TextLinks.Request.Builder.setEntityConfig. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -254,10 +270,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + this builder + + Sets the extended data. + Android reference for android.view.textclassifier.TextLinks.Request.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -294,10 +314,14 @@ - To be added. - To be added. - To be added. - To be added. + The reference time used to interpret relative dates. This should usually be the time when the text was originally composed. + Sets the reference time used to interpret relative dates. + This builder. + + Relative dates, such as "tomorrow," are interpreted using this reference time. + Android reference for android.view.textclassifier.TextLinks.Request.Builder.setReferenceTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -323,7 +347,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -352,7 +376,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+InterfaceConsts.xml index 8aef788e0..57e911f45 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request.xml index ffc280eea..94f7534de 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+Request.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+Request.xml @@ -42,16 +42,8 @@ A request object for generating TextLinks. A request object for generating TextLinks. - - - Java documentation for android.view.textclassifier.TextLinks.Request. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.Request. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,20 +72,10 @@ Returns the name of the package that sent this request. - To be added. - Returns the name of the package that sent this request. - This returns null if no calling package name is set. - - - Java documentation for android.view.textclassifier.TextLinks.Request.getCallingPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the name of the package that sent this request. This returns null if no calling package name is set. + Android reference for android.view.textclassifier.TextLinks.Request.getCallingPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -150,22 +132,12 @@ Android.OS.LocaleList - Returns an ordered list of locale preferences that can be used to disambiguate the - provided text. - To be added. + Returns an ordered list of locale preferences that can be used to disambiguate the provided text. + This value may be null. - Returns an ordered list of locale preferences that can be used to disambiguate the - provided text. - - - Java documentation for android.view.textclassifier.TextLinks.Request.getDefaultLocales(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns an ordered list of locale preferences that can be used to disambiguate the provided text. + Android reference for android.view.textclassifier.TextLinks.Request.getDefaultLocales. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -197,9 +169,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextLinks.Request.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -226,9 +202,14 @@ Android.Views.TextClassifiers.TextClassifierEntityConfig - To be added. - To be added. - To be added. + Returns the config representing the set of entities to look for + This value may be null. + + Returns the config representing the set of entities to look for + See also: + Android reference for android.view.textclassifier.TextLinks.Request.getEntityConfig. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -260,20 +241,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextLinks.Request.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextLinks.Request.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -307,7 +279,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -337,21 +309,12 @@ Java.Time.ZonedDateTime - Returns reference time based on which relative dates (e. - To be added. + Returns reference time based on which relative dates (e.g. + This value may be null. - Returns reference time based on which relative dates (e.g. "tomorrow") should be - interpreted. - - - Java documentation for android.view.textclassifier.TextLinks.Request.getReferenceTime(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns reference time based on which relative dates (e.g. "tomorrow") should be interpreted. + Android reference for android.view.textclassifier.TextLinks.Request.getReferenceTime. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -374,7 +337,7 @@ System.String - + To be added. To be added. To be added. @@ -409,19 +372,11 @@ Returns the text to generate links for. - To be added. + This value cannot be null. Returns the text to generate links for. - - - Java documentation for android.view.textclassifier.TextLinks.Request.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.Request.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -448,7 +403,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -481,7 +436,7 @@ System.Type - + To be added. To be added. To be added. @@ -525,10 +480,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextLinks.Request.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink+InterfaceConsts.xml index 443b5670e..097e66a36 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink.xml index aa9b8062b..3d41a8ad1 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLink.xml @@ -42,16 +42,8 @@ A link, identifying a substring of text and possible entity types for it. A link, identifying a substring of text and possible entity types for it. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -116,9 +108,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextLinks.TextLink.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -149,16 +145,8 @@ the end index Returns the end index of this link in the original text. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getEnd(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getEnd. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -190,16 +178,8 @@ the entity count Returns the number of entity types that have confidence scores. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getEntityCount(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getEntityCount. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -228,19 +208,11 @@ Returns a bundle containing custom data related to this TextLink. - To be added. + This value cannot be null. Returns a bundle containing custom data related to this TextLink. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -271,21 +243,13 @@ - the entity type + String: the entity type. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP Returns the confidence score for a particular entity type. - To be added. + Value is between 0.0f and 1.0f inclusive Returns the confidence score for a particular entity type. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getConfidenceScore(java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -316,21 +280,13 @@ - To be added. + int Returns the entity type at a given index. - the entity type at the provided index + the entity type at the provided index. This value cannot be null. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP Returns the entity type at a given index. Entity types are sorted by confidence. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getEntity(int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getEntity. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -360,7 +316,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -394,16 +350,8 @@ the start index Returns the start index of this link in the original text. - - - Java documentation for android.view.textclassifier.TextLinks.TextLink.getStart(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.TextLink.getStart. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -430,7 +378,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -459,7 +407,7 @@ System.Type - + To be added. To be added. To be added. @@ -503,10 +451,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextLinks.TextLink.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLinkSpan.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLinkSpan.xml index dca6e81f3..7609da568 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLinkSpan.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks+TextLinkSpan.xml @@ -28,18 +28,9 @@ A ClickableSpan for a TextLink. - A ClickableSpan for a TextLink. - Applies only to TextViews. - - - Java documentation for android.view.textclassifier.TextLinks.TextLinkSpan. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + A ClickableSpan for a TextLink. Applies only to TextViews. + Android reference for android.view.textclassifier.TextLinks.TextLinkSpan. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -86,7 +77,7 @@ - + To be added. To be added. To be added. @@ -116,7 +107,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -149,9 +140,13 @@ - To be added. - To be added. - To be added. + View: This value cannot be null. + Performs the click action associated with this span. + + Performs the click action associated with this span. + Android reference for android.view.textclassifier.TextLinks.TextLinkSpan.onClick. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -210,7 +205,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -239,7 +234,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextLinks.xml b/docs/xml/Android.Views.TextClassifiers/TextLinks.xml index 762b5843e..bbdb1a509 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextLinks.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextLinks.xml @@ -39,21 +39,11 @@ - A collection of links, representing subsequences of text and the entity types (phone number, - address, url, etc) they may be. + A collection of links, representing subsequences of text and the entity types (phone number, address, url, etc) they may be. - A collection of links, representing subsequences of text and the entity types (phone number, - address, url, etc) they may be. - - - Java documentation for android.view.textclassifier.TextLinks. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + A collection of links, representing subsequences of text and the entity types (phone number, address, url, etc) they may be. + Android reference for android.view.textclassifier.TextLinks. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -106,29 +96,15 @@ - the text to apply the links to. Must match the original text - the apply strategy used to determine how to apply links to text. - e.g TextLinks#APPLY_STRATEGY_IGNORE - a custom span factory for converting TextLinks to TextLinkSpans. - Set to null to use the default span factory. + Spannable: the text to apply the links to. Must match the original text. This value cannot be null. + int: the apply strategy used to determine how to apply links to text. e.g TextLinks.APPLY_STRATEGY_IGNORE Value is one of the following: APPLY_STRATEGY_IGNORE APPLY_STRATEGY_REPLACE + Function: a custom span factory for converting TextLinks to TextLinkSpans. Set to null to use the default span factory. Annotates the given text with the generated links. - a status code indicating whether or not the links were successfully applied - e.g. #STATUS_LINKS_APPLIED + a status code indicating whether or not the links were successfully applied e.g. STATUS_LINKS_APPLIED Value is one of the following: STATUS_LINKS_APPLIED STATUS_NO_LINKS_FOUND STATUS_NO_LINKS_APPLIED STATUS_DIFFERENT_TEXT STATUS_UNSUPPORTED_CHARACTER - Annotates the given text with the generated links. It will fail if the provided text doesn't - match the original text used to create the TextLinks. - <strong>NOTE: </strong>It may be necessary to set a LinkMovementMethod on the TextView - widget to properly handle links. See TextView#setMovementMethod(MovementMethod) - - - Java documentation for android.view.textclassifier.TextLinks.apply(android.text.Spannable, int, java.util.function.Function<android.view.textclassifier.TextLinks.TextLink, android.view.textclassifier.TextLinks.TextLinkSpan>). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Annotates the given text with the generated links. It will fail if the provided text doesn't match the original text used to create the TextLinks. NOTE: It may be necessary to set a LinkMovementMethod on the TextView widget to properly handle links. See TextView.setMovementMethod(MovementMethod) + Android reference for android.view.textclassifier.TextLinks.apply. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -164,21 +140,11 @@ 0 - Do not replace ClickableSpans that exist where the TextLinkSpan needs to - be applied to. + Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to. - Do not replace ClickableSpans that exist where the TextLinkSpan needs to - be applied to. Do not apply the TextLinkSpan. - - - Java documentation for android.view.textclassifier.TextLinks.APPLY_STRATEGY_IGNORE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to. Do not apply the TextLinkSpan. + Android reference for android.view.textclassifier.TextLinks.APPLY_STRATEGY_IGNORE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -214,21 +180,11 @@ 1 - Replace any ClickableSpans that exist where the TextLinkSpan needs to be - applied to. + Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to. - Replace any ClickableSpans that exist where the TextLinkSpan needs to be - applied to. - - - Java documentation for android.view.textclassifier.TextLinks.APPLY_STRATEGY_REPLACE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to. + Android reference for android.view.textclassifier.TextLinks.APPLY_STRATEGY_REPLACE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -293,9 +249,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextLinks.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -323,20 +283,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextLinks.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextLinks.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -366,7 +317,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -397,19 +348,11 @@ Returns an unmodifiable Collection of the links. - To be added. + This value cannot be null. Returns an unmodifiable Collection of the links. - - - Java documentation for android.view.textclassifier.TextLinks.getLinks(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.getLinks. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -448,16 +391,8 @@ The specified text does not match the text used to generate the links. The specified text does not match the text used to generate the links. - - - Java documentation for android.view.textclassifier.TextLinks.STATUS_DIFFERENT_TEXT. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.STATUS_DIFFERENT_TEXT. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -496,16 +431,8 @@ Links were successfully applied to the text. Links were successfully applied to the text. - - - Java documentation for android.view.textclassifier.TextLinks.STATUS_LINKS_APPLIED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.STATUS_LINKS_APPLIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -544,16 +471,8 @@ No links applied to text. No links applied to text. The links were filtered out. - - - Java documentation for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_APPLIED. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_APPLIED. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -592,16 +511,8 @@ No links exist to apply to text. No links exist to apply to text. Links count is zero. - - - Java documentation for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_FOUND. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.STATUS_NO_LINKS_FOUND. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -640,16 +551,8 @@ The specified text contains unsupported characters. The specified text contains unsupported characters. - - - Java documentation for android.view.textclassifier.TextLinks.STATUS_UNSUPPORTED_CHARACTER. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.STATUS_UNSUPPORTED_CHARACTER. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -676,7 +579,7 @@ System.String - + To be added. To be added. To be added. @@ -707,19 +610,11 @@ Returns the text that was used to generate these links. - To be added. + This value cannot be null. Returns the text that was used to generate these links. - - - Java documentation for android.view.textclassifier.TextLinks.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextLinks.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -746,7 +641,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -775,7 +670,7 @@ System.Type - + To be added. To be added. To be added. @@ -819,10 +714,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextLinks.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection+Builder.xml index b092e5bb7..edf027f54 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection+Builder.xml @@ -26,19 +26,11 @@ - Builder used to build TextSelection objects. + Builder used to build TextSelection objects. - Builder used to build TextSelection objects. - - - Java documentation for android.view.textclassifier.TextSelection.Builder. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builder used to build TextSelection objects. + Android reference for android.view.textclassifier.TextSelection.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -67,21 +59,13 @@ - the start index of the text selection. - the end index of the text selection. Must be greater than startIndex - Creates a builder used to build TextSelection objects. + int: the start index of the text selection. Value is 0 or greater + int: the end index of the text selection. Must be greater than startIndex. Value is 0 or greater + Creates a builder used to build TextSelection objects. - Creates a builder used to build TextSelection objects. - - - Java documentation for android.view.textclassifier.TextSelection.Builder.TextSelection$Builder(int, int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Creates a builder used to build TextSelection objects. + Android reference for android.view.textclassifier.TextSelection.Builder.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -110,20 +94,12 @@ - Builds and returns TextSelection object. - To be added. + Builds and returns TextSelection object. + This value cannot be null. - Builds and returns TextSelection object. - - - Java documentation for android.view.textclassifier.TextSelection.Builder.build(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Builds and returns TextSelection object. + Android reference for android.view.textclassifier.TextSelection.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -150,7 +126,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. @@ -186,12 +162,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value cannot be null. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP + float: a value from 0 (low confidence) to 1 (high confidence). 0 implies the entity does not exist for the classified text. Values greater than 1 are clamped to 1. Value is between 0.0f and 1.0f inclusive + Sets an entity type for the classified text and assigns a confidence score. + This value cannot be null. - Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + Sets an entity type for the classified text and assigns a confidence score. + Android reference for android.view.textclassifier.TextSelection.Builder.setEntityType. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -229,10 +207,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + this builder. This value cannot be null. + + Sets the extended data. + Android reference for android.view.textclassifier.TextSelection.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -269,10 +251,14 @@ - To be added. - To be added. - To be added. - To be added. + String: This value may be null. + Sets an id for the TextSelection object. + This value cannot be null. + + Sets an id for the TextSelection object. + Android reference for android.view.textclassifier.TextSelection.Builder.setId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -309,10 +295,15 @@ - To be added. - To be added. - To be added. - To be added. + TextClassification: This value may be null. + Sets the text classification result of the suggested selection. + this builder + + Sets the text classification result of the suggested selection. If Request.shouldIncludeTextClassification() is true, set this value. Otherwise this value may be set to null. The intention of this method is to avoid doing expensive work if the client is not interested in such result. + See also: + Android reference for android.view.textclassifier.TextSelection.Builder.setTextClassification. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -338,7 +329,7 @@ System.IntPtr - + To be added. To be added. @@ -369,7 +360,7 @@ System.Type - + To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection+InterfaceConsts.xml index e796e253d..5d9962e89 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+Builder.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+Builder.xml index ee11b97ee..5abedf1dd 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+Builder.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+Builder.xml @@ -26,8 +26,12 @@ - To be added. - To be added. + A builder for building TextSelection requests. + + A builder for building TextSelection requests. + Android reference for android.view.textclassifier.TextSelection.Request.Builder. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -121,9 +125,13 @@ - To be added. - To be added. - To be added. + Builds and returns the request object. + This value cannot be null. + + Builds and returns the request object. + Android reference for android.view.textclassifier.TextSelection.Request.Builder.build. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -149,7 +157,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -229,10 +237,14 @@ - To be added. - To be added. - To be added. - To be added. + Bundle: This value may be null. + Sets the extended data. + this builder. This value cannot be null. + + Sets the extended data. + Android reference for android.view.textclassifier.TextSelection.Request.Builder.setExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -262,10 +274,14 @@ - To be added. - To be added. - To be added. - To be added. + Whether to ask the TextClassifier to classify the suggested selection span and include a TextClassification object in the result. + Sets whether the result includes text classification. + This builder. + + The TextClassifier might not support text classification; in that case, TextSelection.getTextClassification() returns null. + Android reference for android.view.textclassifier.TextSelection.Request.Builder.setIncludeTextClassification. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -291,7 +307,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -320,7 +336,7 @@ System.Type - + To be added. To be added. To be added. diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+InterfaceConsts.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+InterfaceConsts.xml index 8f3e1faf1..faa0392de 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+InterfaceConsts.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request+InterfaceConsts.xml @@ -11,7 +11,7 @@ System.Object - + To be added. To be added. @@ -37,21 +37,12 @@ 1 - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. - Descriptor bit used with #describeContents(): indicates that - the Parcelable object's flattened representation includes a file descriptor. - - - Java documentation for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. + See also: + Android reference for android.os.Parcelable.CONTENTS_FILE_DESCRIPTOR. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -80,28 +71,11 @@ 1 - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". - Flag for use with #writeToParcel: the object being written - is a return value, that is the result of a function such as - "Parcelable someFunction()", - "void someFunction(out Parcelable)", or - "void someFunction(inout Parcelable)". Some implementations - may want to release resources at this point. - - - Java documentation for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point. + Android reference for android.os.Parcelable.PARCELABLE_WRITE_RETURN_VALUE. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request.xml index 8a7b4832f..0c268c653 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection+Request.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection+Request.xml @@ -42,16 +42,8 @@ A request object for generating TextSelection. A request object for generating TextSelection. - - - Java documentation for android.view.textclassifier.TextSelection.Request. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.Request. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -84,20 +76,10 @@ Returns the name of the package that sent this request. - To be added. - Returns the name of the package that sent this request. - This returns null if no calling package name is set. - - - Java documentation for android.view.textclassifier.TextSelection.Request.getCallingPackageName(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the name of the package that sent this request. This returns null if no calling package name is set. + Android reference for android.view.textclassifier.TextSelection.Request.getCallingPackageName. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -207,9 +189,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextSelection.Request.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -237,19 +223,11 @@ Returns end index of the selected part of text. - To be added. + Value is 0 or greater Returns end index of the selected part of text. - - - Java documentation for android.view.textclassifier.TextSelection.Request.getEndIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.Request.getEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -278,20 +256,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextSelection.Request.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextSelection.Request.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -321,7 +290,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. To be added. @@ -352,22 +321,11 @@ - Returns true if the client wants the text classifier to classify the text as well and - include a TextClassification object in the result. - To be added. + Returns true if the client wants the text classifier to classify the text as well and include a TextClassification object in the result. - Returns true if the client wants the text classifier to classify the text as well and - include a TextClassification object in the result. - - - Java documentation for android.view.textclassifier.TextSelection.Request.shouldIncludeTextClassification(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns true if the client wants the text classifier to classify the text as well and include a TextClassification object in the result. + Android reference for android.view.textclassifier.TextSelection.Request.shouldIncludeTextClassification. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -396,19 +354,11 @@ Returns start index of the selected part of text. - To be added. + Value is 0 or greater Returns start index of the selected part of text. - - - Java documentation for android.view.textclassifier.TextSelection.Request.getStartIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.Request.getStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -435,7 +385,7 @@ System.String - + To be added. To be added. To be added. @@ -465,22 +415,12 @@ Java.Lang.ICharSequence - Returns the text providing context for the selected text (which is specified by the - sub sequence starting at startIndex and ending at endIndex). - To be added. + Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex). + This value cannot be null. - Returns the text providing context for the selected text (which is specified by the - sub sequence starting at startIndex and ending at endIndex). - - - Java documentation for android.view.textclassifier.TextSelection.Request.getText(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex). + Android reference for android.view.textclassifier.TextSelection.Request.getText. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -507,7 +447,7 @@ System.IntPtr - + To be added. To be added. To be added. @@ -536,7 +476,7 @@ System.Type - + To be added. To be added. To be added. @@ -580,10 +520,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextSelection.Request.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + diff --git a/docs/xml/Android.Views.TextClassifiers/TextSelection.xml b/docs/xml/Android.Views.TextClassifiers/TextSelection.xml index 9b22adf29..4a9819662 100644 --- a/docs/xml/Android.Views.TextClassifiers/TextSelection.xml +++ b/docs/xml/Android.Views.TextClassifiers/TextSelection.xml @@ -42,16 +42,8 @@ Information about where text selection should be. Information about where text selection should be. - - - Java documentation for android.view.textclassifier.TextSelection. - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -116,9 +108,13 @@ - To be added. - To be added. - To be added. + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. + a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR + + Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. + Android reference for android.view.textclassifier.TextSelection.describeContents. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. + @@ -146,19 +142,11 @@ Returns the number of entities found in the classified text. - To be added. + Value is 0 or greater Returns the number of entities found in the classified text. - - - Java documentation for android.view.textclassifier.TextSelection.getEntityCount(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.getEntityCount. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -187,20 +175,11 @@ Returns the extended data. - To be added. + This value cannot be null. - Returns the extended data. - <b>NOTE: </b>Do not modify this bundle. - - - Java documentation for android.view.textclassifier.TextSelection.getExtras(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the extended data. NOTE: Do not modify this bundle. + Android reference for android.view.textclassifier.TextSelection.getExtras. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -242,23 +221,13 @@ - To be added. + String: Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP Returns the confidence score for the specified entity. - To be added. + Value is between 0.0f and 1.0f inclusive - Returns the confidence score for the specified entity. The value ranges from - 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the - classified text. - - - Java documentation for android.view.textclassifier.TextSelection.getConfidenceScore(java.lang.String). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the confidence score for the specified entity. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the classified text. + Android reference for android.view.textclassifier.TextSelection.getConfidenceScore. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -297,22 +266,15 @@ - To be added. + int Returns the entity at the specified index. - To be added. + This value cannot be null. Value is one of the following: TextClassifier.TYPE_UNKNOWN TextClassifier.TYPE_OTHER TextClassifier.TYPE_EMAIL TextClassifier.TYPE_PHONE TextClassifier.TYPE_ADDRESS TextClassifier.TYPE_URL TextClassifier.TYPE_DATE TextClassifier.TYPE_DATE_TIME TextClassifier.TYPE_FLIGHT_NUMBER TextClassifier.TYPE_OTP TextClassifier.TYPE_SMS_RETRIEVER_OTP TextClassifier.TYPE_SMS_WEB_OTP - Returns the entity at the specified index. Entities are ordered from high confidence - to low confidence. - - - Java documentation for android.view.textclassifier.TextSelection.getEntity(int). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the entity at the specified index. Entities are ordered from high confidence to low confidence. + See also: + Throws: IndexOutOfBoundsException if the specified index is out of range. + Android reference for android.view.textclassifier.TextSelection.getEntity. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -345,19 +307,11 @@ Returns the id, if one exists, for this object. - To be added. + This value may be null. Returns the id, if one exists, for this object. - - - Java documentation for android.view.textclassifier.TextSelection.getId(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.getId. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -387,7 +341,7 @@ Java.Interop.JniPeerMembers - + To be added. To be added. @@ -420,19 +374,10 @@ Returns the end index of the text selection. - To be added. Returns the end index of the text selection. - - - Java documentation for android.view.textclassifier.TextSelection.getSelectionEndIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.getSelectionEndIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -461,19 +406,10 @@ Returns the start index of the text selection. - To be added. Returns the start index of the text selection. - - - Java documentation for android.view.textclassifier.TextSelection.getSelectionStartIndex(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Android reference for android.view.textclassifier.TextSelection.getSelectionStartIndex. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -506,22 +442,11 @@ Returns the text classification result of the suggested selection span. - To be added. - Returns the text classification result of the suggested selection span. Enables the text - classification by calling - TextSelection.Request.Builder#setIncludeTextClassification(boolean). If the text - classifier does not support it, a null is returned. - - - Java documentation for android.view.textclassifier.TextSelection.getTextClassification(). - - - - Portions of this page are modifications based on work created and shared by the - Android Open Source Project - and used according to terms described in the - Creative Commons 2.5 Attribution License. + Returns the text classification result of the suggested selection span. Enables the text classification by calling TextSelection.Request.Builder.setIncludeTextClassification(boolean). If the text classifier does not support it, a null is returned. + See also: + Android reference for android.view.textclassifier.TextSelection.getTextClassification. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. @@ -548,7 +473,7 @@ System.IntPtr - + To be added. To be added. @@ -579,7 +504,7 @@ System.Type - + To be added. To be added. @@ -625,10 +550,14 @@ - To be added. - To be added. - To be added. - To be added. + Parcel: The Parcel in which the object should be written. This value cannot be null. + int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE + Flatten this object in to a Parcel. + + Flatten this object in to a Parcel. + Android reference for android.view.textclassifier.TextSelection.writeToParcel. + Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. +