anthrax3 / android-commitcontentsampleime

Android CommitContentSampleIME Sample

This sample demonstrates how to write an keyboard which sends rich content (such as images) to text fields using the Commit Content API.

Introduction

Users often want to communicate with emojis, stickers, and other kinds of rich content. In previous versions of Android, soft keyboards (input method editors or IMEs) could send only unicode emoji to apps. For rich content (such as images), apps had to either build app-specific APIs that couldn't be used in other apps or use workarounds like sending images through the Easy Share Action or the clipboard.

Now in Android 7.1 (API 25), the Android SDK includes the Commit Content API, which provides a universal way for IMEs to send images and other rich content directly to a text editor in an app. The API is also available in the v13 Support Library (ver. 25.0), supporting devices as early as Android 3.2 (API 13).

With this API, you can build messaging apps that accept rich content from any keyboard, as well as keyboards that can send rich content to any app.

Note: This sample does not have a default Activity. After installing it, you will need to enable this app as a keyboard by navigating to Settings > Languages & Input > Virtual Keyboard > Manage Keyboards. This keyboard can then be accessed by pressing the virtual keyboard icon in the lower-right hand corner of the display while in a text field.

Pre-requisites

• Android SDK 27
• Android Build Tools v27.0.2
• Android Support Repository

Screenshots

Getting Started

This sample uses the Gradle build system. To build this project, use the "gradlew build" command or use "Import Project" in Android Studio.

Support

• Google+ Community: https://plus.google.com/communities/105153134372062985968
• Stack Overflow: http://stackoverflow.com/questions/tagged/android

If you've found an error in this sample, please file an issue: https://github.com/googlesamples/android-CommitContentSampleIME

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.

License

Copyright 2017 The Android Open Source Project, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.