About
Support
Developer Guide
Version 43.140.100.56
Preparing search index...
The search index is not available
OpenFin JavaScript API
OpenFin JavaScript API
OpenFin
CustomProtocolOptions
Interface CustomProtocolOptions
Define possible options for Custom protocol.
interface
CustomProtocolOptions
{
protocolName
:
string
;
}
Index
Properties
protocol
Name
Properties
protocol
Name
protocol
Name
:
string
Settings
Theme
OS
Light
Dark
On This Page
Properties
protocol
Name
OpenFin JavaScript API
Application
Channel
Clipboard
ExternalApplication
FDC3
Frame
GlobalHotkey
InterApplicationBus
Interop
InternalInteropBrokerOptions
Layout
OpenFin
Events
ApplicationEvents
BaseEvent
ClosedEvent
ConnectedEvent
CrashedEvent
FileDownloadLocationChangedEvent
InitializedEvent
ManifestChangedEvent
NotRespondingEvent
RespondingEvent
RunRequestedEvent
StartedEvent
TrayIconClickedEvent
WindowAlertRequestedEvent
WindowCreatedEvent
WindowEndLoadEvent
WindowNotRespondingEvent
WindowRespondingEvent
WindowStartLoadEvent
ApplicationConnectedEvent
ApplicationEvent
ApplicationEventType
ApplicationSourcedEvent
ApplicationSourcedEventType
ApplicationWindowEvent
BaseApplicationEvent
ByType
Event
EventType
Payload
PropagatedApplicationEvent
PropagatedApplicationEventType
PropagatedEvent
PropagatedEventType
BaseEvents
BaseEvent
IdentityEvent
NamedEvent
EventHandler
Payload
PropagatedEvent
PropagatedEventType
ExternalApplicationEvents
BaseEvent
ConnectedEvent
DisconnectedEvent
BaseExternalApplicationEvent
ByType
Event
EventType
ExternalApplicationConnectedEvent
ExternalApplicationDisconnectedEvent
ExternalApplicationEvent
ExternalApplicationEventType
Payload
FrameEvents
BaseEvent
ConnectedEvent
DisconnectedEvent
BaseFrameEvent
ByType
Event
EventType
FrameConnectedEvent
FrameDisconnectedEvent
FrameEvent
FrameEventType
Payload
GlobalHotkeyEvents
BaseEvent
RegisteredEvent
UnregisteredEvent
ByType
Event
EventType
GlobalHotkeyEvent
GlobalHotkeyEventType
Payload
PlatformEvents
ApiReadyEvent
SnapshotAppliedEvent
ByType
Event
EventType
Payload
PlatformApiReadyEvent
PlatformEvent
PlatformEventType
PlatformSnapshotAppliedEvent
SystemEvents
ApplicationCreatedEvent
BaseEvent
DesktopIconClickedEvent
ExtensionInstallFailedEvent
ExtensionInstalledEvent
ExtensionsDisabledEvent
ExtensionsEnabledEvent
ExtensionsExcludedEvent
ExtensionsInstallFailedEvent
ExtensionsInstalledEvent
IdleStateChangedEvent
MonitorInfoChangedEvent
SessionChangedEvent
AppVersionEvent
AppVersionEventType
ByType
Event
EventType
ExtensionsInitializationFailedEvent
IdleEvent
MonitorEvent
Payload
SystemEvent
SystemEventType
ViewEvents
AddedToLayoutEvent
BaseEvent
CreatedEvent
DestroyedEvent
HiddenEvent
HostContextChangedEvent
HotkeyEvent
RemovedFromLayoutEvent
ShownEvent
TargetChangedEvent
BaseViewEvent
ByType
Event
EventType
NonPropagatedViewEvent
Payload
PropagatedEvent
PropagatedEventType
PropagatedViewEvent
PropagatedViewEventType
ViewEvent
ViewEventType
WillPropagateViewEvent
WebContentsEvents
BlurredEvent
CertificateErrorEvent
CertificateSelectionShownEvent
ChildContentBlockedEvent
ChildContentOpenedInBrowserEvent
ChildViewCreatedEvent
ChildWindowCreatedEvent
ClipboardCopyBlockedEvent
ClipboardPasteBlockedEvent
ContentBlockedEvent
ContentCreationRulesEvent
CrashedEvent
DidChangeThemeColorEvent
DidFailLoadEvent
DidFinishLoadEvent
DidStartLoadingEvent
FileDownloadCompletedEvent
FileDownloadEvent
FileDownloadProgressEvent
FileDownloadStartedEvent
FocusedEvent
FoundInPageEvent
NavigationRejectedEvent
PageFaviconUpdatedEvent
PageTitleUpdatedEvent
ResourceLoadFailedEvent
ResourceResponseReceivedEvent
UrlChangedEvent
WillRedirectEvent
Event
FaviconUpdatedEvent
NonPropagatedWebContentsEvent
WebContentsEvent
WillPropagateWebContentsEvent
WindowEvents
AlertRequestedEvent
AuthRequestedEvent
BaseEvent
BeginUserBoundsChangingEvent
BoundsChangedEvent
BoundsChangingEvent
BoundsDidChangeEvent
CloseRequestedEvent
ClosedEvent
ClosingEvent
ContextChangedEvent
DisabledMovementBoundsChangedEvent
DisabledMovementBoundsChangingEvent
DownloadShelfVisibilityChangedEvent
EmbeddedEvent
EndLoadEvent
EndUserBoundsChangingEvent
ExternalProcessExitedEvent
ExternalProcessStartedEvent
HiddenEvent
HotkeyEvent
InitializedEvent
InputEvent
LayoutCreatedEvent
LayoutDestroyedEvent
LayoutInitializedEvent
LayoutReadyEvent
LayoutSnapshotAppliedEvent
MaximizedEvent
MinimizedEvent
OptionsChangedEvent
PerformanceReportEvent
PreloadScriptsStateChangeEvent
PreloadScriptsStateChangedEvent
PreloadScriptsStateChangingEvent
ReloadedEvent
RestoredEvent
ShowAllDownloadsEvent
ShowRequestedEvent
ShownEvent
UserBoundsChangeEvent
UserMovementDisabledEvent
UserMovementEnabledEvent
ViewAttachedEvent
ViewDetachedEvent
WillMoveEvent
WillMoveOrResizeEvent
WillResizeEvent
BaseWindowEvent
BoundsChangeEvent
BoundsEvent
ByType
Event
EventType
NonPropagatedWindowEvent
Payload
PreloadScriptInfo
PreloadScriptInfoRunning
PropagatedEvent
PropagatedWindowEvent
PropagatedWindowEventType
WillPropagateWindowEvent
WindowCloseRequestedEvent
WindowClosedEvent
WindowClosingEvent
WindowEvent
WindowEventType
WindowHiddenEvent
WindowHotkeyEvent
WindowInitializedEvent
WindowOptionsChangedEvent
WindowRestoredEvent
WindowShowRequestedEvent
WindowShownEvent
WindowSourcedEvent
WindowViewEvent
FDC3
v1_2
ChannelError
ContextTypes
Intents
OpenError
ResolveError
Convert
AppIntent
AppMetadata
Channel
Contact
ContactID
ContactList
Context
Country
CountryID
DesktopAgent
DisplayMetadata
ImplementationMetadata
Instrument
InstrumentID
InstrumentList
IntentMetadata
IntentResolution
Listener
Organization
OrganizationID
Portfolio
Position
ContextHandler
ContextType
TargetApp
v2_0
ChannelError
ContextTypes
Intents
OpenError
ResolveError
ResultError
Style
Convert
AppIdentifier
AppIntent
AppMetadata
Channel
Chart
ChatInitSettings
Contact
ContactElement
ContactList
ContactListObject
Context
ContextMetadata
Country
CountryID
Currency
CurrencyID
DesktopAgent
DisplayMetadata
Email
FluffyID
FluffyMarket
Icon
Image
ImplementationMetadata
Instrument
InstrumentElement
InstrumentList
IntentMetadata
IntentResolution
Listener
Nothing
Organization
OrganizationID
Portfolio
Position
PositionElement
PrivateChannel
PurpleID
PurpleMarket
RecipientsID
RecipientsObject
StickyID
TentacledID
TimeRange
TimeRangeObject
Valuation
ContextHandler
ContextType
IntentHandler
IntentResult
Version
LayoutDOMEvents
ContainerCreatedEvent
LayoutStateChangedEvent
TabClosedEvent
TabCreatedEvent
TabDroppedEvent
ByType
Event
EventType
Payload
Application
ApplicationModule
Channel
ChannelClient
ChannelProvider
Clipboard
ColumnOrRow
ExternalApplication
ExternalApplicationModule
Frame
GlobalHotkey
InterApplicationBus
InteropBroker
InteropClient
InteropModule
Layout
LayoutModule
NotificationManagerInstance
NotificationManagerModule
Platform
PlatformModule
SnapshotSource
SnapshotSourceModule
System
TabStack
View
ViewModule
Window
_FrameModule
_WindowModule
Accelerator
AddViewOptions
AddViewToStackOptions
ApiSettings
AppAssetInfo
AppAssetRequest
AppProcessInfo
AppVersionCompleteEvent
AppVersionError
AppVersionErrorEvent
AppVersionProgress
AppVersionProgressEvent
AppVersionRuntimeInfo
AppVersionRuntimeStatusEvent
ApplicationCreationOptions
ApplicationIdentity
ApplicationInfo
ApplicationOptions
ApplicationPermissions
ApplicationState
ApplicationType
ApplicationWindowInfo
ApplySnapshotOptions
ApplySnapshotPayload
AutoResizeOptions
BaseClipboardRequest
BaseContentCreationRule
BeforeUnloadUserDecision
BlockedContentCreationRule
Bounds
BrowserContentBehavior
BrowserContentCreationRule
CapturePageOptions
Certificate
CertificationInfo
CertifiedAppInfo
ChannelConnectOptions
ChannelCreateOptions
ChromiumPolicies
ClearCacheOption
ClickedMenuResult
ClientConnectionPayload
ClientIdentity
ClientIdentityMultiRuntime
ClientInfo
ClipboardPermissions
CloseViewOptions
CloseViewPayload
CloseWindowPayload
ClosedMenuResult
ConstViewOptions
ConstWindowOptions
ContentCreationOptions
ContentNavigation
ContentRedirect
Context
ContextForIntent
ContextGroupInfo
ContextMenuOptions
ContextMenuSettings
CookieInfo
CookieOption
CopyPermissions
CornerRounding
CpuInfo
CrashReporterOptions
CrashReporterState
CreateLayoutOptions
CreateViewPayload
CreateViewTarget
CustomProtocolMalformedState
CustomProtocolMissingState
CustomProtocolOptions
CustomProtocolRegisteredState
CustomRequestHeaders
DefaultDomainSettings
DefaultDomainSettingsRule
DeviceInfo
DipRect
DipScaleRects
DisplayMetadata
DomainApiSettings
DomainSettings
DomainSettingsRule
DownloadPreloadInfo
DownloadPreloadOption
DownloadRule
DownloadShelfOptions
Dpi
EntityInfo
EntityProcessDetails
ExcludeOptions
ExitCode
ExtensionInfo
ExternalApplicationInfo
ExternalConnection
ExternalProcessInfo
ExternalProcessRequestType
FetchManifestPayload
FileDownloadSettings
FinApi
FindInPageOptions
FindInPageResult
FindIntentsByContextOptions
FrameInfo
FrameProcessDetails
GetBoundsOptions
GetLogRequestType
GetWindowContextPayload
GpuInfo
HostContextChangedPayload
HostSpecs
Hotkey
Identity
InfoForIntentOptions
InitLayoutOptions
InitPlatformOptions
InstallationInfo
InstalledApps
IntentMetadata
InteropBrokerDisconnectionEvent
InteropBrokerOptions
InteropClientOnDisconnectionListener
InteropConfig
InteropLoggingOptions
JumpListCategory
JumpListSeparator
JumpListTask
LaunchExternalProcessRule
LaunchIntoPlatformPayload
LayoutColumn
LayoutComponent
LayoutEntityDefinition
LayoutIdentity
LayoutItemConfig
LayoutManager
LayoutOptions
LayoutRow
LayoutSnapshot
LegacyWinOptionsInAppOptions
LogInfo
LogUploaderUIOptions
Manifest
ManifestInfo
Margins
MenuItemTemplate
MonitorDetails
MonitorInfo
MutableViewOptions
MutableWindowOptions
NativeWindowIntegrationProviderAuthorization
NavigationRules
NonAppProcessDetails
OSInfo
Opacity
PastePermissions
PerDomainSettings
Permissions
PlatformOptions
PlatformProvider
PlatformViewCreationOptions
PlatformWindowCreationOptions
PlatformWindowOptions
Point
PointTopLeft
PopupOptions
PopupResult
Position
PositioningOptions
PreloadScript
PresetLayoutOptions
PrintOptions
PrintPermission
PrinterInfo
ProcessDetails
ProcessLoggingOptions
ProviderIdentity
ProxyConfig
ProxyInfo
ProxySystemInfo
QueryPermissionResult
RGB
RVMInfo
ReadImageClipboardRequest
Rectangle
RectangleByEdgePositions
RegisterUsageData
RegistryInfo
ReplaceLayoutOptions
ReplaceLayoutOpts
ReplaceLayoutPayload
ReplaceViewOptions
ReplaceViewPayload
ResizeRegion
RoutingInfo
RuntimeDownloadOptions
RuntimeDownloadProgress
RuntimeInfo
RvmLaunchOptions
ScreenCapturePermission
ScreenCaptureState
ScreenshotPrintOptions
SendApplicationLogResponse
ServiceConfiguration
ServiceIdentifier
SessionContextGroup
SetWindowContextPayload
SharedWorkerInfo
ShortCutConfig
ShortcutOverride
ShowPopupMenuOptions
ShowTrayIconPopupMenuOptions
ShowViewOnWindowResizeOptions
Size
Snapshot
SnapshotProvider
StructuredContentPermissions
SubscriptionOptions
SystemPermissions
SystemProcessInfo
TaskBar
TerminateExternalRequestType
Time
Transition
TransitionBase
TransitionOptions
TrayInfo
UpdatableViewOptions
UpdatableWindowOptions
UserAppConfigArgs
ViewContentCreationRule
ViewCreationFailure
ViewCreationOptions
ViewCreationSuccess
ViewInfo
ViewOptions
ViewShowAtOptions
ViewState
ViewStatuses
ViewTitlePriority
ViewVisibilityOption
ViewVisibilityOptions
ViewsPreventingUnloadPayload
WindowBounds
WindowContentCreationRule
WindowCreationOptions
WindowDetail
WindowInfo
WindowOptionDiff
WindowOptions
WindowViewsPrintOptions
WriteAnyClipboardRequest
WriteAnyRequestType
WriteClipboardRequest
WriteImageClipboardRequest
WriteRequestType
AnchorType
Api
ApiInjection
AppAssetServeRequest
ApplicationEvent
AutoplayPolicyOptions
BaseContentBehavior
BaseEvent
BoundsType
ChannelAction
ChannelClientConnectionListener
ChannelClientDisconnectionListener
ChannelMiddleware
ChannelProviderDisconnectionListener
ClipboardApiPermissions
ClipboardSelectionType
Constructor
ConstructorOverride
ContentBehavior
ContentCreationBehavior
ContentCreationBehaviorNames
ContentCreationRule
ContentPermission
ContextGroupStates
ContextHandler
CustomProtocolState
DevicePermissionName
DomainSettingsPreloadScripts
EntityType
ErrorMiddleware
ExternalApplicationEvent
FileDownloadBehavior
FileDownloadBehaviorNames
Fin
FrameEvent
GlobalHotkeyEvent
HostContextChangedReasons
ImageFormatOptions
InheritableOptions
InjectionType
Intent
IntentHandler
InteropActionLoggingOption
InteropLoggingActions
JumpListItem
LaunchEmitter
LaunchExternalProcessListener
LayoutContent
LayoutDOMEvent
LayoutEntityTypes
LayoutManagerConstructor
LayoutManagerOverride
LayoutPosition
LayoutPresetType
LogLevel
LogUploadOptions
LogUploaderOptions
MatchPattern
Me
MenuResult
MessagingProtocols
MultiInstanceViewBehavior
MultipleDomainMatchBehavior
NotificationEvent
NotificationManagerPermissions
OpenExternalPermission
Optional
OverrideCallback
PathServeRequest
PermissionState
PlatformEvent
PolicyOptions
PopupBaseBehavior
PopupBlurBehavior
PopupInteraction
PopupResultBehavior
PrebuiltContextMenuItem
PrintPlaceholder
ProcessAffinityStrategy
ResolvedDomainSettings
ResultBehavior
RuleMatchOptions
ScreenCaptureBehavior
ServeAssetOptions
ServeRequest
ServedAssetInfo
StructuredContentBehavior
SystemEvent
SystemShutdownHandler
TimeZones
VerboseWebPermission
ViewCreationResult
ViewEvent
ViewThrottling
WebContent
WebContentsEvent
WebNotificationInfo
WebNotificationProperties
WebPermission
WebPermissionName
WebRequestHeader
WindowCreationReason
WindowEvent
WindowPrintOptions
WindowState
WindowThrottling
tween
Platform
SnapshotSource
System
View
Window
"
"
Define possible options for Custom protocol.