class MattersHoldsAccounts extends Resource (View source)

The "accounts" collection of methods.

Typical usage is:

 $vaultService = new Google\Service\Vault(...);
 $accounts = $vaultService->matters_holds_accounts;

Methods

create(string $matterId, string $holdId, HeldAccount $postBody, array $optParams = [])

Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned. (accounts.create)

delete(string $matterId, string $holdId, string $accountId, array $optParams = [])

Removes an account from a hold. (accounts.delete)

listMattersHoldsAccounts(string $matterId, string $holdId, array $optParams = [])

Lists the accounts covered by a hold. This can list only individually- specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK. to list the members of the organizational unit on hold.

Details

HeldAccount create(string $matterId, string $holdId, HeldAccount $postBody, array $optParams = [])

Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned. (accounts.create)

Parameters

string $matterId

The matter ID.

string $holdId

The hold ID.

HeldAccount $postBody
array $optParams

Optional parameters.

Return Value

HeldAccount

Exceptions

Exception

VaultEmpty delete(string $matterId, string $holdId, string $accountId, array $optParams = [])

Removes an account from a hold. (accounts.delete)

Parameters

string $matterId

The matter ID.

string $holdId

The hold ID.

string $accountId

The ID of the account to remove from the hold.

array $optParams

Optional parameters.

Return Value

VaultEmpty

Exceptions

Exception

ListHeldAccountsResponse listMattersHoldsAccounts(string $matterId, string $holdId, array $optParams = [])

Lists the accounts covered by a hold. This can list only individually- specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK. to list the members of the organizational unit on hold.

(accounts.listMattersHoldsAccounts)

Parameters

string $matterId

The matter ID.

string $holdId

The hold ID.

array $optParams

Optional parameters.

Return Value

ListHeldAccountsResponse

Exceptions

Exception