@openfin/core 40.83.4 → 40.200.2

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.
@@ -2265,6 +2265,8 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2265
2265
 
2266
2266
  declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2267
2267
 
2268
+ declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2269
+
2268
2270
  declare type ChannelAction = OpenFin_2.ChannelAction;
2269
2271
 
2270
2272
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -2938,18 +2940,6 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
2938
2940
  childOptions: OpenFin_2.WindowOptions;
2939
2941
  };
2940
2942
 
2941
- /**
2942
- * Control behavior for Chromium policies
2943
- *
2944
- * @interface
2945
- */
2946
- declare type ChromiumPolicies = {
2947
- /**
2948
- * Disable AutofillAddressEnabled policy for a Window or View.
2949
- */
2950
- AutofillAddressEnabled?: PolicyOptions;
2951
- };
2952
-
2953
2943
  declare interface ClassicProtocolOffer extends ProtocolPacketBase {
2954
2944
  type: 'classic';
2955
2945
  }
@@ -3418,6 +3408,10 @@ declare type ConstViewOptions = {
3418
3408
  * but the properties in the manifest will take precedence if there is any collision.
3419
3409
  */
3420
3410
  manifestUrl: string;
3411
+ /**
3412
+ * 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.
3413
+ */
3414
+ interceptNotifications: boolean;
3421
3415
  zoomLevel: number;
3422
3416
  experimental: any;
3423
3417
  fdc3InteropApi?: string;
@@ -3461,10 +3455,6 @@ declare type ConstViewOptions = {
3461
3455
  */
3462
3456
  enabled: boolean;
3463
3457
  };
3464
- /**
3465
- * Control which options to ignore when creating a Platform View.
3466
- */
3467
- excludeOptions: ExcludeOptions;
3468
3458
  };
3469
3459
 
3470
3460
  /**
@@ -3595,6 +3585,12 @@ declare type ConstWindowOptions = {
3595
3585
  */
3596
3586
  downloadShelf: DownloadShelfOptions;
3597
3587
  height: number;
3588
+ /**
3589
+ * @defaultValue false
3590
+ * @remarks
3591
+ * When set to `true` the platform will intercept all web notifications and instead raise `notification-intercepted` events.
3592
+ */
3593
+ interceptNotifications: boolean;
3598
3594
  layout: any;
3599
3595
  /**
3600
3596
  * @experimental
@@ -3673,6 +3669,11 @@ declare type ConstWindowOptions = {
3673
3669
  * @deprecated - use `icon` instead.
3674
3670
  */
3675
3671
  taskbarIcon: string;
3672
+ /**
3673
+ * Specify a taskbar group for the window.
3674
+ * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
3675
+ */
3676
+ taskbarIconGroup: string;
3676
3677
  /**
3677
3678
  * @defaultValue "about:blank"
3678
3679
  *
@@ -3709,10 +3710,6 @@ declare type ConstWindowOptions = {
3709
3710
  * 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.
3710
3711
  */
3711
3712
  inheritance?: Partial<InheritableOptions>;
3712
- /**
3713
- * Control which options to ignore when creating a Platform Window.
3714
- */
3715
- excludeOptions: ExcludeOptions;
3716
3713
  };
3717
3714
 
3718
3715
  /**
@@ -4714,7 +4711,6 @@ declare interface Environment {
4714
4711
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4715
4712
  fdc3Version?: Version;
4716
4713
  }>;
4717
- getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4718
4714
  readonly type: EnvironmentType;
4719
4715
  }
4720
4716
 
@@ -4748,7 +4744,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4748
4744
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4749
4745
  * from which they propagate).
4750
4746
  */
4751
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4747
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | NotificationCloseRequested;
4752
4748
 
4753
4749
  /**
4754
4750
  * [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.
@@ -4788,7 +4784,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4788
4784
  */
4789
4785
  declare type Event_5<Topic extends string> = {
4790
4786
  topic: Topic;
4791
- } & (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);
4787
+ } & (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);
4792
4788
 
4793
4789
  /**
4794
4790
  * [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
@@ -4893,18 +4889,6 @@ declare type EventType_9 = Event_12['type'];
4893
4889
 
4894
4890
  /* Excluded from this release type: EventWithId */
4895
4891
 
4896
- /**
4897
- * @interface
4898
- */
4899
- declare type ExcludeOptions = {
4900
- /**
4901
- * @defaultValue false
4902
- *
4903
- * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
4904
- */
4905
- preloadScripts: boolean;
4906
- };
4907
-
4908
4892
  /* Excluded from this release type: ExcludeRequested */
4909
4893
 
4910
4894
  declare type ExistingConnectConfig = ConfigWithUuid & {
@@ -4920,105 +4904,6 @@ declare type ExitCode = {
4920
4904
  exitCode: number;
4921
4905
  };
4922
4906
 
4923
- declare type ExtensionEvent = SecurityRealmEvent & {
4924
- /**
4925
- * Runtime extension whose status has been (possibly) modified
4926
- */
4927
- extension: string;
4928
- };
4929
-
4930
- /**
4931
- * @interface
4932
- */
4933
- declare type ExtensionInfo = {
4934
- extensionId: string;
4935
- name: string;
4936
- enabled: boolean;
4937
- };
4938
-
4939
- /**
4940
- * An event that fires when an extension is installed in the security realm.
4941
- *
4942
- * @interface
4943
- */
4944
- declare type ExtensionInstalledEvent = ExtensionEvent & {
4945
- type: 'extension-installed';
4946
- };
4947
-
4948
- /**
4949
- * An event that fires when an extension fails to install in the security realm.
4950
- *
4951
- * @interface
4952
- */
4953
- declare type ExtensionInstallFailedEvent = ExtensionEvent & {
4954
- type: 'extension-install-failed';
4955
- };
4956
-
4957
- /**
4958
- * An event that fires when extensions are disabled in the security realm.
4959
- *
4960
- * @interface
4961
- */
4962
- declare type ExtensionsDisabledEvent = ExtensionsEvent & {
4963
- type: 'extensions-disabled';
4964
- };
4965
-
4966
- /**
4967
- * An event that fires when extensions are enabled in the security realm.
4968
- *
4969
- * @interface
4970
- */
4971
- declare type ExtensionsEnabledEvent = ExtensionsEvent & {
4972
- type: 'extensions-enabled';
4973
- };
4974
-
4975
- declare type ExtensionsEvent = SecurityRealmEvent & {
4976
- /**
4977
- * Runtime extensions whose status has been (possibly) modified
4978
- */
4979
- extensions: string[];
4980
- };
4981
-
4982
- /**
4983
- * An event that fires when requested extensions are not allowed to be installed in the security realm.
4984
- *
4985
- * @interface
4986
- */
4987
- declare type ExtensionsExcludedEvent = ExtensionsEvent & {
4988
- type: 'extensions-excluded';
4989
- };
4990
-
4991
- /**
4992
- * An event that fires when extension initialization fails on initial app launch. Users may attempt to
4993
- * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
4994
- * to manual extension refreshes (users should catch the error normally).
4995
- */
4996
- declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
4997
- type: 'extensions-initialization-failed';
4998
- /**
4999
- * The error that caused the extension initialization failure
5000
- */
5001
- error: Error;
5002
- };
5003
-
5004
- /**
5005
- * An event that fires when extensions are installed in the security realm.
5006
- *
5007
- * @interface
5008
- */
5009
- declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5010
- type: 'extensions-installed';
5011
- };
5012
-
5013
- /**
5014
- * An event that fires when extensions fail to install in the security realm.
5015
- *
5016
- * @interface
5017
- */
5018
- declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5019
- type: 'extensions-install-failed';
5020
- };
5021
-
5022
4907
  /**
5023
4908
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
5024
4909
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -7648,7 +7533,6 @@ declare type LaunchIntoPlatformPayload = {
7648
7533
  */
7649
7534
  declare class Layout extends Base {
7650
7535
  #private;
7651
- /* Excluded from this release type: getClient */
7652
7536
  /* Excluded from this release type: init */
7653
7537
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7654
7538
  private platform;
@@ -7748,17 +7632,6 @@ declare class Layout extends Base {
7748
7632
  * ```
7749
7633
  */
7750
7634
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7751
- /**
7752
- * Retrieves the OpenFin.TabStack instance which the View belongs to.
7753
- *
7754
- * @example
7755
- * ```js
7756
- * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7757
- * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7758
- * console.log(await stack.getViews());
7759
- * ```
7760
- */
7761
- getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7762
7635
  /**
7763
7636
  * Replaces the specified view with a view with the provided configuration.
7764
7637
  *
@@ -7812,29 +7685,6 @@ declare class Layout extends Base {
7812
7685
  * ```
7813
7686
  */
7814
7687
  applyPreset: (options: PresetLayoutOptions) => Promise<void>;
7815
- /**
7816
- * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
7817
- *
7818
- * @param viewOptions - The options for creating the view.
7819
- * @param options - Optional parameters for adding the view.
7820
- * @param options.location - The location where the view should be added.
7821
- * @param options.targetView - The target view to which the new view should be added.
7822
- * @returns A promise that resolves to an object containing the identity of the added view.
7823
- */
7824
- addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
7825
- location?: OpenFin_2.CreateViewTarget['location'];
7826
- targetView?: OpenFin_2.Identity;
7827
- }): Promise<{
7828
- identity: OpenFin_2.Identity;
7829
- }>;
7830
- /**
7831
- * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
7832
- * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
7833
- *
7834
- * @param viewIdentity - The identity of the view to close.
7835
- * @returns A promise that resolves when the view is closed.
7836
- */
7837
- closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
7838
7688
  }
7839
7689
 
7840
7690
  /**
@@ -7847,7 +7697,7 @@ declare type LayoutColumn = LayoutItemConfig & {
7847
7697
  /**
7848
7698
  * @interface
7849
7699
  */
7850
- declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
7700
+ declare type LayoutComponent = LayoutItemConfig & {
7851
7701
  /**
7852
7702
  * Only a component type will have this property and it should be set to view.
7853
7703
  */
@@ -7856,7 +7706,6 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
7856
7706
  * Only a component type will have this property and it represents the view options of a given component.
7857
7707
  */
7858
7708
  componentState?: Partial<ViewCreationOptions>;
7859
- type: 'component';
7860
7709
  };
7861
7710
 
7862
7711
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -7940,7 +7789,10 @@ declare type LayoutIdentity = Identity_4 & {
7940
7789
  declare type LayoutInitializedEvent = BaseEvent_5 & {
7941
7790
  type: 'layout-initialized';
7942
7791
  layoutIdentity: OpenFin_2.LayoutIdentity;
7943
- ofViews: OpenFin_2.ViewCreationResult[];
7792
+ ofViews: {
7793
+ identity: OpenFin_2.Identity;
7794
+ entityType: 'view';
7795
+ }[];
7944
7796
  };
7945
7797
 
7946
7798
  /**
@@ -8048,7 +7900,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8048
7900
  /**
8049
7901
  * @experimental
8050
7902
  */
8051
- getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
7903
+ getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
8052
7904
  /**
8053
7905
  * @experimental
8054
7906
  */
@@ -8149,17 +8001,6 @@ declare class LayoutModule extends Base {
8149
8001
  * ```
8150
8002
  */
8151
8003
  getCurrentSync(): OpenFin_2.Layout;
8152
- /**
8153
- * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8154
- *
8155
- * @example
8156
- * ```js
8157
- * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8158
- * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8159
- * console.log(await layout.getCurrentViews());
8160
- * ```
8161
- */
8162
- getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
8163
8004
  /**
8164
8005
  * Initialize the window's Layout.
8165
8006
  *
@@ -8799,10 +8640,6 @@ declare type MutableViewOptions = {
8799
8640
  * @defaultValue 'enabled'
8800
8641
  */
8801
8642
  throttling: ViewThrottling;
8802
- /**
8803
- * {@inheritDoc ChromiumPolicies}
8804
- */
8805
- chromiumPolicies: ChromiumPolicies;
8806
8643
  };
8807
8644
 
8808
8645
  /**
@@ -9043,12 +8880,6 @@ declare type MutableWindowOptions = {
9043
8880
  * Shows the window's icon in the taskbar.
9044
8881
  */
9045
8882
  showTaskbarIcon: boolean;
9046
- /**
9047
- * Specify a taskbar group for the window.
9048
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
9049
- * @remarks It's only updatable when `enableJumpList` is set to false.
9050
- */
9051
- taskbarIconGroup: string;
9052
8883
  interop: InteropConfig;
9053
8884
  /* Excluded from this release type: _internalWorkspaceData */
9054
8885
  /* Excluded from this release type: workspacePlatform */
@@ -9060,10 +8891,6 @@ declare type MutableWindowOptions = {
9060
8891
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9061
8892
  */
9062
8893
  throttling: WindowThrottling;
9063
- /**
9064
- * {@inheritDoc ChromiumPolicies}
9065
- */
9066
- chromiumPolicies: ChromiumPolicies;
9067
8894
  };
9068
8895
 
9069
8896
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9171,6 +8998,154 @@ declare type NonPropagatedWindowEvent = never;
9171
8998
 
9172
8999
  /* Excluded from this release type: NotCloseRequested */
9173
9000
 
9001
+ declare type NotificationAction_2 = {
9002
+ /**
9003
+ * Type of action this structure represents (BUTTON, TEXT)
9004
+ */
9005
+ type: number;
9006
+ /**
9007
+ * Action name that the author can use to distinguish them.
9008
+ */
9009
+ action: string;
9010
+ /**
9011
+ * Title of the action button.
9012
+ */
9013
+ title: string;
9014
+ /**
9015
+ * URL of the icon for the button. May be empty if no url was specified.
9016
+ */
9017
+ icon: string;
9018
+ /**
9019
+ * Placeholder to display for text-based actions in absence of user input.
9020
+ */
9021
+ placeholder: string;
9022
+ };
9023
+
9024
+ /**
9025
+ * Emitted when a developer has called .close on a notification which has been interecepted.
9026
+ */
9027
+ declare type NotificationCloseRequested = BaseEvent_9 & {
9028
+ type: 'notification-close-requested';
9029
+ notificationId: string;
9030
+ };
9031
+
9032
+ declare type NotificationData = {
9033
+ /**
9034
+ * Title to be displayed with the Web Notification.
9035
+ */
9036
+ title: string;
9037
+ /**
9038
+ * Hint to determine the directionality of the displayed notification.
9039
+ * (LEFT_TO_RIGHT, RIGHT_TO_LEFT, AUTO)
9040
+ */
9041
+ direction: number;
9042
+ /**
9043
+ * BCP 47 language tag describing the notification's contents. Optional.
9044
+ */
9045
+ lang: string;
9046
+ /**
9047
+ * Contents of the notification.
9048
+ */
9049
+ body: string;
9050
+ /**
9051
+ * Tag of the notification. Notifications sharing both their origin and their, tag
9052
+ * will replace the first displayed notification.
9053
+ */
9054
+ tag: string;
9055
+ /**
9056
+ * URL of the image contents of the notification. May be empty if no url was
9057
+ * specified.
9058
+ */
9059
+ image: string;
9060
+ /**
9061
+ * URL of the icon which is to be displayed with the notification.
9062
+ */
9063
+ icon: string;
9064
+ /**
9065
+ * URL of the badge for representing the notification. May be empty if no url was
9066
+ * specified.
9067
+ */
9068
+ badge: string;
9069
+ /**
9070
+ * Vibration pattern for the notification, following the syntax of the Vibration
9071
+ * API. https://www.w3.org/TR/vibration/
9072
+ */
9073
+ vibration_pattern: number[];
9074
+ /**
9075
+ * The time at which the event the notification represents took place.
9076
+ */
9077
+ timestamp: string;
9078
+ /**
9079
+ * Whether default notification indicators (sound, vibration, light) should be
9080
+ * played again if the notification is replacing an older notification.
9081
+ */
9082
+ renotify: boolean;
9083
+ /**
9084
+ * Whether default notification indicators (sound, vibration, light) should be
9085
+ * played again if the notification is replacing an older notification.
9086
+ */
9087
+ silent: boolean;
9088
+ /**
9089
+ * Whether the notification should remain onscreen indefinitely, rather than being
9090
+ * auto-minimized to the notification center (if allowed by platform).
9091
+ */
9092
+ requireInteraction: boolean;
9093
+ /**
9094
+ * Base64 encoded Developer-provided data associated with the notification, in the
9095
+ * form of a serialized string. Must not exceed |kMaximumDeveloperDataSize| bytes.
9096
+ */
9097
+ data: string;
9098
+ /**
9099
+ * Actions that should be shown as buttons on the notification.
9100
+ */
9101
+ actions: NotificationAction_2[];
9102
+ /**
9103
+ * The time at which the notification should be shown.
9104
+ */
9105
+ showTriggerTimestamp?: string | null;
9106
+ /**
9107
+ * Scenarios that define the notification behavior. (DEFAULT, INCOMING_CALL)
9108
+ */
9109
+ scenario: number;
9110
+ };
9111
+
9112
+ declare type NotificationInterceptedEvent = NamedEvent & {
9113
+ type: 'notification-intercepted';
9114
+ /**
9115
+ * id of the notification
9116
+ */
9117
+ notificationId: string;
9118
+ /**
9119
+ * origin of the notification
9120
+ */
9121
+ origin: string;
9122
+ /**
9123
+ * empty if notification comes from worker
9124
+ */
9125
+ documentUrl: string;
9126
+ notificationData: NotificationData;
9127
+ /**
9128
+ * Image for the notification. The bitmap may be empty if the developer did not
9129
+ * provide an image, or fetching of the image failed.
9130
+ */
9131
+ image: SerializedImage;
9132
+ /**
9133
+ * Main icon for the notification. The bitmap may be empty if the developer did not
9134
+ * provide an icon, or fetching of the icon failed.
9135
+ */
9136
+ notificationIcon: SerializedImage;
9137
+ /**
9138
+ * Badge for the notification. The bitmap may be empty if the developer did not
9139
+ * provide a badge, or fetching of the badge failed.
9140
+ */
9141
+ badge: SerializedImage;
9142
+ /**
9143
+ * Icons for the actions. A bitmap may be empty if the developer did not provide an
9144
+ * icon, or fetching of the icon failed.
9145
+ */
9146
+ actionIcons: SerializedImage[];
9147
+ };
9148
+
9174
9149
  /* Excluded from this release type: NotRequested */
9175
9150
 
9176
9151
  /**
@@ -9274,11 +9249,8 @@ declare namespace OpenFin_2 {
9274
9249
  ViewVisibilityOptions,
9275
9250
  WindowState,
9276
9251
  AutoplayPolicyOptions,
9277
- ExcludeOptions,
9278
9252
  ConstWindowOptions,
9279
9253
  InheritableOptions,
9280
- PolicyOptions,
9281
- ChromiumPolicies,
9282
9254
  MutableWindowOptions,
9283
9255
  WorkspacePlatformOptions,
9284
9256
  WebRequestHeader,
@@ -9312,9 +9284,6 @@ declare namespace OpenFin_2 {
9312
9284
  ViewOptions,
9313
9285
  ConstViewOptions,
9314
9286
  ViewState,
9315
- ViewCreationSuccess,
9316
- ViewCreationFailure,
9317
- ViewCreationResult,
9318
9287
  Certificate,
9319
9288
  HostContextChangedPayload,
9320
9289
  ApplySnapshotOptions,
@@ -9560,7 +9529,6 @@ declare namespace OpenFin_2 {
9560
9529
  RoutingInfo,
9561
9530
  DownloadShelfOptions,
9562
9531
  ViewShowAtOptions,
9563
- ExtensionInfo,
9564
9532
  ApplicationEvents,
9565
9533
  BaseEvents,
9566
9534
  ExternalApplicationEvents,
@@ -9764,10 +9732,6 @@ declare type PerDomainSettings = {
9764
9732
  * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
9765
9733
  */
9766
9734
  content?: ContentPermission;
9767
- /**
9768
- * {@inheritdoc ChromiumPolicies}
9769
- */
9770
- chromiumPolicies?: ChromiumPolicies;
9771
9735
  };
9772
9736
 
9773
9737
  /**
@@ -9813,7 +9777,6 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
9813
9777
  private _channel;
9814
9778
  Application: OpenFin_2.Application;
9815
9779
  identity: OpenFin_2.ApplicationIdentity;
9816
- /* Excluded from this release type: clientMap */
9817
9780
  /* Excluded from this release type: __constructor */
9818
9781
  getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
9819
9782
  /**
@@ -11123,45 +11086,6 @@ declare interface PlatformProvider {
11123
11086
  * @returns {Promise<void>}
11124
11087
  */
11125
11088
  handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
11126
- /**
11127
- * @experimental
11128
- *
11129
- * This method is called to handle errors with view creation and initial navigation during layout creation.
11130
- * Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
11131
- * * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
11132
- * * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
11133
- * * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
11134
- *
11135
- * @param viewIdentity Identity of the view
11136
- * @param error error thrown during a view creation
11137
- * @returns {Promise<OpenFin.ViewCreationSuccess | void>}
11138
- *
11139
- * @example
11140
- *
11141
- * ```js
11142
- * const overrideCallback = (PlatformProvider) => {
11143
- * class Override extends PlatformProvider {
11144
- * async handleFailedViewCreation(viewIdentity, error) {
11145
- * const view = fin.View.wrapSync(viewId);
11146
- * try {
11147
- * // navigate to an error page
11148
- * await view.navigate('http://localhost:3000/errorPage.html');
11149
- * // resolve a success result after redirecting to a error page
11150
- * return {identity: viewIdentity, success: true};
11151
- * } catch(e) {
11152
- * // layout-initialized event will include this view with the error
11153
- * throw error;
11154
- * }
11155
- * }
11156
- * }
11157
- * return new Override();
11158
- * }
11159
- *
11160
- * fin.Platform.init({ overrideCallback });
11161
- *
11162
- * ```
11163
- */
11164
- handleFailedViewCreation(viewIdentity: OpenFin_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
11165
11089
  }
11166
11090
 
11167
11091
  /**
@@ -11226,12 +11150,6 @@ declare type PointTopLeft = {
11226
11150
  left: number;
11227
11151
  };
11228
11152
 
11229
- /**
11230
- * When set to `disable`, disables the policy
11231
- * When set to `defer-to-group-policy`, respects Group Policy settings
11232
- */
11233
- declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
11234
-
11235
11153
  declare type PopupBaseBehavior = 'close' | 'hide';
11236
11154
 
11237
11155
  declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
@@ -12089,6 +12007,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
12089
12007
  'get-version': GetterCall<string>;
12090
12008
  'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
12091
12009
  'delete-cache-request': VoidCall;
12010
+ 'dispatch-notification-action': {
12011
+ request: {
12012
+ notificationId: string;
12013
+ action: 'click' | 'close' | 'show';
12014
+ };
12015
+ response: void;
12016
+ };
12092
12017
  'exit-desktop': VoidCall;
12093
12018
  'fetch-manifest': ApiCall<{
12094
12019
  manifestUrl: string;
@@ -12247,14 +12172,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12247
12172
  }, void>;
12248
12173
  'system-register-shutdown-handler': VoidCall;
12249
12174
  'get-permissions': GetterCall<any>;
12250
- 'refresh-extensions': {
12251
- request: void;
12252
- response: string[] | undefined;
12253
- };
12254
- 'get-installed-extensions': {
12255
- request: void;
12256
- response: OpenFin_2.ExtensionInfo[];
12257
- };
12258
12175
  'fdc3-add-context-listener': VoidCall;
12259
12176
  'fdc3-add-intent-listener': VoidCall;
12260
12177
  'fdc3-raise-intent': VoidCall;
@@ -12943,21 +12860,6 @@ declare type ScreenshotPrintOptions = {
12943
12860
  content: 'screenshot';
12944
12861
  };
12945
12862
 
12946
- /**
12947
- * An event generated when an application modifies the runtime in a way that affects all other applications in the
12948
- * application runtime/security realm.
12949
- */
12950
- declare type SecurityRealmEvent = BaseEvent_9 & {
12951
- /**
12952
- * Config URL of the application that modified the security realm's extensions
12953
- */
12954
- configUrl: string;
12955
- /**
12956
- * Identity of the application that modified the security realm's extensions
12957
- */
12958
- applicationIdentity: OpenFin_2.ApplicationIdentity;
12959
- };
12960
-
12961
12863
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
12962
12864
  data: ProtocolMap[T]['response'];
12963
12865
  } & ProtocolMap[T]['specialResponse']>;
@@ -12974,6 +12876,11 @@ declare type SentMessage<Value> = Promise<Value> & {
12974
12876
  messageId: ReturnType<Environment['getNextMessageId']>;
12975
12877
  };
12976
12878
 
12879
+ /**
12880
+ * Utility type to mark an image serialized as a base64 data URL.
12881
+ */
12882
+ declare type SerializedImage = string;
12883
+
12977
12884
  /**
12978
12885
  * @interface
12979
12886
  */
@@ -13410,6 +13317,13 @@ declare type SubscriptionOptions = {
13410
13317
  */
13411
13318
  declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
13412
13319
  /* Excluded from this release type: __constructor */
13320
+ /**
13321
+ * Dispatch an event to the webcontents that created the notification.
13322
+ * Only works for notifications that have been intercepted in the same runtime.
13323
+ */
13324
+ dispatchNotificationAction(notificationId: string, { action }: {
13325
+ action: 'click' | 'close' | 'show';
13326
+ }): Promise<void>;
13413
13327
  private sendExternalProcessRequest;
13414
13328
  /**
13415
13329
  * Returns the version of the runtime. The version contains the major, minor,
@@ -14849,16 +14763,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14849
14763
  * ```
14850
14764
  */
14851
14765
  setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
14852
- /**
14853
- * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
14854
- * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
14855
- * will be installed/enabled.
14856
- */
14857
- refreshExtensions(): Promise<string[] | undefined>;
14858
- /**
14859
- * Gets the currently-installed
14860
- */
14861
- getInstalledExtensions(): Promise<OpenFin_2.ExtensionInfo[]>;
14862
14766
  }
14863
14767
 
14864
14768
  /**
@@ -14876,6 +14780,7 @@ declare namespace SystemEvents {
14876
14780
  IdleStateChangedEvent,
14877
14781
  IdleEvent,
14878
14782
  MonitorInfoChangedEvent,
14783
+ NotificationCloseRequested,
14879
14784
  MonitorEvent,
14880
14785
  SessionChangedEvent,
14881
14786
  AppVersionEvent,
@@ -14889,14 +14794,6 @@ declare namespace SystemEvents {
14889
14794
  ApplicationCreatedEvent,
14890
14795
  DesktopIconClickedEvent,
14891
14796
  SystemShutdownEvent,
14892
- ExtensionsEnabledEvent,
14893
- ExtensionsDisabledEvent,
14894
- ExtensionsExcludedEvent,
14895
- ExtensionsInstalledEvent,
14896
- ExtensionInstalledEvent,
14897
- ExtensionsInstallFailedEvent,
14898
- ExtensionInstallFailedEvent,
14899
- ExtensionsInitializationFailedEvent,
14900
14797
  Event_11 as Event,
14901
14798
  SystemEvent,
14902
14799
  EventType_8 as EventType,
@@ -15701,7 +15598,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15701
15598
  */
15702
15599
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15703
15600
  /**
15704
- * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15601
+ * Retrieves the layout for the window the view is attached to.
15705
15602
  *
15706
15603
  * @example
15707
15604
  * ```js
@@ -15865,24 +15762,6 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
15865
15762
  options?: Partial<ViewOptions>;
15866
15763
  };
15867
15764
 
15868
- /**
15869
- * @interface
15870
- */
15871
- declare type ViewCreationFailure = {
15872
- /**
15873
- * The identity of the created view
15874
- */
15875
- identity: Identity_4;
15876
- /**
15877
- * Whether the view was created with errors
15878
- */
15879
- success: false;
15880
- /**
15881
- * Error thrown during view creation
15882
- */
15883
- error: Error;
15884
- };
15885
-
15886
15765
  /**
15887
15766
  * The options object required by {@link View.ViewModule.create View.create}.
15888
15767
  *
@@ -15898,25 +15777,6 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
15898
15777
 
15899
15778
  declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;
15900
15779
 
15901
- /**
15902
- * A view creation state
15903
- */
15904
- declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
15905
-
15906
- /**
15907
- * @interface
15908
- */
15909
- declare type ViewCreationSuccess = {
15910
- /**
15911
- * The identity of the created view
15912
- */
15913
- identity: Identity_4;
15914
- /**
15915
- * Whether the view was created without errors
15916
- */
15917
- success: true;
15918
- };
15919
-
15920
15780
  /**
15921
15781
  * Generated when a window has a view detached from it.
15922
15782
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
@@ -16078,9 +15938,6 @@ declare class ViewModule extends Base {
16078
15938
  */
16079
15939
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16080
15940
 
16081
- /**
16082
- * @interface
16083
- */
16084
15941
  declare type ViewShowAtOptions = {
16085
15942
  /**
16086
15943
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
@@ -17167,6 +17024,10 @@ declare namespace WebContentsEvents {
17167
17024
  FileDownloadProgressEvent,
17168
17025
  FileDownloadCompletedEvent,
17169
17026
  ContentBlockedEvent,
17027
+ SerializedImage,
17028
+ NotificationAction_2 as NotificationAction,
17029
+ NotificationData,
17030
+ NotificationInterceptedEvent,
17170
17031
  Event_5 as Event,
17171
17032
  WebContentsEvent,
17172
17033
  WillPropagateWebContentsEvent,