Class FoviaAPI

Static requestServerConnection

• requestServerConnection(connectionCallback: any, fatalServerErrorHandler?: any, sessionDisconnectHandler?: any, nodeServerIP?: string, port?: number, protocol?: string): void

• This method requests the initial communication with the Node.js server. Until this call is made, no communciation will occur between the client and server.

  This is the only method in the Fovia API that does not support a Promise interface. This is due to the fact that this method will first determine if the browser nativelly supports Promises, and if not, include the necessary JavaScript.

  Parameters

  • connectionCallback: any

    client side callback that is invoked upon successfull connection with the server

  • Optional fatalServerErrorHandler: any

    that is an optional callback invokved upon an unrecoverable communication error with the Fovia Web Server

  • Optional sessionDisconnectHandler: any

  • Optional nodeServerIP: string

    network address of the Node.js server. The default value is the IP address that served up the client's web page

  • Optional port: number

    port to use for the Node.js server. The default value is 8088

    NOTE: nodeServerIP and port must both be specified or both empty (which uses the defaults)

  • Optional protocol: string

  Returns void

  This is an asynchronous method does not return any value. The connecitonCallback parameter reports any error condition. All calls return non-zero for error or zero (Fovia.ReturnCode.ok) for successs.