メインコンテンツまでスキップ

ワークスペースの操作

Hexabaseのワークスペースは、複数のプロジェクトを保有します。認証をした後は、処理対象となるワークスペースを設定します。

全ワークスペースの取得​

認証しているユーザーが保有・所属するワークスペースを取得します。

const workspaces = await client.workspaces();

特定のワークスペースの取得​

ワークスペースIDを指定して、特定のワークスペースを取得します。

const workspace = await client.workspace('WORKSPACE_ID');

全ワークスペースと、現在のワークスペースの取得​

保有・所属する全ワークスペースと、現在処理対象となっているワークスペースを取得します。

const {
    workspaces,  // 全ワークスペース
    workspace,   // 現在処理対象となっているワークスペース
} = await client.workspacesWithCurrent();

ワークスペースの設定​

これから処理を行うワークスペースを設定します。

// ワークスペースIDを指定する場合
await client.setWorkspace('WORKSPACE_ID');

// ワークスペースオブジェクトを指定する場合
const workspace = await client.workspace('ANOTHER_WORKSPACE_ID');
await client.setWorkspace(workspace);

現在処理対象となっているワークスペースの取得​

現在処理対象となっているワークスペースを取得します。

client.currentWorkspace;

ワークスペースに他のユーザーを招待する​

ワークスペースに他のユーザーを招待します。招待されたユーザーはメールを確認後、ワークスペースに参加できます。

const workspace = await client.workspace('WORKSPACE_ID');
// ワークスペースへの招待
workspace.invite(
    ['[email protected]'], // 招待するユーザーのメールアドレス
    'hexabase' // ドメイン
);

ワークスペースを新規作成する​

ワークスペースを新規作成する際には、 save メソッドを使います。

const workspace = await client.workspace();
workspace.set('name', 'My Workspace');
await workspace.save();

ワークスペースの更新には2023年11月現在、対応していません。

ワークスペースの内容を最新状態にする​

fetch メソッドを使って、ワークスペースの内容を最新状態に更新します。

await workspace.fetch();

ワークスペースをアーカイブする​

ワークスペースをアーカイブします。アーカイブされたワークスペースは、管理画面から復元することができます。

await workspace.archive();

パスワードポリシーを取得する​

ワークスペースのパスワードポリシーを取得します。

const policy = await workspace.passwordPolicy();

ワークスペースで利用できる機能を取得する​

ワークスペースで利用できる機能を取得します。

const features = await workspace.functionality();

ワークスペースの利用状況を取得する​

ワークスペースの利用状況を取得します。

const usage = await workspace.usage();

ワークスペース配下のグループを取得する​

ワークスペース配下にあるグループを取得します。

const group = await workspace.group('GROUP_ID');

ワークスペース配下にあるプロジェクト一覧を取得する​

ワークスペース配下にあるプロジェクト一覧を取得します。

const projects = await workspace.projects();

ワークスペース配下にある特定のプロジェクトを取得する​

const project = await workspace.project('PROJECT_ID');

ワークスペース配下にあるすべてのプロジェクトとデータストアを取得する​

ワークスペース配下にあるすべてのプロジェクトとデータストアを取得します。

const projects = await workspace.projectsAndDatastores();

ワークスペース配下にあるプロジェクトテンプレートを取得する​

ワークスペース配下にあるプロジェクトテンプレートを取得します。

const templates = await workspace.projectTemplates();