com.textkernel.tx.models.api.matching.ui.hooks.UrlAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tx-java Show documentation

The official Java SDK for the Textkernel Tx v10 API.

The newest version!

// Copyright © 2023 Textkernel BV. All rights reserved.
// This file is provided for use by, or on behalf of, Textkernel licensees
// within the terms of their license of Textkernel products or Textkernel customers
// within the Terms of Service pertaining to the Textkernel SaaS products.

package com.textkernel.tx.models.api.matching.ui.hooks;

/** An action performed with a URL (opening a new window, displaying some webpage)*/
public class UrlAction {
    /**
    * The URL to show (either in another tab/window or in an iFrame inside the Matching UI).
    * 
NOTE: the UI will do a string.replace() on this URL to replace {id} with the document
    * id (that this action was performed on) and {indexId} with the index id (containing the document the action
    * was performed on).
    * 

    * For example: https://my-ats.com/contact-info/{id} gets transformed to https://my-ats.com/contact-info/34879
    */
    public String Url;

    /**
    * Use "tx" to open a popup inside the Matching UI and display the webpage.
    * Any other value will be used just like the target attribute on a normal anchor tag ("_blank" for a new tab/window, etc).
    */
    public String Target;
}