Interface IClipboard

The interface for the system clipboard.

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

Index

Methods

clear getData hasData setData

Methods

clear

clear(): void
Clear the clipboard.

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

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:132

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:124

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:140