@openfin/core 33.76.6 → 33.76.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -9
- package/openfin-core-33.76.9.tgz +0 -0
- package/package.json +1 -1
- package/src/OpenFin.d.ts +51 -6
- package/src/OpenFin.js +0 -3
- package/src/api/clipboard/index.d.ts +44 -23
- package/src/api/clipboard/index.js +63 -32
- package/src/api/interop/fdc3/shapes/fdc3v1.d.ts +10 -10
- package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +14 -14
- package/src/api/system/index.d.ts +7 -0
- package/src/api/system/index.js +9 -0
- package/src/shapes/protocol.d.ts +14 -0
- package/src/transport/wire.d.ts +0 -1
package/README.md
CHANGED
|
@@ -8,19 +8,19 @@ Libraries are also available for the following frameworks:
|
|
|
8
8
|
* [.Net](https://developers.openfin.co/of-docs/docs/net-api)
|
|
9
9
|
* [Java](https://developers.openfin.co/of-docs/docs/java-api)
|
|
10
10
|
|
|
11
|
-
## Prerequsites
|
|
12
|
-
|
|
13
|
-
None.
|
|
14
|
-
|
|
15
11
|
## Installation
|
|
16
12
|
|
|
17
13
|
This package cannot be installed as a dev dependency because it is not types-only.
|
|
18
14
|
|
|
19
15
|
With npm:
|
|
20
|
-
|
|
16
|
+
```bash
|
|
17
|
+
$ npm i -S @openfin/core
|
|
18
|
+
```
|
|
21
19
|
|
|
22
20
|
With yarn:
|
|
23
|
-
|
|
21
|
+
```bash
|
|
22
|
+
$ yarn add @openfin/core
|
|
23
|
+
```
|
|
24
24
|
|
|
25
25
|
## Usage
|
|
26
26
|
|
|
@@ -35,9 +35,38 @@ const showWindow = async (identity: OpenFin.Identity) => {
|
|
|
35
35
|
const win = await fin.Window.wrap(identity);
|
|
36
36
|
await win.show();
|
|
37
37
|
|
|
38
|
-
const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
|
|
38
|
+
const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Migrating to v30+
|
|
43
|
+
|
|
44
|
+
Prior to v30, the `OpenFin` namespace was ambiently declared and always available. Starting with v30, you must import it directly or specify it in the tsconfig.
|
|
45
|
+
|
|
46
|
+
### Importing the type
|
|
47
|
+
|
|
48
|
+
To import the `OpenFin` namespace:
|
|
49
|
+
```typescript
|
|
50
|
+
import OpenFin from "@openfin/core";
|
|
51
|
+
|
|
52
|
+
type OFWindow = OpenFin.Window;
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### TSConfig types array
|
|
56
|
+
|
|
57
|
+
To have the `OpenFin` available in your code automatically, just update your tsconfig `types` key:
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"compilerOptions": {
|
|
61
|
+
"target": ...,
|
|
62
|
+
"module": ...,
|
|
63
|
+
...,
|
|
64
|
+
"types": ["@openfin/core/OpenFin"]
|
|
65
|
+
}
|
|
39
66
|
}
|
|
67
|
+
|
|
40
68
|
```
|
|
69
|
+
|
|
41
70
|
## For more information
|
|
42
71
|
|
|
43
72
|
- [Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
|
|
@@ -45,11 +74,10 @@ const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
|
|
|
45
74
|
|
|
46
75
|
## License
|
|
47
76
|
|
|
48
|
-
Copyright 2020-
|
|
77
|
+
Copyright 2020-2023 OpenFin
|
|
49
78
|
|
|
50
79
|
The code in this package is distributed under the Apache License, Version 2.0.
|
|
51
80
|
|
|
52
81
|
However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
|
|
53
82
|
|
|
54
|
-
- [Licensing](https://www.openfin.co/licensing/)
|
|
55
83
|
- [Developer agreement](https://openfin.co/developer-agreement/)
|
|
Binary file
|
package/package.json
CHANGED
package/src/OpenFin.d.ts
CHANGED
|
@@ -2002,27 +2002,66 @@ export type WindowViewsPrintOptions = {
|
|
|
2002
2002
|
includeSelf?: boolean;
|
|
2003
2003
|
};
|
|
2004
2004
|
export type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
2005
|
+
export type ImageFormatOptions = {
|
|
2006
|
+
format: 'dataURL' | 'png' | 'bmp';
|
|
2007
|
+
} | {
|
|
2008
|
+
format: 'jpg';
|
|
2009
|
+
/**
|
|
2010
|
+
* Must be between 0-100, defaults to 100 if out of bounds or not specified
|
|
2011
|
+
*/
|
|
2012
|
+
quality?: number;
|
|
2013
|
+
};
|
|
2014
|
+
/**
|
|
2015
|
+
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
|
2016
|
+
* Defaults to 'clipboard'. Use 'selection' for linux only.
|
|
2017
|
+
*/
|
|
2018
|
+
export type ClipboardSelectionType = 'clipboard' | 'selection';
|
|
2019
|
+
export type BaseClipboardRequest = {
|
|
2020
|
+
/**
|
|
2021
|
+
* The type of clipboard to write to, can be 'clipboard' or 'selection'.
|
|
2022
|
+
* Defaults to 'clipboard'. Use 'selection' for linux only.
|
|
2023
|
+
*/
|
|
2024
|
+
type?: ClipboardSelectionType;
|
|
2025
|
+
};
|
|
2005
2026
|
/**
|
|
2006
2027
|
* A request to write data to the clipboard.
|
|
2007
2028
|
*/
|
|
2008
|
-
export type
|
|
2029
|
+
export type WriteClipboardRequest = BaseClipboardRequest & {
|
|
2009
2030
|
/**
|
|
2010
2031
|
* Data to write to the clipboard.
|
|
2011
2032
|
*/
|
|
2012
2033
|
data: string;
|
|
2034
|
+
};
|
|
2035
|
+
export type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
|
|
2036
|
+
export type WriteImageClipboardRequest = BaseClipboardRequest & {
|
|
2013
2037
|
/**
|
|
2014
|
-
*
|
|
2038
|
+
* Must be a base-64 data URL string. Supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`
|
|
2039
|
+
* // TODO: Named this `imageDataURL` but the other write request types use `data` - wanted to make it obvious it must be a dataURL string - thoughts?
|
|
2015
2040
|
*/
|
|
2016
|
-
|
|
2041
|
+
imageDataURL: string;
|
|
2017
2042
|
};
|
|
2018
|
-
|
|
2043
|
+
/**
|
|
2044
|
+
* A generic request to write any supported data to the clipboard.
|
|
2045
|
+
*/
|
|
2046
|
+
export type WriteAnyClipboardRequest = BaseClipboardRequest & {
|
|
2019
2047
|
data: {
|
|
2020
2048
|
text?: string;
|
|
2021
2049
|
html?: string;
|
|
2022
2050
|
rtf?: string;
|
|
2023
2051
|
};
|
|
2024
|
-
type?: string;
|
|
2025
2052
|
};
|
|
2053
|
+
/**
|
|
2054
|
+
* @deprecated - instead use OpenFin.WriteClipboardRequest
|
|
2055
|
+
*
|
|
2056
|
+
* A request to write data to the clipboard.
|
|
2057
|
+
*/
|
|
2058
|
+
export type WriteRequestType = WriteClipboardRequest;
|
|
2059
|
+
/**
|
|
2060
|
+
* @deprecated - instead use WriteAnyClipboardRequest
|
|
2061
|
+
*
|
|
2062
|
+
* A generic request to write any supported data to the clipboard.
|
|
2063
|
+
*/
|
|
2064
|
+
export type WriteAnyRequestType = WriteAnyClipboardRequest;
|
|
2026
2065
|
export type SubscriptionOptions = {
|
|
2027
2066
|
/**
|
|
2028
2067
|
* The event timestamp.
|
|
@@ -3032,4 +3071,10 @@ export interface CapturePageOptions {
|
|
|
3032
3071
|
*/
|
|
3033
3072
|
quality?: number;
|
|
3034
3073
|
}
|
|
3035
|
-
export
|
|
3074
|
+
export interface ProcessLoggingOptions {
|
|
3075
|
+
interval?: number;
|
|
3076
|
+
outlierDetection?: {
|
|
3077
|
+
interval?: number;
|
|
3078
|
+
entries?: number;
|
|
3079
|
+
};
|
|
3080
|
+
}
|
package/src/OpenFin.js
CHANGED
|
@@ -7,6 +7,13 @@ import { Base } from '../base';
|
|
|
7
7
|
* @property { string } data Data to be written
|
|
8
8
|
* @property { string } [type] Clipboard Type
|
|
9
9
|
*/
|
|
10
|
+
/**
|
|
11
|
+
* @PORTED
|
|
12
|
+
* OpenFin.WriteAnyClipboardRequest interface
|
|
13
|
+
* @typedef { object } OpenFin.WriteAnyClipboardRequest
|
|
14
|
+
* @property { string } data Data to be written
|
|
15
|
+
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
16
|
+
*/
|
|
10
17
|
/**
|
|
11
18
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
|
12
19
|
* @namespace
|
|
@@ -14,58 +21,72 @@ import { Base } from '../base';
|
|
|
14
21
|
export default class Clipboard extends Base {
|
|
15
22
|
/**
|
|
16
23
|
* Writes data into the clipboard as plain text
|
|
17
|
-
* @param {
|
|
18
|
-
* @return {Promise.<void>}
|
|
24
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
25
|
+
* @return { Promise.<void> }
|
|
19
26
|
* @tutorial Clipboard.writeText
|
|
20
27
|
*/
|
|
21
|
-
writeText(writeObj: OpenFin.
|
|
28
|
+
writeText(writeObj: OpenFin.WriteClipboardRequest): Promise<void>;
|
|
22
29
|
/**
|
|
23
30
|
* Read the content of the clipboard as plain text
|
|
24
|
-
* @param {
|
|
25
|
-
* @return {Promise.<string>}
|
|
31
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
32
|
+
* @return { Promise.<string> }
|
|
26
33
|
* @tutorial Clipboard.readText
|
|
27
34
|
*/
|
|
28
|
-
readText(type?:
|
|
35
|
+
readText(type?: OpenFin.ClipboardSelectionType): Promise<string>;
|
|
36
|
+
/**
|
|
37
|
+
* Writes data into the clipboard as an Image
|
|
38
|
+
* @param { OpenFin.WriteImageClipboardRequest } writeRequest The object to write an image to the clipboard
|
|
39
|
+
* @return { Promise.<void> }
|
|
40
|
+
* @tutorial Clipboard.writeImage
|
|
41
|
+
*/
|
|
42
|
+
writeImage(writeRequest: OpenFin.WriteImageClipboardRequest): Promise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Read the content of the clipboard as a base64 string or a dataURL based on the input parameter 'format', defaults to 'dataURL'
|
|
45
|
+
* @param { OpenFin.ReadImageClipboardRequest } readRequest Clipboard Read Image request with formatting options
|
|
46
|
+
* @return { Promise.<string> }
|
|
47
|
+
* @tutorial Clipboard.readImage
|
|
48
|
+
*/
|
|
49
|
+
readImage(readRequest?: OpenFin.ReadImageClipboardRequest): Promise<string>;
|
|
29
50
|
/**
|
|
30
51
|
* Writes data into the clipboard as Html
|
|
31
|
-
* @param {
|
|
32
|
-
* @return {Promise.<void>}
|
|
52
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
53
|
+
* @return { Promise.<void> }
|
|
33
54
|
* @tutorial Clipboard.writeHtml
|
|
34
55
|
*/
|
|
35
|
-
writeHtml(writeObj: OpenFin.
|
|
56
|
+
writeHtml(writeObj: OpenFin.WriteClipboardRequest): Promise<void>;
|
|
36
57
|
/**
|
|
37
58
|
* Read the content of the clipboard as Html
|
|
38
|
-
* @param {
|
|
39
|
-
* @return {Promise.<string>}
|
|
59
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
60
|
+
* @return { Promise.<string> }
|
|
40
61
|
* @tutorial Clipboard.readHtml
|
|
41
62
|
*/
|
|
42
63
|
readHtml(type?: string): Promise<string>;
|
|
43
64
|
/**
|
|
44
65
|
* Writes data into the clipboard as Rtf
|
|
45
|
-
* @param {
|
|
46
|
-
* @return {Promise.<void>}
|
|
66
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
67
|
+
* @return { Promise.<void> }
|
|
47
68
|
* @tutorial Clipboard.writeRtf
|
|
48
69
|
*/
|
|
49
|
-
writeRtf(writeObj: OpenFin.
|
|
70
|
+
writeRtf(writeObj: OpenFin.WriteClipboardRequest): Promise<void>;
|
|
50
71
|
/**
|
|
51
72
|
* Read the content of the clipboard as Rtf
|
|
52
|
-
* @param {
|
|
53
|
-
* @return {Promise.<string>}
|
|
73
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
74
|
+
* @return { Promise.<string> }
|
|
54
75
|
* @tutorial Clipboard.readRtf
|
|
55
76
|
*/
|
|
56
|
-
readRtf(type?:
|
|
77
|
+
readRtf(type?: OpenFin.ClipboardSelectionType): Promise<string>;
|
|
57
78
|
/**
|
|
58
79
|
* Writes data into the clipboard
|
|
59
|
-
* @param {
|
|
60
|
-
* @return {Promise.<void>}
|
|
80
|
+
* @param { OpenFin.WriteAnyClipboardRequest } writeObj The object for writing data into the clipboard
|
|
81
|
+
* @return { Promise.<void> }
|
|
61
82
|
* @tutorial Clipboard.write
|
|
62
83
|
*/
|
|
63
|
-
write(writeObj: OpenFin.
|
|
84
|
+
write(writeObj: OpenFin.WriteAnyClipboardRequest): Promise<void>;
|
|
64
85
|
/**
|
|
65
86
|
* Reads available formats for the clipboard type
|
|
66
|
-
* @param {
|
|
67
|
-
* @return {Promise.Array.<string>}
|
|
87
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
88
|
+
* @return { Promise.Array.<string> }
|
|
68
89
|
* @tutorial Clipboard.getAvailableFormats
|
|
69
90
|
*/
|
|
70
|
-
getAvailableFormats(type?:
|
|
91
|
+
getAvailableFormats(type?: OpenFin.ClipboardSelectionType): Promise<Array<string>>;
|
|
71
92
|
}
|
|
@@ -8,6 +8,13 @@ const base_1 = require("../base");
|
|
|
8
8
|
* @property { string } data Data to be written
|
|
9
9
|
* @property { string } [type] Clipboard Type
|
|
10
10
|
*/
|
|
11
|
+
/**
|
|
12
|
+
* @PORTED
|
|
13
|
+
* OpenFin.WriteAnyClipboardRequest interface
|
|
14
|
+
* @typedef { object } OpenFin.WriteAnyClipboardRequest
|
|
15
|
+
* @property { string } data Data to be written
|
|
16
|
+
* @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
17
|
+
*/
|
|
11
18
|
/**
|
|
12
19
|
* The Clipboard API allows reading and writing to the clipboard in multiple formats.
|
|
13
20
|
* @namespace
|
|
@@ -15,75 +22,99 @@ const base_1 = require("../base");
|
|
|
15
22
|
class Clipboard extends base_1.Base {
|
|
16
23
|
/**
|
|
17
24
|
* Writes data into the clipboard as plain text
|
|
18
|
-
* @param {
|
|
19
|
-
* @return {Promise.<void>}
|
|
25
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
26
|
+
* @return { Promise.<void> }
|
|
20
27
|
* @tutorial Clipboard.writeText
|
|
21
28
|
*/
|
|
22
|
-
writeText(writeObj) {
|
|
23
|
-
|
|
29
|
+
async writeText(writeObj) {
|
|
30
|
+
await this.wire.sendAction('clipboard-write-text', writeObj);
|
|
24
31
|
}
|
|
25
32
|
/**
|
|
26
33
|
* Read the content of the clipboard as plain text
|
|
27
|
-
* @param {
|
|
28
|
-
* @return {Promise.<string>}
|
|
34
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
35
|
+
* @return { Promise.<string> }
|
|
29
36
|
* @tutorial Clipboard.readText
|
|
30
37
|
*/
|
|
31
|
-
readText(type) {
|
|
32
|
-
|
|
38
|
+
async readText(type) {
|
|
39
|
+
// NOTE: When we start supporting linux, we could detect the OS and choose 'selection' automatically for the user
|
|
40
|
+
const { payload } = await this.wire.sendAction('clipboard-read-text', { type });
|
|
41
|
+
return payload.data;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Writes data into the clipboard as an Image
|
|
45
|
+
* @param { OpenFin.WriteImageClipboardRequest } writeRequest The object to write an image to the clipboard
|
|
46
|
+
* @return { Promise.<void> }
|
|
47
|
+
* @tutorial Clipboard.writeImage
|
|
48
|
+
*/
|
|
49
|
+
async writeImage(writeRequest) {
|
|
50
|
+
await this.wire.sendAction('clipboard-write-image', writeRequest);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Read the content of the clipboard as a base64 string or a dataURL based on the input parameter 'format', defaults to 'dataURL'
|
|
54
|
+
* @param { OpenFin.ReadImageClipboardRequest } readRequest Clipboard Read Image request with formatting options
|
|
55
|
+
* @return { Promise.<string> }
|
|
56
|
+
* @tutorial Clipboard.readImage
|
|
57
|
+
*/
|
|
58
|
+
async readImage(readRequest = { format: 'dataURL' }) {
|
|
59
|
+
const { payload } = await this.wire.sendAction('clipboard-read-image', readRequest);
|
|
60
|
+
return payload.data;
|
|
33
61
|
}
|
|
34
62
|
/**
|
|
35
63
|
* Writes data into the clipboard as Html
|
|
36
|
-
* @param {
|
|
37
|
-
* @return {Promise.<void>}
|
|
64
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
65
|
+
* @return { Promise.<void> }
|
|
38
66
|
* @tutorial Clipboard.writeHtml
|
|
39
67
|
*/
|
|
40
|
-
writeHtml(writeObj) {
|
|
41
|
-
|
|
68
|
+
async writeHtml(writeObj) {
|
|
69
|
+
await this.wire.sendAction('clipboard-write-html', writeObj);
|
|
42
70
|
}
|
|
43
71
|
/**
|
|
44
72
|
* Read the content of the clipboard as Html
|
|
45
|
-
* @param {
|
|
46
|
-
* @return {Promise.<string>}
|
|
73
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
74
|
+
* @return { Promise.<string> }
|
|
47
75
|
* @tutorial Clipboard.readHtml
|
|
48
76
|
*/
|
|
49
|
-
readHtml(type) {
|
|
50
|
-
|
|
77
|
+
async readHtml(type) {
|
|
78
|
+
const { payload } = await this.wire.sendAction('clipboard-read-html', { type });
|
|
79
|
+
return payload.data;
|
|
51
80
|
}
|
|
52
81
|
/**
|
|
53
82
|
* Writes data into the clipboard as Rtf
|
|
54
|
-
* @param {
|
|
55
|
-
* @return {Promise.<void>}
|
|
83
|
+
* @param { OpenFin.WriteClipboardRequest } writeObj The object for writing data into the clipboard
|
|
84
|
+
* @return { Promise.<void> }
|
|
56
85
|
* @tutorial Clipboard.writeRtf
|
|
57
86
|
*/
|
|
58
|
-
writeRtf(writeObj) {
|
|
59
|
-
|
|
87
|
+
async writeRtf(writeObj) {
|
|
88
|
+
await this.wire.sendAction('clipboard-write-rtf', writeObj);
|
|
60
89
|
}
|
|
61
90
|
/**
|
|
62
91
|
* Read the content of the clipboard as Rtf
|
|
63
|
-
* @param {
|
|
64
|
-
* @return {Promise.<string>}
|
|
92
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
93
|
+
* @return { Promise.<string> }
|
|
65
94
|
* @tutorial Clipboard.readRtf
|
|
66
95
|
*/
|
|
67
|
-
readRtf(type) {
|
|
68
|
-
|
|
96
|
+
async readRtf(type) {
|
|
97
|
+
const { payload } = await this.wire.sendAction('clipboard-read-rtf', { type });
|
|
98
|
+
return payload.data;
|
|
69
99
|
}
|
|
70
100
|
/**
|
|
71
101
|
* Writes data into the clipboard
|
|
72
|
-
* @param {
|
|
73
|
-
* @return {Promise.<void>}
|
|
102
|
+
* @param { OpenFin.WriteAnyClipboardRequest } writeObj The object for writing data into the clipboard
|
|
103
|
+
* @return { Promise.<void> }
|
|
74
104
|
* @tutorial Clipboard.write
|
|
75
105
|
*/
|
|
76
|
-
write(writeObj) {
|
|
77
|
-
|
|
106
|
+
async write(writeObj) {
|
|
107
|
+
await this.wire.sendAction('clipboard-write', writeObj);
|
|
78
108
|
}
|
|
79
109
|
/**
|
|
80
110
|
* Reads available formats for the clipboard type
|
|
81
|
-
* @param {
|
|
82
|
-
* @return {Promise.Array.<string>}
|
|
111
|
+
* @param { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
|
|
112
|
+
* @return { Promise.Array.<string> }
|
|
83
113
|
* @tutorial Clipboard.getAvailableFormats
|
|
84
114
|
*/
|
|
85
|
-
getAvailableFormats(type) {
|
|
86
|
-
|
|
115
|
+
async getAvailableFormats(type) {
|
|
116
|
+
const { payload } = await this.wire.sendAction('clipboard-read-formats', { type });
|
|
117
|
+
return payload.data;
|
|
87
118
|
}
|
|
88
119
|
}
|
|
89
120
|
exports.default = Clipboard;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import type { DisplayMetadata } from 'fdc3v1/
|
|
2
|
-
import type { Listener } from 'fdc3v1/
|
|
3
|
-
import type { AppMetadata } from 'fdc3v1/
|
|
4
|
-
import type { AppIntent } from 'fdc3v1/
|
|
5
|
-
import type { ImplementationMetadata } from 'fdc3v1/
|
|
6
|
-
export type { DisplayMetadata } from 'fdc3v1/
|
|
7
|
-
export type { Listener } from 'fdc3v1/
|
|
8
|
-
export type { AppMetadata } from 'fdc3v1/
|
|
9
|
-
export type { AppIntent } from 'fdc3v1/
|
|
10
|
-
export type { ImplementationMetadata } from 'fdc3v1/
|
|
1
|
+
import type { DisplayMetadata } from 'fdc3v1/dist/api/DisplayMetadata';
|
|
2
|
+
import type { Listener } from 'fdc3v1/dist/api/Listener';
|
|
3
|
+
import type { AppMetadata } from 'fdc3v1/dist/api/AppMetadata';
|
|
4
|
+
import type { AppIntent } from 'fdc3v1/dist/api/AppIntent';
|
|
5
|
+
import type { ImplementationMetadata } from 'fdc3v1/dist/api/ImplementationMetadata';
|
|
6
|
+
export type { DisplayMetadata } from 'fdc3v1/dist/api/DisplayMetadata';
|
|
7
|
+
export type { Listener } from 'fdc3v1/dist/api/Listener';
|
|
8
|
+
export type { AppMetadata } from 'fdc3v1/dist/api/AppMetadata';
|
|
9
|
+
export type { AppIntent } from 'fdc3v1/dist/api/AppIntent';
|
|
10
|
+
export type { ImplementationMetadata } from 'fdc3v1/dist/api/ImplementationMetadata';
|
|
11
11
|
export type ContextHandler = (context: Context) => void;
|
|
12
12
|
export type TargetApp = string | AppMetadata;
|
|
13
13
|
export interface Context {
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
import * as OpenFin from '../../../../OpenFin';
|
|
2
2
|
import { Channel as ChannelV1, SystemChannel, TargetApp } from './fdc3v1';
|
|
3
|
-
import type { Listener } from 'fdc3v2/
|
|
4
|
-
import type { AppIntent } from 'fdc3v2/
|
|
5
|
-
import type { ImplementationMetadata } from 'fdc3v2/
|
|
6
|
-
import type { ContextMetadata } from 'fdc3v2/
|
|
7
|
-
import type { AppIdentifier } from 'fdc3v2/
|
|
8
|
-
import type { AppMetadata } from 'fdc3v2/
|
|
9
|
-
import type { DisplayMetadata } from 'fdc3v2/
|
|
10
|
-
export type { Listener } from 'fdc3v2/
|
|
11
|
-
export type { AppIntent } from 'fdc3v2/
|
|
12
|
-
export type { ImplementationMetadata } from 'fdc3v2/
|
|
13
|
-
export type { ContextMetadata } from 'fdc3v2/
|
|
14
|
-
export type { AppIdentifier } from 'fdc3v2/
|
|
15
|
-
export type { AppMetadata } from 'fdc3v2/
|
|
16
|
-
export type { DisplayMetadata } from 'fdc3v2/
|
|
3
|
+
import type { Listener } from 'fdc3v2/dist/api/Listener';
|
|
4
|
+
import type { AppIntent } from 'fdc3v2/dist/api/AppIntent';
|
|
5
|
+
import type { ImplementationMetadata } from 'fdc3v2/dist/api/ImplementationMetadata';
|
|
6
|
+
import type { ContextMetadata } from 'fdc3v2/dist/api/ContextMetadata';
|
|
7
|
+
import type { AppIdentifier } from 'fdc3v2/dist/api/AppIdentifier';
|
|
8
|
+
import type { AppMetadata } from 'fdc3v2/dist/api/AppMetadata';
|
|
9
|
+
import type { DisplayMetadata } from 'fdc3v2/dist/api/DisplayMetadata';
|
|
10
|
+
export type { Listener } from 'fdc3v2/dist/api/Listener';
|
|
11
|
+
export type { AppIntent } from 'fdc3v2/dist/api/AppIntent';
|
|
12
|
+
export type { ImplementationMetadata } from 'fdc3v2/dist/api/ImplementationMetadata';
|
|
13
|
+
export type { ContextMetadata } from 'fdc3v2/dist/api/ContextMetadata';
|
|
14
|
+
export type { AppIdentifier } from 'fdc3v2/dist/api/AppIdentifier';
|
|
15
|
+
export type { AppMetadata } from 'fdc3v2/dist/api/AppMetadata';
|
|
16
|
+
export type { DisplayMetadata } from 'fdc3v2/dist/api/DisplayMetadata';
|
|
17
17
|
export type ContextHandler = (context: Context, metadata?: ContextMetadata) => void;
|
|
18
18
|
export type IntentHandler = (context: Context, metadata?: ContextMetadata) => Promise<IntentResult> | void;
|
|
19
19
|
export type IntentResult = Context | Channel | PrivateChannel;
|
|
@@ -506,5 +506,12 @@ export default class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
506
506
|
* @tutorial System.getPrinters
|
|
507
507
|
*/
|
|
508
508
|
getPrinters(): Promise<PrinterInfo[]>;
|
|
509
|
+
/**
|
|
510
|
+
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
511
|
+
* @param {ProcessLoggingOptions} options Process Logging updatable options.
|
|
512
|
+
* @return { Promise<void> }
|
|
513
|
+
* @tutorial System.updateProcessLoggingOptions
|
|
514
|
+
*/
|
|
515
|
+
updateProcessLoggingOptions(options: OpenFin.ProcessLoggingOptions): Promise<void>;
|
|
509
516
|
}
|
|
510
517
|
export {};
|
package/src/api/system/index.js
CHANGED
|
@@ -882,5 +882,14 @@ class System extends base_1.EmitterBase {
|
|
|
882
882
|
const { payload } = await this.wire.sendAction('system-get-printers');
|
|
883
883
|
return payload.data;
|
|
884
884
|
}
|
|
885
|
+
/**
|
|
886
|
+
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
887
|
+
* @param {ProcessLoggingOptions} options Process Logging updatable options.
|
|
888
|
+
* @return { Promise<void> }
|
|
889
|
+
* @tutorial System.updateProcessLoggingOptions
|
|
890
|
+
*/
|
|
891
|
+
async updateProcessLoggingOptions(options) {
|
|
892
|
+
await this.wire.sendAction('system-update-process-logging-options', { options });
|
|
893
|
+
}
|
|
885
894
|
}
|
|
886
895
|
exports.default = System;
|
package/src/shapes/protocol.d.ts
CHANGED
|
@@ -16,6 +16,20 @@ export interface ProtocolMap extends ProtocolMapBase {
|
|
|
16
16
|
} & OpenFin.ApplicationIdentity;
|
|
17
17
|
response: void;
|
|
18
18
|
};
|
|
19
|
+
'clipboard-read-formats': {
|
|
20
|
+
request: {
|
|
21
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
22
|
+
};
|
|
23
|
+
response: Array<string>;
|
|
24
|
+
};
|
|
25
|
+
'clipboard-read-image': {
|
|
26
|
+
request: OpenFin.ReadImageClipboardRequest;
|
|
27
|
+
response: string;
|
|
28
|
+
};
|
|
29
|
+
'clipboard-write-image': {
|
|
30
|
+
request: OpenFin.WriteImageClipboardRequest;
|
|
31
|
+
response: void;
|
|
32
|
+
};
|
|
19
33
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
20
34
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
21
35
|
uuid: string;
|
package/src/transport/wire.d.ts
CHANGED