メソッドの概要

返却値の型 メソッド名
ResultObject bookmark (MessageKey messageKey)
ブックマークを行います。
ResultObject edit (Entry4EditMessage entry4EditMessage)
メッセージの編集を行います。
ResultObject existsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
ResultObject getLatestMessages (String userCd, String messageId)
指定したメッセージID以降に投稿された全メッセージの取得を行います。
ResultObject getLikedByUserCount (String messageId)
Like登録を行ったユーザ数の取得を行います。
ResultObject getLikedByUsers (String messageId, String start)
Like登録を行ったユーザの一覧取得を行います。
ResultObject getLikedByUsers (String messageId, String start, Boolean deleteFlag)
Like登録を行ったユーザの一覧取得を行います。
ResultObject getMessageType (MessageTypeKey messageTypeKey)
メッセージ種別の取得を行います。
ResultObject getMessageTypes ()
メッセージ種別一覧の取得を行います。
ResultObject getMessage (MessageKey messageKey)
メッセージの取得を行います。
ResultObject getMessages (String userCd, String start)
指定したユーザコードのメッセージ一覧を取得します。
ResultObject isBookmark (String messageId)
ブックマークを行っているかの判定を行います。
ResultObject isLike (String messageId)
Likeを行っているかの判定を行います。
ResultObject like (MessageKey messageKey)
メッセージに対してLikeの登録を行います。
ResultObject logicalExistsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
ResultObject remove (MessageKey messageKey)
メッセージの削除を行います。
ResultObject sendMail (MessageKey messageKey)
指定したメッセージをメールにて送信を行います。
ResultObject unbookmark (MessageKey messageKey)
メッセージに対してブックマークの解除を行います。
ResultObject unlike (MessageKey messageKey)
メッセージに対してLikeの解除を行います。

メソッドの詳細

ResultObject bookmark (MessageKey messageKey)
ブックマークを行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject edit (Entry4EditMessage entry4EditMessage)
メッセージの編集を行います。
パラメータ
entry4EditMessage : Entry4EditMessage
メッセージ編集情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージキー情報が設定されます。
ResultObject existsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
削除フラグのONの場合は存在していないと判定されます。
パラメータ
threadId : String
スレッドID
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージが存在する場合は true、それ以外は false が設定されます。
ResultObject getLatestMessages (String userCd, String messageId)
指定したメッセージID以降に投稿された全メッセージの取得を行います。
パラメータ
userCd : String
ユーザコード
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getLikedByUserCount (String messageId)
Like登録を行ったユーザ数の取得を行います。
パラメータ
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、Like登録を行ったユーザ数が設定されます。
data プロパティの取得結果が存在しない場合は、0が返却されます。
ResultObject getLikedByUsers (String messageId, String start)
Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード(start)を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード(start)にnullを指定した場合は先頭からのユーザが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件)
論理削除されているユーザの取得は行いません。
パラメータ
messageId : String
メッセージID
start : String
ユーザコード
返却値
ResultObject
ResultObject 処理結果
data プロパティには、Like情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getLikedByUsers (String messageId, String start, Boolean deleteFlag)
Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード(start)を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード(start)にnullを指定した場合は先頭からのユーザが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件)
パラメータ
messageId : String
メッセージID
start : String
ユーザコード
deleteFlag : Boolean
削除フラグ true:論理削除されているユーザも取得します。/false:論理削除されているユーザの取得は行いません。
返却値
ResultObject
ResultObject 処理結果
data プロパティには、Like情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getMessageType (MessageTypeKey messageTypeKey)
メッセージ種別の取得を行います。
パラメータ
messageTypeKey : MessageTypeKey
メッセージ種別キー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ種別情報が設定されます。
ResultObject getMessageTypes ()
メッセージ種別一覧の取得を行います。
imbox-message-configに設定されたメッセージ種別情報の取得が行われます。
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ種別情報リストが設定されます。
ResultObject getMessage (MessageKey messageKey)
メッセージの取得を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。
ResultObject getMessages (String userCd, String start)
指定したユーザコードのメッセージ一覧を取得します。
非公開グループへの投稿は含まれません。
引数メッセージID(start)を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージID(start)にnullを指定した場合は先頭からのメッセージが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件)
パラメータ
userCd : String
ユーザコード
start : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject isBookmark (String messageId)
ブックマークを行っているかの判定を行います。
パラメータ
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、ブックマークを行っている場合は true、それ以外は false が設定されます。
ResultObject isLike (String messageId)
Likeを行っているかの判定を行います。
パラメータ
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、Likeを行っている場合は true、それ以外は false が設定されます。
ResultObject like (MessageKey messageKey)
メッセージに対してLikeの登録を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject logicalExistsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
削除フラグがONの場合は存在していると判定されます。
パラメータ
threadId : String
スレッドID
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージが存在する場合は true、それ以外は false が設定されます。
ResultObject remove (MessageKey messageKey)
メッセージの削除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject sendMail (MessageKey messageKey)
指定したメッセージをメールにて送信を行います。
メール送信先にチェックがついているメールアドレスに送信されます。
メール送信先にチェックがついていない場合、もしくはメールアドレスが設定されていない場合、
メール送信処理は行われません。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject unbookmark (MessageKey messageKey)
メッセージに対してブックマークの解除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject unlike (MessageKey messageKey)
メッセージに対してLikeの解除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。