imbox.UserMessageServiceオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.9 |
since | 8.0.0 |
ユーザが投稿したメッセージ一覧に関するサービスを行うクラスです。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
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 )
ブックマークを行います。
パラメータ
返却値
|
ResultObject edit (Entry4EditMessage entry4EditMessage )
メッセージの編集を行います。
パラメータ
返却値
|
ResultObject existsMessage (String threadId , String messageId )
メッセージの存在有無の判定を行います。
削除フラグのONの場合は存在していないと判定されます。
パラメータ
返却値
|
ResultObject getLatestMessages (String userCd , String messageId )
指定したメッセージID以降に投稿された全メッセージの取得を行います。
パラメータ
返却値
|
ResultObject getLikedByUserCount (String messageId )
Like登録を行ったユーザ数の取得を行います。
パラメータ
返却値
|
ResultObject getLikedByUsers (String messageId , String start )
Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード(start)を指定することにより、そのユーザコード以降のユーザ情報が返却されます。 引数ユーザコード(start)にnullを指定した場合は先頭からのユーザが返却されます。 取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件) 論理削除されているユーザの取得は行いません。
パラメータ
返却値
|
ResultObject getLikedByUsers (String messageId , String start , Boolean deleteFlag )
Like登録を行ったユーザの一覧取得を行います。
引数ユーザコード(start)を指定することにより、そのユーザコード以降のユーザ情報が返却されます。 引数ユーザコード(start)にnullを指定した場合は先頭からのユーザが返却されます。 取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件)
パラメータ
返却値
|
ResultObject getMessageType (MessageTypeKey messageTypeKey )
メッセージ種別の取得を行います。
パラメータ
返却値
|
ResultObject getMessageTypes ()
メッセージ種別一覧の取得を行います。
imbox-message-configに設定されたメッセージ種別情報の取得が行われます。
返却値
|
ResultObject getMessage (MessageKey messageKey )
メッセージの取得を行います。
パラメータ
返却値
|
ResultObject getMessages (String userCd , String start )
指定したユーザコードのメッセージ一覧を取得します。
非公開グループへの投稿は含まれません。 引数メッセージID(start)を指定することにより、そのメッセージID以降のメッセージが返却されます。 引数メッセージID(start)にnullを指定した場合は先頭からのメッセージが返却されます。 取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。(デフォルトは20件)
パラメータ
返却値
|
ResultObject isBookmark (String messageId )
ブックマークを行っているかの判定を行います。
パラメータ
返却値
|
ResultObject isLike (String messageId )
Likeを行っているかの判定を行います。
パラメータ
返却値
|
ResultObject like (MessageKey messageKey )
メッセージに対してLikeの登録を行います。
パラメータ
返却値
|
ResultObject logicalExistsMessage (String threadId , String messageId )
メッセージの存在有無の判定を行います。
削除フラグがONの場合は存在していると判定されます。
パラメータ
返却値
|
ResultObject remove (MessageKey messageKey )
メッセージの削除を行います。
パラメータ
返却値
|
ResultObject sendMail (MessageKey messageKey )
指定したメッセージをメールにて送信を行います。
メール送信先にチェックがついているメールアドレスに送信されます。 メール送信先にチェックがついていない場合、もしくはメールアドレスが設定されていない場合、 メール送信処理は行われません。
パラメータ
返却値
|
ResultObject unbookmark (MessageKey messageKey )
メッセージに対してブックマークの解除を行います。
パラメータ
返却値
|
ResultObject unlike (MessageKey messageKey )
メッセージに対してLikeの解除を行います。
パラメータ
返却値
|