Accel Collaboration

iac_workspace.WorkspaceServiceオブジェクト

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

コンポーネント概要

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

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

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

メソッドの概要

返却値の型	メソッド名
ResultObject	addGroupBox (WorkspaceKey `workspaceKey`) IMBoxのGroupBoxを追加します。
ResultObject	addItem (WorkspaceAddItemKey `itemKey`, Object `itemSetting`) ワークスペースにアイテムを追加します。
ResultObject	addWorkspace (Workspace `workspace`) 非推奨ワークスペースを追加します。 createWorkspace(Workspace)を使用してください。
WorkspaceCreateResult	createWorkspaceLimitedNoGroupBox (Workspace `workspace`) ワークスペースを作成します。
WorkspaceCreateResult	createWorkspaceLimited (Workspace `workspace`) ワークスペースを作成します。
WorkspaceCreateResult	createWorkspaceLimited (Workspace `workspace`, Boolean `isPublicGroupBox`) ワークスペースを作成します。
WorkspaceCreateResult	createWorkspaceNoGroupBox (Workspace `workspace`) ワークスペースを作成します。
WorkspaceCreateResult	createWorkspace (Workspace `workspace`) ワークスペースを作成します。
WorkspaceCreateResult	createWorkspace (Workspace `workspace`, Boolean `isPublicGroupBox`) ワークスペースを作成します。
ResultObject	deleteItem (WorkspaceItemKey `itemKey`) ワークスペースのアイテムを削除します。
ResultObject	deleteWorkspace (WorkspaceKey `workspaceKey`) ワークスペースを削除します。
ResultObject	findItemWithSort (ItemKey `itemKey`, String `itemType`) 表示順を含めたアイテムを取得します。
ResultObject	findItem (String `itemType`, ItemKey `itemKey`) アイテムを取得します。
ResultObject	findItemsByItemKeys (WorkspaceKey `workspaceKey`, ItemUniqueKey[] `keys`) アイテムを取得します。
ResultObject	findItemsByUser (String[] `userCds`, String `itemType`) アイテムを取得します。
ResultObject	findItemsExcludable (WorkspaceKey `workspaceKey`, String[] `excludeItemTypes`, ItemUniqueKey[] `excludeItems`) 指定したアイテムを除外したアイテムを取得します。
ResultObject	findItems (WorkspaceKey `workspaceKey`, String `itemType`) ワークスペース内の任意のアイテムをすべて取得します。
ResultObject	findWorkspaceSummary (WorkspaceKey `workspaceKey`) ワークスペースの概要を取得します。
ResultObject	findWorkspace (WorkspaceKey `workspaceKey`) ワークスペースを取得します。
ResultObject	getItemConfigrationMap () アイテム定義を取得します。
ResultObject	getMaxQueueTime (WorkspaceKey `workspaceKey`) ワークスペースにブロードキャストするデータの最新時間を取得します。
ResultObject	pushBroadcastData (BroadcastDataRegister `parameter`) 非推奨ワークスペースにブロードキャストするデータを登録します。 WorkspaceService#sendBroadcast(BroadcastSend) を使用して下さい。
void	sendBroadcast (BroadcastSend `parameter`) 各クライアントのワークスペースへ通知を行います。
void	unWatch (WorkspaceKey `workspaceKey`) ワークスペースをアンウォッチします。
ResultObject	updateActiveStatus (WorkspaceKey[] `workspaceKeys`, Boolean `isActive`) ワークスペースの活動状態を更新します。
ResultObject	updateAllowAddOwnerStatus (WorkspaceKey `workspaceKey`, Boolean `isArrowAddItem`) ワークスペースのアイテム追加の許可権限を更新します。
ResultObject	updateItemSortKey (ItemSortKeyUpdate `parameter`) アイテムの表示順を更新します。
ResultObject	updateItemTitle (WorkspaceItemKey `itemKey`, String `title`) アイテムのタイトルを更新します。
ResultObject	updateWorkspaceSummary (WorkspaceSummary `summary`) ワークスペースの概要を更新します。
void	watch (WorkspaceKey `workspaceKey`) ワークスペースをウォッチします。

メソッドの詳細

ResultObject addGroupBox (WorkspaceKey workspaceKey)

IMBoxのGroupBoxを追加します。

ここでは、ワークスペースのメンバーのみのプライベートなGroupBoxを作成します。
指定したワークスペースのGroupBoxが既に存在する場合、新たに作成することはできません。
IMBox機能がインストールしていない場合、NULLが返却されます。

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

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

パラメータ

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

返却値

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

ResultObject addItem (WorkspaceAddItemKey itemKey, Object itemSetting)

ワークスペースにアイテムを追加します。

操作ユーザがアイテム追加を許可されている場合のみ、アイテムを追加できます。

[ アイテムの固有設定について ]
追加しようとするアイテム固有の設定がある場合に利用します。
固有設定のキー値については、各アイテムを参照してください。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
ワークスペースのアイテム追加を許可されている

パラメータ

itemKey : WorkspaceAddItemKey: アイテムキー

itemSetting : Object: 追加するアイテムの固有設定情報 key には、アイテム固有のキー(String)を設定します。 value には、アイテム固有の設定値(String)を設定します。

返却値

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

ResultObject addWorkspace (Workspace workspace) 非推奨

createWorkspace(Workspace)を使用してください。

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

IMBoxのGroupBoxも合わせて作成します。
作成されるGroupBoxは、ワークスペースメンバーのみのプライベートなグループとなります。
ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。

パラメータ

workspace : Workspace: ワークスペース情報

返却値

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

WorkspaceCreateResult createWorkspaceLimitedNoGroupBox (Workspace workspace)

ワークスペースを作成します。

ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。
ワークスペース作成権限設定がtrueの場合は、以下のいずれかに該当するユーザのみがワークスペースを作成出来ます。

collaboration管理者ロールを保持している
Workspace機能管理者ロールを保持している

パラメータ

workspace : Workspace: ワークスペース情報

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

WorkspaceCreateResult createWorkspaceLimited (Workspace workspace)

ワークスペースを作成します。

IMBoxのGroupBoxも合わせて作成します。
作成されるGroupBoxは、ワークスペースメンバーのみのプライベートなグループとなります。
GroupBox作成権限がない等、GroupBoxの作成に失敗した場合でもワークスペースを作成します。
ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。
ワークスペース作成権限設定がtrueの場合は、以下のいずれかに該当するユーザのみがワークスペースを作成出来ます。

collaboration管理者ロールを保持している
Workspace機能管理者ロールを保持している

パラメータ

workspace : Workspace: ワークスペース情報

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

WorkspaceCreateResult createWorkspaceLimited (Workspace workspace, Boolean isPublicGroupBox)

ワークスペースを作成します。

IMBoxのGroupBoxも合わせて作成します。
GroupBox作成権限がない等、GroupBoxの作成に失敗した場合でもワークスペースを作成します。
ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。
ワークスペース作成権限設定がtrueの場合は、以下のいずれかに該当するユーザのみがワークスペースを作成出来ます。

collaboration管理者ロールを保持している
Workspace機能管理者ロールを保持している

パラメータ

workspace : Workspace: ワークスペース情報

isPublicGroupBox : Boolean: true : 公開GroupBox/ false : 非公開GroupBox

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

WorkspaceCreateResult createWorkspaceNoGroupBox (Workspace workspace)

ワークスペースを作成します。

ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。

パラメータ

workspace : Workspace: ワークスペース情報

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

WorkspaceCreateResult createWorkspace (Workspace workspace)

ワークスペースを作成します。

パラメータ

workspace : Workspace: ワークスペース情報

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

WorkspaceCreateResult createWorkspace (Workspace workspace, Boolean isPublicGroupBox)

ワークスペースを作成します。

IMBoxのGroupBoxも合わせて作成します。
GroupBox作成権限がない等、GroupBoxの作成に失敗した場合でもワークスペースを作成します。
ワークススペースの追加には、操作ユーザのカレント組織に所属組織情報が存在する必要があります。

パラメータ

workspace : Workspace: ワークスペース情報

isPublicGroupBox : Boolean: true : 公開GroupBox/ false : 非公開GroupBox

返却値

WorkspaceCreateResult: WorkspaceCreateResult ワークスペース作成結果情報
data プロパティには、WorkspaceCreateResult を設定します。

ResultObject deleteItem (WorkspaceItemKey itemKey)

ワークスペースのアイテムを削除します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
アイテムの登録者

パラメータ

itemKey : WorkspaceItemKey: アイテムキー

返却値

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

ResultObject deleteWorkspace (WorkspaceKey workspaceKey)

ワークスペースを削除します。

操作ユーザがワークスペースの削除は、オーナー権限をユーザのみ可能です。
IMBoxと連携している場合、GroupBoxの削除は行いません。

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

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

パラメータ

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

返却値

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

ResultObject findItemWithSort (ItemKey itemKey, String itemType)

表示順を含めたアイテムを取得します。

パラメータ

itemKey : ItemKey: アイテムキー

itemType : String: アイテム種別

返却値

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

ResultObject findItem (String itemType, ItemKey itemKey)

アイテムを取得します。

該当するアイテムが存在しない場合、NULLを返却します。

パラメータ

itemType : String: アイテム種別

itemKey : ItemKey: アイテムキー

返却値

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

ResultObject findItemsByItemKeys (WorkspaceKey workspaceKey, ItemUniqueKey[] keys)

アイテムを取得します。

該当するデータが無い場合、空の配列を返却します。

パラメータ

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

keys : ItemUniqueKey[]: アイテムのユニークキー

返却値

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

ResultObject findItemsByUser (String[] userCds, String itemType)

アイテムを取得します。

指定したユーザと操作ユーザがメンバーとなっているワークスペースで、指定したアイテム種別のアイテムを取得します。
アイテム種別を指定しない場合、すべてのアイテムを取得します。
該当するデータがない場合、NULLを返却します。

パラメータ

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

itemType : String: アイテム種別

返却値

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

ResultObject findItemsExcludable (WorkspaceKey workspaceKey, String[] excludeItemTypes, ItemUniqueKey[] excludeItems)

指定したアイテムを除外したアイテムを取得します。

アイテム種別を設定した場合、指定したアイテム種別を除外したアイテムを取得します。
アイテムユニークキーを指定した場合、対象のアイテムを除外したアイテムを取得します。
上記を設定していない場合は、指定したワークスペースに登録されているすべてのアイテムを取得します。

パラメータ

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

excludeItemTypes : String[]: 除外対象のアイテム種別

excludeItems : ItemUniqueKey[]: 除外対象のアイテムユニークキー

返却値

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

ResultObject findItems (WorkspaceKey workspaceKey, String itemType)

ワークスペース内の任意のアイテムをすべて取得します。

アイテム種別には、各アイテムで定義している種別を設定します。
アイテム種別を設定していない場合、すべてのワークスペースのアイテムを取得します。
該当するデータが無い場合、空の配列を返却します。

パラメータ

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

itemType : String: アイテム種別

返却値

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

ResultObject findWorkspaceSummary (WorkspaceKey workspaceKey)

ワークスペースの概要を取得します。

該当するデータが存在しない場合、NULLを返却します。

パラメータ

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

返却値

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

ResultObject findWorkspace (WorkspaceKey workspaceKey)

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

該当するデータが存在しない場合、NULLを返却します。

パラメータ

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

返却値

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

ResultObject getItemConfigrationMap ()

アイテム定義を取得します。

ワークスペースのシステム設定ファイルで定義したアイテムの定義情報を取得します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、アイテム種別をキーにした、ItemConfigration を設定します。

ResultObject getMaxQueueTime (WorkspaceKey workspaceKey)

ワークスペースにブロードキャストするデータの最新時間を取得します。

パラメータ

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

返却値

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

ResultObject pushBroadcastData (BroadcastDataRegister parameter) 非推奨

WorkspaceService#sendBroadcast(BroadcastSend) を使用して下さい。

ワークスペースにブロードキャストするデータを登録します。
現在はデータ登録処理は行いません。必ず、空のBroadcastDataオブジェクトを返します。

パラメータ

parameter : BroadcastDataRegister: 通知情報

返却値

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

void sendBroadcast (BroadcastSend parameter)

各クライアントのワークスペースへ通知を行います。
機能利用ON/OFF切り替え設定(プッシュ配信)がOFFの場合、通知処理は実行されません。

パラメータ

parameter : BroadcastSend: 通知依頼情報

返却値

void

void unWatch (WorkspaceKey workspaceKey)

ワークスペースをアンウォッチします。

IMBox連携時に、操作ユーザがウォッチしているワークスペースに対してアンウォッチします。

パラメータ

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

返却値

void

ResultObject updateActiveStatus (WorkspaceKey[] workspaceKeys, Boolean isActive)

ワークスペースの活動状態を更新します。

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

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

パラメータ

workspaceKeys : WorkspaceKey[]: ワークスペースキー

isActive : Boolean: true : アクティブに更新 / false : 非アクティブに更新

返却値

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

ResultObject updateAllowAddOwnerStatus (WorkspaceKey workspaceKey, Boolean isArrowAddItem)

ワークスペースのアイテム追加の許可権限を更新します。

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

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

パラメータ

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

isArrowAddItem : Boolean: true : メンバーによるアイテム追加を許可 / false : オーナーのみアイテム追加を許可

返却値

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

ResultObject updateItemSortKey (ItemSortKeyUpdate parameter)

アイテムの表示順を更新します。

パラメータ

parameter : ItemSortKeyUpdate: 表示順変更情報

返却値

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

ResultObject updateItemTitle (WorkspaceItemKey itemKey, String title)

アイテムのタイトルを更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
アイテムの登録者

パラメータ

itemKey : WorkspaceItemKey: アイテムキー

title : String: タイトル

返却値

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

ResultObject updateWorkspaceSummary (WorkspaceSummary summary)

ワークスペースの概要を更新します。

IMBox連携時、ワークスペースのタイトルを更新すると、GroupBoxのタイトルも合わせて更新します。

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

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

パラメータ

summary : WorkspaceSummary: 概要情報

返却値

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

void watch (WorkspaceKey workspaceKey)

ワークスペースをウォッチします。

IMBox連携時に、操作ユーザがワークスペースに対してウォッチします。

パラメータ

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

返却値

void