browsingContextStorage.d.ts 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. /**
  2. * Copyright 2022 Google LLC.
  3. * Copyright (c) Microsoft Corporation.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. import { type CommonDataTypes } from '../../../protocol/protocol.js';
  18. import type { BrowsingContextImpl } from './browsingContextImpl.js';
  19. /** Container class for browsing contexts. */
  20. export declare class BrowsingContextStorage {
  21. #private;
  22. /** Gets all top-level contexts, i.e. those with no parent. */
  23. getTopLevelContexts(): BrowsingContextImpl[];
  24. /** Gets all contexts. */
  25. getAllContexts(): BrowsingContextImpl[];
  26. /** Deletes the context with the given ID. */
  27. deleteContextById(id: CommonDataTypes.BrowsingContext): void;
  28. /** Deletes the given context. */
  29. deleteContext(context: BrowsingContextImpl): void;
  30. /** Tracks the given context. */
  31. addContext(context: BrowsingContextImpl): void;
  32. /** Returns true whether there is an existing context with the given ID. */
  33. hasContext(id: CommonDataTypes.BrowsingContext): boolean;
  34. /** Gets the context with the given ID, if any. */
  35. findContext(id: CommonDataTypes.BrowsingContext): BrowsingContextImpl | undefined;
  36. /** Returns the top-level context ID of the given context, if any. */
  37. findTopLevelContextId(id: CommonDataTypes.BrowsingContext | null): CommonDataTypes.BrowsingContext | null;
  38. /** Gets the context with the given ID, if any, otherwise throws. */
  39. getContext(id: CommonDataTypes.BrowsingContext): BrowsingContextImpl;
  40. }