WebKit-6.0 ▶ WebKit ▶ WebExtensionMatchPatternSince 2.48

constructor

• new WebExtensionMatchPattern(properties?: Partial<{}>): WebExtensionMatchPattern

  Parameters

  • Optionalproperties: Partial<{}>

  Returns WebExtensionMatchPattern

Static$gtype

Since 2.48get_host

• get_host(): string

  Gets the host part of the pattern string, unless webkit_web_extension_match_pattern_get_matches_all_urls is true.

  Returns string

  The host string.

  Since

  2.48

Since 2.48get_matches_all_hosts

• get_matches_all_hosts(): boolean

  Gets whether the match pattern matches all host. This happens when the pattern is <all_urls>, or if * is set as the host string.

  Returns boolean

  Whether this match pattern matches all hosts.

  Since

  2.48

Since 2.48get_matches_all_urls

• get_matches_all_urls(): boolean

  Gets whether the match pattern matches all URLs, in other words, whether the pattern is <all_urls>.

  Returns boolean

  Whether this match pattern matches all URLs.

  Since

  2.48

Since 2.48get_path

• get_path(): string

  Gets the path part of the pattern string, unless WebExtensionMatchPattern.get_matches_all_urls is true.

  Returns string

  The path string.

  Since

  2.48

Since 2.48get_scheme

• get_scheme(): string

  Gets the scheme part of the pattern string, unless webkit_web_extension_match_pattern_get_matches_all_urls is true.

  Returns string

  The scheme string.

  Since

  2.48

Since 2.48get_string

• get_string(): string

  Gets the original pattern string.

  Returns string

  The original pattern string.

  Since

  2.48

Since 2.48matches_pattern

• matches_pattern(
      pattern: WebExtensionMatchPattern,
      options: WebKit.WebExtensionMatchPatternOptions,
  ): boolean

  Matches the matchPattern against the specified pattern with options.

  Parameters

  • pattern: WebExtensionMatchPattern

    The WebKit.WebExtensionMatchPattern to match with matchPattern.

  • options: WebKit.WebExtensionMatchPatternOptions

    The WebKit.WebExtensionMatchPatternOptions use while matching.

  Returns boolean

  Whether the pattern matches the specified pattern.

  Since

  2.48

Since 2.48matches_url

• matches_url(
      url: string,
      options: WebKit.WebExtensionMatchPatternOptions,
  ): boolean

  Matches the matchPattern against the specified URL with options.

  Parameters

  • url: string

    The URL to match against the pattern.

  • options: WebKit.WebExtensionMatchPatternOptions

    The WebKit.WebExtensionMatchPatternOptions use while matching.

  Returns boolean

  Whether the pattern matches the specified URL.

  Since

  2.48

Since 2.48ref

• ref(): WebExtensionMatchPattern

  Atomically acquires a reference on the given matchPattern.

  This function is MT-safe and may be called from any thread.

  Returns WebExtensionMatchPattern

  The same matchPattern with an additional reference.

  Since

  2.48

Since 2.48unref

• unref(): void

  Atomically releases a reference on the given matchPattern.

  If the reference was the last, the resources associated to the matchPattern are freed. This function is MT-safe and may be called from any thread.

  Returns void

  Since

  2.48

Staticnew_all_hosts_and_schemes

• new_all_hosts_and_schemes(): WebExtensionMatchPattern

  Returns WebExtensionMatchPattern

Staticnew_all_urls

• new_all_urls(): WebExtensionMatchPattern

  Returns WebExtensionMatchPattern

Staticnew_with_scheme

• new_with_scheme(
      scheme: string,
      host: string,
      path: string,
  ): WebExtensionMatchPattern

  Parameters

  • scheme: string
  • host: string
  • path: string

  Returns WebExtensionMatchPattern

Staticnew_with_string

• new_with_string(string: string): WebExtensionMatchPattern

  Parameters

  • string: string

  Returns WebExtensionMatchPattern

StaticSince 2.52register_custom_url_scheme

• register_custom_url_scheme(urlScheme: string): void

  Registers a custom URL scheme that can be used in match patterns.

  This method should be used to register any custom URL schemes used by the app for the extension base URLs, other than webkit-extension, or if extensions should have access to other supported URL schemes when using <all_urls>.

  Parameters

  • urlScheme: string

    The custom URL scheme to register

  Returns void

  Since

  2.52

StaticDeprecated 2.52Since 2.48register_custom_URL_scheme

• register_custom_URL_scheme(urlScheme: string): void

  Registers a custom URL scheme that can be used in match patterns.

  This method should be used to register any custom URL schemes used by the app for the extension base URLs, other than webkit-extension, or if extensions should have access to other supported URL schemes when using <all_urls>.

  Parameters

  • DeprecatedurlScheme: string

    The custom URL scheme to register

  Returns void

  Since

  2.48

  Deprecated

  since 2.52: Use webkit_web_extension_match_pattern_register_custom_url_scheme() instead.