imbox.ApplicationBoxServiceオブジェクト

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

コンポーネント概要

アプリケーションボックスに関するサービスを行うクラスです。

メソッドの概要

返却値の型	メソッド名
ResultObject	bookmark (MessageKey `messageKey`) ブックマークを行います。
ResultObject	existsMessage (String `threadId`, String `messageId`) メッセージの存在有無の判定を行います。
ResultObject	existsThread (String `threadId`) スレッドの存在有無の判定を行います。
ResultObject	getLatestThreads (String `messageId`) 指定したメッセージ`ID`を除く最新スレッドの取得を行います。
ResultObject	getMessageType (MessageTypeKey `messageTypeKey`) メッセージ種別の取得を行います。
ResultObject	getMessageTypes () メッセージ種別一覧の取得を行います。
ResultObject	getMessage (MessageKey `messageKey`) メッセージの取得を行います。
ResultObject	getMessagesInThread (String `threadId`) スレッド内にある全メッセージの取得を行います。
ResultObject	getMessagesInThread (String `threadId`, String `start`) スレッド内メッセージ取得件数で設定されている件数分、スレッド内にあるメッセージの取得を行います。
ResultObject	getThreads (String `start`) スレッドの取得を行います。
ResultObject	isBookmark (String `messageId`) ブックマークを行っているかの判定を行います。
ResultObject	logicalExistsMessage (String `threadId`, String `messageId`) メッセージの存在有無の判定を行います。
ResultObject	remove (MessageKey `messageKey`) メッセージの削除を行います。
ResultObject	sendMail (MessageKey `messageKey`) 指定したメッセージをメールにて送信を行います。
ResultObject	sendNoticeMessage (Entry4NoticeMessage `entry4NoticeMessage`, Array `userCds`) アプリケーション通知メッセージを`ApplicationBox`に投稿します。
ResultObject	sendNoticeMessage (Entry4NoticeMessage `entry4NoticeMessage`, String `threadSummarizeCd`, Array `userCds`) アプリケーション通知メッセージを`ApplicationBox`に投稿します。
ResultObject	sendWatchMessage (Entry4WatchMessage `entry4WatchMessage`, Array `targetIds`) ウォッチを行ったユーザに、アプリケーションから`ApplicationBox`へメッセージの投稿を行います。
ResultObject	sendWatchMessage (Entry4WatchMessage `entry4WatchMessage`, String `threadSummarizeCd`, Array `targetIds`) ウォッチを行ったユーザに、アプリケーションから`ApplicationBox`へメッセージの投稿を行います。
ResultObject	unbookmark (MessageKey `messageKey`) メッセージに対してブックマークの解除を行います。

メソッドの詳細

ResultObject bookmark (MessageKey messageKey)

ブックマークを行います。

パラメータ

messageKey : MessageKey: メッセージキー情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

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 messageId)

指定したメッセージIDを除く最新スレッドの取得を行います。

パラメータ

messageId : String: メッセージID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、スレッド情報リストが設定されます。
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 start)

スレッドの取得を行います。
引数メッセージID（start）を指定した場合。そのメッセージID以降のスレッドが返却されます。
引数メッセージID（start）にnullを指定した場合は先頭のグループから返却されます。
スレッドに含まれるメッセージは、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）
スレッドに含まれるメッセージはスレッドの先頭のメッセージと、最新の2件のみ戻り値に含まれます。

パラメータ

start : String: メッセージID

返却値

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

ResultObject isBookmark (String messageId)

ブックマークを行っているかの判定を行います。

パラメータ

messageId : String: メッセージID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ブックマークを行っている場合は true、それ以外は false が設定されます。

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 sendNoticeMessage (Entry4NoticeMessage entry4NoticeMessage, Array userCds)

アプリケーション通知メッセージをApplicationBoxに投稿します。
投稿されたメッセージはスレッド単位には表示されません。

パラメータ

entry4NoticeMessage : Entry4NoticeMessage: アプリケーション通知メッセージ登録情報

userCds : Array: 通知を行うユーザのユーザコード(複数)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject sendNoticeMessage (Entry4NoticeMessage entry4NoticeMessage, String threadSummarizeCd, Array userCds)

アプリケーション通知メッセージをApplicationBoxに投稿します。
投稿されたメッセージはthreadSummarizeCdで指定した単位でスレッド表示されます。

パラメータ

entry4NoticeMessage : Entry4NoticeMessage: アプリケーション通知メッセージ登録情報

threadSummarizeCd : String: メッセージをスレッド単位にするためのコード
threadSummarizeCdが同じメッセージを１つのスレッドに纏めます。
異なるアプリケーションで利用する場合、意図せずthreadSummarizeCdが重複してしまう可能性もあるため、設定する値はシステム一意になるコードを設定することを推奨します。

userCds : Array: 通知を行うユーザのユーザコード(複数)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject sendWatchMessage (Entry4WatchMessage entry4WatchMessage, Array targetIds)

ウォッチを行ったユーザに、アプリケーションからApplicationBoxへメッセージの投稿を行います。
投稿されたメッセージはスレッド単位には表示されません。

パラメータ

entry4WatchMessage : Entry4WatchMessage: アプリケーションウォッチメッセージ登録情報

targetIds : Array: 通知を行うアプリケーションの特定データ識別ID(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject sendWatchMessage (Entry4WatchMessage entry4WatchMessage, String threadSummarizeCd, Array targetIds)

ウォッチを行ったユーザに、アプリケーションからApplicationBoxへメッセージの投稿を行います。
投稿されたメッセージはthreadSummarizeCdで指定した単位でスレッド表示されます。

パラメータ

entry4WatchMessage : Entry4WatchMessage: アプリケーションウォッチメッセージ登録情報

threadSummarizeCd : String: メッセージをスレッド単位にするためのコード
threadSummarizeCdが同じメッセージを１つのスレッドに纏めます。
異なるアプリケーションで利用する場合、意図せずthreadSummarizeCdが重複してしまう可能性もあるため、設定する値はシステム一意になるコードを設定することを推奨します。

targetIds : Array: 通知を行うアプリケーションの特定データ識別ID(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject unbookmark (MessageKey messageKey)

メッセージに対してブックマークの解除を行います。

パラメータ

messageKey : MessageKey: メッセージキー情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。