Interface ILibraryApplicationService

Represents the Library application API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface ILibraryApplicationService

Examples

ILibraryApplicationService _libraryApplicationService = RelativityFacade.Resolve<ILibraryApplicationService>();

Methods

| Improve this Doc View Source

DeleteFromLibrary(Int32)

Delete the application from the library.

Declaration

void DeleteFromLibrary(int applicationId)

Parameters

Type	Name	Description
System.Int32	applicationId	The ArtifactID of the application to delete from the library.

Examples

int applicationID = 1015427;
_libraryApplicationService.DeleteFromLibrary(applicationID);

| Improve this Doc View Source

Get(Guid)

Gets the library application by the specified GUID.

Declaration

LibraryApplication Get(Guid identifier)

Parameters

Type	Name	Description
System.Guid	identifier	The Library application GUID identifier.

Returns

Type	Description
LibraryApplication	The LibraryApplication entity or null.

Examples

Guid identifier = Guid.Parse("4c8836a0-5138-4fe4-a1fd-04b04e6730a7");
LibraryApplication application = _libraryApplicationService.Get(identifier);

| Improve this Doc View Source

Get(Int32)

Gets the library application by the specified ID.

Declaration

LibraryApplication Get(int applicationId)

Parameters

Type	Name	Description
System.Int32	applicationId	The ArtifactID of the application.

Returns

Type	Description
LibraryApplication	The LibraryApplication entity or null.

Examples

int applicationID = 1015427;
LibraryApplication application = _libraryApplicationService.Get(applicationID);

| Improve this Doc View Source

Get(String)

Gets the library application by the specified name.

Declaration

LibraryApplication Get(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
LibraryApplication	The LibraryApplication entity or null.

Examples

string applicationName = "CuttingEdgeAppName";
LibraryApplication application = _libraryApplicationService.Get(applicationName);

| Improve this Doc View Source

InstallToLibrary(String, LibraryApplicationInstallOptions)

Installs library application from RAP file.

Declaration

int InstallToLibrary(string pathToRap, LibraryApplicationInstallOptions options = null)

Parameters

Type	Name	Description
System.String	pathToRap	Path to the RAP file.
LibraryApplicationInstallOptions	options	Represents a request for creating or updating a Library Application.

Returns

Type	Description
System.Int32	Artifact ID of installed application.

Examples

string pathToRap = "path/to/cutting/edge/app.rap";
var options = new LibraryApplicationInstallOptions { IgnoreVersion = true };
int applicationID = _libraryApplicationService.InstallToLibrary(pathToRap, options);

| Improve this Doc View Source

InstallToWorkspace(Int32, Int32)

Installs library application to given workspace from library.

Declaration

void InstallToWorkspace(int workspaceId, int applicationId)

Parameters

Type	Name	Description
System.Int32	workspaceId	Workspace ID to install the application to.
System.Int32	applicationId	Application ID to install.

Examples

int workspaceID = 123456;
int applicationID = 1015427;
_libraryApplicationService.InstallToWorkspace(workspaceID, applicationID);

| Improve this Doc View Source

IsInstalledInWorkspace(Int32, Int32)

Determines whether the library application is installed in workspace.

Declaration

bool IsInstalledInWorkspace(int workspaceId, int applicationId)

Parameters

Type	Name	Description
System.Int32	workspaceId	Workspace ID to check.
System.Int32	applicationId	Application ID to check.

Returns

Type	Description
System.Boolean	true if an application is installed in workspace; otherwise, false.

Examples

int workspaceID = 123456;
string applicationName = "CuttingEdgeAppName";
bool isInstalled = _libraryApplicationService.IsInstalledInWorkspace(workspaceID, applicationName);