* $dialogflowService = new Google\Service\Dialogflow(...); * $pages = $dialogflowService->pages; * */ class ProjectsLocationsAgentsFlowsPages extends \Google\Service\Resource { /** * Creates a page in the specified flow. Note: You should always train a flow * prior to sending it queries. See the [training * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * (pages.create) * * @param string $parent Required. The flow to create a page for. Format: * `projects//locations//agents//flows/`. * @param GoogleCloudDialogflowCxV3Page $postBody * @param array $optParams Optional parameters. * * @opt_param string languageCode The language of the following fields in * `page`: * `Page.entry_fulfillment.messages` * * `Page.entry_fulfillment.conditional_cases` * * `Page.event_handlers.trigger_fulfillment.messages` * * `Page.event_handlers.trigger_fulfillment.conditional_cases` * * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `P * age.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_case * s` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases * ` * `Page.transition_routes.trigger_fulfillment.messages` * * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not * specified, the agent's default language is used. [Many * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) * are supported. Note: languages must be enabled in the agent before they can * be used. * @return GoogleCloudDialogflowCxV3Page */ public function create($parent, GoogleCloudDialogflowCxV3Page $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudDialogflowCxV3Page::class); } /** * Deletes the specified page. Note: You should always train a flow prior to * sending it queries. See the [training * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * (pages.delete) * * @param string $name Required. The name of the page to delete. Format: * `projects//locations//agents//Flows//pages/`. * @param array $optParams Optional parameters. * * @opt_param bool force This field has no effect for pages with no incoming * transitions. For pages with incoming transitions: * If `force` is set to * false, an error will be returned with message indicating the incoming * transitions. * If `force` is set to true, Dialogflow will remove the page, as * well as any transitions to the page (i.e. Target page in event handlers or * Target page in transition routes that point to this page will be cleared). * @return GoogleProtobufEmpty */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleProtobufEmpty::class); } /** * Retrieves the specified page. (pages.get) * * @param string $name Required. The name of the page. Format: * `projects//locations//agents//flows//pages/`. * @param array $optParams Optional parameters. * * @opt_param string languageCode The language to retrieve the page for. The * following fields are language dependent: * `Page.entry_fulfillment.messages` * * `Page.entry_fulfillment.conditional_cases` * * `Page.event_handlers.trigger_fulfillment.messages` * * `Page.event_handlers.trigger_fulfillment.conditional_cases` * * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `P * age.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_case * s` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases * ` * `Page.transition_routes.trigger_fulfillment.messages` * * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not * specified, the agent's default language is used. [Many * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) * are supported. Note: languages must be enabled in the agent before they can * be used. * @return GoogleCloudDialogflowCxV3Page */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudDialogflowCxV3Page::class); } /** * Returns the list of all pages in the specified flow. * (pages.listProjectsLocationsAgentsFlowsPages) * * @param string $parent Required. The flow to list all pages for. Format: * `projects//locations//agents//flows/`. * @param array $optParams Optional parameters. * * @opt_param string languageCode The language to list pages for. The following * fields are language dependent: * `Page.entry_fulfillment.messages` * * `Page.entry_fulfillment.conditional_cases` * * `Page.event_handlers.trigger_fulfillment.messages` * * `Page.event_handlers.trigger_fulfillment.conditional_cases` * * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `P * age.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_case * s` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases * ` * `Page.transition_routes.trigger_fulfillment.messages` * * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not * specified, the agent's default language is used. [Many * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) * are supported. Note: languages must be enabled in the agent before they can * be used. * @opt_param int pageSize The maximum number of items to return in a single * page. By default 100 and at most 1000. * @opt_param string pageToken The next_page_token value returned from a * previous list request. * @return GoogleCloudDialogflowCxV3ListPagesResponse */ public function listProjectsLocationsAgentsFlowsPages($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudDialogflowCxV3ListPagesResponse::class); } /** * Updates the specified page. Note: You should always train a flow prior to * sending it queries. See the [training * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). * (pages.patch) * * @param string $name The unique identifier of the page. Required for the * Pages.UpdatePage method. Pages.CreatePage populates the name automatically. * Format: `projects//locations//agents//flows//pages/`. * @param GoogleCloudDialogflowCxV3Page $postBody * @param array $optParams Optional parameters. * * @opt_param string languageCode The language of the following fields in * `page`: * `Page.entry_fulfillment.messages` * * `Page.entry_fulfillment.conditional_cases` * * `Page.event_handlers.trigger_fulfillment.messages` * * `Page.event_handlers.trigger_fulfillment.conditional_cases` * * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `P * age.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_case * s` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases * ` * `Page.transition_routes.trigger_fulfillment.messages` * * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not * specified, the agent's default language is used. [Many * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) * are supported. Note: languages must be enabled in the agent before they can * be used. * @opt_param string updateMask The mask to control which fields get updated. If * the mask is not present, all fields will be updated. * @return GoogleCloudDialogflowCxV3Page */ public function patch($name, GoogleCloudDialogflowCxV3Page $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], GoogleCloudDialogflowCxV3Page::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsAgentsFlowsPages::class, 'Google_Service_Dialogflow_Resource_ProjectsLocationsAgentsFlowsPages');