xref: /aosp_15_r20/developers/build/prebuilts/gradle/CommitContentSampleIME/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid CommitContentSampleIME Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates how to write an keyboard which sends rich content (such as images) to text
6*d353a188SXin Lifields using the Commit Content API.
7*d353a188SXin Li
8*d353a188SXin LiIntroduction
9*d353a188SXin Li------------
10*d353a188SXin Li
11*d353a188SXin LiUsers often want to communicate with emojis, stickers, and other kinds of rich content. In previous
12*d353a188SXin Liversions of Android, soft keyboards (input method editors or IMEs) could send only unicode emoji to
13*d353a188SXin Liapps. For rich content (such as images), apps had to either build app-specific APIs that couldn't
14*d353a188SXin Libe used in other apps or use workarounds like sending images through the Easy Share Action or the
15*d353a188SXin Liclipboard.
16*d353a188SXin Li
17*d353a188SXin LiNow in Android 7.1 (API 25), the Android SDK includes the [Commit Content API][1], which provides a
18*d353a188SXin Liuniversal way for IMEs to send images and other rich content directly to a text editor in an app.
19*d353a188SXin LiThe API is also available in the v13 Support Library (ver. 25.0), supporting devices as early as
20*d353a188SXin LiAndroid 3.2 (API 13).
21*d353a188SXin Li
22*d353a188SXin LiWith this API, you can build messaging apps that accept rich content from any keyboard, as well as
23*d353a188SXin Likeyboards that can send rich content to any app.
24*d353a188SXin Li
25*d353a188SXin Li**Note:** This sample does not have a default Activity. After installing it, you will need to enable
26*d353a188SXin Lithis app as a keyboard by navigating to *Settings > Languages & Input > Virtual Keyboard > Manage
27*d353a188SXin LiKeyboards*. This keyboard can then be accessed by pressing the virtual keyboard icon in the
28*d353a188SXin Lilower-right hand corner of the display while in a text field.
29*d353a188SXin Li
30*d353a188SXin Li[1]: https://android-dot-devsite.googleplex.com/preview/image-keyboard.html
31*d353a188SXin Li
32*d353a188SXin LiPre-requisites
33*d353a188SXin Li--------------
34*d353a188SXin Li
35*d353a188SXin Li- Android SDK 27
36*d353a188SXin Li- Android Build Tools v27.0.2
37*d353a188SXin Li- Android Support Repository
38*d353a188SXin Li
39*d353a188SXin LiScreenshots
40*d353a188SXin Li-------------
41*d353a188SXin Li
42*d353a188SXin Li<img src="screenshots/screenshot-1.png" height="400" alt="Screenshot"/>
43*d353a188SXin Li
44*d353a188SXin LiGetting Started
45*d353a188SXin Li---------------
46*d353a188SXin Li
47*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
48*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
49*d353a188SXin Li
50*d353a188SXin LiSupport
51*d353a188SXin Li-------
52*d353a188SXin Li
53*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
54*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
55*d353a188SXin Li
56*d353a188SXin LiIf you've found an error in this sample, please file an issue:
57*d353a188SXin Lihttps://github.com/googlesamples/android-CommitContentSampleIME
58*d353a188SXin Li
59*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
60*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
61*d353a188SXin Li
62*d353a188SXin LiLicense
63*d353a188SXin Li-------
64*d353a188SXin Li
65*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
66*d353a188SXin Li
67*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
68*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
69*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
70*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
71*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
72*d353a188SXin Lithe License at
73*d353a188SXin Li
74*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
75*d353a188SXin Li
76*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
77*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
78*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
79*d353a188SXin LiLicense for the specific language governing permissions and limitations under
80*d353a188SXin Lithe License.
81