imbox.UserOperationsオブジェクト

コンポーネント情報
version	8.0.8
since	8.0.0

コンポーネント概要

ユーザに対する操作を行うクラスです。

メソッドの概要

返却値の型	メソッド名
ResultObject	attachConformity () ユーザの会社所属情報を現在日の`IM`共通マスタの情報に洗い替えを行います。
ResultObject	attachConformity (Date `date`) ユーザの会社所属情報を与えられた基準日の`IM`共通マスタの情報に洗い替えを行います。
ResultObject	createNotification (Notices `notices`) 通知設定の登録を行います。
ResultObject	createNotification (Notices `notices`, String `userCd`) 指定したユーザコードの通知設定の登録を行います。
ResultObject	createUsers () ユーザ情報を現在日のIM共通マスタを元に作成します。
ResultObject	createUsers (Date `date`) ユーザ情報を現在日のIM共通マスタを元に作成します。
ResultObject	editNotification (Notices `notices`) 通知設定の編集を行います。
ResultObject	editNotification (Notices `notices`, String `userCd`) 指定したユーザコードの通知設定の編集を行います。
ResultObject	edit (Entry4User `entry4User`) ユーザ情報の更新を行います。
ResultObject	existsUser (String `userCd`) ユーザの存在有無の判定を行います。
ResultObject	follow (Array `userCds`) ユーザのフォローを行います。
ResultObject	getFollowers (String `userCd`, String `start`) フォローされているユーザの一覧取得を行います。
ResultObject	getFollowers (String `userCd`, String `start`, Boolean `deleteFlag`) フォローされているユーザの一覧取得を行います。
ResultObject	getFollowing (String `userCd`, String `start`) フォローしているユーザの一覧取得を行います。
ResultObject	getFollowing (String `userCd`, String `start`, Boolean `deleteFlag`) フォローしているユーザの一覧取得を行います。
ResultObject	getNotices () 通知設定情報の取得を行います。
ResultObject	getNotices (String `userCd`) 指定したユーザコードの通知設定情報の取得を行います。
ResultObject	getRemovedUsers (String `companyCd`, String `start`) 指定したカンパニーコードの会社に所属した削除済みユーザ情報の取得を行います。
ResultObject	getUserCount (String `userCd`) ユーザ件数情報取得を行います。
ResultObject	getUser (String `userCd`) ユーザ情報の取得を行います。
ResultObject	isFollowing (String `userCd`) ユーザをフォローしているかの判定を行います。
ResultObject	isOutsideUser (String `userCd`, Boolean `deleteFlag`) 社外ユーザであるかの判定を行います。
ResultObject	register (Entry4User `entry4User`) ユーザ情報の登録を行います。
ResultObject	remove (Boolean `isRemoveType`, Array `userCds`) ユーザの論理削除及び、論理削除状態のユーザの情報を削除します。
ResultObject	unfollow (Array `userCds`) ユーザのフォロー解除を行います。

メソッドの詳細

ResultObject attachConformity ()

ユーザの会社所属情報を現在日のIM共通マスタの情報に洗い替えを行います。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject attachConformity (Date date)

ユーザの会社所属情報を与えられた基準日のIM共通マスタの情報に洗い替えを行います。

パラメータ

date : Date: ユーザの会社所属情報を取得する基準日

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject createNotification (Notices notices)

通知設定の登録を行います。

パラメータ

notices : Notices: 通知情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject createNotification (Notices notices, String userCd)

指定したユーザコードの通知設定の登録を行います。
このメソッドはバージョン 8.0.8 より利用可能です。

パラメータ

notices : Notices: 通知情報

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject createUsers ()

ユーザ情報を現在日のIM共通マスタを元に作成します。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject createUsers (Date date)

ユーザ情報を現在日のIM共通マスタを元に作成します。

パラメータ

date : Date: ユーザ情報を取得する基準日

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject editNotification (Notices notices)

通知設定の編集を行います。

パラメータ

notices : Notices: 通知情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject editNotification (Notices notices, String userCd)

指定したユーザコードの通知設定の編集を行います。
このメソッドはバージョン 8.0.8 より利用可能です。

パラメータ

notices : Notices: 通知情報

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject edit (Entry4User entry4User)

ユーザ情報の更新を行います。

パラメータ

entry4User : Entry4User: ユーザ登録情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject existsUser (String userCd)

ユーザの存在有無の判定を行います。

パラメータ

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザが存在する場合は true、それ以外は false が設定されます。

ResultObject follow (Array userCds)

ユーザのフォローを行います。

パラメータ

userCds : Array: ログインユーザがフォローするユーザのユーザコード(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject getFollowers (String userCd, String start)

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

パラメータ

userCd : String: ユーザコード

start : String: フォローされているユーザのユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、フォロワーが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getFollowers (String userCd, String start, Boolean deleteFlag)

パラメータ

userCd : String: ユーザコード

start : String: フォローされているユーザのユーザコード

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

返却値

ResultObject: ResultObject 処理結果
data プロパティには、フォロワーが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getFollowing (String userCd, String start)

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

パラメータ

userCd : String: ユーザコード

start : String: フォローしているユーザのユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、フォローユーザが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getFollowing (String userCd, String start, Boolean deleteFlag)

パラメータ

userCd : String: ユーザコード

start : String: フォローしているユーザのユーザコード

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

返却値

ResultObject: ResultObject 処理結果
data プロパティには、フォローユーザが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getNotices ()

通知設定情報の取得を行います。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、通知情報が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getNotices (String userCd)

指定したユーザコードの通知設定情報の取得を行います。
このメソッドはバージョン 8.0.8 より利用可能です。

パラメータ

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、通知情報が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getRemovedUsers (String companyCd, String start)

指定したカンパニーコードの会社に所属した削除済みユーザ情報の取得を行います。
companyCdにnullを指定した場合、会社に所属していないユーザ情報の取得を行います。
引数削除済みユーザのユーザコード（start）を指定した場合、そのユーザ以降のユーザ情報が返却されます。
引数削除済みユーザのユーザコード（start）にnullを指定した場合は先頭のユーザ情報から返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ

companyCd : String: カンパニーコード

start : String: 削除済みユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、削除済みユーザ情報が設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getUserCount (String userCd)

ユーザ件数情報取得を行います。

パラメータ

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ件数情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。

ResultObject getUser (String userCd)

ユーザ情報の取得を行います。

パラメータ

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。

ResultObject isFollowing (String userCd)

ユーザをフォローしているかの判定を行います。

パラメータ

userCd : String: 判定対象ユーザのユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、フォローを行っている場合は true、それ以外は false が設定されます。

ResultObject isOutsideUser (String userCd, Boolean deleteFlag)

社外ユーザであるかの判定を行います。

パラメータ

userCd : String: ユーザコード

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

返却値

ResultObject: ResultObject 処理結果
data プロパティには、社外ユーザの場合は true、それ以外は false が設定されます。

ResultObject register (Entry4User entry4User)

ユーザ情報の登録を行います。

パラメータ

entry4User : Entry4User: ユーザ登録情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject remove (Boolean isRemoveType, Array userCds)

ユーザの論理削除及び、論理削除状態のユーザの情報を削除します。
削除方法をtrueを指定した場合は、ユーザ情報は物理削除されます。

パラメータ

isRemoveType : Boolean: 削除方法 true:物理削除 / false :論理削除

userCds : Array: ユーザコード(複数指定可能)

返却値

ResultObject: ResultObject 処理結果

ResultObject unfollow (Array userCds)

ユーザのフォロー解除を行います。

パラメータ

userCds : Array: ユーザコード(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。