webkit

type BoolHandler ¶

type BoolHandler = func(bool)

BoolHandler handles The completion handler block to execute with the decision.

• decision: A Boolean value that indicates whether to continue to use a deprecated version of TLS. Specify [true](<doc://com.apple.documentation/documentation/Swift/true>) to continue, or [false](<doc://com.apple.documentation/documentation/Swift/false>) to reject the connection.

Used by:

• [WKNavigationDelegate.WebViewAuthenticationChallengeShouldAllowDeprecatedTLS]
• [WKNavigationDelegate.WebViewShouldGoToBackForwardListItemWillUseInstantBackCompletionHandler]
• [WKUIDelegate.WebViewRunJavaScriptConfirmPanelWithMessageInitiatedByFrameCompletionHandler]

type DOMEventExceptionCode ¶

type DOMEventExceptionCode uint32

See: https://developer.apple.com/documentation/WebKit/DOMEventExceptionCode

const (
	DOM_UNSPECIFIED_EVENT_TYPE_ERR DOMEventExceptionCode = 0
)

func (e DOMEventExceptionCode) String() string

type DOMExceptionCode ¶

type DOMExceptionCode uint32

See: https://developer.apple.com/documentation/WebKit/DOMExceptionCode

const (
	DOM_DOMSTRING_SIZE_ERR          DOMExceptionCode = 2
	DOM_HIERARCHY_REQUEST_ERR       DOMExceptionCode = 3
	DOM_INDEX_SIZE_ERR              DOMExceptionCode = 1
	DOM_INUSE_ATTRIBUTE_ERR         DOMExceptionCode = 10
	DOM_INVALID_ACCESS_ERR          DOMExceptionCode = 15
	DOM_INVALID_CHARACTER_ERR       DOMExceptionCode = 5
	DOM_INVALID_MODIFICATION_ERR    DOMExceptionCode = 13
	DOM_INVALID_STATE_ERR           DOMExceptionCode = 11
	DOM_NAMESPACE_ERR               DOMExceptionCode = 14
	DOM_NOT_FOUND_ERR               DOMExceptionCode = 8
	DOM_NOT_SUPPORTED_ERR           DOMExceptionCode = 9
	DOM_NO_DATA_ALLOWED_ERR         DOMExceptionCode = 6
	DOM_NO_MODIFICATION_ALLOWED_ERR DOMExceptionCode = 7
	DOM_SYNTAX_ERR                  DOMExceptionCode = 12
	DOM_WRONG_DOCUMENT_ERR          DOMExceptionCode = 4
)

func (e DOMExceptionCode) String() string

type DOMRangeExceptionCode ¶

type DOMRangeExceptionCode uint32

See: https://developer.apple.com/documentation/WebKit/DOMRangeExceptionCode

const (
	DOM_BAD_BOUNDARYPOINTS_ERR DOMRangeExceptionCode = 1
	DOM_INVALID_NODE_TYPE_ERR  DOMRangeExceptionCode = 2
)

func (e DOMRangeExceptionCode) String() string

type DOMTimeStamp ¶

type DOMTimeStamp = uint64

See: https://developer.apple.com/documentation/WebKit/DOMTimeStamp

type DOMXPathExceptionCode ¶

type DOMXPathExceptionCode uint32

See: https://developer.apple.com/documentation/WebKit/DOMXPathExceptionCode

const (
	DOM_INVALID_EXPRESSION_ERR DOMXPathExceptionCode = 51
	DOM_TYPE_ERR               DOMXPathExceptionCode = 52
)

func (e DOMXPathExceptionCode) String() string

type DataErrorHandler ¶

type DataErrorHandler = func(*foundation.NSData, error)

DataErrorHandler handles The completion handler to call when the data is ready.

• pdfDocumentData: A data object that contains the PDF data to use for rendering the contents of the web view.
• error: An error object if a problem occurred, or `nil` on success.

The error can be type-asserted to *foundation.NSError for Domain, Code, and UserInfo.

Used by:

• WKWebView.CreatePDFWithConfigurationCompletionHandler
• WKWebView.CreateWebArchiveDataWithCompletionHandler
• WKWebView.FetchDataOfTypesCompletionHandler
• WKWebsiteDataStore.FetchDataOfTypesCompletionHandler

type DataHandler ¶

type DataHandler = func(*foundation.NSData)

DataHandler handles A closure you provide to capture and store data so that you can resume the download later.

Used by:

• WKDownload.Cancel

type Dom ¶

type Dom uint

const (
	DOM_ADDITION                                  Dom = 2
	DOM_ANY_TYPE                                  Dom = 0
	DOM_ANY_UNORDERED_NODE_TYPE                   Dom = 8
	DOM_ATTRIBUTE_NODE                            Dom = 2
	DOM_AT_TARGET                                 Dom = 2
	DOM_BOOLEAN_TYPE                              Dom = 3
	DOM_BOTH                                      Dom = 2
	DOM_BUBBLING_PHASE                            Dom = 3
	DOM_CAPTURING_PHASE                           Dom = 1
	DOM_CDATA_SECTION_NODE                        Dom = 4
	DOM_CHARSET_RULE                              Dom = 2
	DOM_COMMENT_NODE                              Dom = 8
	DOM_DOCUMENT_FRAGMENT_NODE                    Dom = 11
	DOM_DOCUMENT_NODE                             Dom = 9
	DOM_DOCUMENT_POSITION_CONTAINED_BY            Dom = 16
	DOM_DOCUMENT_POSITION_CONTAINS                Dom = 8
	DOM_DOCUMENT_POSITION_DISCONNECTED            Dom = 1
	DOM_DOCUMENT_POSITION_FOLLOWING               Dom = 4
	DOM_DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC Dom = 32
	DOM_DOCUMENT_POSITION_PRECEDING               Dom = 2
	DOM_DOCUMENT_TYPE_NODE                        Dom = 10
	DOM_ELEMENT_NODE                              Dom = 1
	DOM_END_TO_END                                Dom = 2
	DOM_END_TO_START                              Dom = 3
	DOM_ENTITY_NODE                               Dom = 6
	DOM_ENTITY_REFERENCE_NODE                     Dom = 5
	DOM_FILTER_ACCEPT                             Dom = 1
	DOM_FILTER_REJECT                             Dom = 2
	DOM_FILTER_SKIP                               Dom = 3
	DOM_FIRST_ORDERED_NODE_TYPE                   Dom = 9
	DOM_FONT_FACE_RULE                            Dom = 5
	DOM_HORIZONTAL                                Dom = 0
	DOM_IMPORT_RULE                               Dom = 3
	DOM_KEYFRAMES_RULE                            Dom = 7
	DOM_KEYFRAME_RULE                             Dom = 8
	DOM_MEDIA_RULE                                Dom = 4
	DOM_MODIFICATION                              Dom = 1
	DOM_NAMESPACE_RULE                            Dom = 10
	DOM_NODE_AFTER                                Dom = 1
	DOM_NODE_BEFORE                               Dom = 0
	DOM_NODE_BEFORE_AND_AFTER                     Dom = 2
	DOM_NODE_INSIDE                               Dom = 3
	DOM_NONE                                      Dom = 0
	DOM_NOTATION_NODE                             Dom = 12
	DOM_NUMBER_TYPE                               Dom = 1
	DOM_ORDERED_NODE_ITERATOR_TYPE                Dom = 5
	DOM_ORDERED_NODE_SNAPSHOT_TYPE                Dom = 7
	DOM_PAGE_RULE                                 Dom = 6
	DOM_PROCESSING_INSTRUCTION_NODE               Dom = 7
	DOM_REMOVAL                                   Dom = 3
	DOM_SHOW_ALL                                  Dom = 4294967295
	DOM_SHOW_ATTRIBUTE                            Dom = 2
	DOM_SHOW_CDATA_SECTION                        Dom = 8
	DOM_SHOW_COMMENT                              Dom = 128
	DOM_SHOW_DOCUMENT                             Dom = 256
	DOM_SHOW_DOCUMENT_FRAGMENT                    Dom = 1024
	DOM_SHOW_DOCUMENT_TYPE                        Dom = 512
	DOM_SHOW_ELEMENT                              Dom = 1
	DOM_SHOW_ENTITY                               Dom = 32
	DOM_SHOW_ENTITY_REFERENCE                     Dom = 16
	DOM_SHOW_NOTATION                             Dom = 2048
	DOM_SHOW_PROCESSING_INSTRUCTION               Dom = 64
	DOM_SHOW_TEXT                                 Dom = 4
	DOM_START_TO_END                              Dom = 1
	DOM_START_TO_START                            Dom = 0
	DOM_STRING_TYPE                               Dom = 2
	DOM_STYLE_RULE                                Dom = 1
	DOM_SUPPORTS_RULE                             Dom = 12
	DOM_TEXT_NODE                                 Dom = 3
	DOM_UNKNOWN_RULE                              Dom = 0
	DOM_UNORDERED_NODE_ITERATOR_TYPE              Dom = 4
	DOM_UNORDERED_NODE_SNAPSHOT_TYPE              Dom = 6
	DOM_VERTICAL                                  Dom = 1
	DOM_WEBKIT_KEYFRAMES_RULE                     Dom = 7
	DOM_WEBKIT_KEYFRAME_RULE                      Dom = 8
	DOM_WEBKIT_REGION_RULE                        Dom = 16
)

func (e Dom) String() string

type DomAllowKeyboard ¶

type DomAllowKeyboard uint

const (
	DOM_ALLOW_KEYBOARD_INPUT DomAllowKeyboard = 1
)

func (e DomAllowKeyboard) String() string

type DomCSS ¶

type DomCSS uint

const (
	DOM_CSS_ATTR            DomCSS = 22
	DOM_CSS_CM              DomCSS = 6
	DOM_CSS_COUNTER         DomCSS = 23
	DOM_CSS_CUSTOM          DomCSS = 3
	DOM_CSS_DEG             DomCSS = 11
	DOM_CSS_DIMENSION       DomCSS = 18
	DOM_CSS_EMS             DomCSS = 3
	DOM_CSS_EXS             DomCSS = 4
	DOM_CSS_GRAD            DomCSS = 13
	DOM_CSS_HZ              DomCSS = 16
	DOM_CSS_IDENT           DomCSS = 21
	DOM_CSS_IN              DomCSS = 8
	DOM_CSS_INHERIT         DomCSS = 0
	DOM_CSS_KHZ             DomCSS = 17
	DOM_CSS_MM              DomCSS = 7
	DOM_CSS_MS              DomCSS = 14
	DOM_CSS_NUMBER          DomCSS = 1
	DOM_CSS_PC              DomCSS = 10
	DOM_CSS_PERCENTAGE      DomCSS = 2
	DOM_CSS_PRIMITIVE_VALUE DomCSS = 1
	DOM_CSS_PT              DomCSS = 9
	DOM_CSS_PX              DomCSS = 5
	DOM_CSS_RAD             DomCSS = 12
	DOM_CSS_RECT            DomCSS = 24
	DOM_CSS_RGBCOLOR        DomCSS = 25
	DOM_CSS_S               DomCSS = 15
	DOM_CSS_STRING          DomCSS = 19
	DOM_CSS_UNKNOWN         DomCSS = 0
	DOM_CSS_URI             DomCSS = 20
	DOM_CSS_VALUE_LIST      DomCSS = 2
	DOM_CSS_VH              DomCSS = 27
	DOM_CSS_VMAX            DomCSS = 29
	DOM_CSS_VMIN            DomCSS = 28
	DOM_CSS_VW              DomCSS = 26
)

func (e DomCSS) String() string

type DomDomDelta ¶

type DomDomDelta uint

const (
	DOM_DOM_DELTA_LINE  DomDomDelta = 1
	DOM_DOM_DELTA_PAGE  DomDomDelta = 2
	DOM_DOM_DELTA_PIXEL DomDomDelta = 0
)

func (e DomDomDelta) String() string

type DomKeyLocation ¶

type DomKeyLocation uint

const (
	DOM_KEY_LOCATION_LEFT     DomKeyLocation = 1
	DOM_KEY_LOCATION_NUMPAD   DomKeyLocation = 3
	DOM_KEY_LOCATION_RIGHT    DomKeyLocation = 2
	DOM_KEY_LOCATION_STANDARD DomKeyLocation = 0
)

func (e DomKeyLocation) String() string

type ErrorHandler ¶

type ErrorHandler = func(error)

ErrorHandler handles A completion handler block to call after the removal of the content rule list.

• error: `nil` on success, or an error object if the store encountered an error when deleting the rule list.

The error can be type-asserted to *foundation.NSError for Domain, Code, and UserInfo.

Used by:

• WKContentRuleListStore.RemoveContentRuleListForIdentifierCompletionHandler
• WKWebExtensionContext.LoadBackgroundContentWithCompletionHandler
• [WKWebExtensionControllerDelegate.WebExtensionControllerConnectUsingMessagePortForExtensionContextCompletionHandler]
• [WKWebExtensionControllerDelegate.WebExtensionControllerOpenOptionsPageForExtensionContextCompletionHandler]
• [WKWebExtensionControllerDelegate.WebExtensionControllerPresentPopupForActionForExtensionContextCompletionHandler]
• WKWebExtensionMessagePort.SendMessageCompletionHandler
• [WKWebExtensionTab.ActivateForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.CloseForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.GoBackForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.GoForwardForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.LoadURLForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.ReloadFromOriginForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetMutedForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetParentTabForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetPinnedForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetReaderModeActiveForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetSelectedForWebExtensionContextCompletionHandler]
• [WKWebExtensionTab.SetZoomFactorForWebExtensionContextCompletionHandler]
• [WKWebExtensionWindow.CloseForWebExtensionContextCompletionHandler]
• [WKWebExtensionWindow.FocusForWebExtensionContextCompletionHandler]
• [WKWebExtensionWindow.SetFrameForWebExtensionContextCompletionHandler]
• [WKWebExtensionWindow.SetWindowStateForWebExtensionContextCompletionHandler]
• WKWebView.RestoreDataCompletionHandler
• [WKWebsiteDataStore.RemoveDataStoreForIdentifierCompletionHandler]
• WKWebsiteDataStore.RestoreDataCompletionHandler

type IWKBackForwardList ¶

type IWKBackForwardList interface {
	objectivec.IObject

	// The item immediately preceding the current item, if any.
	BackItem() IWKBackForwardListItem
	// The current item.
	CurrentItem() IWKBackForwardListItem
	// The item immediately following the current item, if any.
	ForwardItem() IWKBackForwardListItem

	// Returns the item at the relative offset from the current item.
	ItemAtIndex(index int) IWKBackForwardListItem

	// The array of items that precede the current item.
	BackList() []WKBackForwardListItem
	// The array of items that follow the current item.
	ForwardList() []WKBackForwardListItem

	// The web view’s back-forward list.
	BackForwardList() IWKBackForwardList
	SetBackForwardList(value IWKBackForwardList)
}

An interface definition for the WKBackForwardList class.

Getting the Most Recent Items ¶

• [IWKBackForwardList.BackItem]: The item immediately preceding the current item, if any.
• [IWKBackForwardList.CurrentItem]: The current item.
• [IWKBackForwardList.ForwardItem]: The item immediately following the current item, if any.

Getting Specific Items in the List ¶

• [IWKBackForwardList.ItemAtIndex]: Returns the item at the relative offset from the current item.

Getting Sublists ¶

• [IWKBackForwardList.BackList]: The array of items that precede the current item.
• [IWKBackForwardList.ForwardList]: The array of items that follow the current item.

See: https://developer.apple.com/documentation/WebKit/WKBackForwardList

type IWKBackForwardListItem ¶

type IWKBackForwardListItem interface {
	objectivec.IObject

	// The title of the webpage this item represents.
	Title() string
	// The URL of the webpage this item represents.
	URL() foundation.INSURL

	// The source URL that originally asked the web view to load this page.
	InitialURL() foundation.INSURL
}

An interface definition for the WKBackForwardListItem class.

Getting the Page-Specific Information ¶

• [IWKBackForwardListItem.Title]: The title of the webpage this item represents.
• [IWKBackForwardListItem.URL]: The URL of the webpage this item represents.

Getting the Requesting Page ¶

• [IWKBackForwardListItem.InitialURL]: The source URL that originally asked the web view to load this page.

See: https://developer.apple.com/documentation/WebKit/WKBackForwardListItem

type IWKContentRuleList ¶

type IWKContentRuleList interface {
	objectivec.IObject

	// The identifier for the rule list.
	Identifier() string
}

An interface definition for the WKContentRuleList class.

Getting the Rules List Identifier ¶

• [IWKContentRuleList.Identifier]: The identifier for the rule list.

See: https://developer.apple.com/documentation/WebKit/WKContentRuleList

type IWKContentRuleListStore ¶

type IWKContentRuleListStore interface {
	objectivec.IObject

	// Compiles the specified JSON content into a new rule list and adds it to the current data store.
	CompileContentRuleListForIdentifierEncodedContentRuleListCompletionHandler(identifier string, encodedContentRuleList string, completionHandler WKContentRuleListErrorHandler)
	// Removes a rule list from the current data store asynchronously.
	RemoveContentRuleListForIdentifierCompletionHandler(identifier string, completionHandler ErrorHandler)

	// Fetches the identifiers for all rule lists in the store asynchronously.
	GetAvailableContentRuleListIdentifiers(completionHandler VoidHandler)
	// Searches asynchronously for a specific rule list in the data store.
	LookUpContentRuleListForIdentifierCompletionHandler(identifier string, completionHandler WKContentRuleListErrorHandler)
}

An interface definition for the WKContentRuleListStore class.

Creating and Deleting Content Rule Lists ¶

• [IWKContentRuleListStore.CompileContentRuleListForIdentifierEncodedContentRuleListCompletionHandler]: Compiles the specified JSON content into a new rule list and adds it to the current data store.
• [IWKContentRuleListStore.RemoveContentRuleListForIdentifierCompletionHandler]: Removes a rule list from the current data store asynchronously.

Accessing the Current Rule Lists ¶

• [IWKContentRuleListStore.GetAvailableContentRuleListIdentifiers]: Fetches the identifiers for all rule lists in the store asynchronously.
• [IWKContentRuleListStore.LookUpContentRuleListForIdentifierCompletionHandler]: Searches asynchronously for a specific rule list in the data store.

See: https://developer.apple.com/documentation/WebKit/WKContentRuleListStore

type IWKContentWorld ¶

type IWKContentWorld interface {
	objectivec.IObject

	// The name of a custom content world.
	Name() string
}

An interface definition for the WKContentWorld class.

Retrieving a Custom Content World ¶

• [IWKContentWorld.Name]: The name of a custom content world.

See: https://developer.apple.com/documentation/WebKit/WKContentWorld

type IWKDownload ¶

type IWKDownload interface {
	objectivec.IObject

	// An object you use to track download progress and handle redirects, authentication challenges, and failures.
	Delegate() WKDownloadDelegate
	SetDelegate(value WKDownloadDelegate)
	// Cancels the download, and optionally captures data so that you can resume the download later.
	Cancel(completionHandler DataHandler)

	// An object that represents the request that initiated the download.
	OriginalRequest() foundation.NSURLRequest
	// The web view where the download initiated.
	WebView() IWKWebView

	UserInitiated() bool
	OriginatingFrame() IWKFrameInfo
}

An interface definition for the WKDownload class.

Managing the download ¶

• [IWKDownload.Delegate]: An object you use to track download progress and handle redirects, authentication challenges, and failures.
• [IWKDownload.SetDelegate]
• [IWKDownload.Cancel]: Cancels the download, and optionally captures data so that you can resume the download later.

Inspecting the download ¶

• [IWKDownload.OriginalRequest]: An object that represents the request that initiated the download.
• [IWKDownload.WebView]: The web view where the download initiated.

Instance Properties ¶

• [IWKDownload.UserInitiated]
• [IWKDownload.OriginatingFrame]

See: https://developer.apple.com/documentation/WebKit/WKDownload

type IWKFindConfiguration ¶

type IWKFindConfiguration interface {
	objectivec.IObject

	// A Boolean value that indicates the search direction, relative to the current selection.
	Backwards() bool
	SetBackwards(value bool)
	// A Boolean value that indicates whether to consider case when matching the search string.
	CaseSensitive() bool
	SetCaseSensitive(value bool)
	// A Boolean value that indicates whether the search wraps around to the other side of the page.
	Wraps() bool
	SetWraps(value bool)
}

An interface definition for the WKFindConfiguration class.

Configuring the Search Parameters ¶

• [IWKFindConfiguration.Backwards]: A Boolean value that indicates the search direction, relative to the current selection.
• [IWKFindConfiguration.SetBackwards]
• [IWKFindConfiguration.CaseSensitive]: A Boolean value that indicates whether to consider case when matching the search string.
• [IWKFindConfiguration.SetCaseSensitive]
• [IWKFindConfiguration.Wraps]: A Boolean value that indicates whether the search wraps around to the other side of the page.
• [IWKFindConfiguration.SetWraps]

See: https://developer.apple.com/documentation/WebKit/WKFindConfiguration

type IWKFindResult ¶

type IWKFindResult interface {
	objectivec.IObject

	// A Boolean value that indicates whether the web view found a match during the search.
	MatchFound() bool
}

An interface definition for the WKFindResult class.

Getting the Search Result ¶

• [IWKFindResult.MatchFound]: A Boolean value that indicates whether the web view found a match during the search.

See: https://developer.apple.com/documentation/WebKit/WKFindResult

type IWKFrameInfo ¶

type IWKFrameInfo interface {
	objectivec.IObject

	// A Boolean value indicating whether the frame is the web site’s main frame or a subframe.
	MainFrame() bool
	// The frame’s current request.
	Request() foundation.NSURLRequest
	// The frame’s security origin.
	SecurityOrigin() IWKSecurityOrigin
	// The web view that contains this frame and the containing webpage.
	WebView() IWKWebView
}

An interface definition for the WKFrameInfo class.

Inspecting frame information ¶

• [IWKFrameInfo.MainFrame]: A Boolean value indicating whether the frame is the web site’s main frame or a subframe.
• [IWKFrameInfo.Request]: The frame’s current request.
• [IWKFrameInfo.SecurityOrigin]: The frame’s security origin.
• [IWKFrameInfo.WebView]: The web view that contains this frame and the containing webpage.

See: https://developer.apple.com/documentation/WebKit/WKFrameInfo

type IWKHTTPCookieStore ¶

type IWKHTTPCookieStore interface {
	objectivec.IObject

	// Adds a cookie to the cookie store.
	SetCookieCompletionHandler(cookie foundation.NSHTTPCookie, completionHandler VoidHandler)
	// Deletes the specified cookie.
	DeleteCookieCompletionHandler(cookie foundation.NSHTTPCookie, completionHandler VoidHandler)

	// Returns a cookie policy that indicates whether the cookie store allows cookie storage.
	GetCookiePolicy(completionHandler WKCookiePolicyHandler)
	// Sets a cookie policy that indicates whether the cookie store allows cookie storage.
	SetCookiePolicyCompletionHandler(policy WKCookiePolicy, completionHandler VoidHandler)

	// Adds an observer to the cookie store.
	AddObserver(observer WKHTTPCookieStoreObserver)
	// Removes an observer from the cookie store.
	RemoveObserver(observer WKHTTPCookieStoreObserver)

	SetCookiesCompletionHandler(cookies []foundation.NSHTTPCookie, completionHandler VoidHandler)

	// The local files WebKit can access when loading content.
	ReadAccessURL() foundation.NSString
}

An interface definition for the WKHTTPCookieStore class.

Managing cookies ¶

• [IWKHTTPCookieStore.SetCookieCompletionHandler]: Adds a cookie to the cookie store.
• [IWKHTTPCookieStore.DeleteCookieCompletionHandler]: Deletes the specified cookie.

Permitting cookie storage ¶

• [IWKHTTPCookieStore.GetCookiePolicy]: Returns a cookie policy that indicates whether the cookie store allows cookie storage.
• [IWKHTTPCookieStore.SetCookiePolicyCompletionHandler]: Sets a cookie policy that indicates whether the cookie store allows cookie storage.

Observing cookie store changes ¶

• [IWKHTTPCookieStore.AddObserver]: Adds an observer to the cookie store.
• [IWKHTTPCookieStore.RemoveObserver]: Removes an observer from the cookie store.

Instance Methods ¶

• [IWKHTTPCookieStore.SetCookiesCompletionHandler]

See: https://developer.apple.com/documentation/WebKit/WKHTTPCookieStore

type IWKNavigation ¶

type IWKNavigation interface {
	objectivec.IObject

	// The content mode WebKit uses to load the webpage.
	EffectiveContentMode() WKContentMode
}

An interface definition for the WKNavigation class.

Getting the Content Mode ¶

• [IWKNavigation.EffectiveContentMode]: The content mode WebKit uses to load the webpage.

See: https://developer.apple.com/documentation/WebKit/WKNavigation

type IWKNavigationAction ¶

type IWKNavigationAction interface {
	objectivec.IObject

	// The type of action that triggered the navigation.
	NavigationType() WKNavigationType

	// The URL request object associated with the navigation action.
	Request() foundation.NSURLRequest
	// The frame that requested the navigation.
	SourceFrame() IWKFrameInfo
	// The frame in which to display the new content.
	TargetFrame() IWKFrameInfo
	// A Boolean value that indicates whether the web content provided an attribute that indicates a download.
	ShouldPerformDownload() bool

	// The number of the mouse button that caused the navigation request.
	ButtonNumber() objectivec.IObject
	// The modifier keys that were pressed at the time of the navigation request.
	ModifierFlags() objectivec.IObject

	IsContentRuleListRedirect() bool
}

An interface definition for the WKNavigationAction class.

Getting the navigation type ¶

• [IWKNavigationAction.NavigationType]: The type of action that triggered the navigation.

Inspecting navigation information ¶

• [IWKNavigationAction.Request]: The URL request object associated with the navigation action.
• [IWKNavigationAction.SourceFrame]: The frame that requested the navigation.
• [IWKNavigationAction.TargetFrame]: The frame in which to display the new content.
• [IWKNavigationAction.ShouldPerformDownload]: A Boolean value that indicates whether the web content provided an attribute that indicates a download.

Inspecting user actions ¶

• [IWKNavigationAction.ButtonNumber]: The number of the mouse button that caused the navigation request.
• [IWKNavigationAction.ModifierFlags]: The modifier keys that were pressed at the time of the navigation request.

Instance Properties ¶

• [IWKNavigationAction.IsContentRuleListRedirect]

See: https://developer.apple.com/documentation/WebKit/WKNavigationAction

type IWKNavigationResponse ¶

type IWKNavigationResponse interface {
	objectivec.IObject

	// The frame’s response.
	Response() foundation.NSURLResponse

	// A Boolean value that indicates whether WebKit is capable of displaying the response’s MIME type natively.
	CanShowMIMEType() bool
	// A Boolean value that indicates whether the response targets the web view’s main frame.
	ForMainFrame() bool
}

An interface definition for the WKNavigationResponse class.

Getting the Response Details ¶

• [IWKNavigationResponse.Response]: The frame’s response.

Getting Additional Response Information ¶

• [IWKNavigationResponse.CanShowMIMEType]: A Boolean value that indicates whether WebKit is capable of displaying the response’s MIME type natively.
• [IWKNavigationResponse.ForMainFrame]: A Boolean value that indicates whether the response targets the web view’s main frame.

See: https://developer.apple.com/documentation/WebKit/WKNavigationResponse

type IWKOpenPanelParameters ¶

type IWKOpenPanelParameters interface {
	objectivec.IObject

	// A Boolean value that indicates whether the file upload control supports multiple files.
	AllowsMultipleSelection() bool
	// A Boolean value that indicates whether the file upload control supports the selection of directories.
	AllowsDirectories() bool
}

An interface definition for the WKOpenPanelParameters class.

Configuring the panel parameters ¶

• [IWKOpenPanelParameters.AllowsMultipleSelection]: A Boolean value that indicates whether the file upload control supports multiple files.
• [IWKOpenPanelParameters.AllowsDirectories]: A Boolean value that indicates whether the file upload control supports the selection of directories.

See: https://developer.apple.com/documentation/WebKit/WKOpenPanelParameters

type IWKPDFConfiguration ¶

type IWKPDFConfiguration interface {
	objectivec.IObject

	// A Boolean value that indicates whether the PDF may have a transparent background.
	AllowTransparentBackground() bool
	SetAllowTransparentBackground(value bool)

	// The portion of your web view to capture, specified as a rectangle in the view’s coordinate system.
	Rect() corefoundation.CGRect
	SetRect(value corefoundation.CGRect)
}

An interface definition for the WKPDFConfiguration class.

Specifying snapshot properties ¶

• [IWKPDFConfiguration.AllowTransparentBackground]: A Boolean value that indicates whether the PDF may have a transparent background.
• [IWKPDFConfiguration.SetAllowTransparentBackground]

See: https://developer.apple.com/documentation/WebKit/WKPDFConfiguration

type IWKPreferences ¶

type IWKPreferences interface {
	objectivec.IObject

	// The minimum font size, in points.
	MinimumFontSize() float64
	SetMinimumFontSize(value float64)
	// A Boolean value that indicates whether to include any background color or graphics when printing content.
	ShouldPrintBackgrounds() bool
	SetShouldPrintBackgrounds(value bool)

	// A Boolean value that indicates whether pressing the tab key changes the focus to links and form controls.
	TabFocusesLinks() bool
	SetTabFocusesLinks(value bool)
	// A Boolean value that indicates whether to allow people to select or otherwise interact with text.
	TextInteractionEnabled() bool
	SetTextInteractionEnabled(value bool)
	// A Boolean value that indicates whether a web view can display content full screen.
	ElementFullscreenEnabled() bool
	SetElementFullscreenEnabled(value bool)
	// A policy you set to specify how a web view that’s not in a window handles tasks.
	InactiveSchedulingPolicy() WKInactiveSchedulingPolicy
	SetInactiveSchedulingPolicy(value WKInactiveSchedulingPolicy)

	// A Boolean value that indicates whether JavaScript can open windows without user interaction.
	JavaScriptCanOpenWindowsAutomatically() bool
	SetJavaScriptCanOpenWindowsAutomatically(value bool)
	// A Boolean that indicates whether to apply site-specific compatibility workarounds.
	SiteSpecificQuirksModeEnabled() bool
	SetSiteSpecificQuirksModeEnabled(value bool)

	// A Boolean value that indicates whether the web view shows warnings for suspected fraudulent content, such as malware or phishing attemps.
	FraudulentWebsiteWarningEnabled() bool
	SetFraudulentWebsiteWarningEnabled(value bool)

	// The object that manages the preference-related settings for the web view.
	Preferences() IWKPreferences
	SetPreferences(value IWKPreferences)
	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKPreferences class.

Setting Rendering Preferences ¶

• [IWKPreferences.MinimumFontSize]: The minimum font size, in points.
• [IWKPreferences.SetMinimumFontSize]
• [IWKPreferences.ShouldPrintBackgrounds]: A Boolean value that indicates whether to include any background color or graphics when printing content.
• [IWKPreferences.SetShouldPrintBackgrounds]

Setting Behavior Preferences ¶

• [IWKPreferences.TabFocusesLinks]: A Boolean value that indicates whether pressing the tab key changes the focus to links and form controls.
• [IWKPreferences.SetTabFocusesLinks]
• [IWKPreferences.TextInteractionEnabled]: A Boolean value that indicates whether to allow people to select or otherwise interact with text.
• [IWKPreferences.SetTextInteractionEnabled]
• [IWKPreferences.ElementFullscreenEnabled]: A Boolean value that indicates whether a web view can display content full screen.
• [IWKPreferences.SetElementFullscreenEnabled]
• [IWKPreferences.InactiveSchedulingPolicy]: A policy you set to specify how a web view that’s not in a window handles tasks.
• [IWKPreferences.SetInactiveSchedulingPolicy]

Setting Java and JavaScript Preferences ¶

• [IWKPreferences.JavaScriptCanOpenWindowsAutomatically]: A Boolean value that indicates whether JavaScript can open windows without user interaction.
• [IWKPreferences.SetJavaScriptCanOpenWindowsAutomatically]
• [IWKPreferences.SiteSpecificQuirksModeEnabled]: A Boolean that indicates whether to apply site-specific compatibility workarounds.
• [IWKPreferences.SetSiteSpecificQuirksModeEnabled]

Setting Fraud Warning Preferences ¶

• [IWKPreferences.FraudulentWebsiteWarningEnabled]: A Boolean value that indicates whether the web view shows warnings for suspected fraudulent content, such as malware or phishing attemps.
• [IWKPreferences.SetFraudulentWebsiteWarningEnabled]

See: https://developer.apple.com/documentation/WebKit/WKPreferences

type IWKScriptMessage ¶

type IWKScriptMessage interface {
	objectivec.IObject

	// The body of the message.
	Body() objectivec.IObject

	// The frame that sent the message.
	FrameInfo() IWKFrameInfo
	// The web view that sent the message.
	WebView() IWKWebView
	// The namespace in which the JavaScript code executes.
	World() IWKContentWorld

	// The name of the message handler to which the message is sent.
	Name() string
}

An interface definition for the WKScriptMessage class.

Getting the Message Contents ¶

• [IWKScriptMessage.Body]: The body of the message.

Getting Message-Related Information ¶

• [IWKScriptMessage.FrameInfo]: The frame that sent the message.
• [IWKScriptMessage.WebView]: The web view that sent the message.
• [IWKScriptMessage.World]: The namespace in which the JavaScript code executes.

Getting the Message Handler’s Name ¶

• [IWKScriptMessage.Name]: The name of the message handler to which the message is sent.

See: https://developer.apple.com/documentation/WebKit/WKScriptMessage

type IWKSecurityOrigin ¶

type IWKSecurityOrigin interface {
	objectivec.IObject

	// The security origin’s host.
	Host() string
	// The security origin’s port.
	Port() int

	// The security origin’s protocol.
	Protocol() string
}

An interface definition for the WKSecurityOrigin class.

Getting the Host Information ¶

• [IWKSecurityOrigin.Host]: The security origin’s host.
• [IWKSecurityOrigin.Port]: The security origin’s port.

Getting the Host Protocol ¶

• [IWKSecurityOrigin.Protocol]: The security origin’s protocol.

See: https://developer.apple.com/documentation/WebKit/WKSecurityOrigin

type IWKSnapshotConfiguration ¶

type IWKSnapshotConfiguration interface {
	objectivec.IObject

	// The portion of your web view to capture, specified as a rectangle in the view’s coordinate system.
	Rect() corefoundation.CGRect
	SetRect(value corefoundation.CGRect)
	// The width of the captured image, in points.
	SnapshotWidth() foundation.NSNumber
	SetSnapshotWidth(value foundation.NSNumber)

	// A Boolean value that indicates whether to take the snapshot after incorporating any pending screen updates.
	AfterScreenUpdates() bool
	SetAfterScreenUpdates(value bool)
}

An interface definition for the WKSnapshotConfiguration class.

Specifying the snapshot dimensions ¶

• [IWKSnapshotConfiguration.Rect]: The portion of your web view to capture, specified as a rectangle in the view’s coordinate system.
• [IWKSnapshotConfiguration.SetRect]
• [IWKSnapshotConfiguration.SnapshotWidth]: The width of the captured image, in points.
• [IWKSnapshotConfiguration.SetSnapshotWidth]

Configuring the capture behavior ¶

• [IWKSnapshotConfiguration.AfterScreenUpdates]: A Boolean value that indicates whether to take the snapshot after incorporating any pending screen updates.
• [IWKSnapshotConfiguration.SetAfterScreenUpdates]

See: https://developer.apple.com/documentation/WebKit/WKSnapshotConfiguration

type IWKUserContentController ¶

type IWKUserContentController interface {
	objectivec.IObject

	// Injects the specified script into the webpage’s content.
	AddUserScript(userScript IWKUserScript)
	// Removes all user scripts from the web view.
	RemoveAllUserScripts()
	// The user scripts associated with the user content controller.
	UserScripts() []WKUserScript

	// Installs a message handler that you can call from your JavaScript code.
	AddScriptMessageHandlerName(scriptMessageHandler WKScriptMessageHandler, name string)
	// Installs a message handler that you can call from the specified content world in your JavaScript code.
	AddScriptMessageHandlerContentWorldName(scriptMessageHandler WKScriptMessageHandler, world IWKContentWorld, name string)
	// Installs a message handler that returns a reply to your JavaScript code.
	AddScriptMessageHandlerWithReplyContentWorldName(scriptMessageHandlerWithReply WKScriptMessageHandlerWithReply, contentWorld IWKContentWorld, name string)
	// Uninstalls the custom message handler with the specified name from your JavaScript code.
	RemoveScriptMessageHandlerForName(name string)
	// Uninstalls a custom message handler from the specified content world in your JavaScript code.
	RemoveScriptMessageHandlerForNameContentWorld(name string, contentWorld IWKContentWorld)
	// Uninstalls all custom message handlers from the specified content world in your JavaScript code.
	RemoveAllScriptMessageHandlersFromContentWorld(contentWorld IWKContentWorld)
	// Uninstalls all custom message handlers associated with the user content controller.
	RemoveAllScriptMessageHandlers()

	// Adds the specified content rule list to the content controller object.
	AddContentRuleList(contentRuleList IWKContentRuleList)
	// Removes the specified rule list from the content controller object.
	RemoveContentRuleList(contentRuleList IWKContentRuleList)
	// Removes all rules lists from the content controller.
	RemoveAllContentRuleLists()

	// The object that coordinates interactions between your app’s native code and the webpage’s scripts and other content.
	UserContentController() IWKUserContentController
	SetUserContentController(value IWKUserContentController)
	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKUserContentController class.

Adding and Removing Custom Scripts ¶

• [IWKUserContentController.AddUserScript]: Injects the specified script into the webpage’s content.
• [IWKUserContentController.RemoveAllUserScripts]: Removes all user scripts from the web view.
• [IWKUserContentController.UserScripts]: The user scripts associated with the user content controller.

Adding and Removing Message Handlers ¶

• [IWKUserContentController.AddScriptMessageHandlerName]: Installs a message handler that you can call from your JavaScript code.
• [IWKUserContentController.AddScriptMessageHandlerContentWorldName]: Installs a message handler that you can call from the specified content world in your JavaScript code.
• [IWKUserContentController.AddScriptMessageHandlerWithReplyContentWorldName]: Installs a message handler that returns a reply to your JavaScript code.
• [IWKUserContentController.RemoveScriptMessageHandlerForName]: Uninstalls the custom message handler with the specified name from your JavaScript code.
• [IWKUserContentController.RemoveScriptMessageHandlerForNameContentWorld]: Uninstalls a custom message handler from the specified content world in your JavaScript code.
• [IWKUserContentController.RemoveAllScriptMessageHandlersFromContentWorld]: Uninstalls all custom message handlers from the specified content world in your JavaScript code.
• [IWKUserContentController.RemoveAllScriptMessageHandlers]: Uninstalls all custom message handlers associated with the user content controller.

Adding and Removing Content Rules ¶

• [IWKUserContentController.AddContentRuleList]: Adds the specified content rule list to the content controller object.
• [IWKUserContentController.RemoveContentRuleList]: Removes the specified rule list from the content controller object.
• [IWKUserContentController.RemoveAllContentRuleLists]: Removes all rules lists from the content controller.

See: https://developer.apple.com/documentation/WebKit/WKUserContentController

type IWKUserScript ¶

type IWKUserScript interface {
	objectivec.IObject

	// Creates a user script object that contains the specified source code and attributes.
	InitWithSourceInjectionTimeForMainFrameOnly(source string, injectionTime WKUserScriptInjectionTime, forMainFrameOnly bool) WKUserScript
	// Creates a user script object that is scoped to a particular content world.
	InitWithSourceInjectionTimeForMainFrameOnlyInContentWorld(source string, injectionTime WKUserScriptInjectionTime, forMainFrameOnly bool, contentWorld IWKContentWorld) WKUserScript

	// The script’s source code.
	Source() string
	// The time at which to inject the script into the webpage.
	InjectionTime() WKUserScriptInjectionTime
	// A Boolean value that indicates whether to inject the script into the main frame or all frames.
	ForMainFrameOnly() bool
}

An interface definition for the WKUserScript class.

Creating a User Script Object ¶

• [IWKUserScript.InitWithSourceInjectionTimeForMainFrameOnly]: Creates a user script object that contains the specified source code and attributes.
• [IWKUserScript.InitWithSourceInjectionTimeForMainFrameOnlyInContentWorld]: Creates a user script object that is scoped to a particular content world.

Inspecting Script Information ¶

• [IWKUserScript.Source]: The script’s source code.
• [IWKUserScript.InjectionTime]: The time at which to inject the script into the webpage.
• [IWKUserScript.ForMainFrameOnly]: A Boolean value that indicates whether to inject the script into the main frame or all frames.

See: https://developer.apple.com/documentation/WebKit/WKUserScript

type IWKWebExtension ¶

type IWKWebExtension interface {
	objectivec.IObject

	// The set of websites that the extension requires access to for injected content and for receiving messages from websites.
	AllRequestedMatchPatterns() foundation.INSSet
	// The default locale for the extension.
	DefaultLocale() foundation.NSLocale
	// The default localized extension action label.
	DisplayActionLabel() string
	// The localized extension description.
	DisplayDescription() string
	// The localized extension name.
	DisplayName() string
	// The localized extension short name.
	DisplayShortName() string
	// The localized extension display version.
	DisplayVersion() string
	// An array of all errors that occurred during the processing of the extension.
	Errors() []foundation.NSError
	// A Boolean value indicating whether the extension has background content that can run when needed.
	HasBackgroundContent() bool
	// A Boolean value indicating whether the extension includes commands that users can invoke.
	HasCommands() bool
	// A Boolean value indicating whether the extension includes rules used for content modification or blocking.
	HasContentModificationRules() bool
	// A Boolean value indicating whether the extension has script or stylesheet content that can be injected into webpages.
	HasInjectedContent() bool
	// A Boolean value indicating whether the extension has an options page.
	HasOptionsPage() bool
	// A Boolean value indicating whether the extension provides an alternative to the default new tab page.
	HasOverrideNewTabPage() bool
	// A Boolean value indicating whether the extension has background content that stays in memory as long as the extension is loaded.
	HasPersistentBackgroundContent() bool
	// The parsed manifest as a dictionary.
	Manifest() foundation.INSDictionary
	// The parsed manifest version, or `0` if there is no version specified in the manifest.
	ManifestVersion() float64
	// The set of websites that the extension may need access to for optional functionality.
	OptionalPermissionMatchPatterns() foundation.INSSet
	// The set of permissions that the extension may need for optional functionality.
	OptionalPermissions() foundation.INSSet
	// The set of websites that the extension requires access to for its base functionality.
	RequestedPermissionMatchPatterns() foundation.INSSet
	// The set of permissions that the extension requires for its base functionality.
	RequestedPermissions() foundation.INSSet
	// The extension version.
	Version() string

	// Returns the default action icon for the specified size.
	ActionIconForSize(size corefoundation.CGSize) objc.ID
	// Returns the extension’s icon image for the specified size.
	IconForSize(size corefoundation.CGSize) objc.ID
	// Checks if a manifest version is supported by the extension.
	SupportsManifestVersion(manifestVersion float64) bool
}

An interface definition for the WKWebExtension class.

Instance Properties ¶

• [IWKWebExtension.AllRequestedMatchPatterns]: The set of websites that the extension requires access to for injected content and for receiving messages from websites.
• [IWKWebExtension.DefaultLocale]: The default locale for the extension.
• [IWKWebExtension.DisplayActionLabel]: The default localized extension action label.
• [IWKWebExtension.DisplayDescription]: The localized extension description.
• [IWKWebExtension.DisplayName]: The localized extension name.
• [IWKWebExtension.DisplayShortName]: The localized extension short name.
• [IWKWebExtension.DisplayVersion]: The localized extension display version.
• [IWKWebExtension.Errors]: An array of all errors that occurred during the processing of the extension.
• [IWKWebExtension.HasBackgroundContent]: A Boolean value indicating whether the extension has background content that can run when needed.
• [IWKWebExtension.HasCommands]: A Boolean value indicating whether the extension includes commands that users can invoke.
• [IWKWebExtension.HasContentModificationRules]: A Boolean value indicating whether the extension includes rules used for content modification or blocking.
• [IWKWebExtension.HasInjectedContent]: A Boolean value indicating whether the extension has script or stylesheet content that can be injected into webpages.
• [IWKWebExtension.HasOptionsPage]: A Boolean value indicating whether the extension has an options page.
• [IWKWebExtension.HasOverrideNewTabPage]: A Boolean value indicating whether the extension provides an alternative to the default new tab page.
• [IWKWebExtension.HasPersistentBackgroundContent]: A Boolean value indicating whether the extension has background content that stays in memory as long as the extension is loaded.
• [IWKWebExtension.Manifest]: The parsed manifest as a dictionary.
• [IWKWebExtension.ManifestVersion]: The parsed manifest version, or `0` if there is no version specified in the manifest.
• [IWKWebExtension.OptionalPermissionMatchPatterns]: The set of websites that the extension may need access to for optional functionality.
• [IWKWebExtension.OptionalPermissions]: The set of permissions that the extension may need for optional functionality.
• [IWKWebExtension.RequestedPermissionMatchPatterns]: The set of websites that the extension requires access to for its base functionality.
• [IWKWebExtension.RequestedPermissions]: The set of permissions that the extension requires for its base functionality.
• [IWKWebExtension.Version]: The extension version.

Instance Methods ¶

• [IWKWebExtension.ActionIconForSize]: Returns the default action icon for the specified size.
• [IWKWebExtension.IconForSize]: Returns the extension’s icon image for the specified size.
• [IWKWebExtension.SupportsManifestVersion]: Checks if a manifest version is supported by the extension.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension

type IWKWebExtensionAction ¶

type IWKWebExtensionAction interface {
	objectivec.IObject

	// The tab that this action is associated with, or `nil` if it’s the default action.
	AssociatedTab() WKWebExtensionTab
	// The badge text for the action.
	BadgeText() string
	// A Boolean value indicating whether the badge text is unread.
	HasUnreadBadgeText() bool
	SetHasUnreadBadgeText(value bool)
	// The name shown when inspecting the pop-up web view.
	InspectionName() string
	SetInspectionName(value string)
	// A Boolean value indicating whether the action is enabled.
	Enabled() bool
	// The localized display label for the action.
	Label() string
	// The menu items provided by the extension for this action.
	MenuItems() []objectivec.IObject
	// A popover that presents a web view loaded with the pop-up page for this action, or `nil` if no popup is specified.
	PopupPopover() appkit.NSPopover
	// A web view loaded with the pop-up page for this action, or `nil` if no pop-up is specified.
	PopupWebView() IWKWebView
	// A Boolean value indicating whether the action has a pop-up.
	PresentsPopup() bool
	// The extension context to which this action is related.
	WebExtensionContext() IWKWebExtensionContext

	// Triggers the dismissal process of the pop-up.
	ClosePopup()
	// Returns the action icon for the specified size.
	IconForSize(size corefoundation.CGSize) objc.ID
}

An interface definition for the WKWebExtensionAction class.

Instance Properties ¶

• [IWKWebExtensionAction.AssociatedTab]: The tab that this action is associated with, or `nil` if it’s the default action.
• [IWKWebExtensionAction.BadgeText]: The badge text for the action.
• [IWKWebExtensionAction.HasUnreadBadgeText]: A Boolean value indicating whether the badge text is unread.
• [IWKWebExtensionAction.SetHasUnreadBadgeText]
• [IWKWebExtensionAction.InspectionName]: The name shown when inspecting the pop-up web view.
• [IWKWebExtensionAction.SetInspectionName]
• [IWKWebExtensionAction.Enabled]: A Boolean value indicating whether the action is enabled.
• [IWKWebExtensionAction.Label]: The localized display label for the action.
• [IWKWebExtensionAction.MenuItems]: The menu items provided by the extension for this action.
• [IWKWebExtensionAction.PopupPopover]: A popover that presents a web view loaded with the pop-up page for this action, or `nil` if no popup is specified.
• [IWKWebExtensionAction.PopupWebView]: A web view loaded with the pop-up page for this action, or `nil` if no pop-up is specified.
• [IWKWebExtensionAction.PresentsPopup]: A Boolean value indicating whether the action has a pop-up.
• [IWKWebExtensionAction.WebExtensionContext]: The extension context to which this action is related.

Instance Methods ¶

• [IWKWebExtensionAction.ClosePopup]: Triggers the dismissal process of the pop-up.
• [IWKWebExtensionAction.IconForSize]: Returns the action icon for the specified size.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/Action

type IWKWebExtensionCommand ¶

type IWKWebExtensionCommand interface {
	objectivec.IObject

	// The primary key used to trigger the command, distinct from any modifier flags.
	ActivationKey() string
	SetActivationKey(value string)
	// A unique identifier for the command.
	Identifier() string
	// A menu item representation of the web extension command for use in menus.
	MenuItem() objectivec.IObject
	// The modifier flags used with the activation key to trigger the command.
	ModifierFlags() objectivec.IObject
	SetModifierFlags(value objectivec.IObject)
	// A descriptive title for the command to help discoverability.
	Title() string
	// The web extension context associated with the command.
	WebExtensionContext() IWKWebExtensionContext
}

An interface definition for the WKWebExtensionCommand class.

Instance Properties ¶

• [IWKWebExtensionCommand.ActivationKey]: The primary key used to trigger the command, distinct from any modifier flags.
• [IWKWebExtensionCommand.SetActivationKey]
• [IWKWebExtensionCommand.Identifier]: A unique identifier for the command.
• [IWKWebExtensionCommand.MenuItem]: A menu item representation of the web extension command for use in menus.
• [IWKWebExtensionCommand.ModifierFlags]: The modifier flags used with the activation key to trigger the command.
• [IWKWebExtensionCommand.SetModifierFlags]
• [IWKWebExtensionCommand.Title]: A descriptive title for the command to help discoverability.
• [IWKWebExtensionCommand.WebExtensionContext]: The web extension context associated with the command.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/Command

type IWKWebExtensionContext ¶

type IWKWebExtensionContext interface {
	objectivec.IObject

	// Returns a web extension context initialized with a specified extension.
	InitForExtension(extension IWKWebExtension) WKWebExtensionContext

	// The base URL the context uses for loading extension resources or injecting content into webpages.
	BaseURL() foundation.INSURL
	SetBaseURL(value foundation.INSURL)
	// The commands associated with the extension.
	Commands() []WKWebExtensionCommand
	// The currently granted permission match patterns that have not expired.
	CurrentPermissionMatchPatterns() foundation.INSSet
	// The currently granted permissions that have not expired.
	CurrentPermissions() foundation.INSSet
	// The currently denied permission match patterns and their expiration dates.
	DeniedPermissionMatchPatterns() foundation.INSDictionary
	SetDeniedPermissionMatchPatterns(value foundation.INSDictionary)
	// The currently denied permissions and their expiration dates.
	DeniedPermissions() foundation.INSDictionary
	SetDeniedPermissions(value foundation.INSDictionary)
	// All errors that occurred in the extension context.
	Errors() []foundation.NSError
	// The window that currently has focus for this extension.
	FocusedWindow() WKWebExtensionWindow
	// The currently granted permission match patterns and their expiration dates.
	GrantedPermissionMatchPatterns() foundation.INSDictionary
	SetGrantedPermissionMatchPatterns(value foundation.INSDictionary)
	// The currently granted permissions and their expiration dates.
	GrantedPermissions() foundation.INSDictionary
	SetGrantedPermissions(value foundation.INSDictionary)
	// A Boolean value indicating if the currently granted permission match patterns set contains the `<all_urls>` pattern or any `*` host patterns.
	HasAccessToAllHosts() bool
	// A Boolean value indicating if the currently granted permission match patterns set contains the `<all_urls>` pattern.
	HasAccessToAllURLs() bool
	// A Boolean value indicating if the extension has access to private data.
	HasAccessToPrivateData() bool
	SetHasAccessToPrivateData(value bool)
	// A boolean value indicating whether the extension includes rules used for content modification or blocking.
	HasContentModificationRules() bool
	// A Boolean value indicating whether the extension has script or stylesheet content that can be injected into webpages.
	HasInjectedContent() bool
	// A Boolean value indicating if the extension has requested optional access to all hosts.
	HasRequestedOptionalAccessToAllHosts() bool
	SetHasRequestedOptionalAccessToAllHosts(value bool)
	// The name shown when inspecting the background web view.
	InspectionName() string
	SetInspectionName(value string)
	// Determines whether Web Inspector can inspect the [WKWebView](<doc://com.apple.webkit/documentation/WebKit/WKWebView>) instances for this context.
	Inspectable() bool
	SetInspectable(value bool)
	// A Boolean value indicating if this context is loaded in an extension controller.
	Loaded() bool
	// A set of open tabs in all open windows that are exposed to this extension.
	OpenTabs() foundation.INSSet
	// The open windows that are exposed to this extension.
	OpenWindows() []objectivec.IObject
	// The URL of the extension’s options page, if the extension has one.
	OptionsPageURL() foundation.INSURL
	// The URL to use as an alternative to the default new tab page, if the extension has one.
	OverrideNewTabPageURL() foundation.INSURL
	// A unique identifier used to distinguish the extension from other extensions and target it for messages.
	UniqueIdentifier() string
	SetUniqueIdentifier(value string)
	// Specifies unsupported APIs for this extension, making them `undefined` in JavaScript.
	UnsupportedAPIs() foundation.INSSet
	SetUnsupportedAPIs(value foundation.INSSet)
	// The extension this context represents.
	WebExtension() IWKWebExtension
	// The extension controller this context is loaded in, otherwise `nil` if it isn’t loaded.
	WebExtensionController() IWKWebExtensionController
	// The web view configuration to use for web views that load pages from this extension.
	WebViewConfiguration() IWKWebViewConfiguration

	// Retrieves the extension action for a given tab, or the default action if `nil` is passed.
	ActionForTab(tab WKWebExtensionTab) IWKWebExtensionAction
	// Called by the app to clear a user gesture in a specific tab.
	ClearUserGestureInTab(tab WKWebExtensionTab)
	// Retrieves the command associated with the given event without performing it.
	CommandForEvent(event appkit.NSEvent) IWKWebExtensionCommand
	// Called by the app when the properties of a tab are changed to fire appropriate events with only this extension.
	DidChangeTabPropertiesForTab(properties WKWebExtensionTabChangedProperties, changedTab WKWebExtensionTab)
	// Called by the app when a window is closed to fire appropriate events with only this extension.
	DidCloseWindow(closedWindow WKWebExtensionWindow)
	// Called by the app when tabs are deselected to fire appropriate events with only this extension.
	DidDeselectTabs(deselectedTabs []objectivec.IObject)
	// Called by the app when a window gains focus to fire appropriate events with only this extension.
	DidFocusWindow(focusedWindow WKWebExtensionWindow)
	// Called by the app when a new tab is opened to fire appropriate events with only this extension.
	DidOpenTab(newTab WKWebExtensionTab)
	// Called by the app when a new window is opened to fire appropriate events with only this extension.
	DidOpenWindow(newWindow WKWebExtensionWindow)
	// Called by the app when a tab is replaced by another tab to fire appropriate events with only this extension.
	DidReplaceTabWithTab(oldTab WKWebExtensionTab, newTab WKWebExtensionTab)
	// Called by the app when tabs are selected to fire appropriate events with only this extension.
	DidSelectTabs(selectedTabs []objectivec.IObject)
	// Checks the specified URL against the currently granted permission match patterns.
	HasAccessToURL(url foundation.INSURL) bool
	// Checks the specified URL against the currently granted permission match patterns in a specific tab.
	HasAccessToURLInTab(url foundation.INSURL, tab WKWebExtensionTab) bool
	// Indicates if a user gesture is currently active in the specified tab.
	HasActiveUserGestureInTab(tab WKWebExtensionTab) bool
	// Checks if the extension has script or stylesheet content that can be injected into the specified URL.
	HasInjectedContentForURL(url foundation.INSURL) bool
	// Checks the specified permission against the currently granted permissions.
	HasPermission(permission WKWebExtensionPermission) bool
	// Checks the specified permission against the currently granted permissions in a specific tab.
	HasPermissionInTab(permission WKWebExtensionPermission, tab WKWebExtensionTab) bool
	// Loads the background content if needed for the extension.
	LoadBackgroundContentWithCompletionHandler(completionHandler ErrorHandler)
	// Retrieves the menu items for a given tab.
	MenuItemsForTab(tab WKWebExtensionTab) []objectivec.IObject
	// Performs the extension action associated with the specified tab or performs the default action if `nil` is passed.
	PerformActionForTab(tab WKWebExtensionTab)
	// Performs the specified command, triggering events specific to this extension.
	PerformCommand(command IWKWebExtensionCommand)
	// Performs the command associated with the given event.
	PerformCommandForEvent(event appkit.NSEvent) bool
	// Checks the specified permission against the currently denied, granted, and requested permissions.
	PermissionStatusForPermission(permission WKWebExtensionPermission) WKWebExtensionContextPermissionStatus
	// Checks the specified match pattern against the currently denied, granted, and requested permission match patterns.
	PermissionStatusForMatchPattern(pattern IWKWebExtensionMatchPattern) WKWebExtensionContextPermissionStatus
	// Checks the specified URL against the currently denied, granted, and requested permission match patterns.
	PermissionStatusForURL(url foundation.INSURL) WKWebExtensionContextPermissionStatus
	// Checks the specified permission against the currently denied, granted, and requested permissions.
	PermissionStatusForPermissionInTab(permission WKWebExtensionPermission, tab WKWebExtensionTab) WKWebExtensionContextPermissionStatus
	// Checks the specified URL against the currently denied, granted, and requested permission match patterns.
	PermissionStatusForURLInTab(url foundation.INSURL, tab WKWebExtensionTab) WKWebExtensionContextPermissionStatus
	// Checks the specified match pattern against the currently denied, granted, and requested permission match patterns.
	PermissionStatusForMatchPatternInTab(pattern IWKWebExtensionMatchPattern, tab WKWebExtensionTab) WKWebExtensionContextPermissionStatus
	// Sets the status of a permission with a distant future expiration date.
	SetPermissionStatusForPermission(status WKWebExtensionContextPermissionStatus, permission WKWebExtensionPermission)
	// Sets the permission status of a URL with a distant future expiration date.
	SetPermissionStatusForURL(status WKWebExtensionContextPermissionStatus, url foundation.INSURL)
	// Sets the status of a match pattern with a distant future expiration date.
	SetPermissionStatusForMatchPattern(status WKWebExtensionContextPermissionStatus, pattern IWKWebExtensionMatchPattern)
	// Sets the permission status of a URL with a distant future expiration date.
	SetPermissionStatusForURLExpirationDate(status WKWebExtensionContextPermissionStatus, url foundation.INSURL, expirationDate foundation.INSDate)
	// Sets the status of a permission with a specific expiration date.
	SetPermissionStatusForPermissionExpirationDate(status WKWebExtensionContextPermissionStatus, permission WKWebExtensionPermission, expirationDate foundation.INSDate)
	// Sets the status of a match pattern with a specific expiration date.
	SetPermissionStatusForMatchPatternExpirationDate(status WKWebExtensionContextPermissionStatus, pattern IWKWebExtensionMatchPattern, expirationDate foundation.INSDate)
	// Should be called by the app when a user gesture is performed in a specific tab.
	UserGesturePerformedInTab(tab WKWebExtensionTab)

	// Called by the app when a tab is activated to notify only this specific extension.
	DidActivateTabPreviousActiveTab(activatedTab WKWebExtensionTab, previousTab WKWebExtensionTab)
	// Called by the app when a tab is closed to fire appropriate events with only this extension.
	DidCloseTabWindowIsClosing(closedTab WKWebExtensionTab, windowIsClosing bool)
	// Called by the app when a tab is moved to fire appropriate events with only this extension.
	DidMoveTabFromIndexInWindow(movedTab WKWebExtensionTab, index uint, oldWindow WKWebExtensionWindow)
}

An interface definition for the WKWebExtensionContext class.

Initializers ¶

• [IWKWebExtensionContext.InitForExtension]: Returns a web extension context initialized with a specified extension.

Instance Properties ¶

• [IWKWebExtensionContext.BaseURL]: The base URL the context uses for loading extension resources or injecting content into webpages.
• [IWKWebExtensionContext.SetBaseURL]
• [IWKWebExtensionContext.Commands]: The commands associated with the extension.
• [IWKWebExtensionContext.CurrentPermissionMatchPatterns]: The currently granted permission match patterns that have not expired.
• [IWKWebExtensionContext.CurrentPermissions]: The currently granted permissions that have not expired.
• [IWKWebExtensionContext.DeniedPermissionMatchPatterns]: The currently denied permission match patterns and their expiration dates.
• [IWKWebExtensionContext.SetDeniedPermissionMatchPatterns]
• [IWKWebExtensionContext.DeniedPermissions]: The currently denied permissions and their expiration dates.
• [IWKWebExtensionContext.SetDeniedPermissions]
• [IWKWebExtensionContext.Errors]: All errors that occurred in the extension context.
• [IWKWebExtensionContext.FocusedWindow]: The window that currently has focus for this extension.
• [IWKWebExtensionContext.GrantedPermissionMatchPatterns]: The currently granted permission match patterns and their expiration dates.
• [IWKWebExtensionContext.SetGrantedPermissionMatchPatterns]
• [IWKWebExtensionContext.GrantedPermissions]: The currently granted permissions and their expiration dates.
• [IWKWebExtensionContext.SetGrantedPermissions]
• [IWKWebExtensionContext.HasAccessToAllHosts]: A Boolean value indicating if the currently granted permission match patterns set contains the `<all_urls>` pattern or any `*` host patterns.
• [IWKWebExtensionContext.HasAccessToAllURLs]: A Boolean value indicating if the currently granted permission match patterns set contains the `<all_urls>` pattern.
• [IWKWebExtensionContext.HasAccessToPrivateData]: A Boolean value indicating if the extension has access to private data.
• [IWKWebExtensionContext.SetHasAccessToPrivateData]
• [IWKWebExtensionContext.HasContentModificationRules]: A boolean value indicating whether the extension includes rules used for content modification or blocking.
• [IWKWebExtensionContext.HasInjectedContent]: A Boolean value indicating whether the extension has script or stylesheet content that can be injected into webpages.
• [IWKWebExtensionContext.HasRequestedOptionalAccessToAllHosts]: A Boolean value indicating if the extension has requested optional access to all hosts.
• [IWKWebExtensionContext.SetHasRequestedOptionalAccessToAllHosts]
• [IWKWebExtensionContext.InspectionName]: The name shown when inspecting the background web view.
• [IWKWebExtensionContext.SetInspectionName]
• [IWKWebExtensionContext.Inspectable]: Determines whether Web Inspector can inspect the WKWebView(<doc://com.apple.webkit/documentation/WebKit/WKWebView>) instances for this context.
• [IWKWebExtensionContext.SetInspectable]
• [IWKWebExtensionContext.Loaded]: A Boolean value indicating if this context is loaded in an extension controller.
• [IWKWebExtensionContext.OpenTabs]: A set of open tabs in all open windows that are exposed to this extension.
• [IWKWebExtensionContext.OpenWindows]: The open windows that are exposed to this extension.
• [IWKWebExtensionContext.OptionsPageURL]: The URL of the extension’s options page, if the extension has one.
• [IWKWebExtensionContext.OverrideNewTabPageURL]: The URL to use as an alternative to the default new tab page, if the extension has one.
• [IWKWebExtensionContext.UniqueIdentifier]: A unique identifier used to distinguish the extension from other extensions and target it for messages.
• [IWKWebExtensionContext.SetUniqueIdentifier]
• [IWKWebExtensionContext.UnsupportedAPIs]: Specifies unsupported APIs for this extension, making them `undefined` in JavaScript.
• [IWKWebExtensionContext.SetUnsupportedAPIs]
• [IWKWebExtensionContext.WebExtension]: The extension this context represents.
• [IWKWebExtensionContext.WebExtensionController]: The extension controller this context is loaded in, otherwise `nil` if it isn’t loaded.
• [IWKWebExtensionContext.WebViewConfiguration]: The web view configuration to use for web views that load pages from this extension.

Instance Methods ¶

• [IWKWebExtensionContext.ActionForTab]: Retrieves the extension action for a given tab, or the default action if `nil` is passed.
• [IWKWebExtensionContext.ClearUserGestureInTab]: Called by the app to clear a user gesture in a specific tab.
• [IWKWebExtensionContext.CommandForEvent]: Retrieves the command associated with the given event without performing it.
• [IWKWebExtensionContext.DidChangeTabPropertiesForTab]: Called by the app when the properties of a tab are changed to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidCloseWindow]: Called by the app when a window is closed to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidDeselectTabs]: Called by the app when tabs are deselected to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidFocusWindow]: Called by the app when a window gains focus to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidOpenTab]: Called by the app when a new tab is opened to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidOpenWindow]: Called by the app when a new window is opened to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidReplaceTabWithTab]: Called by the app when a tab is replaced by another tab to fire appropriate events with only this extension.
• [IWKWebExtensionContext.DidSelectTabs]: Called by the app when tabs are selected to fire appropriate events with only this extension.
• [IWKWebExtensionContext.HasAccessToURL]: Checks the specified URL against the currently granted permission match patterns.
• [IWKWebExtensionContext.HasAccessToURLInTab]: Checks the specified URL against the currently granted permission match patterns in a specific tab.
• [IWKWebExtensionContext.HasActiveUserGestureInTab]: Indicates if a user gesture is currently active in the specified tab.
• [IWKWebExtensionContext.HasInjectedContentForURL]: Checks if the extension has script or stylesheet content that can be injected into the specified URL.
• [IWKWebExtensionContext.HasPermission]: Checks the specified permission against the currently granted permissions.
• [IWKWebExtensionContext.HasPermissionInTab]: Checks the specified permission against the currently granted permissions in a specific tab.
• [IWKWebExtensionContext.LoadBackgroundContentWithCompletionHandler]: Loads the background content if needed for the extension.
• [IWKWebExtensionContext.MenuItemsForTab]: Retrieves the menu items for a given tab.
• [IWKWebExtensionContext.PerformActionForTab]: Performs the extension action associated with the specified tab or performs the default action if `nil` is passed.
• [IWKWebExtensionContext.PerformCommand]: Performs the specified command, triggering events specific to this extension.
• [IWKWebExtensionContext.PerformCommandForEvent]: Performs the command associated with the given event.
• [IWKWebExtensionContext.PermissionStatusForPermission]: Checks the specified permission against the currently denied, granted, and requested permissions.
• [IWKWebExtensionContext.PermissionStatusForMatchPattern]: Checks the specified match pattern against the currently denied, granted, and requested permission match patterns.
• [IWKWebExtensionContext.PermissionStatusForURL]: Checks the specified URL against the currently denied, granted, and requested permission match patterns.
• [IWKWebExtensionContext.PermissionStatusForPermissionInTab]: Checks the specified permission against the currently denied, granted, and requested permissions.
• [IWKWebExtensionContext.PermissionStatusForURLInTab]: Checks the specified URL against the currently denied, granted, and requested permission match patterns.
• [IWKWebExtensionContext.PermissionStatusForMatchPatternInTab]: Checks the specified match pattern against the currently denied, granted, and requested permission match patterns.
• [IWKWebExtensionContext.SetPermissionStatusForPermission]: Sets the status of a permission with a distant future expiration date.
• [IWKWebExtensionContext.SetPermissionStatusForURL]: Sets the permission status of a URL with a distant future expiration date.
• [IWKWebExtensionContext.SetPermissionStatusForMatchPattern]: Sets the status of a match pattern with a distant future expiration date.
• [IWKWebExtensionContext.SetPermissionStatusForURLExpirationDate]: Sets the permission status of a URL with a distant future expiration date.
• [IWKWebExtensionContext.SetPermissionStatusForPermissionExpirationDate]: Sets the status of a permission with a specific expiration date.
• [IWKWebExtensionContext.SetPermissionStatusForMatchPatternExpirationDate]: Sets the status of a match pattern with a specific expiration date.
• [IWKWebExtensionContext.UserGesturePerformedInTab]: Should be called by the app when a user gesture is performed in a specific tab.

See: https://developer.apple.com/documentation/WebKit/WKWebExtensionContext

type IWKWebExtensionController ¶

type IWKWebExtensionController interface {
	objectivec.IObject

	// Returns a web extension controller initialized with the specified configuration.
	InitWithConfiguration(configuration IWKWebExtensionControllerConfiguration) WKWebExtensionController

	// A copy of the configuration with which the web extension controller was initialized.
	Configuration() IWKWebExtensionControllerConfiguration
	// The extension controller delegate.
	Delegate() WKWebExtensionControllerDelegate
	SetDelegate(value WKWebExtensionControllerDelegate)
	// A set of all the currently loaded extension contexts.
	ExtensionContexts() foundation.INSSet
	// A set of all the currently loaded extensions.
	Extensions() foundation.INSSet

	// Should be called by the app when the properties of a tab are changed to fire appropriate events with all loaded web extensions.
	DidChangeTabPropertiesForTab(properties WKWebExtensionTabChangedProperties, changedTab WKWebExtensionTab)
	// Should be called by the app when a window is closed to fire appropriate events with all loaded web extensions.
	DidCloseWindow(closedWindow WKWebExtensionWindow)
	// Should be called by the app when tabs are deselected to fire appropriate events with all loaded web extensions.
	DidDeselectTabs(deselectedTabs []objectivec.IObject)
	// Should be called by the app when a window gains focus to fire appropriate events with all loaded web extensions.
	DidFocusWindow(focusedWindow WKWebExtensionWindow)
	// Should be called by the app when a new tab is opened to fire appropriate events with all loaded web extensions.
	DidOpenTab(newTab WKWebExtensionTab)
	// Should be called by the app when a new window is opened to fire appropriate events with all loaded web extensions.
	DidOpenWindow(newWindow WKWebExtensionWindow)
	// Should be called by the app when a tab is replaced by another tab to fire appropriate events with all loaded web extensions.
	DidReplaceTabWithTab(oldTab WKWebExtensionTab, newTab WKWebExtensionTab)
	// Should be called by the app when tabs are selected to fire appropriate events with all loaded web extensions.
	DidSelectTabs(selectedTabs []objectivec.IObject)
	// Returns a loaded extension context matching the specified URL.
	ExtensionContextForURL(URL foundation.INSURL) IWKWebExtensionContext
	// Returns a loaded extension context for the specified extension.
	ExtensionContextForExtension(extension IWKWebExtension) IWKWebExtensionContext
	// Fetches a data record containing the given extension data types for a specific known web extension context.
	FetchDataRecordOfTypesForExtensionContextCompletionHandler(dataTypes foundation.INSSet, extensionContext IWKWebExtensionContext, completionHandler WKWebExtensionDataRecordHandler)
	// Loads the specified extension context.
	LoadExtensionContextError(extensionContext IWKWebExtensionContext) (bool, error)
	// Removes extension data of the given types for the given data records.
	RemoveDataOfTypesFromDataRecordsCompletionHandler(dataTypes foundation.INSSet, dataRecords []WKWebExtensionDataRecord, completionHandler VoidHandler)
	// Unloads the specified extension context.
	UnloadExtensionContextError(extensionContext IWKWebExtensionContext) (bool, error)

	WebExtensionController() IWKWebExtensionController
	SetWebExtensionController(value IWKWebExtensionController)
	// Should be called by the app when a tab is activated to notify all loaded web extensions.
	DidActivateTabPreviousActiveTab(activatedTab WKWebExtensionTab, previousTab WKWebExtensionTab)
	// Should be called by the app when a tab is closed to fire appropriate events with all loaded web extensions.
	DidCloseTabWindowIsClosing(closedTab WKWebExtensionTab, windowIsClosing bool)
	// Should be called by the app when a tab is moved to fire appropriate events with all loaded web extensions.
	DidMoveTabFromIndexInWindow(movedTab WKWebExtensionTab, index uint, oldWindow WKWebExtensionWindow)
}

An interface definition for the WKWebExtensionController class.

Initializers ¶

• [IWKWebExtensionController.InitWithConfiguration]: Returns a web extension controller initialized with the specified configuration.

Instance Properties ¶

• [IWKWebExtensionController.Configuration]: A copy of the configuration with which the web extension controller was initialized.
• [IWKWebExtensionController.Delegate]: The extension controller delegate.
• [IWKWebExtensionController.SetDelegate]
• [IWKWebExtensionController.ExtensionContexts]: A set of all the currently loaded extension contexts.
• [IWKWebExtensionController.Extensions]: A set of all the currently loaded extensions.

Instance Methods ¶

• [IWKWebExtensionController.DidChangeTabPropertiesForTab]: Should be called by the app when the properties of a tab are changed to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidCloseWindow]: Should be called by the app when a window is closed to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidDeselectTabs]: Should be called by the app when tabs are deselected to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidFocusWindow]: Should be called by the app when a window gains focus to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidOpenTab]: Should be called by the app when a new tab is opened to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidOpenWindow]: Should be called by the app when a new window is opened to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidReplaceTabWithTab]: Should be called by the app when a tab is replaced by another tab to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.DidSelectTabs]: Should be called by the app when tabs are selected to fire appropriate events with all loaded web extensions.
• [IWKWebExtensionController.ExtensionContextForURL]: Returns a loaded extension context matching the specified URL.
• [IWKWebExtensionController.ExtensionContextForExtension]: Returns a loaded extension context for the specified extension.
• [IWKWebExtensionController.FetchDataRecordOfTypesForExtensionContextCompletionHandler]: Fetches a data record containing the given extension data types for a specific known web extension context.
• [IWKWebExtensionController.LoadExtensionContextError]: Loads the specified extension context.
• [IWKWebExtensionController.RemoveDataOfTypesFromDataRecordsCompletionHandler]: Removes extension data of the given types for the given data records.
• [IWKWebExtensionController.UnloadExtensionContextError]: Unloads the specified extension context.

See: https://developer.apple.com/documentation/WebKit/WKWebExtensionController

type IWKWebExtensionControllerConfiguration ¶

type IWKWebExtensionControllerConfiguration interface {
	objectivec.IObject

	// The default data store for website data and cookie access in extension contexts.
	DefaultWebsiteDataStore() IWKWebsiteDataStore
	SetDefaultWebsiteDataStore(value IWKWebsiteDataStore)
	// The unique identifier used for persistent configuration storage, or `nil` when it is the default or not persistent.
	Identifier() foundation.NSUUID
	// A Boolean value indicating if this context will write data to the the file system.
	Persistent() bool
	// The web view configuration to be used as a basis for configuring web views in extension contexts.
	WebViewConfiguration() IWKWebViewConfiguration
	SetWebViewConfiguration(value IWKWebViewConfiguration)

	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKWebExtensionControllerConfiguration class.

Instance Properties ¶

• [IWKWebExtensionControllerConfiguration.DefaultWebsiteDataStore]: The default data store for website data and cookie access in extension contexts.
• [IWKWebExtensionControllerConfiguration.SetDefaultWebsiteDataStore]
• [IWKWebExtensionControllerConfiguration.Identifier]: The unique identifier used for persistent configuration storage, or `nil` when it is the default or not persistent.
• [IWKWebExtensionControllerConfiguration.Persistent]: A Boolean value indicating if this context will write data to the the file system.
• [IWKWebExtensionControllerConfiguration.WebViewConfiguration]: The web view configuration to be used as a basis for configuring web views in extension contexts.
• [IWKWebExtensionControllerConfiguration.SetWebViewConfiguration]

See: https://developer.apple.com/documentation/WebKit/WKWebExtensionController/Configuration-swift.class

type IWKWebExtensionDataRecord ¶

type IWKWebExtensionDataRecord interface {
	objectivec.IObject

	// The set of data types contained in this data record.
	ContainedDataTypes() foundation.INSSet
	// The display name for the web extension to which this data record belongs.
	DisplayName() string
	// An array of errors that may have occurred when either calculating or deleting storage.
	Errors() []foundation.NSError
	// The total size in bytes of all data types contained in this data record.
	TotalSizeInBytes() uint
	// Unique identifier for the web extension context to which this data record belongs.
	UniqueIdentifier() string

	// Retrieves the size in bytes of the specific data types in this data record.
	SizeInBytesOfTypes(dataTypes foundation.INSSet) uint
}

An interface definition for the WKWebExtensionDataRecord class.

Instance Properties ¶

• [IWKWebExtensionDataRecord.ContainedDataTypes]: The set of data types contained in this data record.
• [IWKWebExtensionDataRecord.DisplayName]: The display name for the web extension to which this data record belongs.
• [IWKWebExtensionDataRecord.Errors]: An array of errors that may have occurred when either calculating or deleting storage.
• [IWKWebExtensionDataRecord.TotalSizeInBytes]: The total size in bytes of all data types contained in this data record.
• [IWKWebExtensionDataRecord.UniqueIdentifier]: Unique identifier for the web extension context to which this data record belongs.

Instance Methods ¶

• [IWKWebExtensionDataRecord.SizeInBytesOfTypes]: Retrieves the size in bytes of the specific data types in this data record.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/DataRecord

type IWKWebExtensionMatchPattern ¶

type IWKWebExtensionMatchPattern interface {
	objectivec.IObject

	// Returns a pattern object for the specified scheme, host, and path strings.
	InitWithSchemeHostPathError(scheme string, host string, path string) (WKWebExtensionMatchPattern, error)
	// Returns a pattern object for the specified pattern string.
	InitWithStringError(string_ string) (WKWebExtensionMatchPattern, error)

	// The host part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
	Host() string
	// A Boolean value that indicates if the pattern is `<all_urls>` or has `*` as the host.
	MatchesAllHosts() bool
	// A Boolean value that indicates if the pattern is `<all_urls>`.
	MatchesAllURLs() bool
	// The path part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
	Path() string
	// The scheme part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
	Scheme() string
	// The original pattern string.
	String() string

	// Matches the receiver pattern against the specified URL.
	MatchesURL(url foundation.INSURL) bool
	// Matches the receiver pattern against the specified pattern.
	MatchesPattern(pattern IWKWebExtensionMatchPattern) bool
	// Matches the receiver pattern against the specified URL with options.
	MatchesURLOptions(url foundation.INSURL, options WKWebExtensionMatchPatternOptions) bool
	// Matches the receiver pattern against the specified pattern with options.
	MatchesPatternOptions(pattern IWKWebExtensionMatchPattern, options WKWebExtensionMatchPatternOptions) bool

	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKWebExtensionMatchPattern class.

Initializers ¶

• [IWKWebExtensionMatchPattern.InitWithSchemeHostPathError]: Returns a pattern object for the specified scheme, host, and path strings.
• [IWKWebExtensionMatchPattern.InitWithStringError]: Returns a pattern object for the specified pattern string.

Instance Properties ¶

• [IWKWebExtensionMatchPattern.Host]: The host part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
• [IWKWebExtensionMatchPattern.MatchesAllHosts]: A Boolean value that indicates if the pattern is `<all_urls>` or has `*` as the host.
• [IWKWebExtensionMatchPattern.MatchesAllURLs]: A Boolean value that indicates if the pattern is `<all_urls>`.
• [IWKWebExtensionMatchPattern.Path]: The path part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
• [IWKWebExtensionMatchPattern.Scheme]: The scheme part of the pattern string, unless [matchesAllURLs](<doc://com.apple.webkit/documentation/WebKit/WKWebExtension/MatchPattern/matchesAllURLs>) is [YES].
• [IWKWebExtensionMatchPattern.String]: The original pattern string.

Instance Methods ¶

• [IWKWebExtensionMatchPattern.MatchesURL]: Matches the receiver pattern against the specified URL.
• [IWKWebExtensionMatchPattern.MatchesPattern]: Matches the receiver pattern against the specified pattern.
• [IWKWebExtensionMatchPattern.MatchesURLOptions]: Matches the receiver pattern against the specified URL with options.
• [IWKWebExtensionMatchPattern.MatchesPatternOptions]: Matches the receiver pattern against the specified pattern with options.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/MatchPattern

type IWKWebExtensionMessagePort ¶

type IWKWebExtensionMessagePort interface {
	objectivec.IObject

	// The unique identifier for the app to which this port should be connected.
	ApplicationIdentifier() string
	// The block to be executed when the port disconnects.
	DisconnectHandler() ErrorHandler
	SetDisconnectHandler(value ErrorHandler)
	// Indicates whether the message port is disconnected.
	Disconnected() bool
	// The block to be executed when a message is received from the web extension.
	MessageHandler() ObjectErrorHandler
	SetMessageHandler(value ObjectErrorHandler)

	// Disconnects the port, terminating all further messages.
	Disconnect()
	// Disconnects the port, terminating all further messages with an optional error.
	DisconnectWithError(error_ foundation.INSError)
	// Sends a message to the connected web extension.
	SendMessageCompletionHandler(message objectivec.IObject, completionHandler ErrorHandler)
}

An interface definition for the WKWebExtensionMessagePort class.

Instance Properties ¶

• [IWKWebExtensionMessagePort.ApplicationIdentifier]: The unique identifier for the app to which this port should be connected.
• [IWKWebExtensionMessagePort.DisconnectHandler]: The block to be executed when the port disconnects.
• [IWKWebExtensionMessagePort.SetDisconnectHandler]
• [IWKWebExtensionMessagePort.Disconnected]: Indicates whether the message port is disconnected.
• [IWKWebExtensionMessagePort.MessageHandler]: The block to be executed when a message is received from the web extension.
• [IWKWebExtensionMessagePort.SetMessageHandler]

Instance Methods ¶

• [IWKWebExtensionMessagePort.Disconnect]: Disconnects the port, terminating all further messages.
• [IWKWebExtensionMessagePort.DisconnectWithError]: Disconnects the port, terminating all further messages with an optional error.
• [IWKWebExtensionMessagePort.SendMessageCompletionHandler]: Sends a message to the connected web extension.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/MessagePort

type IWKWebExtensionTabConfiguration ¶

type IWKWebExtensionTabConfiguration interface {
	objectivec.IObject

	// Indicates the position where the tab should be opened within the window.
	Index() int
	SetIndex(value int)
	// Indicates the parent tab with which the tab should be related.
	ParentTab() WKWebExtensionTab
	// Indicates whether the tab should be added to the current tab selection.
	ShouldAddToSelection() bool
	// Indicates whether the tab should be the active tab.
	ShouldBeActive() bool
	// Indicates whether the tab should be muted.
	ShouldBeMuted() bool
	// Indicates whether the tab should be pinned.
	ShouldBePinned() bool
	// Indicates whether reader mode in the tab should be active.
	ShouldReaderModeBeActive() bool
	// Indicates the initial URL for the tab.
	Url() foundation.INSURL
	// Indicates the window where the tab should be opened.
	Window() WKWebExtensionWindow
}

An interface definition for the WKWebExtensionTabConfiguration class.

Instance Properties ¶

• [IWKWebExtensionTabConfiguration.Index]: Indicates the position where the tab should be opened within the window.
• [IWKWebExtensionTabConfiguration.SetIndex]
• [IWKWebExtensionTabConfiguration.ParentTab]: Indicates the parent tab with which the tab should be related.
• [IWKWebExtensionTabConfiguration.ShouldAddToSelection]: Indicates whether the tab should be added to the current tab selection.
• [IWKWebExtensionTabConfiguration.ShouldBeActive]: Indicates whether the tab should be the active tab.
• [IWKWebExtensionTabConfiguration.ShouldBeMuted]: Indicates whether the tab should be muted.
• [IWKWebExtensionTabConfiguration.ShouldBePinned]: Indicates whether the tab should be pinned.
• [IWKWebExtensionTabConfiguration.ShouldReaderModeBeActive]: Indicates whether reader mode in the tab should be active.
• [IWKWebExtensionTabConfiguration.Url]: Indicates the initial URL for the tab.
• [IWKWebExtensionTabConfiguration.Window]: Indicates the window where the tab should be opened.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/TabConfiguration

type IWKWebExtensionWindowConfiguration ¶

type IWKWebExtensionWindowConfiguration interface {
	objectivec.IObject

	// Indicates the frame where the window should be positioned on the main screen.
	Frame() corefoundation.CGRect
	// Indicates whether the window should be focused.
	ShouldBeFocused() bool
	// Indicates whether the window should be private.
	ShouldBePrivate() bool
	// Indicates the URLs that the window should initially load as tabs.
	TabURLs() []foundation.NSURL
	// Indicates the existing tabs that should be moved to the window.
	Tabs() []objectivec.IObject
	// Indicates the window state for the window.
	WindowState() WKWebExtensionWindowState
	// Indicates the window type for the window.
	WindowType() WKWebExtensionWindowType
}

An interface definition for the WKWebExtensionWindowConfiguration class.

Instance Properties ¶

• [IWKWebExtensionWindowConfiguration.Frame]: Indicates the frame where the window should be positioned on the main screen.
• [IWKWebExtensionWindowConfiguration.ShouldBeFocused]: Indicates whether the window should be focused.
• [IWKWebExtensionWindowConfiguration.ShouldBePrivate]: Indicates whether the window should be private.
• [IWKWebExtensionWindowConfiguration.TabURLs]: Indicates the URLs that the window should initially load as tabs.
• [IWKWebExtensionWindowConfiguration.Tabs]: Indicates the existing tabs that should be moved to the window.
• [IWKWebExtensionWindowConfiguration.WindowState]: Indicates the window state for the window.
• [IWKWebExtensionWindowConfiguration.WindowType]: Indicates the window type for the window.

See: https://developer.apple.com/documentation/WebKit/WKWebExtension/WindowConfiguration

type IWKWebView ¶

type IWKWebView interface {
	appkit.INSView

	// Creates a web view and initializes it with the specified frame and configuration data.
	InitWithFrameConfiguration(frame corefoundation.CGRect, configuration IWKWebViewConfiguration) WKWebView
	// The object that contains the configuration details for the web view.
	Configuration() IWKWebViewConfiguration

	// The object you use to integrate custom user interface elements, such as contextual menus or panels, into web view interactions.
	UIDelegate() WKUIDelegate
	SetUIDelegate(value WKUIDelegate)

	// The object you use to manage navigation behavior for the web view.
	NavigationDelegate() WKNavigationDelegate
	SetNavigationDelegate(value WKNavigationDelegate)

	// Loads the web content that the specified URL request object references and navigates to that content.
	LoadRequest(request foundation.NSURLRequest) IWKNavigation
	// Loads the content of the specified data object and navigates to it.
	LoadDataMIMETypeCharacterEncodingNameBaseURL(data foundation.INSData, MIMEType string, characterEncodingName string, baseURL foundation.INSURL) IWKNavigation
	// Loads the contents of the specified HTML string and navigates to it.
	LoadHTMLStringBaseURL(string_ string, baseURL foundation.INSURL) IWKNavigation
	// Loads the web content from the file the URL request object specifies and navigates to that content.
	LoadFileRequestAllowingReadAccessToURL(request foundation.NSURLRequest, readAccessURL foundation.INSURL) IWKNavigation
	// Loads the web content from the specified file and navigates to it.
	LoadFileURLAllowingReadAccessToURL(URL foundation.INSURL, readAccessURL foundation.INSURL) IWKNavigation
	// Loads the web content from the data you provide as if the data were the response to the request.
	LoadSimulatedRequestResponseResponseData(request foundation.NSURLRequest, response foundation.NSURLResponse, data foundation.INSData) IWKNavigation
	// Loads the web content from the HTML you provide as if the HTML were the response to the request.
	LoadSimulatedRequestResponseHTMLString(request foundation.NSURLRequest, string_ string) IWKNavigation
	// A Boolean value that indicates whether the view is currently loading content.
	Loading() bool
	// An estimate of what fraction of the current navigation has been loaded.
	EstimatedProgress() float64

	// Reloads the current webpage.
	Reload() IWKNavigation
	// Reloads the current webpage.
	ReloadWithSender(sender objectivec.IObject)
	// Reloads the current webpage, and performs end-to-end revalidation of the content using cache-validating conditionals, if possible.
	ReloadFromOrigin() IWKNavigation
	// Reloads the current webpage, and performs end-to-end revalidation of the content using cache-validating conditionals, if possible.
	ReloadFromOriginWithSender(sender objectivec.IObject)
	// Stops loading all resources on the current page.
	StopLoading()
	// Stops loading all resources on the current page.
	StopLoadingWithSender(sender objectivec.IObject)

	// Starts to download the resource at the URL in the request.
	StartDownloadUsingRequestCompletionHandler(request foundation.NSURLRequest, completionHandler WKDownloadHandler)
	// Resumes a failed or canceled download.
	ResumeDownloadFromResumeDataCompletionHandler(resumeData foundation.INSData, completionHandler WKDownloadHandler)

	// A Boolean value that indicates whether you can inspect the view with Safari Web Inspector.
	Inspectable() bool
	SetInspectable(value bool)

	// The page title.
	Title() string
	// The URL for the current webpage.
	URL() foundation.INSURL
	// The media type for the contents of the web view.
	MediaType() string
	SetMediaType(value string)
	// The custom user agent string.
	CustomUserAgent() string
	SetCustomUserAgent(value string)
	// The trust management object you use to evaluate trust for the current webpage.
	ServerTrust() security.SecTrustRef
	// A Boolean value that indicates whether the web view loaded all resources on the page through securely encrypted connections.
	HasOnlySecureContent() bool
	// The theme color that the system gets from the first valid meta tag in the webpage.
	ThemeColor() objc.ID
	// The color the web view displays behind the active page, visible when the user scrolls beyond the bounds of the page.
	UnderPageBackgroundColor() objc.ID
	SetUnderPageBackgroundColor(value objc.ID)

	// The scale factor by which the web view scales content relative to its bounds.
	PageZoom() float64
	SetPageZoom(value float64)
	// A Boolean value that indicates whether magnify gestures change the web view’s magnification.
	AllowsMagnification() bool
	SetAllowsMagnification(value bool)
	// The factor by which the page content is currently scaled.
	Magnification() float64
	SetMagnification(value float64)
	// Scales the page content and centers the result on the specified point.
	SetMagnificationCenteredAtPoint(magnification float64, point corefoundation.CGPoint)

	// Pauses playback of all media in the web view.
	PauseAllMediaPlaybackWithCompletionHandler(completionHandler VoidHandler)
	// Requests the playback status of media in the web view.
	RequestMediaPlaybackStateWithCompletionHandler(completionHandler WKMediaPlaybackStateHandler)
	// Changes whether the webpage is suspending playback of all media in the page.
	SetAllMediaPlaybackSuspendedCompletionHandler(suspended bool, completionHandler VoidHandler)
	// Closes all media the web view is presenting, including picture-in-picture video and fullscreen video.
	CloseAllMediaPresentationsWithCompletionHandler(completionHandler VoidHandler)

	// An enumeration case that indicates whether the webpage is using the camera to capture images or video.
	CameraCaptureState() WKMediaCaptureState
	// An enumeration case that indicates whether the webpage is using the microphone to capture audio.
	MicrophoneCaptureState() WKMediaCaptureState
	// Changes whether the webpage is using the camera to capture images or video.
	SetCameraCaptureStateCompletionHandler(state WKMediaCaptureState, completionHandler VoidHandler)
	// Changes whether the webpage is using the microphone to capture audio.
	SetMicrophoneCaptureStateCompletionHandler(state WKMediaCaptureState, completionHandler VoidHandler)

	// A Boolean value that indicates whether horizontal swipe gestures trigger backward and forward page navigation.
	AllowsBackForwardNavigationGestures() bool
	SetAllowsBackForwardNavigationGestures(value bool)
	// The web view’s back-forward list.
	BackForwardList() IWKBackForwardList
	// Navigates to the back item in the back-forward list.
	GoBackWithSender(sender objectivec.IObject)
	// Navigates to the back item in the back-forward list.
	GoBack() IWKNavigation
	// Navigates to the forward item in the back-forward list.
	GoForwardWithSender(sender objectivec.IObject)
	// Navigates to the forward item in the back-forward list.
	GoForward() IWKNavigation
	// Navigates to an item from the back-forward list and sets it as the current item.
	GoToBackForwardListItem(item IWKBackForwardListItem) IWKNavigation
	// A Boolean value that indicates whether there is a valid back item in the back-forward list.
	CanGoBack() bool
	// A Boolean value that indicates whether there is a valid forward item in the back-forward list.
	CanGoForward() bool
	// A Boolean value that determines whether pressing a link displays a preview of the destination for the link.
	AllowsLinkPreview() bool
	SetAllowsLinkPreview(value bool)
	// An object you use to capture the current state of interaction in a web view so that you can restore that state later to another web view.
	InteractionState() objectivec.IObject
	SetInteractionState(value objectivec.IObject)

	// Evaluates the specified JavaScript string.
	EvaluateJavaScriptCompletionHandler(javaScriptString string, completionHandler ObjectErrorHandler)

	// Returns the print operation object to use when printing the contents of the web view.
	PrintOperationWithPrintInfo(printInfo appkit.NSPrintInfo) appkit.NSPrintOperation

	FullscreenState() WKFullscreenState

	SetMinimumViewportInsetMaximumViewportInset(minimumViewportInset objectivec.IObject, maximumViewportInset objectivec.IObject)
	MinimumViewportInset() objectivec.IObject
	MaximumViewportInset() objectivec.IObject

	IsBlockedByScreenTime() bool
	WritingToolsActive() bool
	ObscuredContentInsets() objectivec.IObject
	SetObscuredContentInsets(value objectivec.IObject)

	FetchDataOfTypesCompletionHandler(dataTypes WKWebViewDataType, completionHandler DataErrorHandler)
	RestoreDataCompletionHandler(data foundation.INSData, completionHandler ErrorHandler)

	// Generates PDF data from the web view’s contents asynchronously.
	CreatePDFWithConfigurationCompletionHandler(pdfConfiguration IWKPDFConfiguration, completionHandler DataErrorHandler)
	// Creates a web archive of the web view’s contents asynchronously.
	CreateWebArchiveDataWithCompletionHandler(completionHandler DataErrorHandler)
	// Searches for the specified string in the web view’s content.
	FindStringWithConfigurationCompletionHandler(string_ string, configuration IWKFindConfiguration, completionHandler WKFindResultHandler)
}

An interface definition for the WKWebView class.

Creating a web view ¶

• [IWKWebView.InitWithFrameConfiguration]: Creates a web view and initializes it with the specified frame and configuration data.
• [IWKWebView.Configuration]: The object that contains the configuration details for the web view.

Displaying native user interface elements ¶

• [IWKWebView.UIDelegate]: The object you use to integrate custom user interface elements, such as contextual menus or panels, into web view interactions.
• [IWKWebView.SetUIDelegate]

Managing navigation between webpages ¶

• [IWKWebView.NavigationDelegate]: The object you use to manage navigation behavior for the web view.
• [IWKWebView.SetNavigationDelegate]

Loading web content ¶

• [IWKWebView.LoadRequest]: Loads the web content that the specified URL request object references and navigates to that content.
• [IWKWebView.LoadDataMIMETypeCharacterEncodingNameBaseURL]: Loads the content of the specified data object and navigates to it.
• [IWKWebView.LoadHTMLStringBaseURL]: Loads the contents of the specified HTML string and navigates to it.
• [IWKWebView.LoadFileRequestAllowingReadAccessToURL]: Loads the web content from the file the URL request object specifies and navigates to that content.
• [IWKWebView.LoadFileURLAllowingReadAccessToURL]: Loads the web content from the specified file and navigates to it.
• [IWKWebView.LoadSimulatedRequestResponseResponseData]: Loads the web content from the data you provide as if the data were the response to the request.
• [IWKWebView.LoadSimulatedRequestResponseHTMLString]: Loads the web content from the HTML you provide as if the HTML were the response to the request.
• [IWKWebView.Loading]: A Boolean value that indicates whether the view is currently loading content.
• [IWKWebView.EstimatedProgress]: An estimate of what fraction of the current navigation has been loaded.

Managing the loading process ¶

• [IWKWebView.Reload]: Reloads the current webpage.
• [IWKWebView.ReloadWithSender]: Reloads the current webpage.
• [IWKWebView.ReloadFromOrigin]: Reloads the current webpage, and performs end-to-end revalidation of the content using cache-validating conditionals, if possible.
• [IWKWebView.ReloadFromOriginWithSender]: Reloads the current webpage, and performs end-to-end revalidation of the content using cache-validating conditionals, if possible.
• [IWKWebView.StopLoading]: Stops loading all resources on the current page.
• [IWKWebView.StopLoadingWithSender]: Stops loading all resources on the current page.

Managing downloads ¶

• [IWKWebView.StartDownloadUsingRequestCompletionHandler]: Starts to download the resource at the URL in the request.
• [IWKWebView.ResumeDownloadFromResumeDataCompletionHandler]: Resumes a failed or canceled download.

Making web content inspectable ¶

• [IWKWebView.Inspectable]: A Boolean value that indicates whether you can inspect the view with Safari Web Inspector.
• [IWKWebView.SetInspectable]

Inspecting the view information ¶

• [IWKWebView.Title]: The page title.
• [IWKWebView.URL]: The URL for the current webpage.
• [IWKWebView.MediaType]: The media type for the contents of the web view.
• [IWKWebView.SetMediaType]
• [IWKWebView.CustomUserAgent]: The custom user agent string.
• [IWKWebView.SetCustomUserAgent]
• [IWKWebView.ServerTrust]: The trust management object you use to evaluate trust for the current webpage.
• [IWKWebView.HasOnlySecureContent]: A Boolean value that indicates whether the web view loaded all resources on the page through securely encrypted connections.
• [IWKWebView.ThemeColor]: The theme color that the system gets from the first valid meta tag in the webpage.
• [IWKWebView.UnderPageBackgroundColor]: The color the web view displays behind the active page, visible when the user scrolls beyond the bounds of the page.
• [IWKWebView.SetUnderPageBackgroundColor]

Scaling content ¶

• [IWKWebView.PageZoom]: The scale factor by which the web view scales content relative to its bounds.
• [IWKWebView.SetPageZoom]
• [IWKWebView.AllowsMagnification]: A Boolean value that indicates whether magnify gestures change the web view’s magnification.
• [IWKWebView.SetAllowsMagnification]
• [IWKWebView.Magnification]: The factor by which the page content is currently scaled.
• [IWKWebView.SetMagnification]
• [IWKWebView.SetMagnificationCenteredAtPoint]: Scales the page content and centers the result on the specified point.

Interacting with media ¶

• [IWKWebView.PauseAllMediaPlaybackWithCompletionHandler]: Pauses playback of all media in the web view.
• [IWKWebView.RequestMediaPlaybackStateWithCompletionHandler]: Requests the playback status of media in the web view.
• [IWKWebView.SetAllMediaPlaybackSuspendedCompletionHandler]: Changes whether the webpage is suspending playback of all media in the page.
• [IWKWebView.CloseAllMediaPresentationsWithCompletionHandler]: Closes all media the web view is presenting, including picture-in-picture video and fullscreen video.

Managing the microphone and camera ¶

• [IWKWebView.CameraCaptureState]: An enumeration case that indicates whether the webpage is using the camera to capture images or video.
• [IWKWebView.MicrophoneCaptureState]: An enumeration case that indicates whether the webpage is using the microphone to capture audio.
• [IWKWebView.SetCameraCaptureStateCompletionHandler]: Changes whether the webpage is using the camera to capture images or video.
• [IWKWebView.SetMicrophoneCaptureStateCompletionHandler]: Changes whether the webpage is using the microphone to capture audio.

Navigating between webpages ¶

• [IWKWebView.AllowsBackForwardNavigationGestures]: A Boolean value that indicates whether horizontal swipe gestures trigger backward and forward page navigation.
• [IWKWebView.SetAllowsBackForwardNavigationGestures]
• [IWKWebView.BackForwardList]: The web view’s back-forward list.
• [IWKWebView.GoBackWithSender]: Navigates to the back item in the back-forward list.
• [IWKWebView.GoBack]: Navigates to the back item in the back-forward list.
• [IWKWebView.GoForwardWithSender]: Navigates to the forward item in the back-forward list.
• [IWKWebView.GoForward]: Navigates to the forward item in the back-forward list.
• [IWKWebView.GoToBackForwardListItem]: Navigates to an item from the back-forward list and sets it as the current item.
• [IWKWebView.CanGoBack]: A Boolean value that indicates whether there is a valid back item in the back-forward list.
• [IWKWebView.CanGoForward]: A Boolean value that indicates whether there is a valid forward item in the back-forward list.
• [IWKWebView.AllowsLinkPreview]: A Boolean value that determines whether pressing a link displays a preview of the destination for the link.
• [IWKWebView.SetAllowsLinkPreview]
• [IWKWebView.InteractionState]: An object you use to capture the current state of interaction in a web view so that you can restore that state later to another web view.
• [IWKWebView.SetInteractionState]

Executing JavaScript ¶

• [IWKWebView.EvaluateJavaScriptCompletionHandler]: Evaluates the specified JavaScript string.

Capturing the web view’s content ¶

• [IWKWebView.PrintOperationWithPrintInfo]: Returns the print operation object to use when printing the contents of the web view.

Handling full-screen transitions ¶

• [IWKWebView.FullscreenState]

Configuring viewport insets ¶

• [IWKWebView.SetMinimumViewportInsetMaximumViewportInset]
• [IWKWebView.MinimumViewportInset]
• [IWKWebView.MaximumViewportInset]

Instance Properties ¶

• [IWKWebView.IsBlockedByScreenTime]
• [IWKWebView.WritingToolsActive]
• [IWKWebView.ObscuredContentInsets]
• [IWKWebView.SetObscuredContentInsets]

Instance Methods ¶

• [IWKWebView.FetchDataOfTypesCompletionHandler]
• [IWKWebView.RestoreDataCompletionHandler]

See: https://developer.apple.com/documentation/WebKit/WKWebView

type IWKWebViewConfiguration ¶

type IWKWebViewConfiguration interface {
	objectivec.IObject

	// The object you use to get and set the site’s cookies and to track the cached data objects.
	WebsiteDataStore() IWKWebsiteDataStore
	SetWebsiteDataStore(value IWKWebsiteDataStore)
	// The object that coordinates interactions between your app’s native code and the webpage’s scripts and other content.
	UserContentController() IWKUserContentController
	SetUserContentController(value IWKUserContentController)
	// The app name that appears in the user agent string.
	ApplicationNameForUserAgent() string
	SetApplicationNameForUserAgent(value string)
	// A Boolean value that indicates whether the web view limits navigation to pages within the app’s domain.
	LimitsNavigationsToAppBoundDomains() bool
	SetLimitsNavigationsToAppBoundDomains(value bool)
	// A Boolean value that indicates whether the web view should automatically upgrade supported HTTP requests to HTTPS.
	UpgradeKnownHostsToHTTPS() bool
	SetUpgradeKnownHostsToHTTPS(value bool)

	// The object that manages the preference-related settings for the web view.
	Preferences() IWKPreferences
	SetPreferences(value IWKPreferences)
	// The default preferences to use when loading and rendering content.
	DefaultWebpagePreferences() IWKWebpagePreferences
	SetDefaultWebpagePreferences(value IWKWebpagePreferences)

	// Registers an object to load resources associated with the specified URL scheme.
	SetURLSchemeHandlerForURLScheme(urlSchemeHandler WKURLSchemeHandler, urlScheme string)
	// Returns the currently registered handler object for the specified URL scheme.
	UrlSchemeHandlerForURLScheme(urlScheme string) WKURLSchemeHandler

	// A Boolean value that indicates whether the web view suppresses content rendering until the content is fully loaded into memory.
	SuppressesIncrementalRendering() bool
	SetSuppressesIncrementalRendering(value bool)

	// A Boolean value that indicates whether the web view allows media playback over AirPlay.
	AllowsAirPlayForMediaPlayback() bool
	SetAllowsAirPlayForMediaPlayback(value bool)
	// The media types that require a user gesture to begin playing.
	MediaTypesRequiringUserActionForPlayback() WKAudiovisualMediaTypes
	SetMediaTypesRequiringUserActionForPlayback(value WKAudiovisualMediaTypes)

	// The directionality of user interface elements.
	UserInterfaceDirectionPolicy() WKUserInterfaceDirectionPolicy
	SetUserInterfaceDirectionPolicy(value WKUserInterfaceDirectionPolicy)

	AllowsInlinePredictions() bool
	SetAllowsInlinePredictions(value bool)
	ShowsSystemScreenTimeBlockingView() bool
	SetShowsSystemScreenTimeBlockingView(value bool)
	SupportsAdaptiveImageGlyph() bool
	SetSupportsAdaptiveImageGlyph(value bool)
	WebExtensionController() IWKWebExtensionController
	SetWebExtensionController(value IWKWebExtensionController)
	WritingToolsBehavior() objectivec.IObject
	SetWritingToolsBehavior(value objectivec.IObject)

	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKWebViewConfiguration class.

Configuring the web view’s behavior ¶

• [IWKWebViewConfiguration.WebsiteDataStore]: The object you use to get and set the site’s cookies and to track the cached data objects.
• [IWKWebViewConfiguration.SetWebsiteDataStore]
• [IWKWebViewConfiguration.UserContentController]: The object that coordinates interactions between your app’s native code and the webpage’s scripts and other content.
• [IWKWebViewConfiguration.SetUserContentController]
• [IWKWebViewConfiguration.ApplicationNameForUserAgent]: The app name that appears in the user agent string.
• [IWKWebViewConfiguration.SetApplicationNameForUserAgent]
• [IWKWebViewConfiguration.LimitsNavigationsToAppBoundDomains]: A Boolean value that indicates whether the web view limits navigation to pages within the app’s domain.
• [IWKWebViewConfiguration.SetLimitsNavigationsToAppBoundDomains]
• [IWKWebViewConfiguration.UpgradeKnownHostsToHTTPS]: A Boolean value that indicates whether the web view should automatically upgrade supported HTTP requests to HTTPS.
• [IWKWebViewConfiguration.SetUpgradeKnownHostsToHTTPS]

Configuring the web view’s preferences ¶

• [IWKWebViewConfiguration.Preferences]: The object that manages the preference-related settings for the web view.
• [IWKWebViewConfiguration.SetPreferences]
• [IWKWebViewConfiguration.DefaultWebpagePreferences]: The default preferences to use when loading and rendering content.
• [IWKWebViewConfiguration.SetDefaultWebpagePreferences]

Adding handlers for custom URL schemes ¶

• [IWKWebViewConfiguration.SetURLSchemeHandlerForURLScheme]: Registers an object to load resources associated with the specified URL scheme.
• [IWKWebViewConfiguration.UrlSchemeHandlerForURLScheme]: Returns the currently registered handler object for the specified URL scheme.

Configuring the rendering behavior ¶

• [IWKWebViewConfiguration.SuppressesIncrementalRendering]: A Boolean value that indicates whether the web view suppresses content rendering until the content is fully loaded into memory.
• [IWKWebViewConfiguration.SetSuppressesIncrementalRendering]

Setting media playback preferences ¶

• [IWKWebViewConfiguration.AllowsAirPlayForMediaPlayback]: A Boolean value that indicates whether the web view allows media playback over AirPlay.
• [IWKWebViewConfiguration.SetAllowsAirPlayForMediaPlayback]
• [IWKWebViewConfiguration.MediaTypesRequiringUserActionForPlayback]: The media types that require a user gesture to begin playing.
• [IWKWebViewConfiguration.SetMediaTypesRequiringUserActionForPlayback]

Selecting user interface directionality ¶

• [IWKWebViewConfiguration.UserInterfaceDirectionPolicy]: The directionality of user interface elements.
• [IWKWebViewConfiguration.SetUserInterfaceDirectionPolicy]

Instance Properties ¶

• [IWKWebViewConfiguration.AllowsInlinePredictions]
• [IWKWebViewConfiguration.SetAllowsInlinePredictions]
• [IWKWebViewConfiguration.ShowsSystemScreenTimeBlockingView]
• [IWKWebViewConfiguration.SetShowsSystemScreenTimeBlockingView]
• [IWKWebViewConfiguration.SupportsAdaptiveImageGlyph]
• [IWKWebViewConfiguration.SetSupportsAdaptiveImageGlyph]
• [IWKWebViewConfiguration.WebExtensionController]
• [IWKWebViewConfiguration.SetWebExtensionController]
• [IWKWebViewConfiguration.WritingToolsBehavior]
• [IWKWebViewConfiguration.SetWritingToolsBehavior]

See: https://developer.apple.com/documentation/WebKit/WKWebViewConfiguration

type IWKWebpagePreferences ¶

type IWKWebpagePreferences interface {
	objectivec.IObject

	// A Boolean value that indicates whether JavaScript from web content is allowed to run.
	AllowsContentJavaScript() bool
	SetAllowsContentJavaScript(value bool)

	// The content mode for the web view to use when it loads and renders a webpage.
	PreferredContentMode() WKContentMode
	SetPreferredContentMode(value WKContentMode)

	// A Boolean value that indicates whether to use Lockdown Mode in the web view.
	LockdownModeEnabled() bool
	SetLockdownModeEnabled(value bool)

	PreferredHTTPSNavigationPolicy() WKWebpagePreferencesUpgradeToHTTPSPolicy
	SetPreferredHTTPSNavigationPolicy(value WKWebpagePreferencesUpgradeToHTTPSPolicy)

	SecurityRestrictionMode() WKSecurityRestrictionMode
	SetSecurityRestrictionMode(value WKSecurityRestrictionMode)
}

An interface definition for the WKWebpagePreferences class.

Setting the JavaScript preferences ¶

• [IWKWebpagePreferences.AllowsContentJavaScript]: A Boolean value that indicates whether JavaScript from web content is allowed to run.
• [IWKWebpagePreferences.SetAllowsContentJavaScript]

Setting the preferred content mode ¶

• [IWKWebpagePreferences.PreferredContentMode]: The content mode for the web view to use when it loads and renders a webpage.
• [IWKWebpagePreferences.SetPreferredContentMode]

Getting Lockdown Mode info ¶

• [IWKWebpagePreferences.LockdownModeEnabled]: A Boolean value that indicates whether to use Lockdown Mode in the web view.
• [IWKWebpagePreferences.SetLockdownModeEnabled]

Instance Properties ¶

• [IWKWebpagePreferences.PreferredHTTPSNavigationPolicy]
• [IWKWebpagePreferences.SetPreferredHTTPSNavigationPolicy]

See: https://developer.apple.com/documentation/WebKit/WKWebpagePreferences

type IWKWebsiteDataRecord ¶

type IWKWebsiteDataRecord interface {
	objectivec.IObject

	// The display name for the data record.
	DisplayName() string

	// The types of data associated with the record.
	DataTypes() foundation.INSSet

	// The local files WebKit can access when loading content.
	ReadAccessURL() foundation.NSString
}

An interface definition for the WKWebsiteDataRecord class.

Getting the Record Information ¶

• [IWKWebsiteDataRecord.DisplayName]: The display name for the data record.

Getting the Data Type ¶

• [IWKWebsiteDataRecord.DataTypes]: The types of data associated with the record.

See: https://developer.apple.com/documentation/WebKit/WKWebsiteDataRecord

type IWKWebsiteDataStore ¶

type IWKWebsiteDataStore interface {
	objectivec.IObject

	// An identifier that uniquely identifies a data store.
	Identifier() foundation.NSUUID
	// A Boolean value that indicates whether this object stores data to disk.
	Persistent() bool

	// The object that manages the HTTP cookies for your website.
	HttpCookieStore() IWKHTTPCookieStore

	// Removes the specified types of website data from one or more data records.
	RemoveDataOfTypesForDataRecordsCompletionHandler(dataTypes foundation.INSSet, dataRecords []WKWebsiteDataRecord, completionHandler VoidHandler)
	// Removes website data that changed after the specified date.
	RemoveDataOfTypesModifiedSinceCompletionHandler(dataTypes foundation.INSSet, date foundation.INSDate, completionHandler VoidHandler)

	FetchDataOfTypesCompletionHandler(dataTypes foundation.INSSet, completionHandler DataErrorHandler)
	RestoreDataCompletionHandler(data foundation.INSData, completionHandler ErrorHandler)

	ProxyConfigurations() []objectivec.Object
	SetProxyConfigurations(value []objectivec.Object)
	// The local files WebKit can access when loading content.
	ReadAccessURL() foundation.NSString
	// The object you use to get and set the site’s cookies and to track the cached data objects.
	WebsiteDataStore() IWKWebsiteDataStore
	SetWebsiteDataStore(value IWKWebsiteDataStore)
	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WKWebsiteDataStore class.

Inspecting data store properties ¶

• [IWKWebsiteDataStore.Identifier]: An identifier that uniquely identifies a data store.
• [IWKWebsiteDataStore.Persistent]: A Boolean value that indicates whether this object stores data to disk.

Retrieving a cookie store ¶

• [IWKWebsiteDataStore.HttpCookieStore]: The object that manages the HTTP cookies for your website.

Removing specific types of data ¶

• [IWKWebsiteDataStore.RemoveDataOfTypesForDataRecordsCompletionHandler]: Removes the specified types of website data from one or more data records.
• [IWKWebsiteDataStore.RemoveDataOfTypesModifiedSinceCompletionHandler]: Removes website data that changed after the specified date.

Instance Methods ¶

• [IWKWebsiteDataStore.FetchDataOfTypesCompletionHandler]
• [IWKWebsiteDataStore.RestoreDataCompletionHandler]

See: https://developer.apple.com/documentation/WebKit/WKWebsiteDataStore

type IWKWindowFeatures ¶

type IWKWindowFeatures interface {
	objectivec.IObject

	// A Boolean value that indicates whether to make the containing window window resizable.
	AllowsResizing() foundation.NSNumber
	// The requested height of the containing window.
	Height() foundation.NSNumber
	// The requested width of the containing window.
	Width() foundation.NSNumber
	// The requested x-coordinate of the containing window.
	X() foundation.NSNumber
	// The requested y-coordinate of the containing window.
	Y() foundation.NSNumber

	// A Boolean value that indicates whether the webpage requests a visible menu bar.
	MenuBarVisibility() foundation.NSNumber
	// A Boolean value that indicates whether the webpage requested a visible status bar.
	StatusBarVisibility() foundation.NSNumber
	// A Boolean value that indicates whether the webpage requested a visible toolbar.
	ToolbarsVisibility() foundation.NSNumber
}

An interface definition for the WKWindowFeatures class.

Inspecting Window Position and Dimensions ¶

• [IWKWindowFeatures.AllowsResizing]: A Boolean value that indicates whether to make the containing window window resizable.
• [IWKWindowFeatures.Height]: The requested height of the containing window.
• [IWKWindowFeatures.Width]: The requested width of the containing window.
• [IWKWindowFeatures.X]: The requested x-coordinate of the containing window.
• [IWKWindowFeatures.Y]: The requested y-coordinate of the containing window.

Inspecting Visibility Properties ¶

• [IWKWindowFeatures.MenuBarVisibility]: A Boolean value that indicates whether the webpage requests a visible menu bar.
• [IWKWindowFeatures.StatusBarVisibility]: A Boolean value that indicates whether the webpage requested a visible status bar.
• [IWKWindowFeatures.ToolbarsVisibility]: A Boolean value that indicates whether the webpage requested a visible toolbar.

See: https://developer.apple.com/documentation/WebKit/WKWindowFeatures

type IWebResource ¶

type IWebResource interface {
	objectivec.IObject

	// Initializes and returns a web resource instance.
	InitWithDataURLMIMETypeTextEncodingNameFrameName(data foundation.INSData, URL foundation.INSURL, MIMEType string, textEncodingName string, frameName string) WebResource

	// The receiver’s data.
	Data() foundation.INSData
	// The receiver’s URL.
	URL() foundation.INSURL
	// The receiver’s MIME type.
	MIMEType() string
	// The receiver’s text encoding name.
	TextEncodingName() string
	// The name of the frame. If the receiver does not represent the contents of an entire HTML frame, this is `nil`.
	FrameName() string

	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the WebResource class.

Initializing ¶

• [IWebResource.InitWithDataURLMIMETypeTextEncodingNameFrameName]: Initializes and returns a web resource instance.

Getting attributes ¶

• [IWebResource.Data]: The receiver’s data.
• [IWebResource.URL]: The receiver’s URL.
• [IWebResource.MIMEType]: The receiver’s MIME type.
• [IWebResource.TextEncodingName]: The receiver’s text encoding name.
• [IWebResource.FrameName]: The name of the frame. If the receiver does not represent the contents of an entire HTML frame, this is `nil`.

See: https://developer.apple.com/documentation/WebKit/WebResource

type LocaleErrorHandler ¶

type LocaleErrorHandler = func(*foundation.NSLocale, error)

LocaleErrorHandler handles A block that must be called upon completion. The error can be type-asserted to *foundation.NSError for Domain, Code, and UserInfo.

Used by:

• [WKWebExtensionTab.DetectWebpageLocaleForWebExtensionContextCompletionHandler]

type NSAttributedStringCompletionHandler ¶

type NSAttributedStringCompletionHandler = func(foundation.NSAttributedString, foundation.INSDictionary, foundation.NSError)

See: https://developer.apple.com/documentation/WebKit/NSAttributedStringCompletionHandler

type NSHTTPCookieArrayHandler ¶

type NSHTTPCookieArrayHandler = func(*[]foundation.NSHTTPCookie)

NSHTTPCookieArrayHandler handles A completion handler block to execute asynchronously with the results.

• cookieArray: An array of [HTTPCookie](<doc://com.apple.documentation/documentation/Foundation/HTTPCookie>) objects. If the store contains no cookies, this parameter contains an empty array.

Used by:

• [WKHTTPCookieStore.GetAllCookies]

type NSURLArrayHandler ¶

type NSURLArrayHandler = func(*[]foundation.NSURL)

NSURLArrayHandler handles The completion handler the system calls after a person dismisses the open panel.

Used by:

• [WKUIDelegate.WebViewRunOpenPanelWithParametersInitiatedByFrameCompletionHandler]

type NSUUIDArrayHandler ¶

type NSUUIDArrayHandler = func(*[]foundation.NSUUID)

NSUUIDArrayHandler handles A block to invoke with the fetched list of unique identifiers.

Used by:

• [WKWebsiteDataStore.FetchAllDataStoreIdentifiers]

type ObjectErrorHandler ¶

type ObjectErrorHandler = func(objectivec.IObject, error)

ObjectErrorHandler handles A handler block to execute when script evaluation finishes.

• object: The result of the script evaluation, or `nil` if an error occurred.
• error: `nil` on success, or an error object with information about the problem.

The error can be type-asserted to *foundation.NSError for Domain, Code, and UserInfo.

Used by:

• [WKWebExtensionControllerDelegate.WebExtensionControllerSendMessageToApplicationWithIdentifierForExtensionContextReplyHandler]
• WKWebView.EvaluateJavaScriptCompletionHandler

type StringHandler ¶

type StringHandler = func(*string)

StringHandler handles A reply handler block to execute with the response to send back to the webpage.

• reply: An object that contains the data to return to the webpage. Allowed types for this parameter are [NSNumber](<doc://com.apple.documentation/documentation/Foundation/NSNumber>), [NSString](<doc://com.apple.documentation/documentation/Foundation/NSString>), [NSDate](<doc://com.apple.documentation/documentation/Foundation/NSDate>), [NSArray](<doc://com.apple.documentation/documentation/Foundation/NSArray>), [NSDictionary](<doc://com.apple.documentation/documentation/Foundation/NSDictionary>), and [NSNull](<doc://com.apple.documentation/documentation/Foundation/NSNull>). Specify `nil` if an error occurred.
• errorMessage: `nil` on success, or a string that describes the error that occurred.

Used by:

• [WKScriptMessageHandlerWithReply.UserContentControllerDidReceiveScriptMessageReplyHandler]
• [WKUIDelegate.WebViewRunJavaScriptTextInputPanelWithPromptDefaultTextInitiatedByFrameCompletionHandler]

type StringSetDateHandler ¶

type StringSetDateHandler = func(*foundation.INSSet, *foundation.NSDate)

StringSetDateHandler handles A block to be called with the set of allowed permissions and an optional expiration date.

Used by:

• [WKWebExtensionControllerDelegate.WebExtensionControllerPromptForPermissionsInTabForExtensionContextCompletionHandler]

type UIContextMenuConfigurationHandler ¶

type UIContextMenuConfigurationHandler = func(*objectivec.Object)

UIContextMenuConfigurationHandler handles The completion handler for you to call with information about how you want to handle the interaction.

• configuration: The [UIContextMenuConfiguration](<doc://com.apple.documentation/documentation/UIKit/UIContextMenuConfiguration>) object that contains the details of how you want to handle the interaction. Specify `nil` for this parameter if you don’t want to show a contextual menu.

Used by:

• [WKUIDelegate.WebViewContextMenuConfigurationForElementCompletionHandler]

type UIImageErrorHandler ¶

type UIImageErrorHandler = func(*objc.ID, error)

UIImageErrorHandler handles The completion handler to call when the image is ready.

• snapshotImage: A platform-native image that contains the specified portion of the web view.
• error: An error object if a problem occurred, or `nil` on success.

Used by:

• [WKWebExtensionTab.TakeSnapshotUsingConfigurationForWebExtensionContextCompletionHandler]
• [WKWebView.TakeSnapshotWithConfigurationCompletionHandler]

type URLCredentialHandler ¶

type URLCredentialHandler = func(*foundation.NSURLCredential)

URLCredentialHandler handles A closure you must invoke to respond to the authentication challenge.

• disposition: The option to use to handle the challenge. For a list of options, see [URLSession.AuthChallengeDisposition](<doc://com.apple.documentation/documentation/Foundation/URLSession/AuthChallengeDisposition>).
• credential: The credential to use for authentication when the `disposition` parameter contains the value [URLSession.AuthChallengeDisposition.useCredential](<doc://com.apple.documentation/documentation/Foundation/URLSession/AuthChallengeDisposition/useCredential>). Specify `nil` to continue without a credential.

Used by:

• [WKDownloadDelegate.DownloadDidReceiveAuthenticationChallengeCompletionHandler]
• [WKNavigationDelegate.WebViewDidReceiveAuthenticationChallengeCompletionHandler]

type URLHandler ¶

type URLHandler = func(*foundation.NSURL)

URLHandler handles A closure you invoke with a destination file URL to begin the download, or `nil` to cancel the download.

Used by:

• [WKDownloadDelegate.DownloadDecideDestinationUsingResponseSuggestedFilenameCompletionHandler]
• [WKDownloadDelegate.DownloadDecidePlaceholderPolicy]

type URLSetDateHandler ¶

type URLSetDateHandler = func(*foundation.INSSet, *foundation.NSDate)

URLSetDateHandler handles A block to be called with the set of allowed URLs and an optional expiration date.

Used by:

• [WKWebExtensionControllerDelegate.WebExtensionControllerPromptForPermissionToAccessURLsInTabForExtensionContextCompletionHandler]

type VoidHandler ¶

type VoidHandler = func()

VoidHandler handles A completion handler block to call with the results.

• identifierArray: An array of strings, each of which corresponds to an identifier for a rule list in the data store. Use each string to look up the associated WKContentRuleList(<doc://com.apple.webkit/documentation/WebKit/WKContentRuleList>) object. If the data store has no rule lists, the array is empty.

Used by:

• WKContentRuleListStore.GetAvailableContentRuleListIdentifiers
• [WKDownloadDelegate.DownloadDidReceivePlaceholderURLCompletionHandler]
• WKHTTPCookieStore.DeleteCookieCompletionHandler
• WKHTTPCookieStore.SetCookieCompletionHandler
• WKHTTPCookieStore.SetCookiePolicyCompletionHandler
• WKHTTPCookieStore.SetCookiesCompletionHandler
• [WKUIDelegate.WebViewRunJavaScriptAlertPanelWithMessageInitiatedByFrameCompletionHandler]
• WKWebExtensionController.RemoveDataOfTypesFromDataRecordsCompletionHandler
• WKWebView.CloseAllMediaPresentationsWithCompletionHandler
• WKWebView.PauseAllMediaPlaybackWithCompletionHandler
• WKWebView.SetAllMediaPlaybackSuspendedCompletionHandler
• WKWebView.SetCameraCaptureStateCompletionHandler
• WKWebView.SetMicrophoneCaptureStateCompletionHandler
• WKWebsiteDataStore.RemoveDataOfTypesForDataRecordsCompletionHandler
• WKWebsiteDataStore.RemoveDataOfTypesModifiedSinceCompletionHandler

type WKAudiovisualMediaTypes ¶

type WKAudiovisualMediaTypes uint

See: https://developer.apple.com/documentation/WebKit/WKAudiovisualMediaTypes

const (
	// WKAudiovisualMediaTypeAll: All media types require a user gesture to begin playing.
	WKAudiovisualMediaTypeAll WKAudiovisualMediaTypes = 0
	// WKAudiovisualMediaTypeAudio: Media types that contain audio require a user gesture to begin playing.
	WKAudiovisualMediaTypeAudio WKAudiovisualMediaTypes = 1
	// WKAudiovisualMediaTypeNone: No media types require a user gesture to begin playing.
	WKAudiovisualMediaTypeNone WKAudiovisualMediaTypes = 0
	// WKAudiovisualMediaTypeVideo: Media types that contain video require a user gesture to begin playing.
	WKAudiovisualMediaTypeVideo WKAudiovisualMediaTypes = 2
)

func (e WKAudiovisualMediaTypes) String() string

type WKBackForwardList ¶

type WKBackForwardList struct {
	objectivec.Object
}

An object that manages the list of previously loaded webpages, which the web view uses for forward and backward navigation.

Overview ¶

Use a WKBackForwardList object to retrieve a web view’s previously loaded pages. Typically, you don’t create WKBackForwardList objects directly. Each web view creates one automatically and uses it to store the history of all loaded pages. Fetch this object from your web view’s [BackForwardList] property and use its contents to facilitate programmatic navigation.

Getting the Most Recent Items ¶

• WKBackForwardList.BackItem: The item immediately preceding the current item, if any.
• WKBackForwardList.CurrentItem: The current item.
• WKBackForwardList.ForwardItem: The item immediately following the current item, if any.

Getting Specific Items in the List ¶

• WKBackForwardList.ItemAtIndex: Returns the item at the relative offset from the current item.

Getting Sublists ¶

• WKBackForwardList.BackList: The array of items that precede the current item.
• WKBackForwardList.ForwardList: The array of items that follow the current item.

See: https://developer.apple.com/documentation/WebKit/WKBackForwardList

func NewWKBackForwardList() WKBackForwardList

func WKBackForwardListFromID(id objc.ID) WKBackForwardList

func (b WKBackForwardList) Autorelease() WKBackForwardList

func (b WKBackForwardList) BackForwardList() IWKBackForwardList

func (b WKBackForwardList) BackItem() IWKBackForwardListItem

func (b WKBackForwardList) BackList() []WKBackForwardListItem

func (b WKBackForwardList) CurrentItem() IWKBackForwardListItem

func (b WKBackForwardList) ForwardItem() IWKBackForwardListItem

func (b WKBackForwardList) ForwardList() []WKBackForwardListItem

func (b WKBackForwardList) Init() WKBackForwardList

func (b WKBackForwardList) ItemAtIndex(index int) IWKBackForwardListItem

func (b WKBackForwardList) SetBackForwardList(value IWKBackForwardList)

type WKBackForwardListClass ¶

type WKBackForwardListClass struct {
	// contains filtered or unexported fields
}

func GetWKBackForwardListClass() WKBackForwardListClass

func (wc WKBackForwardListClass) Alloc() WKBackForwardList

func (wc WKBackForwardListClass) Class() objc.Class

type WKBackForwardListItem ¶

type WKBackForwardListItem struct {
	objectivec.Object
}

A representation of a webpage that the web view previously visited.

Overview ¶

Use a WKBackForwardListItem object to get information about previously visited webpages. This object identifies the page’s title and URL. It also identifes the URL that requested the webpage.

You don’t create WKBackForwardListItem objects directly. Instead, a WKBackForwardList object creates them in conjunction with its associated web view when the web view loads new pages.

Getting the Page-Specific Information ¶

• WKBackForwardListItem.Title: The title of the webpage this item represents.
• WKBackForwardListItem.URL: The URL of the webpage this item represents.

Getting the Requesting Page ¶

• WKBackForwardListItem.InitialURL: The source URL that originally asked the web view to load this page.

See: https://developer.apple.com/documentation/WebKit/WKBackForwardListItem

func NewWKBackForwardListItem() WKBackForwardListItem

func WKBackForwardListItemFromID(id objc.ID) WKBackForwardListItem

func (b WKBackForwardListItem) Autorelease() WKBackForwardListItem

func (b WKBackForwardListItem) Init() WKBackForwardListItem

func (b WKBackForwardListItem) InitialURL() foundation.INSURL

func (b WKBackForwardListItem) Title() string

func (b WKBackForwardListItem) URL() foundation.INSURL

type WKBackForwardListItemClass ¶

type WKBackForwardListItemClass struct {
	// contains filtered or unexported fields
}

func GetWKBackForwardListItemClass() WKBackForwardListItemClass