メソッドの概要

返却値の型 メソッド名
ResultObject delete (MessageKey[] keys)
受信伝言メモを削除します。
ReadStatus findReadflgMap (MessageKey key)
既読情報を取得します。
ResultObject find (MessageKey key)
受信伝言メモを取得します。
ResultObject find (ReceiveMessageFilter receiveMessageFilter, PagingParameter target)
受信伝言メモを取得します。
ResultObject updateReadStatus (MessageKey[] keys, Boolean isRead)
受信伝言メモを既読/未読に更新します。

メソッドの詳細

ResultObject delete (MessageKey[] keys)
受信伝言メモを削除します。

送信側の伝言メモは削除しません。

パラメータ
keys : MessageKey[]
伝言メモキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ReadStatus findReadflgMap (MessageKey key)
既読情報を取得します。

指定したメッセージコードを受信したユーザの既読情報を取得します。
該当データがない場合、空の配列を返却します。

パラメータ
key : MessageKey
メッセージコード
返却値
ReadStatus
ReadStatus 既読情報リスト
ResultObject find (MessageKey key)
受信伝言メモを取得します。

該当データがない場合、NULLを返却します。

パラメータ
key : MessageKey
伝言メモキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ReceivedMessageMemo を設定します。
ResultObject find (ReceiveMessageFilter receiveMessageFilter, PagingParameter target)
受信伝言メモを取得します。

指定した検索条件に該当する受信伝言メモをページ情報分取得します。
該当データがない場合、空の配列を返却します。

パラメータ
receiveMessageFilter : ReceiveMessageFilter
検索条件
target : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ReceivePaginCollection# を設定します。
ResultObject updateReadStatus (MessageKey[] keys, Boolean isRead)
受信伝言メモを既読/未読に更新します。
パラメータ
keys : MessageKey[]
伝言メモキー
isRead : Boolean
true : 既読 / false : 未読
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。