Interface RPCErrorPayload

An error raised by the RPC bridge itself rather than by a RecordKit recording — for example calling a method on a recorder that was already cancelled, requesting a feature that needs a newer macOS version, or referencing a window or camera that cannot be found.

Distinguished from RecordKitError and NSErrorPayload by its name discriminator.

interface RPCErrorPayload {
    name: "RPCError";
    message: string;
    userMessage: string;
    debugDescription: string;
}

Properties

name: "RPCError"
message: string

Message describing the problem, intended to be shown directly to the end-user.

userMessage: string

The same message as RPCErrorPayload.message, kept under its legacy field name.

debugDescription: string

Detailed technical description of this error, used in debugging.

Generated using TypeDoc