blob: 4ae1ca299ec5f189289325b8cdf8d02b2dd10087 [file] [log] [blame]
Avi Drissman8ba1bad2022-09-13 19:22:361// Copyright 2014 The Chromium Authors
[email protected]efad90f2014-01-17 00:45:542// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Clark DuVall484c2562020-01-23 22:05:095#ifndef COMPONENTS_PERMISSIONS_PERMISSION_REQUEST_H_
6#define COMPONENTS_PERMISSIONS_PERMISSION_REQUEST_H_
[email protected]efad90f2014-01-17 00:45:547
Jan Wilken Dörriead587c32021-03-11 14:09:278#include <string>
9
Avi Drissman12be0312023-01-11 09:16:0910#include "base/functional/callback.h"
Thomas Nguyen9f1ff7302023-03-30 12:23:3511#include "base/memory/weak_ptr.h"
Clark DuVall484c2562020-01-23 22:05:0912#include "build/build_config.h"
Bret Sepulveda5327d8b52021-07-21 17:44:2313#include "components/content_settings/core/common/content_settings.h"
lshangada00c12016-10-17 04:51:1014#include "components/content_settings/core/common/content_settings_types.h"
Andy Paicu0a6d4b502023-08-29 15:13:0915#include "components/permissions/permission_request_data.h"
Andy Paicu4a88f422020-11-12 18:21:3916#include "components/permissions/permission_request_enums.h"
Illia Klimovfabd8b52021-10-21 07:15:4017#include "components/permissions/request_type.h"
Illia Klimove406ecc12022-11-22 15:53:2918#include "content/public/browser/global_routing_id.h"
Anton Bikineev1156b5f2021-05-15 22:35:3619#include "third_party/abseil-cpp/absl/types/optional.h"
[email protected]d23cdeee2014-03-10 06:39:5320#include "url/gurl.h"
[email protected]efad90f2014-01-17 00:45:5421
Clark DuVall484c2562020-01-23 22:05:0922namespace permissions {
Bret Sepulveda362cce42021-01-13 18:47:5423enum class RequestType;
Clark DuVall484c2562020-01-23 22:05:0924
tsergeant58defcfb2016-07-19 23:47:2825// Describes the interface a feature making permission requests should
26// implement. A class of this type is registered with the permission request
[email protected]efad90f2014-01-17 00:45:5427// manager to receive updates about the result of the permissions request
tsergeant58defcfb2016-07-19 23:47:2828// from the bubble or infobar. It should live until it is unregistered or until
[email protected]634e5982014-04-18 19:20:4829// RequestFinished is called.
[email protected]efad90f2014-01-17 00:45:5430// Note that no particular guarantees are made about what exact UI surface
31// is presented to the user. The delegate may be coalesced with other bubble
32// requests, or depending on the situation, not shown at all.
tsergeant58defcfb2016-07-19 23:47:2833class PermissionRequest {
[email protected]efad90f2014-01-17 00:45:5434 public:
Bret Sepulveda5327d8b52021-07-21 17:44:2335 // If `result` is CONTENT_SETTING_ALLOW, the permission was granted by the
36 // user. If it's CONTENT_SETTING_BLOCK, the permission was blocked by the
37 // user. If it's CONTENT_SETTING_DEFAULT, the permission was ignored or
38 // dismissed without an explicit decision. No other ContentSetting value will
39 // be passed into this callback.
40 // If `is_one_time` is true, the decision will last until all tabs of
41 // `requesting_origin_` are closed or navigated away from.
42 using PermissionDecidedCallback =
Illia Klimove406ecc12022-11-22 15:53:2943 base::RepeatingCallback<void(ContentSetting /*result*/,
44 bool /*is_one_time*/,
45 bool /*is_final_decision*/)>;
[email protected]efad90f2014-01-17 00:45:5446
Bret Sepulveda5327d8b52021-07-21 17:44:2347 // `permission_decided_callback` is called when the permission request is
48 // resolved by the user (see comment on PermissionDecidedCallback above).
49 // `delete_callback` is called when the permission request is no longer needed