1 2 Android CommitContentSampleIME Sample 3 =================================== 4 5 This sample demonstrates how to write an keyboard which sends rich content (such as images) to text 6 fields 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 **Note:** This sample does not have a default Activity. After installing it, you will need to enable 26 this app as a keyboard by navigating to *Settings > Languages & Input > Virtual Keyboard > Manage 27 Keyboards*. This keyboard can then be accessed by pressing the virtual keyboard icon in the 28 lower-right hand corner of the display while in a text field. 29 30 [1]: https://android-dot-devsite.googleplex.com/preview/image-keyboard.html 31 32 Pre-requisites 33 -------------- 34 35 - Android SDK 27 36 - Android Build Tools v27.0.2 37 - Android Support Repository 38 39 Screenshots 40 ------------- 41 42 <img src="screenshots/screenshot-1.png" height="400" alt="Screenshot"/> 43 44 Getting Started 45 --------------- 46 47 This sample uses the Gradle build system. To build this project, use the 48 "gradlew build" command or use "Import Project" in Android Studio. 49 50 Support 51 ------- 52 53 - Google+ Community: https://plus.google.com/communities/105153134372062985968 54 - Stack Overflow: http://stackoverflow.com/questions/tagged/android 55 56 If you've found an error in this sample, please file an issue: 57 https://github.com/googlesamples/android-CommitContentSampleIME 58 59 Patches are encouraged, and may be submitted by forking this project and 60 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. 61 62 License 63 ------- 64 65 Copyright 2017 The Android Open Source Project, Inc. 66 67 Licensed to the Apache Software Foundation (ASF) under one or more contributor 68 license agreements. See the NOTICE file distributed with this work for 69 additional information regarding copyright ownership. The ASF licenses this 70 file to you under the Apache License, Version 2.0 (the "License"); you may not 71 use this file except in compliance with the License. You may obtain a copy of 72 the License at 73 74 http://www.apache.org/licenses/LICENSE-2.0 75 76 Unless required by applicable law or agreed to in writing, software 77 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 78 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 79 License for the specific language governing permissions and limitations under 80 the License. 81
