メソッドの概要

返却値の型 メソッド名
ResultObject addressbookExportAuthz (AddressbookKey addressbookKey)
アドレスブック内の連絡先をCSV形式でエクスポートします。
ResultObject addressbookExport (AddressbookKey addressbookKey)
アドレスブック内の連絡先をCSV形式でエクスポートします。
ResultObject deleteContactAddress (ContactAddressKey[] contactAddressKeys)
連絡先を削除します。
ResultObject findDisplayItem (AddressbookKey addressbookKey)
連絡先の表示項目設定を取得します。
ResultObject findListAuthz (ContactFilter contactFilter, PagingParameter target)
連絡先を取得します。
ResultObject findList (ContactFilter contactFilter, PagingParameter target)
連絡先を取得します。
ResultObject findOverPeriodUser (AddressbookKey addressbookKey)
期間外ユーザを取得します。
ResultObject updateDisplayItem (ListSort listSort)
連絡先の表示項目順を更新します。

メソッドの詳細

ResultObject addressbookExportAuthz (AddressbookKey addressbookKey)
アドレスブック内の連絡先をCSV形式でエクスポートします。
プロファイル連携ありの場合、プロファイル認可が拒否の項目は出力しません。

エクスポートファイルは、SessionStorageに配置します。

パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、AddressbookExport を設定します。
ResultObject addressbookExport (AddressbookKey addressbookKey)
アドレスブック内の連絡先をCSV形式でエクスポートします。

エクスポートファイルは、SessionStorageに配置します。

パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、AddressbookExport を設定します。
ResultObject deleteContactAddress (ContactAddressKey[] contactAddressKeys)
連絡先を削除します。
パラメータ
contactAddressKeys : ContactAddressKey[]
連絡先キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject findDisplayItem (AddressbookKey addressbookKey)
連絡先の表示項目設定を取得します。
パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ItemSetupDisplayOnAddressbook を設定します。
ResultObject findListAuthz (ContactFilter contactFilter, PagingParameter target)
連絡先を取得します。
プロファイル連携ありの場合、プロファイル認可が拒否の項目は出力しません。

指定した検索条件に該当するデータをページ情報分取得します。

パラメータ
contactFilter : ContactFilter
検索条件
target : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ContactListDisplayItem を設定します。
ResultObject findList (ContactFilter contactFilter, PagingParameter target)
連絡先を取得します。

指定した検索条件に該当するデータをページ情報分取得します。

パラメータ
contactFilter : ContactFilter
検索条件
target : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ContactListDisplayItem を設定します。
ResultObject findOverPeriodUser (AddressbookKey addressbookKey)
期間外ユーザを取得します。

指定したアドレスブックでプロファイル連携している場合に、期間外となったユーザを取得します。
期間外となったユーザがいない場合は、空の配列を返却します。

パラメータ
addressbookKey : AddressbookKey
アドレスブックキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、OverPeriodUser[] を設定します。
ResultObject updateDisplayItem (ListSort listSort)
連絡先の表示項目順を更新します。
パラメータ
listSort : ListSort
連絡先の表示項目順情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。