One Logo Pool Ball
WebKit · IOS API REFERENCE

WKWebExtension

class · iOS 18.4+ · SDK 27.1

@MainActor class WKWebExtension

Members (28)

get · iOS 18.4+

errorDomain

TypeScript
static get errorDomain(): Promise<string>
Swift declaration
nonisolated class let errorDomain: String
method · iOS 18.4+

actionIcon

TypeScript
actionIcon(size: { width: number; height: number }): Promise<(_UIKit_UIImage) | null>
Swift declaration
func actionIcon(for size: CGSize) -> UIImage?
method · iOS 18.4+

icon

TypeScript
icon(size: { width: number; height: number }): Promise<(_UIKit_UIImage) | null>
Swift declaration
func icon(for size: CGSize) -> UIImage?
method · iOS 18.4+

supportsManifestVersion

TypeScript
supportsManifestVersion(manifestVersion: number): Promise<boolean>
Swift declaration
func supportsManifestVersion(_ manifestVersion: Double) -> Bool
get · iOS 18.4+

allRequestedMatchPatterns

TypeScript
get allRequestedMatchPatterns(): Promise<Array<WKWebExtension_MatchPattern>>
Swift declaration
var allRequestedMatchPatterns: Set<WKWebExtension.MatchPattern> { get }
get · iOS 18.4+

defaultLocale

TypeScript
get defaultLocale(): Promise<(_Foundation_Locale) | null>
Swift declaration
var defaultLocale: Locale? { get }
get · iOS 18.4+

displayActionLabel

TypeScript
get displayActionLabel(): Promise<(string) | null>
Swift declaration
var displayActionLabel: String? { get }
get · iOS 18.4+

displayDescription

TypeScript
get displayDescription(): Promise<(string) | null>
Swift declaration
var displayDescription: String? { get }
get · iOS 18.4+

displayName

TypeScript
get displayName(): Promise<(string) | null>
Swift declaration
var displayName: String? { get }
get · iOS 18.4+

displayShortName

TypeScript
get displayShortName(): Promise<(string) | null>
Swift declaration
var displayShortName: String? { get }
get · iOS 18.4+

displayVersion

TypeScript
get displayVersion(): Promise<(string) | null>
Swift declaration
var displayVersion: String? { get }
get · iOS 18.4+

errors

TypeScript
get errors(): Promise<Array<NativeError>>
Swift declaration
var errors: [any Error] { get }
get · iOS 18.4+

hasBackgroundContent

TypeScript
get hasBackgroundContent(): Promise<boolean>
Swift declaration
var hasBackgroundContent: Bool { get }
get · iOS 18.4+

hasCommands

TypeScript
get hasCommands(): Promise<boolean>
Swift declaration
var hasCommands: Bool { get }
get · iOS 18.4+

hasContentModificationRules

TypeScript
get hasContentModificationRules(): Promise<boolean>
Swift declaration
var hasContentModificationRules: Bool { get }
get · iOS 18.4+

hasInjectedContent

TypeScript
get hasInjectedContent(): Promise<boolean>
Swift declaration
var hasInjectedContent: Bool { get }
get · iOS 18.4+

hasOptionsPage

TypeScript
get hasOptionsPage(): Promise<boolean>
Swift declaration
var hasOptionsPage: Bool { get }
get · iOS 18.4+

hasOverrideNewTabPage

TypeScript
get hasOverrideNewTabPage(): Promise<boolean>
Swift declaration
var hasOverrideNewTabPage: Bool { get }
get · iOS 18.4+

hasPersistentBackgroundContent

TypeScript
get hasPersistentBackgroundContent(): Promise<boolean>
Swift declaration
var hasPersistentBackgroundContent: Bool { get }
get · iOS 18.4+

manifest

TypeScript
get manifest(): Promise<Record<string, unknown>>
Swift declaration
var manifest: [String : Any] { get }
get · iOS 18.4+

manifestVersion

TypeScript
get manifestVersion(): Promise<number>
Swift declaration
var manifestVersion: Double { get }
get · iOS 18.4+

optionalPermissionMatchPatterns

TypeScript
get optionalPermissionMatchPatterns(): Promise<Array<WKWebExtension_MatchPattern>>
Swift declaration
var optionalPermissionMatchPatterns: Set<WKWebExtension.MatchPattern> { get }
get · iOS 18.4+

optionalPermissions

TypeScript
get optionalPermissions(): Promise<Array<WKWebExtension_Permission>>
Swift declaration
var optionalPermissions: Set<WKWebExtension.Permission> { get }
get · iOS 18.4+

requestedPermissionMatchPatterns

TypeScript
get requestedPermissionMatchPatterns(): Promise<Array<WKWebExtension_MatchPattern>>
Swift declaration
var requestedPermissionMatchPatterns: Set<WKWebExtension.MatchPattern> { get }
get · iOS 18.4+

requestedPermissions

TypeScript
get requestedPermissions(): Promise<Array<WKWebExtension_Permission>>
Swift declaration
var requestedPermissions: Set<WKWebExtension.Permission> { get }
get · iOS 18.4+

version

TypeScript
get version(): Promise<(string) | null>
Swift declaration
var version: String? { get }
init · iOS 18.4+

init

TypeScript
static initAppExtensionBundle(appExtensionBundle: _Foundation_Bundle): Promise<WKWebExtension>
Swift declaration
@MainActor @preconcurrency convenience init(appExtensionBundle: Bundle) async throws

Creates a web extension initialized with a specified app extension bundle. The app extension bundle must contain a `manifest.json` file in its resources directory. If the manifest is invalid or missing, or the bundle is otherwise improperly configured, an error will be thrown. - Parameter appExtensionBundle: The bundle to use for the new web extension. - Throws: An error if the manifest is invalid or missing, or the bundle is otherwise improperly configured.

init · iOS 18.4+

init

TypeScript
static initResourceBaseURL(resourceBaseURL: string): Promise<WKWebExtension>
Swift declaration
@MainActor @preconcurrency convenience init(resourceBaseURL: URL) async throws

Creates a web extension initialized with a specified resource base URL, which can point to either a directory or a ZIP archive. The URL must be a file URL that points to either a directory with a `manifest.json` file or a ZIP archive containing a `manifest.json` file. If the manifest is invalid or missing, or the URL points to an unsupported format or invalid archive, an error will be returned. - Parameter resourceBaseURL: The file URL to use for the new web extension. - Throws: An error if the manifest is invalid or missing, or the URL points to an unsupported format or invalid archive.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

WKWebExtension.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All WebKit types →