Accel Collaboration

iac_workspace.MemberServiceオブジェクト

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

コンポーネント概要

ワークスペースのメンバーに対する操作を提供するサービスです。

[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。

[ 操作可能なワークスペースについて ]
ワークスペースを操作する場合、操作ユーザがワークスペースのメンバーである必要があります。

メソッドの概要

返却値の型	メソッド名
ResultObject	addMember (WorkspaceKey `workspaceKey`, Member[] `members`) ワークスペースメンバーを追加します。
ResultObject	findMemberList (WorkspaceKey `workspaceKey`) ワークスペースの全メンバーを取得します。
ResultObject	findMember (String `itemType`, ItemKey `itemKey`, String `userCd`) ワークスペースメンバーを取得します。
ResultObject	findMember (WorkspaceKey `workspaceKey`, String `userCd`) ワークスペースメンバーを取得します。
ResultObject	grantOwnerShip (WorkspaceKey `workspaceKey`, String[] `userCds`) ワークスペースのオーナー権限を付与します。
ResultObject	leaveMember (WorkspaceKey `workspaceKey`) ワークスペースから離脱します。
ResultObject	rejectOwnerShip (WorkspaceKey `workspaceKey`, String[] `userCds`) ワークスペースのオーナー権限を剥奪します。
ResultObject	removeMember (WorkspaceKey `workspaceKey`, String[] `userCds`) ワークスペースから離脱します。

メソッドの詳細

ResultObject addMember (WorkspaceKey workspaceKey, Member[] members)

ワークスペースメンバーを追加します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下の場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

members : Member[]: メンバー情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、Member[] を設定します。

ResultObject findMemberList (WorkspaceKey workspaceKey)

ワークスペースの全メンバーを取得します。

IMBoxのGroupBoxと各メンバーの連携状態を含めて取得します。
該当するデータが存在しない場合、空の配列を返却します。

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、MemberReference[] を設定します。

ResultObject findMember (String itemType, ItemKey itemKey, String userCd)

ワークスペースメンバーを取得します。

指定したアイテム情報に該当するワークスペースのメンバーを取得します。

パラメータ

itemType : String: アイテム種別

itemKey : ItemKey: アイテムキー

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、MemberReference を設定します。

ResultObject findMember (WorkspaceKey workspaceKey, String userCd)

ワークスペースメンバーを取得します。

指定したアイテム情報に該当するワークスペースのメンバーを取得します。

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

userCd : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、MemberReference を設定します。

ResultObject grantOwnerShip (WorkspaceKey workspaceKey, String[] userCds)

ワークスペースのオーナー権限を付与します。

IMBoxのGroupBoxに対してもオーナー権限を付与します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下の場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

userCds : String[]: ユーザコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、java.lang.String# [] を設定します。

ResultObject leaveMember (WorkspaceKey workspaceKey)

ワークスペースから離脱します。

操作ユーザをワークスペースから離脱させます。
離脱時、IMBoxのGroupBox上からもメンバーから離脱します。
オーナーが不在となる場合、離脱することはできません。

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject rejectOwnerShip (WorkspaceKey workspaceKey, String[] userCds)

ワークスペースのオーナー権限を剥奪します。

IMBoxのGroupBoxに対してもオーナー権限の剥奪を行います。
オーナーが不在となる場合、離脱することはできません。

[ 操作ユーザの権限状態 ]
操作ユーザが以下の場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

userCds : String[]: ユーザコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、剥奪したユーザコードを設定します。

ResultObject removeMember (WorkspaceKey workspaceKey, String[] userCds)

ワークスペースから離脱します。

指定したユーザをワークスペースから離脱させます。
離脱時、IMBoxのGroupBox上からもメンバーから離脱します。
オーナーが不在となる場合、離脱させることはできません。

[ 操作ユーザの権限状態 ]
操作ユーザが以下の場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している

パラメータ

workspaceKey : WorkspaceKey: ワークスペースキー

userCds : String[]: ユーザコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、離脱させたユーザコードを設定します。