formcycle 8.3.6 - JavaScript for forms
    Preparing search index...

    Interface MetadataUrls

    An object with all formcycle-specific resources, such as database queries or plugin servlets. To access the URLs for the currently opened form, use XFC_METADATA.urls. You should always use these URLs instead of hard-coding URLs. This way you can make sure that your code keeps working even when the URL to the formcycle system changes.

    interface MetadataUrls {
        ajax_upload: string;
        appointment_freeslots: string;
        attachment: string;
        authLoginBase: string;
        authLogout: string;
        authLogoutBase: string;
        context: string;
        counter_client: string;
        dataquery_db: string;
        dataquery_ldap: string;
        datasource_csv: string;
        datasource_db: string;
        datasource_json: string;
        datasource_xml: string;
        keepalive: string;
        plugin: string;
        previewAction: string;
        request: string;
        requestBase: string;
        submitAction: string;
        template: string;
    }
    Index

    Properties

    ajax_upload appointment_freeslots attachment authLoginBase authLogout authLogoutBase context counter_client dataquery_db dataquery_ldap datasource_csv datasource_db datasource_json datasource_xml keepalive plugin previewAction request requestBase submitAction template

    Properties

    ajax_upload: string

    Base URL for accessing the AJAX upload servlet, as configured in the formcycle backend.

    appointment_freeslots: string

    Base URL for accessing free appointment slots, as configured in the formcycle backend.

    attachment: string

    Base URL for accessing attachments uploaded via upload elements.

    authLoginBase: string

    Base URL for the logging in via some login service.

    authLogout: string

    URL for logging out the current, if they are logged in.

    authLogoutBase: string

    Base URL for logging out the current, without parameters.

    context: string

    The current context path of the web application, e.g. /formcycle.

    counter_client: string

    Base URL for client counter queries as configured in the formcycle backend.

    dataquery_db: string

    Base URL for accessing database queries as configured in the formcycle backend.

    dataquery_ldap: string

    Base URL for accessing LDAP queries as configured in the formcycle backend.

    datasource_csv: string

    Base URL for accessing CSV data sources as configured in the formcycle backend.

    datasource_db: string

    Use dataquery_db instead.

    datasource_json: string

    Base URL for accessing JSON data sources as configured in the formcycle backend.

    datasource_xml: string

    Base URL for accessing XML data sources as configured in the formcycle backend.

    keepalive: string

    URL for keeping the current session alive. Similar to a ping.

    plugin: string

    URL for executing servlet plugins.

    previewAction: string

    URL for requesting a preview of a form. A preview cannot be submitted.

    request: string

    URL for requesting the form itself, without the fragment and any query parameters. This is the URL that was used to open the form. It is different depending on how the form was opened, e.g. whether it was opened by a frontend user or in the inbox.

    requestBase: string

    URL for requesting the form itself, with the fragment and all query parameters. This is the URL that was used to open the form. It is different depending on how the form was opened, e.g. whether it was opened by a frontend user or in the inbox.

    submitAction: string

    URL to which the form data is submitted.

    template: string

    Base URL for requesting a template configured in the backend, used for example when a footer template is configured in the designer.

    Settings

    Member Visibility

    On This Page

    Properties