Console
    Contact Us Start free

    Class v2.ContextsClient (3.3.0)

    Service for managing . v2

    Package

    @google-cloud/dialogflow!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of ContextsClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

    Property Value
    Type Description
    string

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    contextsStub

      contextsStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;
    Property Value
    Type Description
    Promise <{ [name: string]: Function ; }>

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

      innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: Function ; }

    pathTemplates

      pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: gax. PathTemplate ; }

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

    The scopes needed to make gRPC calls for every method defined in this service.

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    Methods

    agentPath(project)

      agentPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified agent resource name string.

    Parameter
    Name Description
    project string
    Returns
    Type Description
    string

    {string} Resource name string.

    close()

      close 
 () 
 : 
  
 Promise<void> 
 ;

    Terminate the gRPC channel and close the client.

    The client will no longer be usable and all future behavior is undefined.

    Returns
    Type Description
    Promise <void>

    {Promise} A promise that resolves when the client is closed.

    createContext(request, options)

      createContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.ICreateContextRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.ICreateContextRequest | undefined, {} | undefined]>

    createContext(request, options, callback)

      createContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.ICreateContextRequest
    options CallOptions
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.ICreateContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    createContext(request, callback)

      createContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 ICreateContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.ICreateContextRequest
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.ICreateContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteAllContexts(request, options)

      deleteAllContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest | undefined, {} | undefined]>

    deleteAllContexts(request, options, callback)

      deleteAllContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest
    options CallOptions
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteAllContexts(request, callback)

      deleteAllContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteAllContextsRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteAllContextsRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteContext(request, options)

      deleteContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteContextRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteContextRequest | undefined, {} | undefined]>

    deleteContext(request, options, callback)

      deleteContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteContextRequest
    options CallOptions
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    deleteContext(request, callback)

      deleteContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IDeleteContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IDeleteContextRequest
    callback Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dialogflow.v2.IDeleteContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    entityTypePath(project, entityType)

      entityTypePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 entityType 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified entityType resource name string.

    Parameters
    Name Description
    project string
    entityType string
    Returns
    Type Description
    string

    {string} Resource name string.

    environmentPath(project, environment)

      environmentPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 environment 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified environment resource name string.

    Parameters
    Name Description
    project string
    environment string
    Returns
    Type Description
    string

    {string} Resource name string.

    getContext(request, options)

      getContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IGetContextRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IGetContextRequest | undefined, {} | undefined]>

    getContext(request, options, callback)

      getContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IGetContextRequest
    options CallOptions
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IGetContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    getContext(request, callback)

      getContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IGetContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IGetContextRequest
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IGetContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    getProjectId()

      getProjectId 
 () 
 : 
  
 Promise<string> 
 ;
    Returns
    Type Description
    Promise <string>

    getProjectId(callback)

      getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback Callback <string, undefined, undefined>
    Returns
    Type Description
    void

    initialize()

      initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

    Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

    You can await on this method if you want to make sure the client is initialized.

    Returns
    Type Description
    Promise <{ [name: string]: Function ; }>

    {Promise} A promise that resolves to an authenticated service stub.

    intentPath(project, intent)

      intentPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 intent 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified intent resource name string.

    Parameters
    Name Description
    project string
    intent string
    Returns
    Type Description
    string

    {string} Resource name string.

    listContexts(request, options)

      listContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsResponse 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IListContextsRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.dialogflow.v2.IContext [], protos. google.cloud.dialogflow.v2.IListContextsRequest | null, protos. google.cloud.dialogflow.v2.IListContextsResponse ]>

    listContexts(request, options, callback)

      listContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IListContextsRequest
    options CallOptions
    callback PaginationCallback <protos. google.cloud.dialogflow.v2.IListContextsRequest , protos. google.cloud.dialogflow.v2.IListContextsResponse | null | undefined, protos. google.cloud.dialogflow.v2.IContext >
    Returns
    Type Description
    void

    listContexts(request, callback)

      listContexts 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IListContextsRequest
    callback PaginationCallback <protos. google.cloud.dialogflow.v2.IListContextsRequest , protos. google.cloud.dialogflow.v2.IListContextsResponse | null | undefined, protos. google.cloud.dialogflow.v2.IContext >
    Returns
    Type Description
    void

    listContextsAsync(request, options)

      listContextsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
> ;

    Equivalent to listContexts , but returns an iterable object.

    for - await - of syntax is used with the iterable to get response elements on-demand.

    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IListContextsRequest

    The request object that will be sent.
    options CallOptions

    Call options. See CallOptions for more details.
    Returns
    Type Description
    AsyncIterable <protos. google.cloud.dialogflow.v2.IContext >

    {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Context]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

    listContextsStream(request, options)

      listContextsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IListContextsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

    Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IListContextsRequest

    The request object that will be sent.
    options CallOptions

    Call options. See CallOptions for more details.
    Returns
    Type Description
    Transform

    {Stream} An object stream which emits an object representing [Context] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listContextsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

    matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

      matchContextFromProjectAgentEnvironmentUserSessionContextName 
 ( 
 projectAgentEnvironmentUserSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the context from ProjectAgentEnvironmentUserSessionContext resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionContextName string

    A fully-qualified path representing project_agent_environment_user_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the context.

    matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)

      matchContextFromProjectAgentSessionContextName 
 ( 
 projectAgentSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the context from ProjectAgentSessionContext resource.

    Parameter
    Name Description
    projectAgentSessionContextName string

    A fully-qualified path representing project_agent_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the context.

    matchEntityTypeFromEntityTypeName(entityTypeName)

      matchEntityTypeFromEntityTypeName 
 ( 
 entityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the entity_type from EntityType resource.

    Parameter
    Name Description
    entityTypeName string

    A fully-qualified path representing EntityType resource.
    Returns
    Type Description
    string | number

    {string} A string representing the entity_type.

    matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

      matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName 
 ( 
 projectAgentEnvironmentUserSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionEntityTypeName string

    A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the entity_type.

    matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

      matchEntityTypeFromProjectAgentSessionEntityTypeName 
 ( 
 projectAgentSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the entity_type from ProjectAgentSessionEntityType resource.

    Parameter
    Name Description
    projectAgentSessionEntityTypeName string

    A fully-qualified path representing project_agent_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the entity_type.

    matchEnvironmentFromEnvironmentName(environmentName)

      matchEnvironmentFromEnvironmentName 
 ( 
 environmentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the environment from Environment resource.

    Parameter
    Name Description
    environmentName string

    A fully-qualified path representing Environment resource.
    Returns
    Type Description
    string | number

    {string} A string representing the environment.

    matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

      matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName 
 ( 
 projectAgentEnvironmentUserSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionContextName string

    A fully-qualified path representing project_agent_environment_user_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the environment.

    matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

      matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName 
 ( 
 projectAgentEnvironmentUserSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionEntityTypeName string

    A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the environment.

    matchIntentFromIntentName(intentName)

      matchIntentFromIntentName 
 ( 
 intentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the intent from Intent resource.

    Parameter
    Name Description
    intentName string

    A fully-qualified path representing Intent resource.
    Returns
    Type Description
    string | number

    {string} A string representing the intent.

    matchProjectFromAgentName(agentName)

      matchProjectFromAgentName 
 ( 
 agentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Agent resource.

    Parameter
    Name Description
    agentName string

    A fully-qualified path representing Agent resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromEntityTypeName(entityTypeName)

      matchProjectFromEntityTypeName 
 ( 
 entityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from EntityType resource.

    Parameter
    Name Description
    entityTypeName string

    A fully-qualified path representing EntityType resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromEnvironmentName(environmentName)

      matchProjectFromEnvironmentName 
 ( 
 environmentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Environment resource.

    Parameter
    Name Description
    environmentName string

    A fully-qualified path representing Environment resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromIntentName(intentName)

      matchProjectFromIntentName 
 ( 
 intentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Intent resource.

    Parameter
    Name Description
    intentName string

    A fully-qualified path representing Intent resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

      matchProjectFromProjectAgentEnvironmentUserSessionContextName 
 ( 
 projectAgentEnvironmentUserSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectAgentEnvironmentUserSessionContext resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionContextName string

    A fully-qualified path representing project_agent_environment_user_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

      matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName 
 ( 
 projectAgentEnvironmentUserSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionEntityTypeName string

    A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)

      matchProjectFromProjectAgentSessionContextName 
 ( 
 projectAgentSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectAgentSessionContext resource.

    Parameter
    Name Description
    projectAgentSessionContextName string

    A fully-qualified path representing project_agent_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

      matchProjectFromProjectAgentSessionEntityTypeName 
 ( 
 projectAgentSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectAgentSessionEntityType resource.

    Parameter
    Name Description
    projectAgentSessionEntityTypeName string

    A fully-qualified path representing project_agent_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectAgentSessionName(projectAgentSessionName)

      matchProjectFromProjectAgentSessionName 
 ( 
 projectAgentSessionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from ProjectAgentSession resource.

    Parameter
    Name Description
    projectAgentSessionName string

    A fully-qualified path representing project_agent_session resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProjectName(projectName)

      matchProjectFromProjectName 
 ( 
 projectName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Project resource.

    Parameter
    Name Description
    projectName string

    A fully-qualified path representing Project resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

      matchSessionFromProjectAgentEnvironmentUserSessionContextName 
 ( 
 projectAgentEnvironmentUserSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the session from ProjectAgentEnvironmentUserSessionContext resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionContextName string

    A fully-qualified path representing project_agent_environment_user_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the session.

    matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

      matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName 
 ( 
 projectAgentEnvironmentUserSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionEntityTypeName string

    A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the session.

    matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)

      matchSessionFromProjectAgentSessionContextName 
 ( 
 projectAgentSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the session from ProjectAgentSessionContext resource.

    Parameter
    Name Description
    projectAgentSessionContextName string

    A fully-qualified path representing project_agent_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the session.

    matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

      matchSessionFromProjectAgentSessionEntityTypeName 
 ( 
 projectAgentSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the session from ProjectAgentSessionEntityType resource.

    Parameter
    Name Description
    projectAgentSessionEntityTypeName string

    A fully-qualified path representing project_agent_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the session.

    matchSessionFromProjectAgentSessionName(projectAgentSessionName)

      matchSessionFromProjectAgentSessionName 
 ( 
 projectAgentSessionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the session from ProjectAgentSession resource.

    Parameter
    Name Description
    projectAgentSessionName string

    A fully-qualified path representing project_agent_session resource.
    Returns
    Type Description
    string | number

    {string} A string representing the session.

    matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

      matchUserFromProjectAgentEnvironmentUserSessionContextName 
 ( 
 projectAgentEnvironmentUserSessionContextName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the user from ProjectAgentEnvironmentUserSessionContext resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionContextName string

    A fully-qualified path representing project_agent_environment_user_session_context resource.
    Returns
    Type Description
    string | number

    {string} A string representing the user.

    matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

      matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName 
 ( 
 projectAgentEnvironmentUserSessionEntityTypeName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.

    Parameter
    Name Description
    projectAgentEnvironmentUserSessionEntityTypeName string

    A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
    Returns
    Type Description
    string | number

    {string} A string representing the user.

    projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)

      projectAgentEnvironmentUserSessionContextPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 environment 
 : 
  
 string 
 , 
  
 user 
 : 
  
 string 
 , 
  
 session 
 : 
  
 string 
 , 
  
 context 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.

    Parameters
    Name Description
    project string
    environment string
    user string
    session string
    context string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)

      projectAgentEnvironmentUserSessionEntityTypePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 environment 
 : 
  
 string 
 , 
  
 user 
 : 
  
 string 
 , 
  
 session 
 : 
  
 string 
 , 
  
 entityType 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.

    Parameters
    Name Description
    project string
    environment string
    user string
    session string
    entityType string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectAgentSessionContextPath(project, session, context)

      projectAgentSessionContextPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 session 
 : 
  
 string 
 , 
  
 context 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectAgentSessionContext resource name string.

    Parameters
    Name Description
    project string
    session string
    context string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectAgentSessionEntityTypePath(project, session, entityType)

      projectAgentSessionEntityTypePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 session 
 : 
  
 string 
 , 
  
 entityType 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectAgentSessionEntityType resource name string.

    Parameters
    Name Description
    project string
    session string
    entityType string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectAgentSessionPath(project, session)

      projectAgentSessionPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 session 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified projectAgentSession resource name string.

    Parameters
    Name Description
    project string
    session string
    Returns
    Type Description
    string

    {string} Resource name string.

    projectPath(project)

      projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified project resource name string.

    Parameter
    Name Description
    project string
    Returns
    Type Description
    string

    {string} Resource name string.

    updateContext(request, options)

      updateContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IUpdateContextRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IUpdateContextRequest | undefined, {} | undefined]>

    updateContext(request, options, callback)

      updateContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IUpdateContextRequest
    options CallOptions
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IUpdateContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    updateContext(request, callback)

      updateContext 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IContext 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dialogflow 
 . 
 v2 
 . 
 IUpdateContextRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.dialogflow.v2.IUpdateContextRequest
    callback Callback <protos. google.cloud.dialogflow.v2.IContext , protos. google.cloud.dialogflow.v2.IUpdateContextRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: