imbox.DirectMessageOperationsオブジェクト

コンポーネント情報
version	8.0.6
since	8.0.0

コンポーネント概要

ダイレクトメッセージボックスに関するサービスを行うクラスです。

メソッドの概要

返却値の型	メソッド名
ResultObject	getReferenceUserCount (String `threadId`) ダイレクトメッセージ参照可能ユーザ数の取得を行います。
ResultObject	getReferenceUsersWithCheckDeleteFlag (String `threadId`, String `start`, Boolean `deleteFlag`) ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
ResultObject	getReferenceUsers (String `threadId`, String `start`) ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
ResultObject	getReferenceUsers (String `threadId`, String `start`, Number `count`) ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
ResultObject	getReferenceUsers (String `threadId`, String `start`, Number `count`, Boolean `deleteFlag`) ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
ResultObject	isReferenceUser (String `threadId`, String `userCd`) 指定スレッドが参照可能であるかの判定を行います。

メソッドの詳細

ResultObject getReferenceUserCount (String threadId)

ダイレクトメッセージ参照可能ユーザ数の取得を行います。

パラメータ

threadId : String: スレッドID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ダイレクトメッセージ参照可能ユーザ数が設定されます。
data プロパティの取得結果が存在しない場合は、0が返却されます。

ResultObject getReferenceUsersWithCheckDeleteFlag (String threadId, String start, Boolean deleteFlag)

ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ

threadId : String: スレッドID

start : String: ユーザコード

deleteFlag : Boolean: 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getReferenceUsers (String threadId, String start)

ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）
論理削除されているユーザの取得は行いません。

パラメータ

threadId : String: スレッドID

start : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getReferenceUsers (String threadId, String start, Number count)

ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
取得件数は、指定した件数分取得が行われます。
論理削除されているユーザの取得は行いません。

パラメータ

threadId : String: スレッドID

start : String: ユーザコード

count : Number: 取得件数

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getReferenceUsers (String threadId, String start, Number count, Boolean deleteFlag)

ダイレクトメッセージ参照可能ユーザ一覧の取得を行います。
取得件数は、指定した件数分取得が行われます。

パラメータ

threadId : String: スレッドID

start : String: ユーザコード

count : Number: 取得件数

deleteFlag : Boolean: 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject isReferenceUser (String threadId, String userCd)

指定スレッドが参照可能であるかの判定を行います。

パラメータ

threadId : String: 判定対象スレッドのスレッドID

userCd : String: 判定対象ユーザのユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、参照可能である場合は true、それ以外は false が設定されます。