メソッドの概要

返却値の型 メソッド名
ResultObject addTag (String threadId, Entry4Tags entry4Tags)
スレッドにタグの付与を行います。
ResultObject bookmark (MessageKey messageKey)
ブックマークを行います。
ResultObject edit (Entry4EditMessage entry4EditMessage)
メッセージの編集を行います。
ResultObject existsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
ResultObject existsThread (String threadId)
スレッドの存在有無の判定を行います。
ResultObject getLatestThreads (String boxCd, 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 getMessagesInThread (String threadId)
スレッド内にある全メッセージの取得を行います。
ResultObject getMessagesInThread (String threadId, String start)
スレッド内メッセージ取得件数で設定されている件数分、スレッド内にあるメッセージの取得を行います。
ResultObject getThreads (String boxCd, String start)
ボックスコードに紐づくグループボックスのタイムラインの取得を行います。
ResultObject isBookmark (String messageId)
ブックマークを行っているかの判定を行います。
ResultObject isLike (String messageId)
Likeを行っているかの判定を行います。
ResultObject isNoticeMessage (String messageId, String userCd)
メッセージの通知先に設定されているかの判定を行います。
ResultObject isRemoveTag (String threadId, String tag, String userCd)
タグをスレッドから削除が行えるユーザであるかの判定を行います。
ResultObject like (MessageKey messageKey)
メッセージに対してLikeの登録を行います。
ResultObject logicalExistsMessage (String threadId, String messageId)
メッセージの存在有無の判定を行います。
ResultObject removeTag (String threadId, Array tags)
タグの取り外し(タグをスレッドから削除)を行います。
ResultObject remove (MessageKey messageKey)
メッセージの削除を行います。
ResultObject sendMail (MessageKey messageKey)
指定したメッセージをメールにて送信を行います。
ResultObject send (Entry4SendMessage entry4SendMessage)
メッセージの投稿を行います。
ResultObject send (Entry4SendMessage entry4SendMessage, String threadId)
指定したスレッドIDに対してメッセージの返信を行います。
ResultObject unbookmark (MessageKey messageKey)
メッセージに対してブックマークの解除を行います。
ResultObject unlike (MessageKey messageKey)
メッセージに対してLikeの解除を行います。

メソッドの詳細

ResultObject addTag (String threadId, Entry4Tags entry4Tags)
スレッドにタグの付与を行います。
パラメータ
threadId : String
スレッドID
entry4Tags : Entry4Tags
タグ登録情報リスト(複数可能)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
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 existsThread (String threadId)
スレッドの存在有無の判定を行います。
パラメータ
threadId : String
スレッドID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドが存在する場合は true、それ以外は false が設定されます。
ResultObject getLatestThreads (String boxCd, String messageId)
指定したメッセージID以降に投稿されたスレッドの取得を行います。
パラメータ
boxCd : 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 getMessagesInThread (String threadId)
スレッド内にある全メッセージの取得を行います。
パラメータ
threadId : String
スレッドID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getMessagesInThread (String threadId, String start)
スレッド内メッセージ取得件数で設定されている件数分、スレッド内にあるメッセージの取得を行います。
パラメータ
threadId : String
スレッドID
start : String
メッセージID (メッセージ取得開始位置)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。
ResultObject getThreads (String boxCd, String start)
ボックスコードに紐づくグループボックスのタイムラインの取得を行います。
引数メッセージIDstart)を指定した場合、そのメッセージID以降のスレッドが返却されます。
引数メッセージIDstart)にnullを指定した場合は先頭のスレッドから返却されます。
スレッドに含まれるメッセージは、imbox-config.xmlに設定された件数分のみ取得が行われます。
スレッドに含まれるメッセージはスレッドの先頭のメッセージと、最新の2件のみ戻り値に含まれます。
パラメータ
boxCd : 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 isNoticeMessage (String messageId, String userCd)
メッセージの通知先に設定されているかの判定を行います。
パラメータ
messageId : String
メッセージID
userCd : String
通知対象ユーザのユーザコード
返却値
ResultObject
ResultObject 処理結果
data プロパティには、通知先に設定されている場合は true、それ以外は false が設定されます。
ResultObject isRemoveTag (String threadId, String tag, String userCd)
タグをスレッドから削除が行えるユーザであるかの判定を行います。
パラメータ
threadId : String
スレッドID
tag : String
タグ
userCd : String
判定対象ユーザのユーザコード
返却値
ResultObject
ResultObject 処理結果
data プロパティには、スレッドから削除が行える場合は 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 removeTag (String threadId, Array tags)
タグの取り外し(タグをスレッドから削除)を行います。
タグ自体は削除されません。
パラメータ
threadId : String
スレッドID
tags : Array
タグ(複数可能)
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject remove (MessageKey messageKey)
メッセージの削除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject sendMail (MessageKey messageKey)
指定したメッセージをメールにて送信を行います。
メール送信先にチェックがついているメールアドレスに送信されます。
メール送信先にチェックがついていない場合、もしくはメールアドレスが設定されていない場合、
メール送信処理は行われません。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject send (Entry4SendMessage entry4SendMessage)
メッセージの投稿を行います。
パラメータ
entry4SendMessage : Entry4SendMessage
投稿メッセージ登録情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージキー情報が設定されます。
ResultObject send (Entry4SendMessage entry4SendMessage, String threadId)
指定したスレッドIDに対してメッセージの返信を行います。
パラメータ
entry4SendMessage : Entry4SendMessage
メッセージ登録情報
threadId : String
スレッドID
返却値
ResultObject
ResultObject 処理結果
data プロパティには、メッセージキーが設定されます。
ResultObject unbookmark (MessageKey messageKey)
メッセージに対してブックマークの解除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。
ResultObject unlike (MessageKey messageKey)
メッセージに対してLikeの解除を行います。
パラメータ
messageKey : MessageKey
メッセージキー情報
返却値
ResultObject
ResultObject 処理結果
data プロパティには、nullが設定されます。