imbox.DirectMessageBoxServiceオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.9 |
since | 8.0.0 |
ダイレクトメッセージボックスに関するサービスを行うクラスです。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | addAddress (String threadId , Array userCds ) 指定したスレッドの宛先にメンバーの追加を行います。 |
ResultObject | bookmark (MessageKey messageKey ) ブックマークを行います。 |
ResultObject | edit (Entry4EditMessage entry4EditMessage ) メッセージの編集を行います。 |
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 | isNoticeMessage (String messageId , String userCd ) メッセージの通知先に設定されているかの判定を行います。 |
ResultObject | logicalExistsMessage (String threadId , String messageId ) メッセージの存在有無の判定を行います。 |
ResultObject | remove (MessageKey messageKey ) メッセージの削除を行います。 |
ResultObject | sendMail (MessageKey messageKey ) 指定したメッセージをメールにて送信を行います。 |
ResultObject | send (Entry4SendMessage entry4SendMessage ) メッセージの投稿を行います。 |
ResultObject | send (Entry4SendMessage entry4SendMessage , String threadId ) 指定したスレッドIDに対してメッセージの返信を行います。 |
ResultObject | unbookmark (MessageKey messageKey ) メッセージに対してブックマークの解除を行います。 |
メソッドの詳細
ResultObject addAddress (String threadId , Array userCds )
指定したスレッドの宛先にメンバーの追加を行います。
パラメータ
返却値
|
ResultObject bookmark (MessageKey messageKey )
ブックマークを行います。
パラメータ
返却値
|
ResultObject edit (Entry4EditMessage entry4EditMessage )
メッセージの編集を行います。
パラメータ
返却値
|
ResultObject existsMessage (String threadId , String messageId )
メッセージの存在有無の判定を行います。
削除フラグのONの場合は存在していないと判定されます。
パラメータ
返却値
|
ResultObject existsThread (String threadId )
スレッドの存在有無の判定を行います。
パラメータ
返却値
|
ResultObject getLatestThreads (String messageId )
指定したメッセージIDを除く最新スレッドの取得を行います。
パラメータ
返却値
|
ResultObject getMessageType (MessageTypeKey messageTypeKey )
メッセージ種別の取得を行います。
パラメータ
返却値
|
ResultObject getMessageTypes ()
メッセージ種別一覧の取得を行います。
imbox-message-configに設定されたメッセージ種別情報の取得が行われます。
返却値
|
ResultObject getMessage (MessageKey messageKey )
メッセージの取得を行います。
パラメータ
返却値
|
ResultObject getMessagesInThread (String threadId )
スレッド内にある全メッセージの取得を行います。
パラメータ
返却値
|
ResultObject getMessagesInThread (String threadId , String start )
スレッド内メッセージ取得件数で設定されている件数分、スレッド内にあるメッセージの取得を行います。
パラメータ
返却値
|
ResultObject getThreads (String start )
スレッドの取得を行います。
引数メッセージID(start)を指定した場合。そのメッセージID以降のスレッドが返却されます。 引数メッセージID(start)にnullを指定した場合は先頭のグループから返却されます。 スレッドに含まれるメッセージは、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件) スレッドに含まれるメッセージはスレッドの先頭のメッセージと、最新の2件のみ戻り値に含まれます。
パラメータ
返却値
|
ResultObject isBookmark (String messageId )
ブックマークを行っているかの判定を行います。
パラメータ
返却値
|
ResultObject isNoticeMessage (String messageId , String userCd )
メッセージの通知先に設定されているかの判定を行います。
パラメータ
返却値
|
ResultObject logicalExistsMessage (String threadId , String messageId )
メッセージの存在有無の判定を行います。
削除フラグがONの場合は存在していると判定されます。
パラメータ
返却値
|
ResultObject remove (MessageKey messageKey )
メッセージの削除を行います。
パラメータ
返却値
|
ResultObject sendMail (MessageKey messageKey )
指定したメッセージをメールにて送信を行います。
メール送信先にチェックがついているメールアドレスに送信されます。 メール送信先にチェックがついていない場合、もしくはメールアドレスが設定されていない場合、 メール送信処理は行われません。
パラメータ
返却値
|
ResultObject send (Entry4SendMessage entry4SendMessage )
メッセージの投稿を行います。
パラメータ
返却値
|
ResultObject send (Entry4SendMessage entry4SendMessage , String threadId )
指定したスレッドIDに対してメッセージの返信を行います。
パラメータ
返却値
|
ResultObject unbookmark (MessageKey messageKey )
メッセージに対してブックマークの解除を行います。
パラメータ
返却値
|