Skip to main content
Version: Next

Errors

FDC3 API operations may sometimes result in an error that is returned to the caller. Errors MUST be returned by rejecting the promise returned by the API with a JavaScript Error object (or equivalent for the language of the implementation). The Error Object's message should be chosen from the appropriate Error enumeration below.

AgentError​

Contains constants representing the errors that can be encountered when calling the getAgent function to establish connectivity to a Desktop Agent. Primarily used with web applications, but may also be used in other language implementations.

enum AgentError { 
    /** Returned if no Desktop Agent was found by any means available or 
     * if the Agent previously connected to is not contactable on a  
     * subsequent connection attempt.*/
    AgentNotFound = "AgentNotFound",

    /** Returned if validation of the app identity by the Desktop Agent 
     * failed or the app is not being allowed to connect to the Desktop Agent 
     * for another reason. */ 
    AccessDenied = "AccessDenied",

    /** Returned if an error or exception occurs while trying to set  
     * up communication with a Desktop Agent. */ 
    ErrorOnConnect = "ErrorOnConnect",

    /** Returned if the failover function is not a function, or it did not
     * resolve to one of the allowed types.*/ 
    InvalidFailover = "InvalidFailover",
}

ChannelError​

Contains constants representing the errors that can be encountered when calling channels using the joinUserChannel or getOrCreateChannel methods, or the getCurrentContext, broadcast or addContextListener methods on the Channel object.

enum ChannelError {
  /** Returned if the specified channel is not found when attempting to join a
   *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
   */
  NoChannelFound = "NoChannelFound",

  /** SHOULD be returned when a request to join a user channel or to a retrieve
   *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
   *  of the DesktopAgent (`fdc3`) object is denied. 
   */
  AccessDenied = "AccessDenied",
  
  /** SHOULD be returned when a channel cannot be created or retrieved via the
   *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
   */
  CreationFailed = "CreationFailed",

  /** Returned if a call to the `broadcast` functions is made with an invalid
   *  context argument. Contexts should be Objects with at least a `type` field
   *  that has a `string` value.
   */
  MalformedContext = "MalformedContext",
}

See also:

OpenError​

Contains constants representing the errors that can be encountered when calling the open method on the DesktopAgent object.

enum OpenError {
  /** Returned if the specified application is not found.*/
  AppNotFound = "AppNotFound",

  /** Returned if the specified application fails to launch correctly.*/
  ErrorOnLaunch = "ErrorOnLaunch",

  /** Returned if the specified application launches but fails to add a context
   *  listener in order to receive the context passed to the `fdc3.open` call.
   */
  AppTimeout = "AppTimeout",

  /** Returned if the FDC3 desktop agent implementation is not currently able
   *  to handle the request.
   */
  ResolverUnavailable = "ResolverUnavailable",

  /** Returned if a call to the `open` function is made with an invalid
   *  context argument. Contexts should be Objects with at least a `type` field
   *  that has a `string` value.
   */
  MalformedContext = "MalformedContext",

    /** @experimental Returned if the specified Desktop Agent is not found, via a connected 
   *  Desktop Agent Bridge. */
  DesktopAgentNotFound = "DesktopAgentNotFound",
}

See also:

ResolveError​

Contains constants representing the errors that can be encountered when calling the findIntent, findIntentsByContext, raiseIntent or raiseIntentForContext methods on the DesktopAgent.

export enum ResolveError {
  /** SHOULD be returned if no apps are available that can resolve the intent
   *  and context combination.
   */
  NoAppsFound = "NoAppsFound",

  /** Returned if the FDC3 desktop agent implementation is not currently able
   *  to handle the request.
   */
  ResolverUnavailable = "ResolverUnavailable",

  /** Returned if the user cancelled the resolution request, for example by
   *  closing or cancelling a resolver UI.
   */
  UserCancelled = "UserCancelledResolution",

  /** SHOULD be returned if a timeout cancels an intent resolution that
   *  required user interaction. Please use `ResolverUnavailable` instead for
   *  situations where a resolver UI or similar fails.
   */
  ResolverTimeout = "ResolverTimeout",

  /** Returned if a specified target application is not available or a new
   *  instance of it cannot be opened. 
   */
  TargetAppUnavailable = "TargetAppUnavailable",

  /** Returned if a specified target application instance is not available,
   *  for example because it has been closed. 
   */
  TargetInstanceUnavailable = "TargetInstanceUnavailable",

  /** Returned if the intent and context could not be delivered to the selected
   *  application or instance, for example because it has not added an intent
   *  handler within a timeout.
   */
  IntentDeliveryFailed = "IntentDeliveryFailed",

  /** Returned if a call to one of the `raiseIntent` functions is made with an 
   *  invalid context argument. Contexts should be Objects with at least a `type`
   *  field that has a `string` value.
   */
  MalformedContext = "MalformedContext",

    /** @experimental Returned if the specified Desktop Agent is not found, via a connected 
   *  Desktop Agent Bridge. */
  DesktopAgentNotFound = "DesktopAgentNotFound",
}

See also:

ResultError​

Contains constants representing the errors that can be encountered when calling the getResult method on the IntentResolution Object.

enum ResultError {
  /** Returned if the intent handler exited without returning a valid result 
   * (a promise resolving to a Context, Channel object or void).
   */
  NoResultReturned = "NoResultReturned",

  /** Returned if the `IntentHandler` function processing the raised intent
   *  throws an error or rejects the Promise it returned. 
   */
  IntentHandlerRejected = "IntentHandlerRejected",
}

See also:

BridgingError​

@experimental

enum BridgingError {
  /** @experimental Returned if a Desktop Agent did not return a response, via 
   *  Desktop Agent Bridging, within the allotted timeout. */
  ResponseTimedOut = "ResponseToBridgeTimedOut",

  /** @experimental Returned if a Desktop Agent that has been targeted by a 
   *  particular request has been disconnected from the Bridge before a 
   *  response has been received from it. */
  AgentDisconnected = "AgentDisconnected",

  /** @experimental Returned for FDC3 API calls that are specified with
   *  arguments indicating that a remote Desktop agent should be targeted
   *  (e.g. raiseIntent with an app on a remote DesktopAgent targeted), 
   *  when the local Desktop Agent is not connected to a bridge. */
  NotConnectedToBridge = "NotConnectedToBridge",

  /** @experimental Returned if a message to a Bridge deviates from the schema
   *  for that message sufficiently that it could not be processed.
   */
  MalformedMessage = "MalformedMessage",
}

Contains constants representing the errors that can be encountered when queries are forwarded to a Desktop Agent Bridge, but one or more remote Desktop Agents connected to it disconnects, times-out or a malformed message is encountered while a particular request is in flight. These errors may be returned via the FDC3 API when a Desktop Agent is (or was) connected to a Desktop Agent Bridge.

See also:

Last updated on by Kris West