Namespace: types

clients.Interop.types

Type Aliases

AuthenticationToken

Ƭ AuthenticationToken: Object

Type declaration

Name	Type
meta	AppMetadata
signatureString	string
signatureStringType	"dynamic" | "static" | "static-jwt" | "unauthenticated"
timestamp?	number

---

ContextAny

Ƭ ContextAny: Context & { [data: string]: any; }

---

ContextMap

Ƭ ContextMap: Object

Index signature

▪ [contextType: string]: { context: ContextAny ; senderUuid: string }

---

IntentResolverHandler

Ƭ IntentResolverHandler: (choices: IntentTargetList) => Promise<ResolverResolution>

Type declaration

▸ (choices): Promise<ResolverResolution>

Parameters

Name	Type
choices	IntentTargetList

Returns

Promise<ResolverResolution>

---

IntentTargetList

Ƭ IntentTargetList: Object

Type declaration

Name	Type
originatingAppId?	string
originatingAppName?	string
originatingAppWindow?	string
resolutionList	ResolutionList[]

---

InteropAddAppDefinitions

Ƭ InteropAddAppDefinitions: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ apps: { [appName: string]: AppDefinition; } }
payload.apps	{ [appName: string]: AppDefinition; }
type	"addAppDefinitions"

---

InteropBroadcast

Ƭ InteropBroadcast: Object

Type declaration

Name	Type
meta	InteropMeta & { channel?: string ; targetSubscriberId?: string }
payload	{ context: ContextAny }
payload.context	ContextAny
type	"broadcast"

---

InteropCurrentContext

Ƭ InteropCurrentContext: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context: Context | null }
payload.context	Context | null
type	"currentContext"

---

InteropCurrentContextRequest

Ƭ InteropCurrentContextRequest: Object

Type declaration

Name	Type
meta	InteropMeta & { channel?: string }
payload	{ contextType?: string }
payload.contextType?	string
type	"currentContextRequest"

---

InteropFindIntentRequest

Ƭ InteropFindIntentRequest: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context ; intent: string }
payload.context?	Context
payload.intent	string
type	"findIntent"

---

InteropFindIntentResponse

Ƭ InteropFindIntentResponse: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ appIntent?: AppIntent ; error?: ResolveError | null }
payload.appIntent?	AppIntent
payload.error?	ResolveError | null
type	"findIntentResponse"

---

InteropFindIntentsByContext

Ƭ InteropFindIntentsByContext: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context }
payload.context?	Context
type	"findIntentsByContext"

---

InteropGetCurrentChannels

Ƭ InteropGetCurrentChannels: Object

Type declaration

Name	Type
meta	InteropMeta
type	"getCurrentChannels"

---

InteropGetCurrentChannelsResponse

Ƭ InteropGetCurrentChannelsResponse: Object

Type declaration

Name	Type
meta?	InteropMeta
payload	{ data?: { channel: string }[] ; error?: string }
payload.data?	{ channel: string }[]
payload.error?	string
type	"interopGetCurrentChannelsResponse"

---

InteropGetSystemChannels

Ƭ InteropGetSystemChannels: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context ; target: TargetApp }
payload.context?	Context
payload.target	TargetApp
type	"open"

---

InteropHeartbeat

Ƭ InteropHeartbeat: Object

Type declaration

Name	Type
meta	InteropMeta
type	"heartbeat"

---

InteropIntent

Ƭ InteropIntent: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context ; intent: string }
payload.context?	Context
payload.intent	string
type	"intent"

---

InteropIntentsList

Ƭ InteropIntentsList: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ error?: ResolveError | null ; intents: AppIntent[] }
payload.error?	ResolveError | null
payload.intents	AppIntent[]
type	"intentsList"

---

InteropJoinChannels

Ƭ InteropJoinChannels: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ channels: string[] }
payload.channels	string[]
type	"joinChannels"

---

InteropLeaveChannels

Ƭ InteropLeaveChannels: Object

If payload.channnels is omitted then all joined channels are removed.

Type declaration

Name	Type
meta	InteropMeta
payload	{ channels?: string[] }
payload.channels?	string[]
type	"leaveChannels"

---

InteropMessage

Ƭ InteropMessage: InteropRegister | InteropUnregister | InteropBroadcast | InteropSystemChannels | InteropSystemChannelRequest | InteropCurrentContextRequest | InteropCurrentContext | InteropOpenRequest | InteropOpenResponse | InteropFindIntentRequest | InteropFindIntentResponse | InteropFindIntentsByContext | InteropHeartbeat | InteropIntent | InteropIntentsList | InteropJoinChannels | InteropLeaveChannels | InteropRaiseIntent | InteropRaiseIntentResponse | InteropSubscribeContext | InteropUnsubscribeContext | InteropSubscribeIntent | InteropUnsubscribeIntent | InteropAddAppDefinitions | InteropRemoveAppDefinitions | InteropGetCurrentChannels | InteropGetCurrentChannelsResponse | InteropRegisterUIResolver | InteropSetRegistrationData

---

InteropMeta

Ƭ InteropMeta: Object

The following are the Flux Standard Actions (FSA) that are exchanged between the Desktop Agent and the Interop Server.

Type declaration

Name	Type
authenticatedTransport?	object
href?	string
path?	string
routerOrigin?	string
uuid	string

---

InteropOpenRequest

Ƭ InteropOpenRequest: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context ; target: TargetApp }
payload.context?	Context
payload.target	TargetApp
type	"open"

---

InteropOpenResponse

Ƭ InteropOpenResponse: Object

Type declaration

Name	Type
meta?	InteropMeta
payload	{ error?: OpenError }
payload.error?	OpenError
type	"openResponse"

---

InteropRaiseIntent

Ƭ InteropRaiseIntent: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ context?: Context ; intent?: string ; target?: TargetApp }
payload.context?	Context
payload.intent?	string
payload.target?	TargetApp
type	"raiseIntent"

---

InteropRaiseIntentResponse

Ƭ InteropRaiseIntentResponse: Object

Type declaration

Name	Type
meta?	InteropMeta
payload	{ data?: IntentResolution ; error?: ResolveError | null }
payload.data?	IntentResolution
payload.error?	ResolveError | null
type	"intentResolution"

---

InteropRegister

Ƭ InteropRegister: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ authenticationToken: AuthenticationToken ; clientChannel: string ; windowName: string }
payload.authenticationToken	AuthenticationToken
payload.clientChannel	string
payload.windowName	string
type	"register"

---

InteropRegisterUIResolver

Ƭ InteropRegisterUIResolver: Object

Type declaration

Name	Type
meta	InteropMeta
type	"registerUIResolver"

---

InteropRemoveAppDefinitions

Ƭ InteropRemoveAppDefinitions: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ apps: string[] }
payload.apps	string[]
type	"removeAppDefinitions"

---

InteropSetRegistrationData

Ƭ InteropSetRegistrationData: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ windowDescriptor: WindowDescriptor }
payload.windowDescriptor	WindowDescriptor
type	"setInteropRegistrationData"

---

InteropSubscribeContext

Ƭ InteropSubscribeContext: Object

Type declaration

Name	Type
meta	InteropMeta & { channel?: string ; targetSubscriberId?: string }
payload	{ contextType: ContextType }
payload.contextType	ContextType
type	"subscribeContext"

---

InteropSubscribeIntent

Ƭ InteropSubscribeIntent: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ intent: string }
payload.intent	string
type	"subscribeIntent"

---

InteropSystemChannelRequest

Ƭ InteropSystemChannelRequest: Object

Type declaration

Name	Type
meta	InteropMeta
type	"systemChannelRequest"

---

InteropSystemChannels

Ƭ InteropSystemChannels: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ channels: string[] }
payload.channels	string[]
type	"systemChannels"

---

InteropType

Ƭ InteropType: Member<InteropMessage, "type">

---

InteropUnregister

Ƭ InteropUnregister: Object

Type declaration

Name	Type
meta	InteropMeta
type	"unregister"

---

InteropUnsubscribeContext

Ƭ InteropUnsubscribeContext: Object

Type declaration

Name	Type
meta	InteropMeta & { channel?: string }
payload	{ contextType?: ContextType }
payload.contextType?	ContextType
type	"unsubscribeContext"

---

InteropUnsubscribeIntent

Ƭ InteropUnsubscribeIntent: Object

Type declaration

Name	Type
meta	InteropMeta
payload	{ intent: string }
payload.intent	string
type	"unsubscribeIntent"

---

Member

Ƭ Member<T, K>: T[K]

Type parameters

Name	Type
T	T
K	extends keyof T

---

MultiMap

Ƭ MultiMap<T>: Record<string, T[]>

Type parameters

Name
T

---

ResolutionCandidate

Ƭ ResolutionCandidate: Object

Type declaration

Name	Type
appId	string
meta	AppMetadata
uuid?	string
windowName?	string

---

ResolutionList

Ƭ ResolutionList: Object

A list of intent resolutions that are possible for a given intent and optional context.

Arrays of Resolutionlist's are used in raiseIntent to deal with the raiseIntentByContext, which might result in several resolution lists (one list for each possible intent that is associated with the requested context).

For instance, raiseIntentByContext({"symbol" : "IBM"}) could result in: contetType("symbol") => intent("Quote") => QuotesApp, RFQApp, ... contetType("symbol") => intent("News") => NewsApp, TwitterApp, ... contetType("symbol") => intent("Chart") => ChartApp, SnapshotChartApp, ...

Type declaration

Name	Type
context?	ContextAny
intent	{ displayName: string ; name: string }
intent.displayName	string
intent.name	string
launchableApps	ResolutionCandidate[]
openApps	ResolutionCandidate[]

---

ResolverResolution

Ƭ ResolverResolution: Object

Type declaration

Name	Type
error?	ResolveError
intent?	string
originatingAppId?	string
originatingAppName?	string
originatingAppWindow?	string
selectedApp?	AppMetadata
windowName?	string

Variables

AnonymousAuthenticationToken

• Const AnonymousAuthenticationToken: AuthenticationToken

---

GLOBAL_CHANNEL

• Const GLOBAL_CHANNEL: "global"

---

INTENT_RESOLVER_CHANNEL

• Const INTENT_RESOLVER_CHANNEL: "FSBL.FDC3.intent.resolver"

---

SERVER_CHANNEL

• Const SERVER_CHANNEL: "FSBL.FDC3.Interop.Server"

Functions

concatNoDups

▸ concatNoDups(arr, item): any[]

Concats an item to an array, eliminating any dups, and creating the array if it is null or undefined

Parameters

Name	Type
arr	undefined | null | any[]
item	any

Returns

any[]

---

errorAsString

▸ errorAsString(err): string

Parameters

Name	Type
err	any

Returns

string

---

mmAdd

▸ mmAdd(records, index, handler): any[]

MultiMap add

Parameters

Name	Type
records	MultiMap<any>
index	string
handler	any

Returns

any[]

---

mmRemove

▸ mmRemove(records, index, handler): any[]

MultiMap remove

Parameters

Name	Type
records	MultiMap<any>
index	string
handler	any

Returns

any[]