Documentation

Google_Service_Vault_Resource_Matters extends Google_Service_Resource
in package

Application

The "matters" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addPermissions() : Google_Service_Vault_MatterPermission: Adds an account as a matter collaborator. (matters.addPermissions)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
close() : Google_Service_Vault_CloseMatterResponse: Closes the specified matter. Returns matter with updated state.
create() : Google_Service_Vault_Matter: Creates a new 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Vault_Matter: Deletes the specified matter. Returns matter with updated state.
get() : Google_Service_Vault_Matter: Gets the specified matter. (matters.get)
listMatters() : Google_Service_Vault_ListMattersResponse: Lists matters the user has access to. (matters.listMatters)
removePermissions() : Google_Service_Vault_VaultEmpty: Removes an account as a matter collaborator. (matters.removePermissions)
reopen() : Google_Service_Vault_ReopenMatterResponse: Reopens the specified matter. Returns matter with updated state.
undelete() : Google_Service_Vault_Matter: Undeletes the specified matter. Returns matter with updated state.
update() : Google_Service_Vault_Matter: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

addPermissions()

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


    public
                addPermissions(string $matterId, Google_Service_Vault_AddMatterPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_MatterPermission

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_AddMatterPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_MatterPermission —

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

Return values

Google_Http_Request|expectedClass —

close()

Closes the specified matter. Returns matter with updated state.


    public
                close(string $matterId, Google_Service_Vault_CloseMatterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_CloseMatterResponse

(matters.close)

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_CloseMatterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_CloseMatterResponse —

create()

Creates a new 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)


    public
                create(Google_Service_Vault_Matter $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Matter

Parameters

$postBody : Google_Service_Vault_Matter
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Matter —

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>

Return values

string —

$requestUrl

delete()

Deletes the specified matter. Returns matter with updated state.


    public
                delete(string $matterId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Matter

(matters.delete)

Parameters

$matterId : string: The matter ID
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Matter —

get()

Gets the specified matter. (matters.get)


    public
                get(string $matterId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Matter

Parameters

$matterId : string: The matter ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Matter —

listMatters()

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


    public
                listMatters([array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_ListMattersResponse

Parameters

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

Return values

Google_Service_Vault_ListMattersResponse —

removePermissions()

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


    public
                removePermissions(string $matterId, Google_Service_Vault_RemoveMatterPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_VaultEmpty

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_RemoveMatterPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_VaultEmpty —

reopen()

Reopens the specified matter. Returns matter with updated state.


    public
                reopen(string $matterId, Google_Service_Vault_ReopenMatterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_ReopenMatterResponse

(matters.reopen)

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_ReopenMatterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_ReopenMatterResponse —

undelete()

Undeletes the specified matter. Returns matter with updated state.


    public
                undelete(string $matterId, Google_Service_Vault_UndeleteMatterRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Matter

(matters.undelete)

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_UndeleteMatterRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Matter —

update()

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.


    public
                update(string $matterId, Google_Service_Vault_Matter $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Matter

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

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_Matter
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Matter —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —