com.sovren.models.api.matching.ui.hooks

Class UserActionHook

java.lang.Object

com.sovren.models.api.matching.ui.hooks.UserActionHook

Direct Known Subclasses:

ClientSideHook, ServerSideHook

public class UserActionHook
extends Object

A base class for all 3 kinds of hooks

Field Summary

Fields

Modifier and Type	Field and Description
boolean	IsBulk Set to true to allow users to select multiple documents and perform this action on all of them at once.
String	LinkText Text to display on the button for the user action.

Constructor Summary

Constructors

Constructor and Description
UserActionHook()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LinkText

public String LinkText

Text to display on the button for the user action.

IsBulk

public boolean IsBulk

Set to true to allow users to select multiple documents and perform this action on all of them at once.
NOTE: this can only be set to true when you use a JsAction. UrlActions are not supported.
See https://sovren.com/technical-specs/latest/rest-api/matching-ui/overview/#ui-match-hooks for more info.
This value is not supported for Sourcing hooks, yet

Constructor Detail

UserActionHook

public UserActionHook()