1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Vault
  7. \
  8. Resource
  9. \
  10. Matters

Matters

class Matters extends Resource (View source)

The "matters" collection of methods.

Typical usage is:

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

Methods

MatterPermission
addPermissions(string $matterId, AddMatterPermissionsRequest $postBody, array $optParams = [])

Adds an account as a matter collaborator. (matters.addPermissions)

CloseMatterResponse
close(string $matterId, CloseMatterRequest $postBody, array $optParams = [])

Closes the specified matter. Returns the matter with updated state.

Operation
count(string $matterId, CountArtifactsRequest $postBody, array $optParams = [])

Counts the accounts processed by the specified query. (matters.count)

Matter
create(Matter $postBody, array $optParams = [])

Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view. (matters.create)

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

Deletes the specified matter. Returns the matter with updated state.

Matter
get(string $matterId, array $optParams = [])

Gets the specified matter. (matters.get)

ListMattersResponse
listMatters(array $optParams = [])

Lists matters the requestor has access to. (matters.listMatters)

VaultEmpty
removePermissions(string $matterId, RemoveMatterPermissionsRequest $postBody, array $optParams = [])

Removes an account as a matter collaborator. (matters.removePermissions)

ReopenMatterResponse
reopen(string $matterId, ReopenMatterRequest $postBody, array $optParams = [])

Reopens the specified matter. Returns the matter with updated state.

Matter
undelete(string $matterId, UndeleteMatterRequest $postBody, array $optParams = [])

Undeletes the specified matter. Returns the matter with updated state.

Matter
update(string $matterId, Matter $postBody, array $optParams = [])

Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored.

Details

at line 53
MatterPermission addPermissions(string $matterId, AddMatterPermissionsRequest $postBody, array $optParams = [])

Adds an account as a matter collaborator. (matters.addPermissions)

Parameters

string $matterId

The matter ID.
AddMatterPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

MatterPermission

Exceptions

Exception

at line 69
CloseMatterResponse close(string $matterId, CloseMatterRequest $postBody, array $optParams = [])

Closes the specified matter. Returns the matter with updated state.

(matters.close)

Parameters

string $matterId

The matter ID.
CloseMatterRequest $postBody
array $optParams

Optional parameters.

Return Value

CloseMatterResponse

Exceptions

Exception

at line 84
Operation count(string $matterId, CountArtifactsRequest $postBody, array $optParams = [])

Counts the accounts processed by the specified query. (matters.count)

Parameters

string $matterId

The matter ID.
CountArtifactsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 100
Matter create(Matter $postBody, array $optParams = [])

Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view. (matters.create)

Parameters

Matter $postBody
array $optParams

Optional parameters.

Return Value

Matter

Exceptions

Exception

at line 115
Matter delete(string $matterId, array $optParams = [])

Deletes the specified matter. Returns the matter with updated state.

(matters.delete)

Parameters

string $matterId

The matter ID
array $optParams

Optional parameters.

Return Value

Matter

Exceptions

Exception

at line 132
Matter get(string $matterId, array $optParams = [])

Gets the specified matter. (matters.get)

Parameters

string $matterId

The matter ID.
array $optParams

Optional parameters.

Return Value

Matter

Exceptions

Exception

at line 153
ListMattersResponse listMatters(array $optParams = [])

Lists matters the requestor has access to. (matters.listMatters)

Parameters

array $optParams

Optional parameters.

Return Value

ListMattersResponse

Exceptions

Exception

at line 168
VaultEmpty removePermissions(string $matterId, RemoveMatterPermissionsRequest $postBody, array $optParams = [])

Removes an account as a matter collaborator. (matters.removePermissions)

Parameters

string $matterId

The matter ID.
RemoveMatterPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

VaultEmpty

Exceptions

Exception

at line 184
ReopenMatterResponse reopen(string $matterId, ReopenMatterRequest $postBody, array $optParams = [])

Reopens the specified matter. Returns the matter with updated state.

(matters.reopen)

Parameters

string $matterId

The matter ID.
ReopenMatterRequest $postBody
array $optParams

Optional parameters.

Return Value

ReopenMatterResponse

Exceptions

Exception

at line 200
Matter undelete(string $matterId, UndeleteMatterRequest $postBody, array $optParams = [])

Undeletes the specified matter. Returns the matter with updated state.

(matters.undelete)

Parameters

string $matterId

The matter ID.
UndeleteMatterRequest $postBody
array $optParams

Optional parameters.

Return Value

Matter

Exceptions

Exception

at line 217
Matter update(string $matterId, Matter $postBody, array $optParams = [])

Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored.

Returns the default view of the matter. (matters.update)

Parameters

string $matterId

The matter ID.
Matter $postBody
array $optParams

Optional parameters.

Return Value

Matter

Exceptions

Exception