パッケージ jp.co.ucm.im.groupmail.api

クラス PreferenceService

java.lang.Object

jp.co.ucm.im.groupmail.api.PreferenceService

public class PreferenceService
extends Object

ユーザの個人情報を取得・設定するAPIです。
このAPIが更新・取得する対象はログインユーザの情報のみです。

バージョン:

8.0.0

作成者:

UCM Co., Ltd.

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
PreferenceService()	コンストラクター。

メソッドの概要

修飾子とタイプ	メソッド	説明
Preference	get()	ログインユーザの個人設定オブジェクトを取得して返却する。
void	set(Preference pref)	設定を更新または登録します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PreferenceService

public PreferenceService()

コンストラクター。 初期化処理InitProcess が完了していなければ失敗します。

メソッドの詳細

get

@JSFunction
public Preference get()

ログインユーザの個人設定オブジェクトを取得して返却する。
個人設定オブジェクトがない場合はデフォルト設定のオブジェクトを返却する。
ユーザがログインしていない状態の場合も同様。

戻り値:

個人設定オブジェクト

set

@JSFunction
public void set(Preference pref)
         throws GroupMailException

設定を更新または登録します。条件にログインユーザコードを使用するため、ログインユーザ以外の設定は更新されません。

パラメータ:

pref - 設定内容

例外:

GroupMailException - 設定内容に問題がある場合