@openfin/core 40.83.3 → 40.200.2
Sign up to get free protection for your applications and to get access to all the features.
- package/out/mock-alpha.d.ts +198 -337
- package/out/mock-beta.d.ts +198 -337
- package/out/mock-public.d.ts +198 -337
- package/out/mock.d.ts +199 -346
- package/out/mock.js +9658 -9766
- package/package.json +1 -1
package/out/mock.d.ts
CHANGED
@@ -2304,6 +2304,8 @@ declare class Channel extends EmitterBase<ChannelEvent> {
|
|
2304
2304
|
|
2305
2305
|
declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
2306
2306
|
|
2307
|
+
declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
2308
|
+
|
2307
2309
|
declare type ChannelAction = OpenFin_2.ChannelAction;
|
2308
2310
|
|
2309
2311
|
declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
|
@@ -2994,18 +2996,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
2994
2996
|
childOptions: OpenFin_2.WindowOptions;
|
2995
2997
|
};
|
2996
2998
|
|
2997
|
-
/**
|
2998
|
-
* Control behavior for Chromium policies
|
2999
|
-
*
|
3000
|
-
* @interface
|
3001
|
-
*/
|
3002
|
-
declare type ChromiumPolicies = {
|
3003
|
-
/**
|
3004
|
-
* Disable AutofillAddressEnabled policy for a Window or View.
|
3005
|
-
*/
|
3006
|
-
AutofillAddressEnabled?: PolicyOptions;
|
3007
|
-
};
|
3008
|
-
|
3009
2999
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
3010
3000
|
type: 'classic';
|
3011
3001
|
}
|
@@ -3477,6 +3467,10 @@ declare type ConstViewOptions = {
|
|
3477
3467
|
* but the properties in the manifest will take precedence if there is any collision.
|
3478
3468
|
*/
|
3479
3469
|
manifestUrl: string;
|
3470
|
+
/**
|
3471
|
+
* If true, the view's call to the Web Notifications API will be intercepted by the platform. The event `notification-intercepted` will be emitted with the notification object as the payload.
|
3472
|
+
*/
|
3473
|
+
interceptNotifications: boolean;
|
3480
3474
|
zoomLevel: number;
|
3481
3475
|
experimental: any;
|
3482
3476
|
fdc3InteropApi?: string;
|
@@ -3520,10 +3514,6 @@ declare type ConstViewOptions = {
|
|
3520
3514
|
*/
|
3521
3515
|
enabled: boolean;
|
3522
3516
|
};
|
3523
|
-
/**
|
3524
|
-
* Control which options to ignore when creating a Platform View.
|
3525
|
-
*/
|
3526
|
-
excludeOptions: ExcludeOptions;
|
3527
3517
|
};
|
3528
3518
|
|
3529
3519
|
/**
|
@@ -3654,6 +3644,12 @@ declare type ConstWindowOptions = {
|
|
3654
3644
|
*/
|
3655
3645
|
downloadShelf: DownloadShelfOptions;
|
3656
3646
|
height: number;
|
3647
|
+
/**
|
3648
|
+
* @defaultValue false
|
3649
|
+
* @remarks
|
3650
|
+
* When set to `true` the platform will intercept all web notifications and instead raise `notification-intercepted` events.
|
3651
|
+
*/
|
3652
|
+
interceptNotifications: boolean;
|
3657
3653
|
layout: any;
|
3658
3654
|
/**
|
3659
3655
|
* @experimental
|
@@ -3732,6 +3728,11 @@ declare type ConstWindowOptions = {
|
|
3732
3728
|
* @deprecated - use `icon` instead.
|
3733
3729
|
*/
|
3734
3730
|
taskbarIcon: string;
|
3731
|
+
/**
|
3732
|
+
* Specify a taskbar group for the window.
|
3733
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
3734
|
+
*/
|
3735
|
+
taskbarIconGroup: string;
|
3735
3736
|
/**
|
3736
3737
|
* @defaultValue "about:blank"
|
3737
3738
|
*
|
@@ -3768,10 +3769,6 @@ declare type ConstWindowOptions = {
|
|
3768
3769
|
* Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
|
3769
3770
|
*/
|
3770
3771
|
inheritance?: Partial<InheritableOptions>;
|
3771
|
-
/**
|
3772
|
-
* Control which options to ignore when creating a Platform Window.
|
3773
|
-
*/
|
3774
|
-
excludeOptions: ExcludeOptions;
|
3775
3772
|
};
|
3776
3773
|
|
3777
3774
|
/**
|
@@ -4778,7 +4775,6 @@ declare interface Environment {
|
|
4778
4775
|
getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
|
4779
4776
|
fdc3Version?: Version;
|
4780
4777
|
}>;
|
4781
|
-
getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
|
4782
4778
|
readonly type: EnvironmentType;
|
4783
4779
|
}
|
4784
4780
|
|
@@ -4812,7 +4808,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
4812
4808
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
4813
4809
|
* from which they propagate).
|
4814
4810
|
*/
|
4815
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent |
|
4811
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | NotificationCloseRequested;
|
4816
4812
|
|
4817
4813
|
/**
|
4818
4814
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
@@ -4852,7 +4848,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
4852
4848
|
*/
|
4853
4849
|
declare type Event_5<Topic extends string> = {
|
4854
4850
|
topic: Topic;
|
4855
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
|
4851
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent | NotificationInterceptedEvent);
|
4856
4852
|
|
4857
4853
|
/**
|
4858
4854
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
@@ -4966,18 +4962,6 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
4966
4962
|
appVersionId: string;
|
4967
4963
|
} : never;
|
4968
4964
|
|
4969
|
-
/**
|
4970
|
-
* @interface
|
4971
|
-
*/
|
4972
|
-
declare type ExcludeOptions = {
|
4973
|
-
/**
|
4974
|
-
* @defaultValue false
|
4975
|
-
*
|
4976
|
-
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
4977
|
-
*/
|
4978
|
-
preloadScripts: boolean;
|
4979
|
-
};
|
4980
|
-
|
4981
4965
|
/**
|
4982
4966
|
* @internal
|
4983
4967
|
*
|
@@ -5002,105 +4986,6 @@ declare type ExitCode = {
|
|
5002
4986
|
exitCode: number;
|
5003
4987
|
};
|
5004
4988
|
|
5005
|
-
declare type ExtensionEvent = SecurityRealmEvent & {
|
5006
|
-
/**
|
5007
|
-
* Runtime extension whose status has been (possibly) modified
|
5008
|
-
*/
|
5009
|
-
extension: string;
|
5010
|
-
};
|
5011
|
-
|
5012
|
-
/**
|
5013
|
-
* @interface
|
5014
|
-
*/
|
5015
|
-
declare type ExtensionInfo = {
|
5016
|
-
extensionId: string;
|
5017
|
-
name: string;
|
5018
|
-
enabled: boolean;
|
5019
|
-
};
|
5020
|
-
|
5021
|
-
/**
|
5022
|
-
* An event that fires when an extension is installed in the security realm.
|
5023
|
-
*
|
5024
|
-
* @interface
|
5025
|
-
*/
|
5026
|
-
declare type ExtensionInstalledEvent = ExtensionEvent & {
|
5027
|
-
type: 'extension-installed';
|
5028
|
-
};
|
5029
|
-
|
5030
|
-
/**
|
5031
|
-
* An event that fires when an extension fails to install in the security realm.
|
5032
|
-
*
|
5033
|
-
* @interface
|
5034
|
-
*/
|
5035
|
-
declare type ExtensionInstallFailedEvent = ExtensionEvent & {
|
5036
|
-
type: 'extension-install-failed';
|
5037
|
-
};
|
5038
|
-
|
5039
|
-
/**
|
5040
|
-
* An event that fires when extensions are disabled in the security realm.
|
5041
|
-
*
|
5042
|
-
* @interface
|
5043
|
-
*/
|
5044
|
-
declare type ExtensionsDisabledEvent = ExtensionsEvent & {
|
5045
|
-
type: 'extensions-disabled';
|
5046
|
-
};
|
5047
|
-
|
5048
|
-
/**
|
5049
|
-
* An event that fires when extensions are enabled in the security realm.
|
5050
|
-
*
|
5051
|
-
* @interface
|
5052
|
-
*/
|
5053
|
-
declare type ExtensionsEnabledEvent = ExtensionsEvent & {
|
5054
|
-
type: 'extensions-enabled';
|
5055
|
-
};
|
5056
|
-
|
5057
|
-
declare type ExtensionsEvent = SecurityRealmEvent & {
|
5058
|
-
/**
|
5059
|
-
* Runtime extensions whose status has been (possibly) modified
|
5060
|
-
*/
|
5061
|
-
extensions: string[];
|
5062
|
-
};
|
5063
|
-
|
5064
|
-
/**
|
5065
|
-
* An event that fires when requested extensions are not allowed to be installed in the security realm.
|
5066
|
-
*
|
5067
|
-
* @interface
|
5068
|
-
*/
|
5069
|
-
declare type ExtensionsExcludedEvent = ExtensionsEvent & {
|
5070
|
-
type: 'extensions-excluded';
|
5071
|
-
};
|
5072
|
-
|
5073
|
-
/**
|
5074
|
-
* An event that fires when extension initialization fails on initial app launch. Users may attempt to
|
5075
|
-
* re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
|
5076
|
-
* to manual extension refreshes (users should catch the error normally).
|
5077
|
-
*/
|
5078
|
-
declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
|
5079
|
-
type: 'extensions-initialization-failed';
|
5080
|
-
/**
|
5081
|
-
* The error that caused the extension initialization failure
|
5082
|
-
*/
|
5083
|
-
error: Error;
|
5084
|
-
};
|
5085
|
-
|
5086
|
-
/**
|
5087
|
-
* An event that fires when extensions are installed in the security realm.
|
5088
|
-
*
|
5089
|
-
* @interface
|
5090
|
-
*/
|
5091
|
-
declare type ExtensionsInstalledEvent = ExtensionsEvent & {
|
5092
|
-
type: 'extensions-installed';
|
5093
|
-
};
|
5094
|
-
|
5095
|
-
/**
|
5096
|
-
* An event that fires when extensions fail to install in the security realm.
|
5097
|
-
*
|
5098
|
-
* @interface
|
5099
|
-
*/
|
5100
|
-
declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
5101
|
-
type: 'extensions-install-failed';
|
5102
|
-
};
|
5103
|
-
|
5104
4989
|
/**
|
5105
4990
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
5106
4991
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
@@ -7765,10 +7650,6 @@ declare type LaunchIntoPlatformPayload = {
|
|
7765
7650
|
*/
|
7766
7651
|
declare class Layout extends Base {
|
7767
7652
|
#private;
|
7768
|
-
/**
|
7769
|
-
* @internal
|
7770
|
-
*/
|
7771
|
-
static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
|
7772
7653
|
/**
|
7773
7654
|
* @internal
|
7774
7655
|
*/
|
@@ -7874,17 +7755,6 @@ declare class Layout extends Base {
|
|
7874
7755
|
* ```
|
7875
7756
|
*/
|
7876
7757
|
getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
|
7877
|
-
/**
|
7878
|
-
* Retrieves the OpenFin.TabStack instance which the View belongs to.
|
7879
|
-
*
|
7880
|
-
* @example
|
7881
|
-
* ```js
|
7882
|
-
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
7883
|
-
* const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
|
7884
|
-
* console.log(await stack.getViews());
|
7885
|
-
* ```
|
7886
|
-
*/
|
7887
|
-
getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
|
7888
7758
|
/**
|
7889
7759
|
* Replaces the specified view with a view with the provided configuration.
|
7890
7760
|
*
|
@@ -7938,29 +7808,6 @@ declare class Layout extends Base {
|
|
7938
7808
|
* ```
|
7939
7809
|
*/
|
7940
7810
|
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
7941
|
-
/**
|
7942
|
-
* Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
|
7943
|
-
*
|
7944
|
-
* @param viewOptions - The options for creating the view.
|
7945
|
-
* @param options - Optional parameters for adding the view.
|
7946
|
-
* @param options.location - The location where the view should be added.
|
7947
|
-
* @param options.targetView - The target view to which the new view should be added.
|
7948
|
-
* @returns A promise that resolves to an object containing the identity of the added view.
|
7949
|
-
*/
|
7950
|
-
addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
|
7951
|
-
location?: OpenFin_2.CreateViewTarget['location'];
|
7952
|
-
targetView?: OpenFin_2.Identity;
|
7953
|
-
}): Promise<{
|
7954
|
-
identity: OpenFin_2.Identity;
|
7955
|
-
}>;
|
7956
|
-
/**
|
7957
|
-
* Closes a view by its identity. Throws an error if the view does not belong to the current layout.
|
7958
|
-
* Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
|
7959
|
-
*
|
7960
|
-
* @param viewIdentity - The identity of the view to close.
|
7961
|
-
* @returns A promise that resolves when the view is closed.
|
7962
|
-
*/
|
7963
|
-
closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
|
7964
7811
|
}
|
7965
7812
|
|
7966
7813
|
/**
|
@@ -7973,7 +7820,7 @@ declare type LayoutColumn = LayoutItemConfig & {
|
|
7973
7820
|
/**
|
7974
7821
|
* @interface
|
7975
7822
|
*/
|
7976
|
-
declare type LayoutComponent =
|
7823
|
+
declare type LayoutComponent = LayoutItemConfig & {
|
7977
7824
|
/**
|
7978
7825
|
* Only a component type will have this property and it should be set to view.
|
7979
7826
|
*/
|
@@ -7982,7 +7829,6 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
|
|
7982
7829
|
* Only a component type will have this property and it represents the view options of a given component.
|
7983
7830
|
*/
|
7984
7831
|
componentState?: Partial<ViewCreationOptions>;
|
7985
|
-
type: 'component';
|
7986
7832
|
};
|
7987
7833
|
|
7988
7834
|
declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
|
@@ -8066,7 +7912,10 @@ declare type LayoutIdentity = Identity_4 & {
|
|
8066
7912
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
8067
7913
|
type: 'layout-initialized';
|
8068
7914
|
layoutIdentity: OpenFin_2.LayoutIdentity;
|
8069
|
-
ofViews:
|
7915
|
+
ofViews: {
|
7916
|
+
identity: OpenFin_2.Identity;
|
7917
|
+
entityType: 'view';
|
7918
|
+
}[];
|
8070
7919
|
};
|
8071
7920
|
|
8072
7921
|
/**
|
@@ -8174,7 +8023,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8174
8023
|
/**
|
8175
8024
|
* @experimental
|
8176
8025
|
*/
|
8177
|
-
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity
|
8026
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
|
8178
8027
|
/**
|
8179
8028
|
* @experimental
|
8180
8029
|
*/
|
@@ -8275,17 +8124,6 @@ declare class LayoutModule extends Base {
|
|
8275
8124
|
* ```
|
8276
8125
|
*/
|
8277
8126
|
getCurrentSync(): OpenFin_2.Layout;
|
8278
|
-
/**
|
8279
|
-
* Retrieves the OpenFin.Layout instance for the Window the View is attached to.
|
8280
|
-
*
|
8281
|
-
* @example
|
8282
|
-
* ```js
|
8283
|
-
* const viewIdentity = { uuid: 'uuid', name: 'view-name' };
|
8284
|
-
* const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
|
8285
|
-
* console.log(await layout.getCurrentViews());
|
8286
|
-
* ```
|
8287
|
-
*/
|
8288
|
-
getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
|
8289
8127
|
/**
|
8290
8128
|
* Initialize the window's Layout.
|
8291
8129
|
*
|
@@ -9099,10 +8937,6 @@ declare type MutableViewOptions = {
|
|
9099
8937
|
* @defaultValue 'enabled'
|
9100
8938
|
*/
|
9101
8939
|
throttling: ViewThrottling;
|
9102
|
-
/**
|
9103
|
-
* {@inheritDoc ChromiumPolicies}
|
9104
|
-
*/
|
9105
|
-
chromiumPolicies: ChromiumPolicies;
|
9106
8940
|
};
|
9107
8941
|
|
9108
8942
|
/**
|
@@ -9343,12 +9177,6 @@ declare type MutableWindowOptions = {
|
|
9343
9177
|
* Shows the window's icon in the taskbar.
|
9344
9178
|
*/
|
9345
9179
|
showTaskbarIcon: boolean;
|
9346
|
-
/**
|
9347
|
-
* Specify a taskbar group for the window.
|
9348
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
9349
|
-
* @remarks It's only updatable when `enableJumpList` is set to false.
|
9350
|
-
*/
|
9351
|
-
taskbarIconGroup: string;
|
9352
9180
|
interop: InteropConfig;
|
9353
9181
|
/**
|
9354
9182
|
* @internal
|
@@ -9368,10 +9196,6 @@ declare type MutableWindowOptions = {
|
|
9368
9196
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
9369
9197
|
*/
|
9370
9198
|
throttling: WindowThrottling;
|
9371
|
-
/**
|
9372
|
-
* {@inheritDoc ChromiumPolicies}
|
9373
|
-
*/
|
9374
|
-
chromiumPolicies: ChromiumPolicies;
|
9375
9199
|
};
|
9376
9200
|
|
9377
9201
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
@@ -9484,6 +9308,154 @@ declare type NonPropagatedWindowEvent = never;
|
|
9484
9308
|
*/
|
9485
9309
|
declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
|
9486
9310
|
|
9311
|
+
declare type NotificationAction_2 = {
|
9312
|
+
/**
|
9313
|
+
* Type of action this structure represents (BUTTON, TEXT)
|
9314
|
+
*/
|
9315
|
+
type: number;
|
9316
|
+
/**
|
9317
|
+
* Action name that the author can use to distinguish them.
|
9318
|
+
*/
|
9319
|
+
action: string;
|
9320
|
+
/**
|
9321
|
+
* Title of the action button.
|
9322
|
+
*/
|
9323
|
+
title: string;
|
9324
|
+
/**
|
9325
|
+
* URL of the icon for the button. May be empty if no url was specified.
|
9326
|
+
*/
|
9327
|
+
icon: string;
|
9328
|
+
/**
|
9329
|
+
* Placeholder to display for text-based actions in absence of user input.
|
9330
|
+
*/
|
9331
|
+
placeholder: string;
|
9332
|
+
};
|
9333
|
+
|
9334
|
+
/**
|
9335
|
+
* Emitted when a developer has called .close on a notification which has been interecepted.
|
9336
|
+
*/
|
9337
|
+
declare type NotificationCloseRequested = BaseEvent_9 & {
|
9338
|
+
type: 'notification-close-requested';
|
9339
|
+
notificationId: string;
|
9340
|
+
};
|
9341
|
+
|
9342
|
+
declare type NotificationData = {
|
9343
|
+
/**
|
9344
|
+
* Title to be displayed with the Web Notification.
|
9345
|
+
*/
|
9346
|
+
title: string;
|
9347
|
+
/**
|
9348
|
+
* Hint to determine the directionality of the displayed notification.
|
9349
|
+
* (LEFT_TO_RIGHT, RIGHT_TO_LEFT, AUTO)
|
9350
|
+
*/
|
9351
|
+
direction: number;
|
9352
|
+
/**
|
9353
|
+
* BCP 47 language tag describing the notification's contents. Optional.
|
9354
|
+
*/
|
9355
|
+
lang: string;
|
9356
|
+
/**
|
9357
|
+
* Contents of the notification.
|
9358
|
+
*/
|
9359
|
+
body: string;
|
9360
|
+
/**
|
9361
|
+
* Tag of the notification. Notifications sharing both their origin and their, tag
|
9362
|
+
* will replace the first displayed notification.
|
9363
|
+
*/
|
9364
|
+
tag: string;
|
9365
|
+
/**
|
9366
|
+
* URL of the image contents of the notification. May be empty if no url was
|
9367
|
+
* specified.
|
9368
|
+
*/
|
9369
|
+
image: string;
|
9370
|
+
/**
|
9371
|
+
* URL of the icon which is to be displayed with the notification.
|
9372
|
+
*/
|
9373
|
+
icon: string;
|
9374
|
+
/**
|
9375
|
+
* URL of the badge for representing the notification. May be empty if no url was
|
9376
|
+
* specified.
|
9377
|
+
*/
|
9378
|
+
badge: string;
|
9379
|
+
/**
|
9380
|
+
* Vibration pattern for the notification, following the syntax of the Vibration
|
9381
|
+
* API. https://www.w3.org/TR/vibration/
|
9382
|
+
*/
|
9383
|
+
vibration_pattern: number[];
|
9384
|
+
/**
|
9385
|
+
* The time at which the event the notification represents took place.
|
9386
|
+
*/
|
9387
|
+
timestamp: string;
|
9388
|
+
/**
|
9389
|
+
* Whether default notification indicators (sound, vibration, light) should be
|
9390
|
+
* played again if the notification is replacing an older notification.
|
9391
|
+
*/
|
9392
|
+
renotify: boolean;
|
9393
|
+
/**
|
9394
|
+
* Whether default notification indicators (sound, vibration, light) should be
|
9395
|
+
* played again if the notification is replacing an older notification.
|
9396
|
+
*/
|
9397
|
+
silent: boolean;
|
9398
|
+
/**
|
9399
|
+
* Whether the notification should remain onscreen indefinitely, rather than being
|
9400
|
+
* auto-minimized to the notification center (if allowed by platform).
|
9401
|
+
*/
|
9402
|
+
requireInteraction: boolean;
|
9403
|
+
/**
|
9404
|
+
* Base64 encoded Developer-provided data associated with the notification, in the
|
9405
|
+
* form of a serialized string. Must not exceed |kMaximumDeveloperDataSize| bytes.
|
9406
|
+
*/
|
9407
|
+
data: string;
|
9408
|
+
/**
|
9409
|
+
* Actions that should be shown as buttons on the notification.
|
9410
|
+
*/
|
9411
|
+
actions: NotificationAction_2[];
|
9412
|
+
/**
|
9413
|
+
* The time at which the notification should be shown.
|
9414
|
+
*/
|
9415
|
+
showTriggerTimestamp?: string | null;
|
9416
|
+
/**
|
9417
|
+
* Scenarios that define the notification behavior. (DEFAULT, INCOMING_CALL)
|
9418
|
+
*/
|
9419
|
+
scenario: number;
|
9420
|
+
};
|
9421
|
+
|
9422
|
+
declare type NotificationInterceptedEvent = NamedEvent & {
|
9423
|
+
type: 'notification-intercepted';
|
9424
|
+
/**
|
9425
|
+
* id of the notification
|
9426
|
+
*/
|
9427
|
+
notificationId: string;
|
9428
|
+
/**
|
9429
|
+
* origin of the notification
|
9430
|
+
*/
|
9431
|
+
origin: string;
|
9432
|
+
/**
|
9433
|
+
* empty if notification comes from worker
|
9434
|
+
*/
|
9435
|
+
documentUrl: string;
|
9436
|
+
notificationData: NotificationData;
|
9437
|
+
/**
|
9438
|
+
* Image for the notification. The bitmap may be empty if the developer did not
|
9439
|
+
* provide an image, or fetching of the image failed.
|
9440
|
+
*/
|
9441
|
+
image: SerializedImage;
|
9442
|
+
/**
|
9443
|
+
* Main icon for the notification. The bitmap may be empty if the developer did not
|
9444
|
+
* provide an icon, or fetching of the icon failed.
|
9445
|
+
*/
|
9446
|
+
notificationIcon: SerializedImage;
|
9447
|
+
/**
|
9448
|
+
* Badge for the notification. The bitmap may be empty if the developer did not
|
9449
|
+
* provide a badge, or fetching of the badge failed.
|
9450
|
+
*/
|
9451
|
+
badge: SerializedImage;
|
9452
|
+
/**
|
9453
|
+
* Icons for the actions. A bitmap may be empty if the developer did not provide an
|
9454
|
+
* icon, or fetching of the icon failed.
|
9455
|
+
*/
|
9456
|
+
actionIcons: SerializedImage[];
|
9457
|
+
};
|
9458
|
+
|
9487
9459
|
/**
|
9488
9460
|
* @internal
|
9489
9461
|
*
|
@@ -9592,11 +9564,8 @@ declare namespace OpenFin_2 {
|
|
9592
9564
|
ViewVisibilityOptions,
|
9593
9565
|
WindowState,
|
9594
9566
|
AutoplayPolicyOptions,
|
9595
|
-
ExcludeOptions,
|
9596
9567
|
ConstWindowOptions,
|
9597
9568
|
InheritableOptions,
|
9598
|
-
PolicyOptions,
|
9599
|
-
ChromiumPolicies,
|
9600
9569
|
MutableWindowOptions,
|
9601
9570
|
WorkspacePlatformOptions,
|
9602
9571
|
WebRequestHeader,
|
@@ -9630,9 +9599,6 @@ declare namespace OpenFin_2 {
|
|
9630
9599
|
ViewOptions,
|
9631
9600
|
ConstViewOptions,
|
9632
9601
|
ViewState,
|
9633
|
-
ViewCreationSuccess,
|
9634
|
-
ViewCreationFailure,
|
9635
|
-
ViewCreationResult,
|
9636
9602
|
Certificate,
|
9637
9603
|
HostContextChangedPayload,
|
9638
9604
|
ApplySnapshotOptions,
|
@@ -9878,7 +9844,6 @@ declare namespace OpenFin_2 {
|
|
9878
9844
|
RoutingInfo,
|
9879
9845
|
DownloadShelfOptions,
|
9880
9846
|
ViewShowAtOptions,
|
9881
|
-
ExtensionInfo,
|
9882
9847
|
ApplicationEvents,
|
9883
9848
|
BaseEvents,
|
9884
9849
|
ExternalApplicationEvents,
|
@@ -10082,10 +10047,6 @@ declare type PerDomainSettings = {
|
|
10082
10047
|
* {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
|
10083
10048
|
*/
|
10084
10049
|
content?: ContentPermission;
|
10085
|
-
/**
|
10086
|
-
* {@inheritdoc ChromiumPolicies}
|
10087
|
-
*/
|
10088
|
-
chromiumPolicies?: ChromiumPolicies;
|
10089
10050
|
};
|
10090
10051
|
|
10091
10052
|
/**
|
@@ -10133,14 +10094,8 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
10133
10094
|
identity: OpenFin_2.ApplicationIdentity;
|
10134
10095
|
/**
|
10135
10096
|
* @internal
|
10136
|
-
* Reuse clients to avoid overwriting already-registered client in provider
|
10137
|
-
* This ensures that only channel client is created per channel name per `fin` instance
|
10138
10097
|
*/
|
10139
|
-
|
10140
|
-
/**
|
10141
|
-
* @internal
|
10142
|
-
*/
|
10143
|
-
constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity, channelName?: string);
|
10098
|
+
constructor(identity: OpenFin_2.ApplicationIdentity, channel: Channel_3);
|
10144
10099
|
getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
|
10145
10100
|
/**
|
10146
10101
|
* Creates a new view and attaches it to a specified target window.
|
@@ -11524,45 +11479,6 @@ declare interface PlatformProvider {
|
|
11524
11479
|
* @returns {Promise<void>}
|
11525
11480
|
*/
|
11526
11481
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
11527
|
-
/**
|
11528
|
-
* @experimental
|
11529
|
-
*
|
11530
|
-
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
11531
|
-
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
11532
|
-
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
11533
|
-
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
11534
|
-
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
11535
|
-
*
|
11536
|
-
* @param viewIdentity Identity of the view
|
11537
|
-
* @param error error thrown during a view creation
|
11538
|
-
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
11539
|
-
*
|
11540
|
-
* @example
|
11541
|
-
*
|
11542
|
-
* ```js
|
11543
|
-
* const overrideCallback = (PlatformProvider) => {
|
11544
|
-
* class Override extends PlatformProvider {
|
11545
|
-
* async handleFailedViewCreation(viewIdentity, error) {
|
11546
|
-
* const view = fin.View.wrapSync(viewId);
|
11547
|
-
* try {
|
11548
|
-
* // navigate to an error page
|
11549
|
-
* await view.navigate('http://localhost:3000/errorPage.html');
|
11550
|
-
* // resolve a success result after redirecting to a error page
|
11551
|
-
* return {identity: viewIdentity, success: true};
|
11552
|
-
* } catch(e) {
|
11553
|
-
* // layout-initialized event will include this view with the error
|
11554
|
-
* throw error;
|
11555
|
-
* }
|
11556
|
-
* }
|
11557
|
-
* }
|
11558
|
-
* return new Override();
|
11559
|
-
* }
|
11560
|
-
*
|
11561
|
-
* fin.Platform.init({ overrideCallback });
|
11562
|
-
*
|
11563
|
-
* ```
|
11564
|
-
*/
|
11565
|
-
handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
|
11566
11482
|
}
|
11567
11483
|
|
11568
11484
|
/**
|
@@ -11627,12 +11543,6 @@ declare type PointTopLeft = {
|
|
11627
11543
|
left: number;
|
11628
11544
|
};
|
11629
11545
|
|
11630
|
-
/**
|
11631
|
-
* When set to `disable`, disables the policy
|
11632
|
-
* When set to `defer-to-group-policy`, respects Group Policy settings
|
11633
|
-
*/
|
11634
|
-
declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
|
11635
|
-
|
11636
11546
|
declare type PopupBaseBehavior = 'close' | 'hide';
|
11637
11547
|
|
11638
11548
|
declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
@@ -12490,6 +12400,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
12490
12400
|
'get-version': GetterCall<string>;
|
12491
12401
|
'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
|
12492
12402
|
'delete-cache-request': VoidCall;
|
12403
|
+
'dispatch-notification-action': {
|
12404
|
+
request: {
|
12405
|
+
notificationId: string;
|
12406
|
+
action: 'click' | 'close' | 'show';
|
12407
|
+
};
|
12408
|
+
response: void;
|
12409
|
+
};
|
12493
12410
|
'exit-desktop': VoidCall;
|
12494
12411
|
'fetch-manifest': ApiCall<{
|
12495
12412
|
manifestUrl: string;
|
@@ -12648,14 +12565,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
12648
12565
|
}, void>;
|
12649
12566
|
'system-register-shutdown-handler': VoidCall;
|
12650
12567
|
'get-permissions': GetterCall<any>;
|
12651
|
-
'refresh-extensions': {
|
12652
|
-
request: void;
|
12653
|
-
response: string[] | undefined;
|
12654
|
-
};
|
12655
|
-
'get-installed-extensions': {
|
12656
|
-
request: void;
|
12657
|
-
response: OpenFin_2.ExtensionInfo[];
|
12658
|
-
};
|
12659
12568
|
'fdc3-add-context-listener': VoidCall;
|
12660
12569
|
'fdc3-add-intent-listener': VoidCall;
|
12661
12570
|
'fdc3-raise-intent': VoidCall;
|
@@ -13344,21 +13253,6 @@ declare type ScreenshotPrintOptions = {
|
|
13344
13253
|
content: 'screenshot';
|
13345
13254
|
};
|
13346
13255
|
|
13347
|
-
/**
|
13348
|
-
* An event generated when an application modifies the runtime in a way that affects all other applications in the
|
13349
|
-
* application runtime/security realm.
|
13350
|
-
*/
|
13351
|
-
declare type SecurityRealmEvent = BaseEvent_9 & {
|
13352
|
-
/**
|
13353
|
-
* Config URL of the application that modified the security realm's extensions
|
13354
|
-
*/
|
13355
|
-
configUrl: string;
|
13356
|
-
/**
|
13357
|
-
* Identity of the application that modified the security realm's extensions
|
13358
|
-
*/
|
13359
|
-
applicationIdentity: OpenFin_2.ApplicationIdentity;
|
13360
|
-
};
|
13361
|
-
|
13362
13256
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
13363
13257
|
data: ProtocolMap[T]['response'];
|
13364
13258
|
} & ProtocolMap[T]['specialResponse']>;
|
@@ -13375,6 +13269,11 @@ declare type SentMessage<Value> = Promise<Value> & {
|
|
13375
13269
|
messageId: ReturnType<Environment['getNextMessageId']>;
|
13376
13270
|
};
|
13377
13271
|
|
13272
|
+
/**
|
13273
|
+
* Utility type to mark an image serialized as a base64 data URL.
|
13274
|
+
*/
|
13275
|
+
declare type SerializedImage = string;
|
13276
|
+
|
13378
13277
|
/**
|
13379
13278
|
* @interface
|
13380
13279
|
*/
|
@@ -13817,6 +13716,13 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
13817
13716
|
* @internal
|
13818
13717
|
*/
|
13819
13718
|
constructor(wire: Transport);
|
13719
|
+
/**
|
13720
|
+
* Dispatch an event to the webcontents that created the notification.
|
13721
|
+
* Only works for notifications that have been intercepted in the same runtime.
|
13722
|
+
*/
|
13723
|
+
dispatchNotificationAction(notificationId: string, { action }: {
|
13724
|
+
action: 'click' | 'close' | 'show';
|
13725
|
+
}): Promise<void>;
|
13820
13726
|
private sendExternalProcessRequest;
|
13821
13727
|
/**
|
13822
13728
|
* Returns the version of the runtime. The version contains the major, minor,
|
@@ -15256,16 +15162,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
15256
15162
|
* ```
|
15257
15163
|
*/
|
15258
15164
|
setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
|
15259
|
-
/**
|
15260
|
-
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
15261
|
-
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
15262
|
-
* will be installed/enabled.
|
15263
|
-
*/
|
15264
|
-
refreshExtensions(): Promise<string[] | undefined>;
|
15265
|
-
/**
|
15266
|
-
* Gets the currently-installed
|
15267
|
-
*/
|
15268
|
-
getInstalledExtensions(): Promise<OpenFin_2.ExtensionInfo[]>;
|
15269
15165
|
}
|
15270
15166
|
|
15271
15167
|
/**
|
@@ -15283,6 +15179,7 @@ declare namespace SystemEvents {
|
|
15283
15179
|
IdleStateChangedEvent,
|
15284
15180
|
IdleEvent,
|
15285
15181
|
MonitorInfoChangedEvent,
|
15182
|
+
NotificationCloseRequested,
|
15286
15183
|
MonitorEvent,
|
15287
15184
|
SessionChangedEvent,
|
15288
15185
|
AppVersionEvent,
|
@@ -15296,14 +15193,6 @@ declare namespace SystemEvents {
|
|
15296
15193
|
ApplicationCreatedEvent,
|
15297
15194
|
DesktopIconClickedEvent,
|
15298
15195
|
SystemShutdownEvent,
|
15299
|
-
ExtensionsEnabledEvent,
|
15300
|
-
ExtensionsDisabledEvent,
|
15301
|
-
ExtensionsExcludedEvent,
|
15302
|
-
ExtensionsInstalledEvent,
|
15303
|
-
ExtensionInstalledEvent,
|
15304
|
-
ExtensionsInstallFailedEvent,
|
15305
|
-
ExtensionInstallFailedEvent,
|
15306
|
-
ExtensionsInitializationFailedEvent,
|
15307
15196
|
Event_11 as Event,
|
15308
15197
|
SystemEvent,
|
15309
15198
|
EventType_8 as EventType,
|
@@ -16118,7 +16007,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
|
|
16118
16007
|
*/
|
16119
16008
|
getInfo: () => Promise<OpenFin_2.ViewInfo>;
|
16120
16009
|
/**
|
16121
|
-
* Retrieves the
|
16010
|
+
* Retrieves the layout for the window the view is attached to.
|
16122
16011
|
*
|
16123
16012
|
* @example
|
16124
16013
|
* ```js
|
@@ -16316,24 +16205,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
16316
16205
|
options?: Partial<ViewOptions>;
|
16317
16206
|
};
|
16318
16207
|
|
16319
|
-
/**
|
16320
|
-
* @interface
|
16321
|
-
*/
|
16322
|
-
declare type ViewCreationFailure = {
|
16323
|
-
/**
|
16324
|
-
* The identity of the created view
|
16325
|
-
*/
|
16326
|
-
identity: Identity_4;
|
16327
|
-
/**
|
16328
|
-
* Whether the view was created with errors
|
16329
|
-
*/
|
16330
|
-
success: false;
|
16331
|
-
/**
|
16332
|
-
* Error thrown during view creation
|
16333
|
-
*/
|
16334
|
-
error: Error;
|
16335
|
-
};
|
16336
|
-
|
16337
16208
|
/**
|
16338
16209
|
* The options object required by {@link View.ViewModule.create View.create}.
|
16339
16210
|
*
|
@@ -16349,25 +16220,6 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
16349
16220
|
|
16350
16221
|
declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
|
16351
16222
|
|
16352
|
-
/**
|
16353
|
-
* A view creation state
|
16354
|
-
*/
|
16355
|
-
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
16356
|
-
|
16357
|
-
/**
|
16358
|
-
* @interface
|
16359
|
-
*/
|
16360
|
-
declare type ViewCreationSuccess = {
|
16361
|
-
/**
|
16362
|
-
* The identity of the created view
|
16363
|
-
*/
|
16364
|
-
identity: Identity_4;
|
16365
|
-
/**
|
16366
|
-
* Whether the view was created without errors
|
16367
|
-
*/
|
16368
|
-
success: true;
|
16369
|
-
};
|
16370
|
-
|
16371
16223
|
/**
|
16372
16224
|
* Generated when a window has a view detached from it.
|
16373
16225
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
@@ -16529,9 +16381,6 @@ declare class ViewModule extends Base {
|
|
16529
16381
|
*/
|
16530
16382
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
16531
16383
|
|
16532
|
-
/**
|
16533
|
-
* @interface
|
16534
|
-
*/
|
16535
16384
|
declare type ViewShowAtOptions = {
|
16536
16385
|
/**
|
16537
16386
|
* Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
|
@@ -17618,6 +17467,10 @@ declare namespace WebContentsEvents {
|
|
17618
17467
|
FileDownloadProgressEvent,
|
17619
17468
|
FileDownloadCompletedEvent,
|
17620
17469
|
ContentBlockedEvent,
|
17470
|
+
SerializedImage,
|
17471
|
+
NotificationAction_2 as NotificationAction,
|
17472
|
+
NotificationData,
|
17473
|
+
NotificationInterceptedEvent,
|
17621
17474
|
Event_5 as Event,
|
17622
17475
|
WebContentsEvent,
|
17623
17476
|
WillPropagateWebContentsEvent,
|