Class WebkitMessagingTransport`Implements`

Example

On macOS 11+, this will just call through to window.webkit.messageHandlers.x.postMessage

Eg: for a foo message defined in Swift that accepted the payload {"bar": "baz"}, the following would occur:

const json = await window.webkit.messageHandlers.foo.postMessage({ bar: "baz" });
const response = JSON.parse(json)

Example

On macOS 10 however, the process is a little more involved. A method will be appended to window that allows the response to be delivered there instead. It's not exactly this, but you can visualize the flow as being something along the lines of:

// add the window method
window["_0123456"] = (response) => {
   // decrypt `response` and deliver the result to the caller here
   // then remove the temporary method
   delete window['_0123456']
};

// send the data + `messageHanding` values
window.webkit.messageHandlers.foo.postMessage({
  bar: "baz",
  messagingHandling: {
    methodName: "_0123456",
    secret: "super-secret",
    key: [1, 2, 45, 2],
    iv: [34, 4, 43],
  }
});

// later in swift, the following JavaScript snippet will be executed
(() => {
  window['_0123456']({
    ciphertext: [12, 13, 4],
    tag: [3, 5, 67, 56]
  })
})()

Index

Constructors

constructor

new WebkitMessagingTransport(
config: WebkitMessagingConfig,
messagingContext: MessagingContext,
): WebkitMessagingTransport
Parameters
- config: WebkitMessagingConfig
- messagingContext: MessagingContext
Returns WebkitMessagingTransport
- Defined in messaging/lib/webkit.js:64

Properties

config

config: WebkitMessagingConfig

globals

globals: {
    addEventListener: any;
    Arrayfrom: {
        <T>(arrayLike: ArrayLike<T>): T[];
        <T, U>(
            arrayLike: ArrayLike<T>,
            mapfn: (v: T, k: number) => U,
            thisArg?: any,
        ): U[];
        <T>(iterable: Iterable<T> | ArrayLike<T>): T[];
        <T, U>(
            iterable: Iterable<T> | ArrayLike<T>,
            mapfn: (v: T, k: number) => U,
            thisArg?: any,
        ): U[];
    };
    capturedWebkitHandlers: Record<string, any>;
    Error: ErrorConstructor;
    getRandomValues: any;
    JSONparse: (
        text: string,
        reviver?: (this: any, key: string, value: any) => any,
    ) => any;
    JSONstringify: {
        (
            value: any,
            replacer?: (this: any, key: string, value: any) => any,
            space?: string | number,
        ): string;
        (
            value: any,
            replacer?: null | (string | number)[],
            space?: string | number,
        ): string;
    };
    ObjectDefineProperty: <T>(
        o: T,
        p: PropertyKey,
        attributes: PropertyDescriptor & ThisType<any>,
    ) => T;
    Promise: PromiseConstructor;
    ReflectDeleteProperty: any;
    TextDecoder: new (
        label?: string,
        options?: TextDecoderOptions,
    ) => TextDecoder;
    TextEncoder: new () => TextEncoder;
    Uint16Array: Uint16ArrayConstructor;
    Uint32Array: Uint32ArrayConstructor;
    Uint8Array: Uint8ArrayConstructor;
    window: Window & typeof globalThis;
}

Type declaration

addEventListener: any
Arrayfrom: {
    <T>(arrayLike: ArrayLike<T>): T[];
    <T, U>(
        arrayLike: ArrayLike<T>,
        mapfn: (v: T, k: number) => U,
        thisArg?: any,
    ): U[];
    <T>(iterable: Iterable<T> | ArrayLike<T>): T[];
    <T, U>(
        iterable: Iterable<T> | ArrayLike<T>,
        mapfn: (v: T, k: number) => U,
        thisArg?: any,
    ): U[];
}
capturedWebkitHandlers: Record<string, any>
Error: ErrorConstructor
getRandomValues: any
JSONparse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any
JSONstringify: {
    (
        value: any,
        replacer?: (this: any, key: string, value: any) => any,
        space?: string | number,
    ): string;
    (
        value: any,
        replacer?: null | (string | number)[],
        space?: string | number,
    ): string;
}
ObjectDefineProperty: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T
Promise: PromiseConstructor
ReflectDeleteProperty: any
TextDecoder: new (label?: string, options?: TextDecoderOptions) => TextDecoder
TextEncoder: new () => TextEncoder
Uint16Array: Uint16ArrayConstructor
Uint32Array: Uint32ArrayConstructor
Uint8Array: Uint8ArrayConstructor
window: Window & typeof globalThis

messagingContext

messagingContext: MessagingContext

Methods

captureWebkitHandlers

captureWebkitHandlers(handlerNames: string[]): void
When required (such as on macos 10.x), capture the postMessage method on each webkit messageHandler
Parameters
- handlerNames: string[]
Returns void
- Defined in messaging/lib/webkit.js:264

notify

notify(msg: NotificationMessage): void
Parameters
- msg: NotificationMessage
Returns void
- Defined in messaging/lib/webkit.js:149

request

request(msg: RequestMessage): Promise<Record<string, any>>
Parameters
- msg: RequestMessage
Returns Promise<Record<string, any>>
- Defined in messaging/lib/webkit.js:156

subscribe(msg: Subscription, callback: (value: unknown) => void): () => void
Parameters
- msg: Subscription
- callback: (value: unknown) => void
Returns () => void
- Defined in messaging/lib/webkit.js:285

Class WebkitMessagingTransportImplements

Example

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebkitMessagingTransport

Properties

config

globals

Type declaration

addEventListener: any

Arrayfrom: { <T>(arrayLike: ArrayLike<T>): T[]; <T, U>( arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any, ): U[]; <T>(iterable: Iterable<T> | ArrayLike<T>): T[]; <T, U>( iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any, ): U[];}

capturedWebkitHandlers: Record<string, any>

Error: ErrorConstructor

getRandomValues: any

JSONparse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any

JSONstringify: { ( value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number, ): string; ( value: any, replacer?: null | (string | number)[], space?: string | number, ): string;}

ObjectDefineProperty: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T

Promise: PromiseConstructor

ReflectDeleteProperty: any

TextDecoder: new (label?: string, options?: TextDecoderOptions) => TextDecoder

TextEncoder: new () => TextEncoder

Uint16Array: Uint16ArrayConstructor

Uint32Array: Uint32ArrayConstructor

Uint8Array: Uint8ArrayConstructor

window: Window & typeof globalThis

messagingContext

Methods

captureWebkitHandlers

Parameters

Returns void

notify

Parameters

Returns void

request

Parameters

Returns Promise<Record<string, any>>

subscribe

Parameters

Returns () => void

Settings

On This Page

Class WebkitMessagingTransport`Implements`

Arrayfrom: {
<T>(arrayLike: ArrayLike<T>): T[];
<T, U>(
arrayLike: ArrayLike<T>,
mapfn: (v: T, k: number) => U,
thisArg?: any,
): U[];
<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
<T, U>(
iterable: Iterable<T> | ArrayLike<T>,
mapfn: (v: T, k: number) => U,
thisArg?: any,
): U[];
}

JSONstringify: {
(
value: any,
replacer?: (this: any, key: string, value: any) => any,
space?: string | number,
): string;
(
value: any,
replacer?: null | (string | number)[],
space?: string | number,
): string;
}