Interface IClipboard

The interface for the system clipboard.

interface IClipboard {
    clear(): void;
    getData(mime: string): Promise<unknown>;
    hasData(mime: string): Promise<boolean>;
    matchesLastWrite(mime: string, data: unknown): boolean;
    setData(mime: string, data: unknown): Promise<void>;
}

Index

Methods

clear getData hasData matchesLastWrite setData

Methods

clear

clear(): void
Clear the clipboard.

Returns void
- Defined in packages/apputils/src/clipboard.ts:170

getData

getData(mime: string): Promise<unknown>
Retrieve the data for a given mime type. Returns null if the data does not exist.
Parameters
- mime: string
  The mime type to retrieve.
Returns Promise<unknown>
- Defined in packages/apputils/src/clipboard.ts:145

hasData

hasData(mime: string): Promise<boolean>
Whether the clipboard has data for a given mime type. Returns false if the data does not exist.
Parameters
- mime: string
  The mime type to check.
Returns Promise<boolean>
- Defined in packages/apputils/src/clipboard.ts:137

matchesLastWrite

matchesLastWrite(mime: string, data: unknown): boolean
Whether the given data matches the last value this application wrote to the clipboard for this mime type.

Pass the value just returned by getData. Returns false once the current clipboard data differs from what this application last wrote.
Parameters
- mime: string
  The mime type that was retrieved.
- data: unknown
  The data returned by getData.
Returns boolean
- Defined in packages/apputils/src/clipboard.ts:157

setData

setData(mime: string, data: unknown): Promise<void>
Set the data for a given mime type.
Parameters
- mime: string
  The mime type to set.
- data: unknown
  The data to set.
Returns Promise<void>
- Defined in packages/apputils/src/clipboard.ts:165

Interface IClipboard

Index

Methods

Methods

clear

Returns void

getData

Parameters

Returns Promise<unknown>

hasData

Parameters

Returns Promise<boolean>

matchesLastWrite

Parameters

Returns boolean

setData

Parameters

Returns Promise<void>

Settings

On This Page