Relativity.Testing.Framework.Api.Services.IClientService

IClientService

public interface IClientService

Represents the client API service.

Documentation

Creates the specified client.

void Delete(int id)

Deletes the [Client](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Client.html) by ID.

Client Get(int id)

Gets the [Client](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Client.html) by ArtifactID.

Client Get(string name)

Gets the [Client](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Client.html) by name.

IEnumerable<NamedArtifact> GetEligibleStatuses()

Gets a list of available statuses for a [Client](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Client.html).

Client Require(Client entity)

Requires the specified client. If the [ArtifactID](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Artifact.html#Relativity_Testing_Framework_Models_Artifact_ArtifactID) property of entity has a positive value, this gets the client by ID and returns it.Else if the [Name](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.NamedArtifact.html#Relativity_Testing_Framework_Models_NamedArtifact_Name) property of entity has a value, this gets the client by name and returns it if it exists.Otherwise this creates a new client using [ICreateStrategy<T>](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Strategies.ICreateStrategy-1.html).

void Update(Client entity)

Updates the specified [Client](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Client.html).