Documentation

Google_Service_Vault_Resource_MattersHoldsAccounts extends Google_Service_Resource
in package

The "accounts" collection of methods.

Typical usage is: $vaultService = new Google_Service_Vault(...); $accounts = $vaultService->accounts;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Vault_HeldAccount
Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error. (accounts.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Vault_VaultEmpty
Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts. (accounts.delete)
listMattersHoldsAccounts()  : Google_Service_Vault_ListHeldAccountsResponse
Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members. (accounts.listMattersHoldsAccounts)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error. (accounts.create)

public create(string $matterId, string $holdId, Google_Service_Vault_HeldAccount $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_HeldAccount
Parameters
$matterId : string

The matter ID.

$holdId : string

The hold ID.

$postBody : Google_Service_Vault_HeldAccount
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Vault_HeldAccount —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts. (accounts.delete)

public delete(string $matterId, string $holdId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_VaultEmpty
Parameters
$matterId : string

The matter ID.

$holdId : string

The hold ID.

$accountId : string

The ID of the account to remove from the hold.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Vault_VaultEmpty —

listMattersHoldsAccounts()

Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members. (accounts.listMattersHoldsAccounts)

public listMattersHoldsAccounts(string $matterId, string $holdId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_ListHeldAccountsResponse
Parameters
$matterId : string

The matter ID.

$holdId : string

The hold ID.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Vault_ListHeldAccountsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results