Namespace: types
Interfaces
Type Aliases
AppDIcon
Ƭ AppDIcon: Object
Type declaration
| Name | Type |
|---|---|
sizes? | string |
src | string |
AppDefinition
Ƭ AppDefinition: Object
Type declaration
| Name | Type |
|---|---|
appId | string |
contactEmail? | string |
description? | string |
firstRegistrationTimestamp? | number |
icons? | AppDIcon[] |
images? | object[] |
intents? | { appListenerAdded?: boolean ; contexts?: string[] ; displayName: string ; name: string }[] |
manifest? | FinsembleComponentConfig & { [index: string]: any; } |
manifestType? | string |
name | string |
publisher? | string |
releaseNotes? | string |
supportEmail? | string |
tags? | string[] |
title? | string |
tooltip? | string |
type? | string |
verified? | boolean |
version? | string |
AutoAssociateRule
Ƭ AutoAssociateRule: Object
Type declaration
| Name | Type |
|---|---|
allChildren? | boolean |
selectChildren? | string[] |
usingConnectId? | string |
ClientAdded
Ƭ ClientAdded: Object
Type declaration
| Name | Type |
|---|---|
appId | string |
config | AppConfig |
connectId? | ConnectId |
spawnedFromWorkspace? | boolean |
uuid | string |
windowName | string |
ClientDestination
Ƭ ClientDestination: { channel?: string ; routerChannel: string ; type: "client" ; uuid: string } & IntentOrContextType
ClientRemoved
Ƭ ClientRemoved: Object
Type declaration
| Name | Type |
|---|---|
uuid | string |
windowName | string |
ConnectDestination
Ƭ ConnectDestination: { name: string ; type: "selectConnect" ; uuid: string } & IntentOrContextType
uuid is either the uuid of the broadcaster or the destination depending on whether the triggered rule was broadcast or destination side (if both then there will be two outgoing messages)
CurrentContext
Ƭ CurrentContext: Object
Type declaration
| Name | Type |
|---|---|
context | ContextAny |
meta | { targetSubscriberId?: string ; timestamp: number } |
meta.targetSubscriberId? | string |
meta.timestamp | number |
DIAM
Ƭ DIAM: Object
Type declaration
| Name | Type |
|---|---|
appId? | string |
domain? | string |
executable? | string |
name? | string |
Destination
Ƭ Destination: ClientDestination | ConnectDestination
FinsembleComponentConfig
Ƭ FinsembleComponentConfig: Object
See finsemble.scheme.json for full config
Type declaration
| Name | Type |
|---|---|
bootParams? | Record<string, any> |
childWindowOptions? | Record<string, any> |
component? | Record<string, any> |
custom? | Record<string, any> |
foreign? | Record<string, any> |
interop? | { autoConnect?: boolean ; selectConnect?: SelectConnectRule[] ; useLinker?: boolean } |
interop.autoConnect? | boolean |
interop.selectConnect? | SelectConnectRule[] |
interop.useLinker? | boolean |
isAnApp? | boolean |
signatureKey? | Record<string, any> |
window? | SpawnParams |
IntentOrContextType
Ƭ IntentOrContextType: Object
Type declaration
| Name | Type |
|---|---|
context? | ContextAny |
contextType? | string |
intent? | string |
InteropBroadcastInternal
Ƭ InteropBroadcastInternal: Object
This type is used internally by the broadcast action. It can handle either an intent or a context.
It supports necessary internal features that are not possible through the desktop agent.
Type declaration
| Name | Type |
|---|---|
meta | { autoBroadcast?: boolean ; channel?: string ; noSelectConnect?: boolean ; pendingActionId?: ActionId ; setSenderContext?: boolean ; targetSubscriberId?: string ; to?: string ; uuid: string } |
meta.autoBroadcast? | boolean |
meta.channel? | string |
meta.noSelectConnect? | boolean |
meta.pendingActionId? | ActionId |
meta.setSenderContext? | boolean |
meta.targetSubscriberId? | string |
meta.to? | string |
meta.uuid | string |
payload | { context?: ContextAny ; intent?: string } |
payload.context? | ContextAny |
payload.intent? | string |
type | "broadcast" | "raiseIntent" |
InteropClient
Ƭ InteropClient: Object
Type declaration
| Name | Type |
|---|---|
appId | string |
appName | string |
authenticated | boolean |
authenticatedTransport | object |
channels | string[] |
config? | AppConfig |
connectId? | ConnectId |
heartbeatTime | number |
joinedChannels | string[] |
mostRecentContext? | ContextAny |
readiness | "initializing" | "ready" |
routerChannel | string |
subscriptions | { channels: { [channel: string]: { contexts: { [contextType: string]: CurrentContext; } ; intents: { [intent: string]: ContextType | true; } }; } ; globals: { contexts: { [contextType: string]: CurrentContext; } ; intents: { [intent: string]: ContextType | true; } } } |
subscriptions.channels | { [channel: string]: { contexts: { [contextType: string]: CurrentContext; } ; intents: { [intent: string]: ContextType | true; } }; } |
subscriptions.globals | { contexts: { [contextType: string]: CurrentContext; } ; intents: { [intent: string]: ContextType | true; } } |
subscriptions.globals.contexts | { [contextType: string]: CurrentContext; } |
subscriptions.globals.intents | { [intent: string]: ContextType | true; } |
uuid | string |
windowName | string |
InteropConfig
Ƭ InteropConfig: Object
Type declaration
| Name | Type |
|---|---|
channels? | { private?: Record<string, true> ; system?: Record<string, true> } |
channels.private? | Record<string, true> |
channels.system? | Record<string, true> |
intents? | [{ contexts?: [string] ; displayName: string ; name: string }] |
selectConnect? | SelectConnectRule[] |
useLinker? | boolean |
InteropMessageWithActonId
Ƭ InteropMessageWithActonId<T>: Object
Type parameters
| Name |
|---|
T |
Type declaration
| Name | Type |
|---|---|
actionId | ActionId |
fsa | T |
InteropRegistrationData
Ƭ InteropRegistrationData: Object
Type declaration
| Name | Type |
|---|---|
authenticationToken | AuthenticationToken |
windowDescriptor | WindowDescriptor |
InteropStore
Ƭ InteropStore: Object
Type declaration
| Name | Type |
|---|---|
@@cmds? | any[] |
linker | { activeWindowName?: string ; allChannels: LinkerChannel[] ; clients: { [windowName: string]: LinkerClient; } ; connectIdToJoinedChannel: Record<string, string> } |
linker.activeWindowName? | string |
linker.allChannels | LinkerChannel[] |
linker.clients | { [windowName: string]: LinkerClient; } |
linker.connectIdToJoinedChannel | Record<string, string> |
resolver | { addIntentListenerMaxInitializationTimeout: number ; apps: { definitions: { [appName: string]: AppDefinition; } ; intentResolutionCurrentActionId: any ; intentResolutionInProgress: boolean } ; channelMeta: { [id: string]: { displayMetaData?: DisplayMetadata ; type: string }; } ; clients: { [uuid: string]: InteropClient; } ; config: { registeredUIResolver: string | null ; serverUUID: string } ; contextTypes: { [contextType: string]: { intents: { launchable: AppIntent[] ; live: AppIntent[] } ; launchableHandlers: { [appId: string]: true; } }; } ; intents: { [intent: string]: { info: IntentMetadata ; launchableHandlers: { [key: string]: ContextType[] | null; } }; } ; lastChannelState: { [channel: string]: { context: ContextAny ; senderUuid: string }; } ; lastChannelStateByType: { [channel: string]: ContextMap; } ; loopDetectionMap: { [uuid: string]: LoopDetectionEntry; } ; pendingInteropRegistrationData: WindowDescriptor[] ; pendingOpenActionIds: { [windowName: string]: ActionId; } ; queue: { [uuidOrWindowName: string]: { pendingMessage: InteropBroadcastInternal ; subscriberIsReady?: boolean ; timestamp: number }[]; } ; selectConnectChannels: { [name: string]: { dispatchAction: string ; name: string } | { name: string ; routerChannel: string }; } } |
resolver.addIntentListenerMaxInitializationTimeout | number |
resolver.apps | { definitions: { [appName: string]: AppDefinition; } ; intentResolutionCurrentActionId: any ; intentResolutionInProgress: boolean } |
resolver.apps.definitions | { [appName: string]: AppDefinition; } |
resolver.apps.intentResolutionCurrentActionId | any |
resolver.apps.intentResolutionInProgress | boolean |
resolver.channelMeta | { [id: string]: { displayMetaData?: DisplayMetadata ; type: string }; } |
resolver.clients | { [uuid: string]: InteropClient; } |
resolver.config | { registeredUIResolver: string | null ; serverUUID: string } |
resolver.config.registeredUIResolver | string | null |
resolver.config.serverUUID | string |
resolver.contextTypes | { [contextType: string]: { intents: { launchable: AppIntent[] ; live: AppIntent[] } ; launchableHandlers: { [appId: string]: true; } }; } |
resolver.intents | { [intent: string]: { info: IntentMetadata ; launchableHandlers: { [key: string]: ContextType[] | null; } }; } |
resolver.lastChannelState | { [channel: string]: { context: ContextAny ; senderUuid: string }; } |
resolver.lastChannelStateByType | { [channel: string]: ContextMap; } |
resolver.loopDetectionMap | { [uuid: string]: LoopDetectionEntry; } |
resolver.pendingInteropRegistrationData | WindowDescriptor[] |
resolver.pendingOpenActionIds | { [windowName: string]: ActionId; } |
resolver.queue | { [uuidOrWindowName: string]: { pendingMessage: InteropBroadcastInternal ; subscriberIsReady?: boolean ; timestamp: number }[]; } |
resolver.selectConnectChannels | { [name: string]: { dispatchAction: string ; name: string } | { name: string ; routerChannel: string }; } |
root | { heartbeats: boolean ; isVisible: boolean ; testing: { destinationsBeforeSelectConnect: Destination[] ; dispatchesToSend: PayloadAction<OutgoingDispatchMessage>[] ; error: string ; messagesToSend: OutgoingMessage[] ; selectConnectChannelMessagesToSend: OutgoingSelectConnectChannelMessage[] ; triggeredRules: { destination: Destination ; result: string ; rule: any ; rulePhase: string ; uuid: string }[] ; unitTestingEnabled: boolean } } |
root.heartbeats | boolean |
root.isVisible | boolean |
root.testing | { destinationsBeforeSelectConnect: Destination[] ; dispatchesToSend: PayloadAction<OutgoingDispatchMessage>[] ; error: string ; messagesToSend: OutgoingMessage[] ; selectConnectChannelMessagesToSend: OutgoingSelectConnectChannelMessage[] ; triggeredRules: { destination: Destination ; result: string ; rule: any ; rulePhase: string ; uuid: string }[] ; unitTestingEnabled: boolean } |
root.testing.destinationsBeforeSelectConnect | Destination[] |
root.testing.dispatchesToSend | PayloadAction<OutgoingDispatchMessage>[] |
root.testing.error | string |
root.testing.messagesToSend | OutgoingMessage[] |
root.testing.selectConnectChannelMessagesToSend | OutgoingSelectConnectChannelMessage[] |
root.testing.triggeredRules | { destination: Destination ; result: string ; rule: any ; rulePhase: string ; uuid: string }[] |
root.testing.unitTestingEnabled | boolean |
workspace | { persistedData: { [windowName: string]: Record<string, ContextAny>; } } |
workspace.persistedData | { [windowName: string]: Record<string, ContextAny>; } |
LinkerChannel
Ƭ LinkerChannel: Object
Type declaration
| Name | Type |
|---|---|
color | string |
cssClassName | string |
label | string |
name | string |
LinkerClient
Ƭ LinkerClient: Object
Type declaration
| Name | Type |
|---|---|
connectId? | ConnectId |
joinedChannels | string[] |
spawnedFromWorkspace? | boolean |
LinkerStore
Ƭ LinkerStore: InteropStore["linker"]
LoopDetectionEntry
Ƭ LoopDetectionEntry: Object
Type declaration
| Name | Type |
|---|---|
count | number |
loopNotificationIssued | boolean |
timerId? | ReturnType<typeof setTimeout> |
timestamp | number |
LoopDetectionMap
Ƭ LoopDetectionMap: InteropStore["resolver"][``"loopDetectionMap"``]
OpenActionResult
Ƭ OpenActionResult: Object
Type declaration
| Name | Type |
|---|---|
error? | OpenError |
result? | {} |
type | InteropOpenRequest["type"] |
OutgoingDispatchMessage
Ƭ OutgoingDispatchMessage: { fsa: InteropBroadcastInternal ; uuid: string } & IntentOrContextType
OutgoingDispatchMessage's trigger redux actions, based on SelectConnect rules resulting from a broadcast.
uuid is either the uuid of the broadcaster or the destination depending on whether the triggered rule was broadcast or destination side (if both then there will be two outgoing messages)
OutgoingMessage
Ƭ OutgoingMessage: Object
OutgoingMessage's are sent back to subscribing FDC3 clients as the result of a broadcast or intent.
Type declaration
| Name | Type |
|---|---|
channel? | string |
context? | ContextAny |
intent? | string |
pendingActionId? | ActionId |
routerChannel | string |
targetSubscriberId? | string |
uuid | string |
OutgoingSelectConnectChannelMessage
Ƭ OutgoingSelectConnectChannelMessage: { fsa: InteropBroadcastInternal ; routerChannel: string ; uuid: string } & IntentOrContextType
OutgoingSelectConnectChannelMessage's are sent to registered SelectConnect channels from remote apps based on results from a broadcast that target those channels.
uuid is either the uuid of the broadcaster or the destination depending on whether the triggered rule was broadcast or destination side (if both then there will be two outgoing messages)
RaiseIntentActionResult
Ƭ RaiseIntentActionResult: Object
Type declaration
| Name | Type |
|---|---|
error? | ResolveError |
result? | IntentResolution |
type | InteropRaiseIntent["type"] |
RegisterSelectConnectChannel
Ƭ RegisterSelectConnectChannel: { name: string } & { dispatchAction: string } | { routerChannel: string }
RegistrationResult
Ƭ RegistrationResult: Object
Type declaration
| Name | Type |
|---|---|
actionId | ActionId |
appId | string |
authenticated | boolean |
config | AppConfig |
connectId? | ConnectId |
newPendingInteropRegistrationData? | InteropRegistrationData[] |
spawnedFromWorkspace? | boolean |
uuid | string |
windowName | string |
ResolverApps
Ƭ ResolverApps: InteropStore["resolver"][``"apps"``]
ResolverAppsDefinition
Ƭ ResolverAppsDefinition: InteropStore["resolver"][``"apps"``]["definitions"]
ResolverChannelMeta
Ƭ ResolverChannelMeta: InteropStore["resolver"][``"channelMeta"``]
ResolverClients
Ƭ ResolverClients: InteropStore["resolver"][``"clients"``]
ResolverIntent
Ƭ ResolverIntent: InteropStore["resolver"][``"intents"``]["intent"]
ResolverIntentsData
Ƭ ResolverIntentsData: InteropStore["resolver"][``"intents"``]
ResolverStore
Ƭ ResolverStore: InteropStore["resolver"]
RootStore
Ƭ RootStore: InteropStore["root"]
SelectConnectAppList
Ƭ SelectConnectAppList: Object
Type declaration
| Name | Type |
|---|---|
name | string |
SelectConnectChannel
Ƭ SelectConnectChannel: ResolverStore["selectConnectChannels"][``""``]
SelectConnectRule
Ƭ SelectConnectRule: Object
Type declaration
| Name | Type |
|---|---|
authorize? | SelectConnectAppList[] |
autoAssociate? | AutoAssociateRule |
cc? | any |
contextType? | string |
from? | SelectConnectAppList[] |
fwd? | any |
intentType? | string |
to? | SelectConnectAppList[] |
WorkspaceStore
Ƭ WorkspaceStore: InteropStore["workspace"]
Variables
CLEANUP_INTERVAL
• Const CLEANUP_INTERVAL: 10000
EmptyCurrentContext
• Const EmptyCurrentContext: Object
Type declaration
| Name | Type |
|---|---|
context | { type: string = "" } |
context.type | string |
meta | { targetSubscriberId: undefined = undefined; timestamp: number = 0 } |
meta.targetSubscriberId | undefined |
meta.timestamp | number |