# Interface IWorkflowTenantRegistry

OptimaJet.Workflow.Api.IWorkflowTenantRegistry

Registry of runtime workflow tenants.

Namespace: [OptimaJet.Workflow.Api](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/)

```csharp
public interface IWorkflowTenantRegistry
```

## Methods

`Task<IReadOnlyCollection<IWorkflowTenant>> RegisterTenantsAsync(IEnumerable<WorkflowTenantCreationOptions> options)` 

Creates, registers, and publishes tenants from the provided creation options.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `options` | `IEnumerable<WorkflowTenantCreationOptions>` | The options used to create the tenants. |

### Returns

| Type | Description |
| --- | --- |
| `Task<IWorkflowTenant>` | The created tenant instances. |

`Task<IReadOnlyCollection<IWorkflowTenant>> RegisterTenantsAsync(params WorkflowTenantCreationOptions[] options)` 

Creates, registers, and publishes tenants from the provided creation options.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `options` | `WorkflowTenantCreationOptions[]` | The options used to create the tenants. |

### Returns

| Type | Description |
| --- | --- |
| `Task<IWorkflowTenant>` | The created tenant instances. |

`Task RegisterTenantsAsync(IEnumerable<IWorkflowTenant> tenants)` 

Registers already created tenants and publishes a new immutable tenant snapshot.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenants` | `IEnumerable<IWorkflowTenant>` | The tenants to register. |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`Task RegisterTenantsAsync(params IWorkflowTenant[] tenants)` 

Registers already created tenants and publishes a new immutable tenant snapshot.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenants` | `IWorkflowTenant[]` | The tenants to register. |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`Task UnregisterTenantsAsync(IEnumerable<IWorkflowTenant> tenants)` 

Unregisters tenant instances and publishes a new immutable tenant snapshot.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenants` | `IEnumerable<IWorkflowTenant>` | The tenants to unregister. |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`Task UnregisterTenantsAsync(params IWorkflowTenant[] tenants)` 

Unregisters tenant instances and publishes a new immutable tenant snapshot.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `tenants` | `IWorkflowTenant[]` | The tenants to unregister. |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`IWorkflowTenantSnapshot GetSnapshot()` 

Gets an immutable tenant snapshot actual at the moment of the call.

### Returns

| Type | Description |
| --- | --- |
| `IWorkflowTenantSnapshot` | The immutable tenant snapshot. The caller must dispose it when it is no longer needed. |

[Previous IWorkflowTenantLocator](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/IWorkflowTenantLocator/) [Next IWorkflowTenantRegistryLifecycle](https://api.workflowengine.io/web-api/OptimaJet.Workflow.Api/IWorkflowTenantRegistryLifecycle/)