SeaTable\Client\SharingApi¶

createGroupShare($workspace_id, $base_name, $group_id, $permission): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$group_id = 'group_id_example'; // string | The ID of the group.
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write

try {
    $result = $apiInstance->createGroupShare($workspace_id, $base_name, $group_id, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->createGroupShare: ', $e->getMessage(), PHP_EOL;
}

createGroupViewShare($workspace_id, $base_name, $table_id, $view_id, $permission, $to_group_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$table_id = 'table_id_example'; // string
$view_id = 'view_id_example'; // string
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write
$to_group_id = 'to_group_id_example'; // string | The ID of the group.

try {
    $result = $apiInstance->createGroupViewShare($workspace_id, $base_name, $table_id, $view_id, $permission, $to_group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->createGroupViewShare: ', $e->getMessage(), PHP_EOL;
}

createUserShare($workspace_id, $base_name, $permission, $email): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write
$email = 'email_example'; // string | The user ID ending with @auth.local

try {
    $result = $apiInstance->createUserShare($workspace_id, $base_name, $permission, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->createUserShare: ', $e->getMessage(), PHP_EOL;
}

createUserViewShare($workspace_id, $base_name, $permission, $to_user, $table_id, $view_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write
$to_user = 'to_user_example'; // string | The user ID ending with @auth.local
$table_id = 'table_id_example'; // string
$view_id = 'view_id_example'; // string

try {
    $result = $apiInstance->createUserViewShare($workspace_id, $base_name, $permission, $to_user, $table_id, $view_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->createUserViewShare: ', $e->getMessage(), PHP_EOL;
}

deleteGroupAllViewShare($table_id, $view_id, $workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$table_id = 0000; // string | The id of the table. The id of a table is unique inside a base and is often used to identify a table. **Important: the table_id is not the table_name**.
$view_id = Jz4d; // string | id of view, string
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->deleteGroupAllViewShare($table_id, $view_id, $workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteGroupAllViewShare: ', $e->getMessage(), PHP_EOL;
}

deleteGroupShare($workspace_id, $base_name, $group_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$group_id = 1; // int

try {
    $result = $apiInstance->deleteGroupShare($workspace_id, $base_name, $group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteGroupShare: ', $e->getMessage(), PHP_EOL;
}

deleteGroupViewShare($workspace_id, $base_name, $group_view_share_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$group_view_share_id = 6; // int

try {
    $result = $apiInstance->deleteGroupViewShare($workspace_id, $base_name, $group_view_share_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteGroupViewShare: ', $e->getMessage(), PHP_EOL;
}

deleteUserAllViewShare($table_id, $view_id, $workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$table_id = 0000; // string | The id of the table. The id of a table is unique inside a base and is often used to identify a table. **Important: the table_id is not the table_name**.
$view_id = Jz4d; // string | id of view, string
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->deleteUserAllViewShare($table_id, $view_id, $workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteUserAllViewShare: ', $e->getMessage(), PHP_EOL;
}

deleteUserShare($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->deleteUserShare($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteUserShare: ', $e->getMessage(), PHP_EOL;
}

deleteUserViewShare($workspace_id, $base_name, $user_view_share_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$user_view_share_id = 15; // int

try {
    $result = $apiInstance->deleteUserViewShare($workspace_id, $base_name, $user_view_share_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->deleteUserViewShare: ', $e->getMessage(), PHP_EOL;
}

leaveSharedView($user_view_share_id): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$user_view_share_id = 15; // int

try {
    $result = $apiInstance->leaveSharedView($user_view_share_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->leaveSharedView: ', $e->getMessage(), PHP_EOL;
}

listCollaborators($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->listCollaborators($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listCollaborators: ', $e->getMessage(), PHP_EOL;
}

listGroupShares($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->listGroupShares($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listGroupShares: ', $e->getMessage(), PHP_EOL;
}

listGroupViewShares($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->listGroupViewShares($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listGroupViewShares: ', $e->getMessage(), PHP_EOL;
}

listMyGroupShares(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listMyGroupShares();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listMyGroupShares: ', $e->getMessage(), PHP_EOL;
}

listMyGroupViewShares(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listMyGroupViewShares();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listMyGroupViewShares: ', $e->getMessage(), PHP_EOL;
}

listMyShares(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listMyShares();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listMyShares: ', $e->getMessage(), PHP_EOL;
}

listMyUserViewShares(): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listMyUserViewShares();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listMyUserViewShares: ', $e->getMessage(), PHP_EOL;
}

listUserShares($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->listUserShares($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listUserShares: ', $e->getMessage(), PHP_EOL;
}

listUserViewShares($workspace_id, $base_name): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.

try {
    $result = $apiInstance->listUserViewShares($workspace_id, $base_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->listUserViewShares: ', $e->getMessage(), PHP_EOL;
}

updateGroupShare($workspace_id, $base_name, $group_id, $permission): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$group_id = 1; // int
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write

try {
    $result = $apiInstance->updateGroupShare($workspace_id, $base_name, $group_id, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->updateGroupShare: ', $e->getMessage(), PHP_EOL;
}

updateGroupViewShare($workspace_id, $base_name, $group_view_share_id, $permission): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$group_view_share_id = 6; // int
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write

try {
    $result = $apiInstance->updateGroupViewShare($workspace_id, $base_name, $group_view_share_id, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->updateGroupViewShare: ', $e->getMessage(), PHP_EOL;
}

updateUserShare($workspace_id, $base_name, $permission, $email): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write
$email = 'email_example'; // string | The user ID ending with @auth.local

try {
    $result = $apiInstance->updateUserShare($workspace_id, $base_name, $permission, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->updateUserShare: ', $e->getMessage(), PHP_EOL;
}

updateUserViewShare($workspace_id, $base_name, $user_view_share_id, $permission): object

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth (use the right token for your request)
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_TOKEN');

$apiInstance = new SeaTable\Client\User\SharingApi(
    new GuzzleHttp\Client(),
    $config
);
$workspace_id = 127; // int | id of your workspace.
$base_name = My Projects; // string | name of your base.
$user_view_share_id = 15; // int
$permission = 'permission_example'; // string | `r` for read only or `rw` for read and write

try {
    $result = $apiInstance->updateUserViewShare($workspace_id, $base_name, $user_view_share_id, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SharingApi->updateUserViewShare: ', $e->getMessage(), PHP_EOL;
}