Interface IOcrProfileService

Represents the optical character recognition API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IOcrProfileService

Examples

IOcrProfileService _ocrProfileService = relativityFacade.Resolve<IOcrProfileService>();

Methods

Create(Int32, OcrProfile)

Creates the specified OcrProfile.

Declaration

OcrProfile Create(int workspaceId, OcrProfile entity)

Parameters

Type	Name	Description
System.Int32	workspaceId	The ArtifactID of the workspace where you want to add the OcrProfile, or use -1 to indicate the admin-level context.
OcrProfile	entity	The OcrProfileentity to create.

Returns

Type	Description
OcrProfile	The created OcrProfile entity.

Examples

This example shows how to create OCR Profile with some properties set.

int workspaceArtifactID = 1015427;
var ocrProfileToCreate = new OcrProfile
{
	Name = "My script Name",
	ImageTimeout = 120
};
OcrProfile ocrProfile = _ocrProfileService.Create(workspaceArtifactID, ocrProfileToCreate);

This example shows how to create OCR Profile without setting any properties - default values will be assigned.

int workspaceArtifactID = 1015427;
OcrProfile ocrProfile = _ocrProfileService.Create(workspaceArtifactID, new OcrProfile());

Delete(Int32, Int32)

Deletes the OcrProfile by ArtifactID.

Declaration

void Delete(int workspaceId, int entityId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The ArtifactID of the workspace where you want to delete the OcrProfile, or use -1 to indicate the admin-level context.
System.Int32	entityId	The ArtifactID of the OcrProfile.

Examples

int workspaceArtifactID = 1015427;
int existingOCRProfileArtifactID = 1015427;
_ocrProfileService.Delete(workspaceArtifactID, existingOCRProfileArtifactID);

Get(Int32, Int32)

Gets the OcrProfile by the specified ArtifactID.

Declaration

OcrProfile Get(int workspaceId, int entityId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The ArtifactID of the workspace where you want to get the OcrProfile, or use -1 to indicate the admin-level context.
System.Int32	entityId	The ArtifactID of the OcrProfile.

Returns

Type	Description
OcrProfile	The OcrProfile entity or null.

Examples

int workspaceArtifactID = 1015427;
int existingOCRProfileArtifactID = 1015427;
OcrProfile ocrProfile = _ocrProfileService.Get(workspaceArtifactID, existingOCRProfileArtifactID);