Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "connection"

Index

Functions

Functions

Const beforeSend

  • beforeSend(xhr: XMLHttpRequest, tenantId: string, authenticationToken: string, event: string, request: any): void

  • Adding authentication token and tenant id to request headers

    Parameters

    • xhr: XMLHttpRequest
    • tenantId: string
    • authenticationToken: string
    • event: string
    • request: any

    Returns void

Const request

  • request(context: any, event: string, url: string, type: string, tenantId: string, stateId: string, authenticationToken: string, data: object): jqXHR<any>

  • Make an AJAX request to the Boomi Flow platform

    Parameters

    • context: any

      TODO

    • event: string

      Type of event, Settings.event(event + '.done') will be called when the request completes

    • url: string

      The path to make the request against, excluding the host which is fetched from Settings.global('platform.uri')

    • type: string

      AJAX request type e.g. GET, POST, etc

    • tenantId: string

      The GUID of the tenant to make the request against

    • stateId: string

      The GUID of the state we are making the request from

    • authenticationToken: string

      Current running users authentication token

    • data: object

      Body of the request data

    Returns jqXHR<any>

    JQuery deferred from the $.ajax request

Const upload

  • upload(context: any, event: string, url: string, formData: FormData, tenantId: string, authenticationToken: string, onProgress: EventListenerOrEventListenerObject): jqXHR<any>

  • Upload a file to the Boomi Flow platform

    Parameters

    • context: any

      TODO

    • event: string

      Type of event, Settings.event(event + '.done') will be called when the request completes

    • url: string

      The path to make the request against, excluding the host which is fetched from Settings.global('platform.uri')

    • formData: FormData

      FormData for the file being uploaded

    • tenantId: string

      The GUID of the tenant to make the request against

    • authenticationToken: string

      Current running users authentication token

    • onProgress: EventListenerOrEventListenerObject

      Callback to recieve progress event info

    Returns jqXHR<any>

    JQuery deferred from the $.ajax request

Const uploadFiles

  • uploadFiles(context: any, event: string, url: string, files: File[], request: any, tenantId: string, authenticationToken: string, onProgress: EventListenerOrEventListenerObject, _: string): jqXHR<any>

  • Upload a file to the Boomi Flow platform

    Parameters

    • context: any

      TODO

    • event: string

      Type of event, Settings.event(event + '.done') will be called when the request completes

    • url: string

      The path to make the request against, excluding the host which is fetched from Settings.global('platform.uri')

    • files: File[]

      List of files to be uploaded

    • request: any

      Request payload data

    • tenantId: string

      The GUID of the tenant to make the request against

    • authenticationToken: string

      Current running users authentication token

    • onProgress: EventListenerOrEventListenerObject

      Callback to recieve progress event info

    • _: string

      (stateId) Only currently used when offline

    Returns jqXHR<any>

    JQuery deferred from the $.ajax request

Generated using TypeDoc