iac_workspace.AdminWorkspaceServiceオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.20 |
since | 8.0.0 |
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
- Collaboration管理者ロールを持つユーザ
- Workspace機能管理者ロールを持つユーザ
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なワークスペースは、認可で許可された会社のワークスペースに限ります。
[ Workspace機能管理者の場合 ]
Workspace機能管理者として操作可能なワークスペースは、操作ユーザのカレント組織の会社に一致するワークスペースに限ります。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | addItem (WorkspaceAddItemKey itemKey , Object itemSetting ) ワークスペースにアイテムを追加します。 |
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 | findItemsExcludable (WorkspaceKey workspaceKey , String[] excludeItemTypes , ItemUniqueKey[] excludeItems ) 指定したアイテムを除外したアイテムを取得します。 |
ResultObject | findItems (WorkspaceKey workspaceKey , String itemType ) ワークスペース内の任意のアイテムをすべて取得します。 |
ResultObject | findWorkspaceSummary (WorkspaceKey workspaceKey ) ワークスペースの概要を取得します。 |
ResultObject | findWorkspace (WorkspaceKey workspaceKey ) ワークスペースを取得します。 |
ResultObject | getMaxQueueTime (WorkspaceKey workspaceKey ) ワークスペースにブロードキャストするデータの最新時間を取得します。 |
ResultObject | pushBroadcastData (BroadcastDataRegister parameter ) 非推奨ワークスペースにブロードキャストするデータを登録します。
AdminWorkspaceService#sendBroadcast(BroadcastSend) を使用して下さい。
|
void | sendBroadcast (BroadcastSend parameter ) 各クライアントのワークスペースへ通知を行います。 |
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 ) ワークスペースの概要を更新します。 |
メソッドの詳細
ResultObject addItem (WorkspaceAddItemKey itemKey , Object itemSetting )
ワークスペースにアイテムを追加します。
[ アイテムの固有設定について ]
パラメータ
返却値
|
ResultObject deleteItem (WorkspaceItemKey itemKey )
ワークスペースのアイテムを削除します。
パラメータ
返却値
|
ResultObject deleteWorkspace (WorkspaceKey workspaceKey )
ワークスペースを削除します。
IMBoxと連携している場合、GroupBoxの削除は行いません。
[ 操作ユーザの権限状態 ]
パラメータ
返却値
|
ResultObject findItemWithSort (ItemKey itemKey , String itemType )
表示順を含めたアイテムを取得します。
パラメータ
返却値
|
ResultObject findItem (String itemType , ItemKey itemKey )
アイテムを取得します。
該当するアイテムが存在しない場合、
パラメータ
返却値
|
ResultObject findItemsByItemKeys (WorkspaceKey workspaceKey , ItemUniqueKey[] keys )
アイテムを取得します。
該当するデータが無い場合、空の配列を返却します。
パラメータ
返却値
|
ResultObject findItemsExcludable (WorkspaceKey workspaceKey , String[] excludeItemTypes , ItemUniqueKey[] excludeItems )
指定したアイテムを除外したアイテムを取得します。
アイテム種別を設定した場合、指定したアイテム種別を除外したアイテムを取得します。
パラメータ
返却値
|
ResultObject findItems (WorkspaceKey workspaceKey , String itemType )
ワークスペース内の任意のアイテムをすべて取得します。
アイテム種別には、各アイテムで定義している種別を設定します。
パラメータ
返却値
|
ResultObject findWorkspaceSummary (WorkspaceKey workspaceKey )
ワークスペースの概要を取得します。
該当するデータが存在しない場合、
パラメータ
返却値
|
ResultObject findWorkspace (WorkspaceKey workspaceKey )
ワークスペースを取得します。
該当するデータが存在しない場合、
パラメータ
返却値
|
ResultObject getMaxQueueTime (WorkspaceKey workspaceKey )
ワークスペースにブロードキャストするデータの最新時間を取得します。
パラメータ
返却値
|
ResultObject pushBroadcastData (BroadcastDataRegister parameter )
非推奨
AdminWorkspaceService#sendBroadcast(BroadcastSend) を使用して下さい。
ワークスペースにブロードキャストするデータを登録します。
現在はデータ登録処理は行いません。必ず、空のBroadcastDataオブジェクトを返します。
パラメータ
返却値
|
void sendBroadcast (BroadcastSend parameter )
各クライアントのワークスペースへ通知を行います。
機能利用ON/OFF切り替え設定(プッシュ配信)がOFFの場合、通知処理は実行されません。
パラメータ
返却値
|
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 )
ワークスペースの概要を更新します。
IMBox連携時、ワークスペースのタイトルを更新すると、GroupBoxのタイトルも合わせて更新します。
パラメータ
返却値
|