メソッドの概要

返却値の型 メソッド名
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)
ワークスペースにアイテムを追加します。

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

パラメータ
itemKey : WorkspaceAddItemKey
アイテムキー
itemSetting : Object
追加するアイテムの固有設定情報 key には、アイテム固有のキー(String)を設定します。 value には、アイテム固有の設定値(String)を設定します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、WorkspaceItem を設定します。
ResultObject deleteItem (WorkspaceItemKey itemKey)
ワークスペースのアイテムを削除します。
パラメータ
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 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 getMaxQueueTime (WorkspaceKey workspaceKey)
ワークスペースにブロードキャストするデータの最新時間を取得します。
パラメータ
workspaceKey : WorkspaceKey
ワークスペースキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、最新時間 を設定します。
ResultObject pushBroadcastData (BroadcastDataRegister parameter) 非推奨
AdminWorkspaceService#sendBroadcast(BroadcastSend) を使用して下さい。
ワークスペースにブロードキャストするデータを登録します。
現在はデータ登録処理は行いません。必ず、空のBroadcastDataオブジェクトを返します。
パラメータ
parameter : BroadcastDataRegister
通知情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、BroadcastData を設定します。
void sendBroadcast (BroadcastSend parameter)
各クライアントのワークスペースへ通知を行います。
機能利用ON/OFF切り替え設定(プッシュ配信)がOFFの場合、通知処理は実行されません。
パラメータ
parameter : BroadcastSend
通知依頼情報
返却値
void
ResultObject updateActiveStatus (WorkspaceKey[] workspaceKeys, Boolean isActive)
ワークスペースの活動状態を更新します。
パラメータ
workspaceKeys : WorkspaceKey[]
ワークスペースキー
isActive : Boolean
true : アクティブに更新 / false : 非アクティブに更新
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、WorkspaceKey[] を設定します。
ResultObject updateAllowAddOwnerStatus (WorkspaceKey workspaceKey, Boolean isArrowAddItem)
ワークスペースのアイテム追加の許可権限を更新します。
パラメータ
workspaceKey : WorkspaceKey
ワークスペースキー
isArrowAddItem : Boolean
true : メンバーによるアイテム追加を許可 / false : オーナーのみアイテム追加を許可
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateItemSortKey (ItemSortKeyUpdate parameter)
アイテムの表示順を更新します。
パラメータ
parameter : ItemSortKeyUpdate
表示順変更情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateItemTitle (WorkspaceItemKey itemKey, String title)
アイテムのタイトルを更新します。
パラメータ
itemKey : WorkspaceItemKey
アイテムキー
title : String
タイトル
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateWorkspaceSummary (WorkspaceSummary summary)
ワークスペースの概要を更新します。

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

パラメータ
summary : WorkspaceSummary
概要情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。