Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static class

UserDictionary.Words

extends Object
implements BaseColumns
java.lang.Object
   ↳ android.provider.UserDictionary.Words

Class Overview

Contains the user defined words.

Summary

Constants
String APP_ID The uid of the application that inserted the word.
String CONTENT_ITEM_TYPE The MIME type of a CONTENT_URI sub-directory of a single word.
String CONTENT_TYPE The MIME type of CONTENT_URI providing a directory of words.
String DEFAULT_SORT_ORDER Sort by descending order of frequency.
String FREQUENCY The frequency column.
String LOCALE The locale that this word belongs to.
int LOCALE_TYPE_ALL This constant was deprecated in API level 16. Use addWord(Context, String, int, String, Locale) .
int LOCALE_TYPE_CURRENT This constant was deprecated in API level 16. Use addWord(Context, String, int, String, Locale) .
String SHORTCUT An optional shortcut for this word.
String WORD The word column.
String _ID
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
Fields
public static final Uri CONTENT_URI The content:// style URL for this table
Public Constructors
UserDictionary.Words ()
Public Methods
static void addWord ( Context context, String word, int frequency, int localeType)
This method was deprecated in API level 16. Please use addWord(Context, String, int, String, Locale) instead.
static void addWord ( Context context, String word, int frequency, String shortcut, Locale locale)
Adds a word to the dictionary, with the given frequency and the specified locale type.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String APP_ID

Added in API level 3

The uid of the application that inserted the word.

TYPE: INTEGER

Constant Value: "appid"

public static final String CONTENT_ITEM_TYPE

Added in API level 3

The MIME type of a CONTENT_URI sub-directory of a single word.

Constant Value: "vnd.android.cursor.item/vnd.google.userword"

public static final String CONTENT_TYPE

Added in API level 3

The MIME type of CONTENT_URI providing a directory of words.

Constant Value: "vnd.android.cursor.dir/vnd.google.userword"

public static final String DEFAULT_SORT_ORDER

Added in API level 3

Sort by descending order of frequency.

Constant Value: "frequency DESC"

public static final String FREQUENCY

Added in API level 3

The frequency column. A value between 1 and 255. Higher values imply higher frequency.

TYPE: INTEGER

Constant Value: "frequency"

public static final String LOCALE

Added in API level 3

The locale that this word belongs to. Null if it pertains to all locales. Locale is as defined by the string returned by Locale.toString().

TYPE: TEXT

Constant Value: "locale"

public static final int LOCALE_TYPE_ALL

Added in API level 3

This constant was deprecated in API level 16.
Use addWord(Context, String, int, String, Locale) .

Constant Value: 0 (0x00000000)

public static final int LOCALE_TYPE_CURRENT

Added in API level 3

This constant was deprecated in API level 16.
Use addWord(Context, String, int, String, Locale) .

Constant Value: 1 (0x00000001)

public static final String SHORTCUT

Added in API level 16

An optional shortcut for this word. When the shortcut is typed, supporting IMEs should suggest the word in this row as an alternate spelling too.

Constant Value: "shortcut"

public static final String WORD

Added in API level 3

The word column.

TYPE: TEXT

Constant Value: "word"

public static final String _ID

Added in API level 3

Constant Value: "_id"

Fields

public static final Uri CONTENT_URI

Added in API level 3

The content:// style URL for this table

Public Constructors

public UserDictionary.Words ()

Added in API level 3

Public Methods

public static void addWord ( Context context, String word, int frequency, int localeType)

Added in API level 3

This method was deprecated in API level 16.
Please use addWord(Context, String, int, String, Locale) instead.

Adds a word to the dictionary, with the given frequency and the specified specified locale type.

Parameters
context the current application context
word the word to add to the dictionary. This should not be null or empty.
localeType the locale type for this word. It should be one of LOCALE_TYPE_ALL or LOCALE_TYPE_CURRENT .

public static void addWord ( Context context, String word, int frequency, String shortcut, Locale locale)

Adds a word to the dictionary, with the given frequency and the specified locale type.

Parameters
context the current application context
word the word to add to the dictionary. This should not be null or empty.
shortcut optional shortcut spelling for this word. When the shortcut is typed, the word may be suggested by applications that support it. May be null.
locale the locale to insert the word for, or null to insert the word for all locales.