errorApi

The errorApi is sub-set of the relativity.internal API, and it displays error UIs.

1
relativity.internal.errorApi

Note: Anything on relativity.internal.errorApi which is not listed below should not be used, and should be considered volatile (subject to change or removal without warning).

Supported Surface Area of relativity.internal.errorApi

accessDenied

Displays an error overlay with a message based on the supplied lockoutType. If no lockoutType is specified, the default message is used.

1
accessDenied(lockoutType?: number) : void

lockoutType - the type of access denied error. The possible types are:

• 2 - Indicates that the user's Relativity account has been disabled
• 6 - Indicates that an assembly needed to verify the Relativity license is missing or has changed
• 7 - Indicates that a Relativity license is missing
• 10 - Indicates that Relativity is temporarily unavailable

Example:

1
2
relativity.internal.errorApi.accessDenied();
// an error overlay is displayed with a message indicating that your account is not configured to use Global.Relativity

init

Displays an error based on the supplied parameters

1
init(errorParameter: object|string|number) : void

errorParameter - the parameters of the error to display. The possible inputs here are:

• object - An object containing message and artifactId properties
• artifactId - The artifact ID of the object for which to display an error message. If this number is greater than 0, this method will attempt to retrieve the error details for that particular object.
• message - A message you'd like to display on the error page. The error message to be shown is either the error message from error details, the error message passed here, or a generic "an error has occurred" message.
• string - A message that you'd like to display on the error page
• number - The artifact ID of the object for which you'd like to display an error message

Example:

1
2
relativity.internal.errorApi.init("Hello! This is the error message I'd like to display.");
// an error overlay is displayed with the supplied error message

noView

Displays an error overlay with a message indicating that no views exist (or the logged in user has no permissions to any views) for the selected object.

1
noView() : void

Example:

1
2
relativity.internal.errorApi.noView();
// an error overlay is displayed that no views exist for the selected object

permissionDenied

Displays an error overlay with a message indicating that the user doesn't have permissions to view this item.

1
permissionDenied() : void

Example:

1
2
relativity.internal.errorApi.permissionDenied();
// an error overlay is displayed that the user doesn't have permissions to view the item

workspaceVersion

Displays an error overlay with a message indicating that the workspace is not accessible because it hasn't been upgraded to the current version of Relativity.

1
workspaceVersion() : void

Example:

1
2
relativity.internal.errorApi.workspaceVersion();
// an error overlay is displayed that the workspace is not accessible because it hasn't been upgraded to the current version of Relativity