README.md
1
2 Android CommitContentSampleApp Sample
3 ===================================
4
5 This sample demonstrates how to write an application which accepts rich content (such as images)
6 sent from a keyboard using the Commit Content API.
7
8 Introduction
9 ------------
10
11 Users often want to communicate with emojis, stickers, and other kinds of rich content. In previous
12 versions of Android, soft keyboards (input method editors or IMEs) could send only unicode emoji to
13 apps. For rich content (such as images), apps had to either build app-specific APIs that couldn't
14 be used in other apps or use workarounds like sending images through the Easy Share Action or the
15 clipboard.
16
17 Now in Android 7.1 (API 25), the Android SDK includes the [Commit Content API][1], which provides a
18 universal way for IMEs to send images and other rich content directly to a text editor in an app.
19 The API is also available in the v13 Support Library (ver. 25.0), supporting devices as early as
20 Android 3.2 (API 13).
21
22 With this API, you can build messaging apps that accept rich content from any keyboard, as well as
23 keyboards that can send rich content to any app.
24
25 [1]: https://android-dot-devsite.googleplex.com/preview/image-keyboard.html
26
27 Pre-requisites
28 --------------
29
30 - Android SDK 26
31 - Android Build Tools v26.0.1
32 - Android Support Repository
33
34 Screenshots
35 -------------
36
37 <img src="screenshots/screenshot-1.png" height="400" alt="Screenshot"/>
38
39 Getting Started
40 ---------------
41
42 This sample uses the Gradle build system. To build this project, use the
43 "gradlew build" command or use "Import Project" in Android Studio.
44
45 Support
46 -------
47
48 - Google+ Community: https://plus.google.com/communities/105153134372062985968
49 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
50
51 If you've found an error in this sample, please file an issue:
52 https://github.com/googlesamples/android-CommitContentSampleApp
53
54 Patches are encouraged, and may be submitted by forking this project and
55 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
56
57 License
58 -------
59
60 Copyright 2017 The Android Open Source Project, Inc.
61
62 Licensed to the Apache Software Foundation (ASF) under one or more contributor
63 license agreements. See the NOTICE file distributed with this work for
64 additional information regarding copyright ownership. The ASF licenses this
65 file to you under the Apache License, Version 2.0 (the "License"); you may not
66 use this file except in compliance with the License. You may obtain a copy of
67 the License at
68
69 http://www.apache.org/licenses/LICENSE-2.0
70
71 Unless required by applicable law or agreed to in writing, software
72 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
73 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
74 License for the specific language governing permissions and limitations under
75 the License.
76