jp.co.intra_mart.foundation.master.user

インタフェース UserImageManager

public interface UserImageManager

ユーザのプロファイル画像を操作するインタフェースです。

導入されたバージョン:

8.0.20

バージョン:

8.0.20

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	deleteUserImage(String userCd) プロファイル画像を削除します。
String	getUserImage(String userCd, String imageType) プロファイル画像をデータURL形式で取得します。
Map<String,String>	getUserImages(List<String> userCds, String imageType) プロファイル画像をデータURL形式で取得します。
Map<String,UserImageFileInfo>	getUserImagesStream(List<String> userCds, String imageType) プロファイル画像をStream形式で取得します。
UserImageFileInfo	getUserImageStream(String userCds, String imageType) プロファイル画像をStream形式で取得します。
int	setUserImage(UserImage image) ユーザのプロファイル画像を登録します。

メソッドの詳細

deleteUserImage

int deleteUserImage(String userCd)
             throws BizApiException

プロファイル画像を削除します。

パラメータ:

userCd - ユーザコード

戻り値:

処理件数

例外:

BizApiException - 削除に失敗した場合、または引数が不正だった場合にスローされます。

getUserImage

String getUserImage(String userCd,
                    String imageType)
             throws BizApiException

プロファイル画像をデータURL形式で取得します。
画像種別には、im-master-config.xmlで定義された画像ファイルのサイズを表すキー名を指定します。
画像が取得できなかった場合は null を返却します。

パラメータ:

userCd - ユーザコード

imageType - 画像種別

戻り値:

プロファイル画像のデータURL

例外:

BizApiException - 取得に失敗した場合、または引数が不正だった場合にスローされます。

getUserImages

Map<String,String> getUserImages(List<String> userCds,
                                 String imageType)
                          throws BizApiException

プロファイル画像をデータURL形式で取得します。
画像種別には、im-master-config.xmlで定義された画像ファイルのサイズを表すキー名を指定します。

パラメータ:

userCds - ユーザコードのリスト

imageType - 画像種別

戻り値:

ユーザコードと画像のデータURLのマップ

例外:

BizApiException - 取得に失敗した場合、または引数が不正だった場合にスローされます。

getUserImagesStream

Map<String,UserImageFileInfo> getUserImagesStream(List<String> userCds,
                                                  String imageType)
                                           throws BizApiException

プロファイル画像をStream形式で取得します。

パラメータ:

userCds - ユーザコードのリスト

imageType - 画像種別

戻り値:

ユーザコードと画像情報のマップ

例外:

BizApiException - 取得に失敗した場合、または引数が不正だった場合にスローされます。

getUserImageStream

UserImageFileInfo getUserImageStream(String userCds,
                                     String imageType)
                              throws BizApiException

プロファイル画像をStream形式で取得します。
画像種別には、im-master-config.xmlで定義された画像ファイルのサイズを表すキー名を指定します。
画像が取得できなかった場合は null を返却します。

パラメータ:

userCd - ユーザコード

imageType - 画像種別

戻り値:

画像情報

例外:

BizApiException - 取得に失敗した場合、または引数が不正だった場合にスローされます。

setUserImage

int setUserImage(UserImage image)
          throws BizApiException

ユーザのプロファイル画像を登録します。
対応する拡張子はjpg(jpeg)、pngです。

パラメータ:

image - プロファイル画像情報

戻り値:

処理件数

例外:

BizApiException - 登録に失敗した場合、または引数が不正だった場合にスローされます。