jp.co.intra_mart.imbox.service

インタフェース MessageOperations

既知のサブインタフェースのリスト:

ApplicationBoxService, BookmarkMessageService, CompanyBoxService, DirectMessageBoxService, GroupBoxService, HiddenBoxService, LikeMessageService, MyBoxService, MylistMessageService, NoticeMessageService, TagBoxService, UnitBoxService, UnreadMessageService, UserMessageService

public interface MessageOperations

メッセージに対する操作を行うクラスです。

導入されたバージョン:

8.0.0

バージョン:

8.0.9

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	bookmark(MessageKey messageKey) ブックマークを行います。
MessageKey	edit(Entry4EditMessage entry4EditMessage) メッセージの編集を行います。
Boolean	existsMessage(CharSequence threadId, CharSequence messageId) メッセージの存在有無の判定を行います。
Messages	getLatestMessages(CharSequence messageId) 指定したメッセージID以降に投稿された全メッセージの取得を行います。
long	getLikedByUserCount(CharSequence messageId) Like登録を行ったユーザ数の取得を行います。
LikeUsers	getLikedByUsers(CharSequence messageId, CharSequence start) Like登録を行ったユーザの一覧取得を行います。
LikeUsers	getLikedByUsers(CharSequence messageId, CharSequence start, boolean deleteFlag) Like登録を行ったユーザの一覧取得を行います。
Message	getMessage(MessageKey messageKey) メッセージの取得を行います。
Messages	getMessages(CharSequence start) メッセージ一覧を取得します。
Messages	getMessagesInThread(CharSequence threadId) スレッド内にある全メッセージの取得を行います。
Messages	getMessagesInThread(CharSequence threadId, CharSequence start) スレッド内にあるメッセージの取得を行います。
MessageType	getMessageType(MessageTypeKey messageTypeKey) メッセージ種別の取得を行います。
MessageTypes	getMessageTypes() メッセージ種別一覧の取得を行います。
Boolean	isBookmark(CharSequence messageId) ブックマークを行っているかの判定を行います。
Boolean	isLike(CharSequence messageId) Likeを行っているかの判定を行います。
Boolean	isNoticeMessage(CharSequence messageId, CharSequence userCd) メッセージの通知先に設定されているかの判定を行います。
void	like(MessageKey messageKey) メッセージに対してLikeの登録を行います。
Boolean	logicalExistsMessage(CharSequence threadId, CharSequence messageId) メッセージの存在有無の判定を行います。
void	remove(MessageKey messageKey) メッセージの削除を行います。
MessageKey	send(Entry4SendMessage entry4SendMessage) メッセージの投稿を行います。
MessageKey	send(Entry4SendMessage entry4SendMessage, CharSequence threadId) 指定したスレッドIDに対してメッセージの返信を行います。
void	sendMail(MessageKey messageKey) 指定したメッセージをメールにて送信を行います。
void	unbookmark(MessageKey messageKey) メッセージに対してブックマークの解除を行います。
void	unlike(MessageKey messageKey) メッセージに対してLikeの解除を行います。

メソッドの詳細

bookmark

void bookmark(MessageKey messageKey)
       throws IMBoxException

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

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - ブックマークに失敗した場合に通知されます。

edit

MessageKey edit(Entry4EditMessage entry4EditMessage)
         throws IMBoxException

メッセージの編集を行います。

パラメータ:

entry4EditMessage - メッセージ編集情報

戻り値:

メッセージキー情報

例外:

IMBoxException - メッセージの投稿に失敗した場合に通知されます。

導入されたバージョン:

8.0.8

existsMessage

Boolean existsMessage(CharSequence threadId,
                      CharSequence messageId)
               throws IMBoxException

メッセージの存在有無の判定を行います。
削除フラグのONの場合は存在していないと判定されます。

パラメータ:

threadId - スレッドID

messageId - メッセージID

戻り値:

true:存在している/false:存在していない

例外:

IMBoxException - メッセージの存在有無の判定に失敗した場合に通知されます。

getLatestMessages

Messages getLatestMessages(CharSequence messageId)
                    throws IMBoxException

指定したメッセージID以降に投稿された全メッセージの取得を行います。

パラメータ:

messageId - メッセージID

戻り値:

メッセージ情報リスト

例外:

IMBoxException - メッセージの取得に失敗した場合に通知されます。

getLikedByUserCount

long getLikedByUserCount(CharSequence messageId)
                  throws IMBoxException

Like登録を行ったユーザ数の取得を行います。

パラメータ:

messageId - メッセージID

戻り値:

Like登録を行ったユーザ数

例外:

IMBoxException - Like登録を行ったユーザ数の取得に失敗した場合に通知されます。

getLikedByUsers

LikeUsers getLikedByUsers(CharSequence messageId,
                          CharSequence start)
                   throws IMBoxException

Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード（start）を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード（start）にnullを指定した場合は先頭からのユーザが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）
論理削除されているユーザの取得は行いません。

パラメータ:

messageId - メッセージID

start - ユーザコード

戻り値:

Like情報リスト

例外:

IMBoxException - Like登録ユーザ一覧の取得に失敗した場合に通知されます。

getLikedByUsers

LikeUsers getLikedByUsers(CharSequence messageId,
                          CharSequence start,
                          boolean deleteFlag)
                   throws IMBoxException

Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード（start）を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード（start）にnullを指定した場合は先頭からのユーザが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ:

messageId - メッセージID

start - ユーザコード

deleteFlag - 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

戻り値:

Like情報リスト

例外:

IMBoxException - Like登録ユーザ一覧の取得に失敗した場合に通知されます。

導入されたバージョン:

8.0.6

getMessage

Message getMessage(MessageKey messageKey)
            throws IMBoxException

メッセージの取得を行います。

パラメータ:

messageKey - メッセージキー情報

戻り値:

メッセージ情報

例外:

IMBoxException - メッセージの取得に失敗した場合に通知されます。

getMessages

Messages getMessages(CharSequence start)
              throws IMBoxException

メッセージ一覧を取得します。
引数メッセージID（start）を指定することにより、そのメッセージID以降のメッセージが返却されます。
引数メッセージID（start）にnullを指定した場合は先頭からのメッセージが返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ:

start - メッセージID

戻り値:

メッセージ情報リスト

例外:

IMBoxException - メッセージ一覧の取得に失敗した場合に通知されます。

getMessagesInThread

Messages getMessagesInThread(CharSequence threadId)
                      throws IMBoxException

スレッド内にある全メッセージの取得を行います。

パラメータ:

threadId - スレッドID

戻り値:

メッセージ情報リスト

例外:

IMBoxException - メッセージの取得に失敗した場合に通知されます。

getMessagesInThread

Messages getMessagesInThread(CharSequence threadId,
                             CharSequence start)
                      throws IMBoxException

スレッド内にあるメッセージの取得を行います。
引数メッセージID（start）を指定することにより、そのメッセージID以前のメッセージがスレッド内メッセージ取得件数分返却されます。
引数メッセージID（start）にnullを指定した場合は先頭からのメッセージが返却されます。

パラメータ:

threadId - スレッドID

start - メッセージ取得開始位置

戻り値:

メッセージ情報リスト

例外:

IMBoxException - メッセージの取得に失敗した場合に通知されます。

導入されたバージョン:

8.0.9

getMessageType

MessageType getMessageType(MessageTypeKey messageTypeKey)
                    throws IMBoxException

メッセージ種別の取得を行います。

パラメータ:

messageTypeKey - メッセージ種別キー

戻り値:

メッセージ種別情報

例外:

IMBoxException - メッセージ種別の取得に失敗した場合に通知されます。

getMessageTypes

MessageTypes getMessageTypes()
                      throws IMBoxException

メッセージ種別一覧の取得を行います。
imbox-message-configに設定されたメッセージ種別情報の取得が行われます。

戻り値:

メッセージ種別情報リスト

例外:

IMBoxException - メッセージ種別一覧取得に失敗した場合に通知されます。

isBookmark

Boolean isBookmark(CharSequence messageId)
            throws IMBoxException

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

パラメータ:

messageId - メッセージID

戻り値:

true:ブックマークを行っている/false:ブックマークを行っていない

例外:

IMBoxException - ブックマークを行っているかの判定に失敗した場合に通知されます。

isLike

Boolean isLike(CharSequence messageId)
        throws IMBoxException

Likeを行っているかの判定を行います。

パラメータ:

messageId - メッセージID

戻り値:

true:Likeを行っている/false:Likeを行っていない

例外:

IMBoxException - Likeを行っているかの判定に失敗した場合に通知されます。

isNoticeMessage

Boolean isNoticeMessage(CharSequence messageId,
                        CharSequence userCd)
                 throws IMBoxException

メッセージの通知先に設定されているかの判定を行います。

パラメータ:

messageId - メッセージID

userCd - 通知対象ユーザのユーザCD

戻り値:

true:通知先に設定されている/false:通知先に設定されていない

例外:

IMBoxException - 通知先に設定されているかの判定に失敗した場合に通知されます。

導入されたバージョン:

8.0.3

like

void like(MessageKey messageKey)
   throws IMBoxException

メッセージに対してLikeの登録を行います。

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - Likeの登録に失敗した場合に通知されます。

logicalExistsMessage

Boolean logicalExistsMessage(CharSequence threadId,
                             CharSequence messageId)
                      throws IMBoxException

メッセージの存在有無の判定を行います。
削除フラグがONの場合は存在していると判定されます。

パラメータ:

threadId - スレッドID

messageId - メッセージID

戻り値:

true:存在している/false:存在していない

例外:

IMBoxException - メッセージの存在有無の判定に失敗した場合に通知されます。

remove

void remove(MessageKey messageKey)
     throws IMBoxException

メッセージの削除を行います。

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - メッセージの削除に失敗した場合に通知されます。

send

MessageKey send(Entry4SendMessage entry4SendMessage)
         throws IMBoxException

メッセージの投稿を行います。

パラメータ:

entry4SendMessage - 投稿メッセージ登録情報

戻り値:

メッセージキー情報

例外:

IMBoxException - メッセージの投稿に失敗した場合に通知されます。

send

MessageKey send(Entry4SendMessage entry4SendMessage,
                CharSequence threadId)
         throws IMBoxException

指定したスレッドIDに対してメッセージの返信を行います。

パラメータ:

entry4SendMessage - 投稿メッセージ登録情報

threadId - スレッドID

戻り値:

メッセージキー情報

例外:

IMBoxException - メッセージの返信に失敗した場合に通知されます。

sendMail

void sendMail(MessageKey messageKey)
       throws IMBoxException

指定したメッセージをメールにて送信を行います。
メール送信先にチェックがついているメールアドレスに送信されます。
メール送信先にチェックがついていない場合、もしくはメールアドレスが設定されていない場合、
メール送信処理は行われません。

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - メール送信に失敗した場合に通知されます。

unbookmark

void unbookmark(MessageKey messageKey)
         throws IMBoxException

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

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - ブックマークの解除に失敗した場合に通知されます。

unlike

void unlike(MessageKey messageKey)
     throws IMBoxException

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

パラメータ:

messageKey - メッセージキー情報

例外:

IMBoxException - Likeの解除に失敗した場合に通知されます。