Skip to content

Most visited

Recently visited

navigation
Added in API level 3

UserDictionary.Words

public static class UserDictionary.Words
extends Object implements BaseColumns

java.lang.Object
   ↳ android.provider.UserDictionary.Words


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

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.

Inherited methods

From class java.lang.Object

Constants

APP_ID

Added in API level 3
String APP_ID

The uid of the application that inserted the word.

TYPE: INTEGER

Constant Value: "appid"

CONTENT_ITEM_TYPE

Added in API level 3
String CONTENT_ITEM_TYPE

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

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

CONTENT_TYPE

Added in API level 3
String CONTENT_TYPE

The MIME type of CONTENT_URI providing a directory of words.

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

DEFAULT_SORT_ORDER

Added in API level 3
String DEFAULT_SORT_ORDER

Sort by descending order of frequency.

Constant Value: "frequency DESC"

FREQUENCY

Added in API level 3
String FREQUENCY

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

TYPE: INTEGER

Constant Value: "frequency"

LOCALE

Added in API level 3
String LOCALE

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"

LOCALE_TYPE_ALL

Added in API level 3
int LOCALE_TYPE_ALL

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

Constant Value: 0 (0x00000000)

LOCALE_TYPE_CURRENT

Added in API level 3
int LOCALE_TYPE_CURRENT

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

Constant Value: 1 (0x00000001)

SHORTCUT

Added in API level 16
String SHORTCUT

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"

WORD

Added in API level 3
String WORD

The word column.

TYPE: TEXT

Constant Value: "word"

_ID

Added in API level 3
String _ID

Constant Value: "_id"

Fields

CONTENT_URI

Added in API level 3
Uri CONTENT_URI

The content:// style URL for this table

Public constructors

UserDictionary.Words

Added in API level 3
UserDictionary.Words ()

Public methods

addWord

Added in API level 3
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.

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

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

addWord

Added in API level 16
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 Context: the current application context
word String: the word to add to the dictionary. This should not be null or empty.
frequency int
shortcut String: 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 Locale: the locale to insert the word for, or null to insert the word for all locales.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.