連絡先の詳細情報を取得する

このレッスンでは、連絡先の詳細データ（メールアドレス、電話番号、 使用できます。これは、ユーザーが連絡先を取得する際に探している詳細情報です。 連絡先のすべての詳細情報を提供することも、メールアドレスなど、特定のタイプの詳細情報だけを表示することもできます。

このレッスンの手順では、 ユーザーが選択した連絡先の ContactsContract.Contacts 行。 連絡先名の取得レッスンでは、 連絡先のリストを取得します。

連絡先のすべての詳細情報を取得する

連絡先の詳細をすべて取得するには、 連絡先のデータを含む行を含む ContactsContract.Data テーブル LOOKUP_KEY。この列は ContactsContract.Data テーブルは保持されません。これは、Contacts API が プロバイダが ContactsContract.Contacts を暗黙的に結合する ContactsContract.Data テーブルを結合します。LOOKUP_KEY 列の詳細については、連絡先名を取得するをご覧ください。

注: 連絡先のすべての詳細情報を取得する場合、ContactsContract.Data テーブル内のすべての列を取得する必要があるため、デバイスのパフォーマンスが低下します。移行前にパフォーマンスへの影響を考慮する この方法を使用します。

権限をリクエストする

連絡先プロバイダから読み取るには、アプリに READ_CONTACTS 権限。 この権限をリクエストするには、マニフェスト ファイルの <manifest> 要素に次の子要素を追加します。

    <uses-permission android:name="android.permission.READ_CONTACTS" />

射影をセットアップする

行に含まれるデータ型に応じて、使用する列の数は変わります。また データ型に応じて異なる列に格納されます。 可能な限りすべてのデータ型を対象に、可能な限りすべての列を取得するには、すべての列名を射影に追加する必要があります。結果 Cursor を ListView にバインドする場合は、必ず Data._ID を取得するようにします。そうでないと、バインドは機能しません。また、Data.MIMETYPE を取得することにより、取得する各行のデータ型を識別できるようになります。次に例を示します。

private val PROJECTION: Array<out String> = arrayOf(
        ContactsContract.Data._ID,
        ContactsContract.Data.MIMETYPE,
        ContactsContract.Data.DATA1,
        ContactsContract.Data.DATA2,
        ContactsContract.Data.DATA3,
        ContactsContract.Data.DATA4,
        ContactsContract.Data.DATA5,
        ContactsContract.Data.DATA6,
        ContactsContract.Data.DATA7,
        ContactsContract.Data.DATA8,
        ContactsContract.Data.DATA9,
        ContactsContract.Data.DATA10,
        ContactsContract.Data.DATA11,
        ContactsContract.Data.DATA12,
        ContactsContract.Data.DATA13,
        ContactsContract.Data.DATA14,
        ContactsContract.Data.DATA15
)

    private static final String[] PROJECTION =
            {
                ContactsContract.Data._ID,
                ContactsContract.Data.MIMETYPE,
                ContactsContract.Data.DATA1,
                ContactsContract.Data.DATA2,
                ContactsContract.Data.DATA3,
                ContactsContract.Data.DATA4,
                ContactsContract.Data.DATA5,
                ContactsContract.Data.DATA6,
                ContactsContract.Data.DATA7,
                ContactsContract.Data.DATA8,
                ContactsContract.Data.DATA9,
                ContactsContract.Data.DATA10,
                ContactsContract.Data.DATA11,
                ContactsContract.Data.DATA12,
                ContactsContract.Data.DATA13,
                ContactsContract.Data.DATA14,
                ContactsContract.Data.DATA15
            };

この射影は、ContactsContract.Data クラスで定義されている列名を使用して、ContactsContract.Data テーブル内の 1 つの行を対象に、すべての列を取得します。

必要に応じて、ContactsContract.Data クラス内で定義や継承が指定されている他の列定数を使用することもできます。ただし、この列には SYNC1～ SYNC4 は同期で使用されます それらのデータは有用ではありません。

選択基準を定義する

選択句の定数、選択引数を保持する配列、 選択値を保持します。使用 Contacts.LOOKUP_KEY 列を 連絡先を見つけます。次に例を示します。

// Defines the selection clause
private const val SELECTION: String = "${ContactsContract.Data.LOOKUP_KEY} = ?"
...
// Defines the array to hold the search criteria
private val selectionArgs: Array<String> = arrayOf("")
/*
 * Defines a variable to contain the selection value. Once you
 * have the Cursor from the Contacts table, and you've selected
 * the desired row, move the row's LOOKUP_KEY value into this
 * variable.
 */
private var lookupKey: String? = null

    // Defines the selection clause
    private static final String SELECTION = Data.LOOKUP_KEY + " = ?";
    // Defines the array to hold the search criteria
    private String[] selectionArgs = { "" };
    /*
     * Defines a variable to contain the selection value. Once you
     * have the Cursor from the Contacts table, and you've selected
     * the desired row, move the row's LOOKUP_KEY value into this
     * variable.
     */
    private lateinit var lookupKey: String

「?」の使用をプレースホルダとして指定すると、検索結果が SQL コンパイルではなくバインディングによって生成されます。このアプローチにより、悪意のある SQL インジェクションの可能性を排除できます。

ソート順を定義する

結果 Cursor 内のソート順を定義します。宛先 特定のデータ型のすべての行をまとめて保持する、並べ替える Data.MIMETYPE。このクエリ引数は、すべてのメールアドレスの行、すべての電話番号の行などをグループ化します。次に例を示します。

/*
 * Defines a string that specifies a sort order of MIME type
 */
private const val SORT_ORDER = ContactsContract.Data.MIMETYPE

    /*
     * Defines a string that specifies a sort order of MIME type
     */
    private static final String SORT_ORDER = ContactsContract.Data.MIMETYPE;

注: 一部のデータ型はサブタイプを使用しないため、サブタイプに基づいてソートすることはできません。代わりに、返された Cursor を反復処理して、現在の行のデータ型を判断し、サブタイプを使用する行のデータを格納する必要があります。日時 カーソルの読み取りが終了したら、各データ型をサブタイプで並べ替えて 表示されます。

ローダーを初期化する

連絡先プロバイダ（および他のすべてのコンテンツ プロバイダ）からは常に 使用します。LoaderManager クラスと LoaderManager.LoaderCallbacks インターフェースによって定義されるローダー フレームワークを使用して、バックグラウンド取得を実行します。

行を取得する準備ができたら、initLoader() を呼び出してローダー フレームワークを初期化します。 整数識別子をメソッドに渡します。この識別子が LoaderManager.LoaderCallbacks メソッド。ID を使用すると、 1 つのアプリで複数のローダを使用して、それらのローダを区別できるようにします。

次のスニペットは、ローダー フレームワークを初期化する方法を示しています。

// Defines a constant that identifies the loader
private const val DETAILS_QUERY_ID: Int = 0

class DetailsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor> {
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        ...
        // Initializes the loader framework
        loaderManager.initLoader(DETAILS_QUERY_ID, null, this)

public class DetailsFragment extends Fragment implements
        LoaderManager.LoaderCallbacks<Cursor> {
    ...
    // Defines a constant that identifies the loader
    static int DETAILS_QUERY_ID = 0;
    ...
    @Override
    public void onCreate(Bundle savedInstanceState) {
        ...
        // Initializes the loader framework
        getLoaderManager().initLoader(DETAILS_QUERY_ID, null, this);

onCreateLoader() を実装する

onCreateLoader() メソッドを実装します。このメソッドは、initLoader() を呼び出した直後にローダー フレームワークによって呼び出されます。返品 このメソッドから CursorLoader。現在 ContactsContract.Data テーブルを検索しているため、Data.CONTENT_URI 定数をコンテンツ URI として使用します。次に例を示します。

override fun onCreateLoader(loaderId: Int, args: Bundle?): Loader<Cursor> {
    // Choose the proper action
    mLoader = when(loaderId) {
        DETAILS_QUERY_ID -> {
            // Assigns the selection parameter
            selectionArgs[0] = lookupKey
            // Starts the query
            activity?.let {
                CursorLoader(
                        it,
                        ContactsContract.Data.CONTENT_URI,
                        PROJECTION,
                        SELECTION,
                        selectionArgs,
                        SORT_ORDER
                )
            }
        }
        ...
    }
    return mLoader
}

@Override
    public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) {
        // Choose the proper action
        switch (loaderId) {
            case DETAILS_QUERY_ID:
            // Assigns the selection parameter
            selectionArgs[0] = lookupKey;
            // Starts the query
            CursorLoader mLoader =
                    new CursorLoader(
                            getActivity(),
                            ContactsContract.Data.CONTENT_URI,
                            PROJECTION,
                            SELECTION,
                            selectionArgs,
                            SORT_ORDER
                    );
    }

onLoadFinished() と onLoaderReset() を実装する

実装 onLoadFinished() メソッドを呼び出します。ローダー フレームワークは、 onLoadFinished() 連絡先プロバイダがクエリの結果を返したとき。次に例を示します。

    override fun onLoadFinished(loader: Loader<Cursor>, data: Cursor) {
        when(loader.id) {
            DETAILS_QUERY_ID -> {
                /*
                 * Process the resulting Cursor here.
                 */
            }
            ...
        }
    }

    @Override
    public void onLoadFinished(Loader<Cursor> loader, Cursor cursor) {
        switch (loader.getId()) {
            case DETAILS_QUERY_ID:
                    /*
                     * Process the resulting Cursor here.
                     */
                }
                break;
            ...
        }
    }

結果 Cursor を支えるデータが変更されたことをローダー フレームワークが検出すると、onLoaderReset() メソッドが呼び出されます。この時点で、Cursor に対する既存の参照を null に設定することで削除します。この指定を行わなかった場合、ローダー フレームワークが古い Cursor を破棄しなくなり、メモリリークが発生します。次に例を示します。

    override fun onLoaderReset(loader: Loader<Cursor>) {
        when (loader.id) {
            DETAILS_QUERY_ID -> {
                /*
                 * If you have current references to the Cursor,
                 * remove them here.
                 */
            }
            ...
        }
    }

    @Override
    public void onLoaderReset(Loader<Cursor> loader) {
        switch (loader.getId()) {
            case DETAILS_QUERY_ID:
                /*
                 * If you have current references to the Cursor,
                 * remove them here.
                 */
                }
                break;
    }

連絡先の特定の詳細情報を取得する

すべてのメールなど、連絡先の特定のデータ型を取得する場合、すべての詳細情報を取得する場合と同様のパターンで行います。連絡先のすべての詳細情報を取得するで示したコードリストに対して、以下の変更を加える必要があります。

予測

射影を変更して、特定の列に固有の列を取得 指定します。また、データ型に対応する ContactsContract.CommonDataKinds サブクラスで定義されている列名定数を使用するように、射影を編集します。

選択

選択テキストを編集して、データ型に固有の MIMETYPE 値を検索するようにします。

並べ替え順

1 つの詳細タイプのみを選択しているため、返されたデータをグループ化しないでください。 Data.MIMETYPE による Cursor。

これらの変更点については、以降のセクションで説明します。

プロジェクションを定義する

サブクラスで列名定数を使用して、取得する列を定義します。 データ型は ContactsContract.CommonDataKinds です。 Cursor を ListView にバインドする場合は、 必ず _ID 列を取得してください。たとえば、メールデータを取得する場合は、次のように射影を定義します。

private val PROJECTION: Array<String> = arrayOf(
        ContactsContract.CommonDataKinds.Email._ID,
        ContactsContract.CommonDataKinds.Email.ADDRESS,
        ContactsContract.CommonDataKinds.Email.TYPE,
        ContactsContract.CommonDataKinds.Email.LABEL
)

    private static final String[] PROJECTION =
            {
                ContactsContract.CommonDataKinds.Email._ID,
                ContactsContract.CommonDataKinds.Email.ADDRESS,
                ContactsContract.CommonDataKinds.Email.TYPE,
                ContactsContract.CommonDataKinds.Email.LABEL
            };

なお、この射影は、ContactsContract.Data クラスで定義されている列名ではなく、ContactsContract.CommonDataKinds.Email クラスで定義されている列名を使用しています。メール固有の 列名が読みやすくなります。

プロジェクションでは、ContactsContract.CommonDataKinds サブクラスで定義されている他の列を使用することもできます。

選択基準を定義する

特定の連絡先の行を取得する検索テキスト式を定義する LOOKUP_KEY および 必要な詳細情報の Data.MIMETYPE できます。MIMETYPE 値を次で囲みます。 「'」を連結して一重引用符で囲む（単一引用符）文字 定数のそれ以外の場合、プロバイダは定数を変数名として解釈し、 指定することもできます。この値にプレースホルダを使用する必要はありません 定数を使用します。次に例を示します。

/*
 * Defines the selection clause. Search for a lookup key
 * and the Email MIME type
 */
private const val SELECTION =
        "${ContactsContract.Data.LOOKUP_KEY} = ? AND " +
        "${ContactsContract.Data.MIMETYPE} = '${Email.CONTENT_ITEM_TYPE}'"
...
// Defines the array to hold the search criteria
private val selectionArgs: Array<String> = arrayOf("")

    /*
     * Defines the selection clause. Search for a lookup key
     * and the Email MIME type
     */
    private static final String SELECTION =
            Data.LOOKUP_KEY + " = ?" +
            " AND " +
            Data.MIMETYPE + " = " +
            "'" + Email.CONTENT_ITEM_TYPE + "'";
    // Defines the array to hold the search criteria
    private String[] selectionArgs = { "" };

ソート順を定義する

返された Cursor のソート順を定義します。特定のデータ型を取得しているため、MIMETYPE を基準とするソートは省略します。検索する詳細データのタイプにサブタイプが含まれている場合は、そのタイプで並べ替えます。 たとえばメールデータの場合は Email.TYPE:

private const val SORT_ORDER: String = "${Email.TYPE} ASC"

    private static final String SORT_ORDER = Email.TYPE + " ASC ";