chromium/chrome/browser/ui/user_education/start_tutorial_in_page.h

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_
#define CHROME_BROWSER_UI_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_

#include <optional>

#include "base/functional/callback_helpers.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/profiles/profile.h"
#include "components/user_education/common/tutorial_identifier.h"
#include "components/user_education/common/tutorial_service.h"
#include "url/gurl.h"

class Browser;

// Utility for opening a page and starting a tutorial. The object exists
// only as long as the operation is in progress.
//
// Example:
//
//    // Open security settings page and start a tutorial.
//    StartTutorialInPage::Params params;
//
//    // The page does not need to be a WebUI page. It could be any page
//    // that is contextually needed for the tutorial.
//    // components/user_education/webui/README.md
//    params.target_url = "chrome://settings/security";
//
//    // The tutorial to start.
//    params.tutorial_id = kEnhancedSecuritySettingElementId;
//
//    // Log when the tutorial has been triggered. The page navigation
//    // may not be complete yet.
//    params.callback = base::BindOnce(
//      &::MaybeLogEnhancedSecurityTutorialStarted);
//
//    // Start the procedure of showing the tutorial and triggering
//    // the navigation.
//    StartTutorialInPage::Start(browser_, std::move(params));
//
class StartTutorialInPage { … };

#endif  // CHROME_BROWSER_UI_USER_EDUCATION_START_TUTORIAL_IN_PAGE_H_