Constants Api

Provides access to certain constants used globally in an application. These constants are available under the `convenienceApi.constants` namespace.

Properties Details

ACTION_TYPES : Object.<String, String>

Enum of actions used in item list.

• ACTION_TYPES : Object.<String, String>
  • .NEW : String
  • .DELETE : String
  • .LINK : String
  • .UNLINK : String

ACTION_TYPES.NEW : String

ACTION_TYPES.DELETE : String

ACTION_TYPES.LINK : String

ACTION_TYPES.UNLINK : String

ACTION_THEMES : Object.<String, String>

Enum of action themes.

• ACTION_THEMES : Object.<String, String>
  • .PRIMARY : String
  • .SECONDARY : String
  • .TERTIARY : String
  • .NEGATIVE : String

ACTION_THEMES.PRIMARY : String

ACTION_THEMES.SECONDARY : String

ACTION_THEMES.TERTIARY : String

ACTION_THEMES.NEGATIVE : String

ACTIONS : Object.<String, String>

Enum of actions that are localized.

• ACTIONS : Object.<String, String>
  • .SAVE : String
  • .DELETE : String

ACTIONS.SAVE : String

ACTIONS.DELETE : String

ADMIN_WORKSPACE_ARTIFACT_ID : Number

The ArtifactID identifying the instance ("admin case") level workspace.

ARTIFACT_TYPE : Object.<String, Number>

Enum of artifact type ids for Relativity object types.

• ARTIFACT_TYPE : Object.<String, Number>
  • .AGENT : Number
  • .AGENT_TYPE : Number
  • .BATCH : Number
  • .BATCH_SET : Number
  • .CHOICE : Number
  • .CLIENT : Number
  • .CREDENTIAL : Number
  • .CUSTOM_PAGE : Number
  • .DOCUMENT : Number
  • .ERROR : Number
  • .EVENT_HANDLER : Number
  • .FIELD : Number
  • .GROUP : Number
  • .INSTALL_EVENT_HANDLER : Number
  • .INSTANCE_SETTING : Number
  • .LAYOUT : Number
  • .LIBRARY_APPLICATION : Number
  • .LOGIN_METHOD : Number
  • .MATTER : Number
  • .MASS_OPERATION : Number
  • .OBJECT_RULE : Number
  • .OBJECT_TYPE : Number
  • .RELATIVITY_APPLICATION : Number
  • .RELATIVITY_SCRIPT : Number
  • .SEARCH : Number
  • .SEARCH_INDEX : Number
  • .SYSTEM : Number
  • .TAB : Number
  • .USER : Number
  • .WORKSPACE : Number
  • .RESOURCE_FILE : Number
  • .RESOURCE_POOL : Number
  • .RESOURCE_SERVER : Number
  • .VIEW : Number

ARTIFACT_TYPE.AGENT : Number

ARTIFACT_TYPE.AGENT_TYPE : Number

ARTIFACT_TYPE.BATCH : Number

ARTIFACT_TYPE.BATCH_SET : Number

ARTIFACT_TYPE.CHOICE : Number

ARTIFACT_TYPE.CLIENT : Number

ARTIFACT_TYPE.CREDENTIAL : Number

ARTIFACT_TYPE.CUSTOM_PAGE : Number

ARTIFACT_TYPE.DOCUMENT : Number

ARTIFACT_TYPE.ERROR : Number

ARTIFACT_TYPE.EVENT_HANDLER : Number

ARTIFACT_TYPE.FIELD : Number

ARTIFACT_TYPE.GROUP : Number

ARTIFACT_TYPE.INSTALL_EVENT_HANDLER : Number

ARTIFACT_TYPE.INSTANCE_SETTING : Number

ARTIFACT_TYPE.LAYOUT : Number

ARTIFACT_TYPE.LIBRARY_APPLICATION : Number

ARTIFACT_TYPE.LOGIN_METHOD : Number

ARTIFACT_TYPE.MATTER : Number

ARTIFACT_TYPE.MASS_OPERATION : Number

ARTIFACT_TYPE.OBJECT_RULE : Number

ARTIFACT_TYPE.OBJECT_TYPE : Number

ARTIFACT_TYPE.RELATIVITY_APPLICATION : Number

ARTIFACT_TYPE.RELATIVITY_SCRIPT : Number

ARTIFACT_TYPE.SEARCH : Number

ARTIFACT_TYPE.SEARCH_INDEX : Number

ARTIFACT_TYPE.SYSTEM : Number

ARTIFACT_TYPE.TAB : Number

ARTIFACT_TYPE.USER : Number

ARTIFACT_TYPE.WORKSPACE : Number

ARTIFACT_TYPE.RESOURCE_FILE : Number

ARTIFACT_TYPE.RESOURCE_POOL : Number

ARTIFACT_TYPE.RESOURCE_SERVER : Number

ARTIFACT_TYPE.VIEW : Number

DISPLAYABLE_OBJECT_IDENTIFIER : Object.<String, String>

Enum of displayable object identifiers.

EVENT_TYPE : Object.<String, Number>

Enum of event types in Relativity.

FORM_VIEW_MODEL_TYPE : Object.<String, Number>

Enum of view model types in Relativity.

• FORM_VIEW_MODEL_TYPE : Object.<String, Number>
  • .VIEW : Number
  • .ADD : Number
  • .EDIT : Number

FORM_VIEW_MODEL_TYPE.VIEW : Number

FORM_VIEW_MODEL_TYPE.ADD : Number

FORM_VIEW_MODEL_TYPE.EDIT : Number

MESSAGE_CONTAINER_THEMES : Object.<String, String>

Enum of message container themes.

• MESSAGE_CONTAINER_THEMES : Object.<String, String>
  • .WARNING : String
  • .INFORMATION : String
  • .SUCCESS : String

MESSAGE_CONTAINER_THEMES.WARNING : String

MESSAGE_CONTAINER_THEMES.INFORMATION : String

MESSAGE_CONTAINER_THEMES.SUCCESS : String

MODAL_CLASSES : Object.<String, String>

Enum of modal css classes.

• MODAL_CLASSES : Object.<String, String>
  • .SMALL : String
  • .MEDIUM : String
  • .LARGE : String
  • .AUTO : String

MODAL_CLASSES.SMALL : String

MODAL_CLASSES.MEDIUM : String

MODAL_CLASSES.LARGE : String

MODAL_CLASSES.AUTO : String

NAME_ID_PAIR : Object.<String, String>

Enum of name id pairs.

OBJECT_TYPE_IDENTIFIER : Object.<String, String>

Enum of object type identifiers.

PERMISSION_ID : Object.<String, Number>

Enum for permission ids in Relativity.

PERMISSION_TYPE : Object.<String, Number>

Enum for CRUD permission types in Relativity.

SELECTION_TYPE : Object.<String, String>

Enum indicating the selection type the user has made for a mass action on an item list.

VIEW_MODEL_NAME : Object.<String, String>

Enum of view model types in Relativity.

• VIEW_MODEL_NAME : Object.<String, String>
  • .ADD : String
  • .VIEW : String
  • .EDIT : String

VIEW_MODEL_NAME.ADD : String

VIEW_MODEL_NAME.VIEW : String

VIEW_MODEL_NAME.EDIT : String

SAVE_OPERATIONS : Object.<String, Number>

Enum of save operation types.

• SAVE_OPERATIONS : Object.<String, Number>
  • .SAVE : Number
  • .SAVE_AND_NEW : Number
  • .SAVE_AND_BACK : Number
  • .SAVE_AND_CONTINUE : Number
  • .SAVE_AND_NEXT : Number
  • .SAVE_AND_PREVIOUS : Number
  • .SAVE_AND_GO : Number

SAVE_OPERATIONS.SAVE : Number

SAVE_OPERATIONS.SAVE_AND_NEW : Number

SAVE_OPERATIONS.SAVE_AND_BACK : Number

SAVE_OPERATIONS.SAVE_AND_CONTINUE : Number

SAVE_OPERATIONS.SAVE_AND_NEXT : Number

SAVE_OPERATIONS.SAVE_AND_PREVIOUS : Number

SAVE_OPERATIONS.SAVE_AND_GO : Number

KEYS : Array.<Object>

Array of UTF character codes for keyboard shortcuts.

HTTP_STATUS_CODE : Object.<String, Number>

HTTP request status codes.

ITEM_LIST_COMMAND_COLUMN_TYPE : Object.<String, (String|null)>

Enum of command column types to use for item lists.

• ITEM_LIST_COMMAND_COLUMN_TYPE : Object.<String, (String|null)>
  • .SINGLE_SELECTION : String
  • .MULTI_SELECTION : String
  • .NONE : null
  • .AUTO : String

ITEM_LIST_COMMAND_COLUMN_TYPE.SINGLE_SELECTION : String

Allow the user to select up to one item

ITEM_LIST_COMMAND_COLUMN_TYPE.MULTI_SELECTION : String

Allow the user to select any number of items

ITEM_LIST_COMMAND_COLUMN_TYPE.NONE : null

Do not allow the user to select items

ITEM_LIST_COMMAND_COLUMN_TYPE.AUTO : String

Automatically determine the command column type based on the actions present on the item list