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
StringAPP_IDThe uid of the application that inserted the word.
StringCONTENT_ITEM_TYPEThe MIME type of a CONTENT_URI sub-directory of a single word.
StringCONTENT_TYPEThe MIME type of CONTENT_URI providing a directory of words.
UriCONTENT_URIThe content:// style URL for this table
StringDEFAULT_SORT_ORDERSort by descending order of frequency.
StringFREQUENCYThe frequency column.
StringLOCALEThe locale that this word belongs to.
intLOCALE_TYPE_ALLThe locale type to specify that the word is common to all locales.
intLOCALE_TYPE_CURRENTThe locale type to specify that the word is for the current locale.
StringWORDThe word column.
String_ID
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
Public Constructors
UserDictionary.Words()
Public Methods
static void addWord(Context context, String word, int frequency, int localeType)
Adds a word to the dictionary, with the given frequency and the specified specified locale type.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String APP_ID

Since: API Level 3

The uid of the application that inserted the word.

TYPE: INTEGER

Constant Value: "appid"

public static final String CONTENT_ITEM_TYPE

Since: 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

Since: 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 Uri CONTENT_URI

Since: API Level 3

The content:// style URL for this table

public static final String DEFAULT_SORT_ORDER

Since: API Level 3

Sort by descending order of frequency.

Constant Value: "frequency DESC"

public static final String FREQUENCY

Since: 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

Since: 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

Since: API Level 3

The locale type to specify that the word is common to all locales.

Constant Value: 0 (0x00000000)

public static final int LOCALE_TYPE_CURRENT

Since: API Level 3

The locale type to specify that the word is for the current locale.

Constant Value: 1 (0x00000001)

public static final String WORD

Since: API Level 3

The word column.

TYPE: TEXT

Constant Value: "word"

public static final String _ID

Since: API Level 3

Constant Value: "_id"

Public Constructors

public UserDictionary.Words ()

Since: API Level 3

Public Methods

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

Since: API Level 3

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.