Documentation

Google_Service_Dialogflow_Resource_ProjectsAgentEnvironmentsUsersSessionsContexts extends Google_Service_Resource
in package

Application

The "contexts" collection of methods.

Typical usage is: $dialogflowService = new Google_Service_Dialogflow(...); $contexts = $dialogflowService->contexts;

$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_Dialogflow_GoogleCloudDialogflowV2Context: Creates a context. If the specified context already exists, overrides the context. (contexts.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Dialogflow_GoogleProtobufEmpty: Deletes the specified context. (contexts.delete)
get() : Google_Service_Dialogflow_GoogleCloudDialogflowV2Context: Retrieves the specified context. (contexts.get)
listProjectsAgentEnvironmentsUsersSessionsContexts() : Google_Service_Dialogflow_GoogleCloudDialogflowV2ListContextsResponse: Returns the list of all contexts in the specified session.
patch() : Google_Service_Dialogflow_GoogleCloudDialogflowV2Context: Updates the specified context. (contexts.patch)
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 —

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 —

create()

Creates a context. If the specified context already exists, overrides the context. (contexts.create)


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

Parameters

$parent : string: Required. The session to create a context for. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
$postBody : Google_Service_Dialogflow_GoogleCloudDialogflowV2Context
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dialogflow_GoogleCloudDialogflowV2Context —

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 context. (contexts.delete)


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

Parameters

$name : string: Required. The name of the context to delete. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dialogflow_GoogleProtobufEmpty —

get()

Retrieves the specified context. (contexts.get)


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

Parameters

$name : string: Required. The name of the context. Format: projects//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dialogflow_GoogleCloudDialogflowV2Context —

listProjectsAgentEnvironmentsUsersSessionsContexts()

Returns the list of all contexts in the specified session.


    public
                listProjectsAgentEnvironmentsUsersSessionsContexts(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2ListContextsResponse

(contexts.listProjectsAgentEnvironmentsUsersSessionsContexts)

Parameters

$parent : string: Required. The session to list all contexts from. Format: projects//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dialogflow_GoogleCloudDialogflowV2ListContextsResponse —

patch()

Updates the specified context. (contexts.patch)


    public
                patch(string $name, Google_Service_Dialogflow_GoogleCloudDialogflowV2Context $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dialogflow_GoogleCloudDialogflowV2Context

Parameters

$name : string: Required. The unique identifier of the context. Format: projects//agent/sessions//contexts/, or projects//agent/environments//users//sessions//contexts/. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * __system_counters__ * *_id_dialog_context * *_dialog_params_size
$postBody : Google_Service_Dialogflow_GoogleCloudDialogflowV2Context
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dialogflow_GoogleCloudDialogflowV2Context —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —