> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ConnectorClient

> A connector reached only through its calls, as JSON over a channel.

```csharp
public class ConnectorClient : ITargetConnector, IConnector, ISupportsPrincipalWrites, ISupportsOperations, ISupportsGrants, ISupportsGrantReads, ISupportsCatalog, ISupportsDiscovery, ISupportsDeltaReads, ISupportsActions, ISupportsLinks, ISupportsElementEnds, ISupportsSignInUrl, ISupportsOAuthCompletion, ISupportsWorkerReads, ISupportsPushEvents, ISupportsPollEvents
```

**Implements:** `ITargetConnector`, `IConnector`, `ISupportsPrincipalWrites`, `ISupportsOperations`, `ISupportsGrants`, `ISupportsGrantReads`, `ISupportsCatalog`, `ISupportsDiscovery`, `ISupportsDeltaReads`, `ISupportsActions`, `ISupportsLinks`, `ISupportsElementEnds`, `ISupportsSignInUrl`, `ISupportsOAuthCompletion`, `ISupportsWorkerReads`, `ISupportsPushEvents`, `ISupportsPollEvents`

It answers every interface, so what it can do is what its manifest declares.

## Constructors

```csharp
public ConnectorClient(IConnectorChannel channel, ConnectorManifest manifest)
```

A connector reached only through its calls, as JSON over a channel.

It answers every interface, so what it can do is what its manifest declares.

### Parameters

**channel** `IConnectorChannel` *required*

**manifest** `ConnectorManifest` *required*

## Methods

### AddLinkAsync()

```csharp
public Task AddLinkAsync(ConnectionContext context, string externalId, string fieldKey, ObjectLink link, string operationId, CancellationToken cancellationToken)
```

Adds one link to an account's array of links.

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**fieldKey** `string` *required*

**link** `ObjectLink` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

### ChangeGrantsAsync()

```csharp
public Task<GrantOutcome> ChangeGrantsAsync(ConnectionContext context, PrincipalRef holder, string entitlementField, IReadOnlyCollection<string> add, IReadOnlyCollection<string> remove, string operationId, CancellationToken cancellationToken)
```

Adds and removes grants on one field of an account or a principal, each value on its own.

#### Parameters

**context** `ConnectionContext` *required*

The connection.

**holder** `PrincipalRef` *required*

The account or principal, of a kind the field is grantable to.

**entitlementField** `string` *required*

The field.

**add** `IReadOnlyCollection\<string\>` *required*

The values to grant.

**remove** `IReadOnlyCollection\<string\>` *required*

The values to take away.

**operationId** `string` *required*

Stable across every retry of one change.

**cancellationToken** `CancellationToken` *required*

Stops the change.

#### Returns

`Task<GrantOutcome>`

### CheckAsync()

```csharp
public Task<CheckAnswer> CheckAsync(ConnectionContext context, JsonObject? tokenAnswer, CancellationToken cancellationToken)
```

Checks the connection, or finishes an authorization when given the token endpoint's `tokenAnswer`.

#### Parameters

**context** `ConnectionContext` *required*

**tokenAnswer** `JsonObject` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<CheckAnswer>`

### CheckConnectionAsync()

```csharp
public Task<ConnectionCheck> CheckConnectionAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Checks the connection, naming anything that stops the host using it.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<ConnectionCheck>`

### CompleteOAuthAsync()

```csharp
public Task<OAuthCompletion> CompleteOAuthAsync(ConnectionContext context, OAuthApproval approval, CancellationToken cancellationToken)
```

Reads what a new authorization reaches.

#### Parameters

**context** `ConnectionContext` *required*

**approval** `OAuthApproval` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<OAuthCompletion>`

### CreatePrincipalAsync()

```csharp
public Task<WriteOutcome> CreatePrincipalAsync(ConnectionContext context, DesiredPrincipal desired, CancellationToken cancellationToken)
```

Creates a principal, touching nothing the vendor already holds.

#### Parameters

**context** `ConnectionContext` *required*

**desired** `DesiredPrincipal` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<WriteOutcome>`

### DiscoverAsync()

```csharp
public Task<Discovery> DiscoverAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Reads every field the tenant adds, each with the path it attaches at, and the rules it holds values to.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Discovery>`

### EndElementAsync()

```csharp
public Task EndElementAsync(ConnectionContext context, string externalId, ElementKey element, LocalDate endsOn, string operationId, CancellationToken cancellationToken)
```

Ends an element, and the elements it holds, on a given date.

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**element** `ElementKey` *required*

**endsOn** `LocalDate` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

### GetOperationAsync()

```csharp
public Task<OperationState> GetOperationAsync(ConnectionContext context, string handle, CancellationToken cancellationToken)
```

Says where a pending write stands, from its handle alone.

#### Parameters

**context** `ConnectionContext` *required*

**handle** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<OperationState>`

### GetPrincipalAsync()

```csharp
public Task<PrincipalRead> GetPrincipalAsync(ConnectionContext context, string kind, string id, JsonObject? desired, CancellationToken cancellationToken)
```

Reads one principal by its id.

#### Parameters

**context** `ConnectionContext` *required*

**kind** `string` *required*

**id** `string` *required*

**desired** `JsonObject` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<PrincipalRead>`

### GetWorkersAsync()

```csharp
public Task<IReadOnlyList<SourceWorker>> GetWorkersAsync(ConnectionContext context, IReadOnlyCollection<string> sourceIds, CancellationToken cancellationToken)
```

Reads the workers with the given ids that the source holds, and no others.

#### Parameters

**context** `ConnectionContext` *required*

**sourceIds** `IReadOnlyCollection\<string\>` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<IReadOnlyList<SourceWorker>>`

### InMemory()

```csharp
public static ConnectorClient InMemory(object connector, ConnectorManifest manifest)
```

A client that reaches a connector in this process, through JSON.

#### Parameters

**connector** `object` *required*

**manifest** `ConnectorManifest` *required*

#### Returns

`ConnectorClient`

### InvokeActionAsync()

```csharp
public Task<ActionOutcome> InvokeActionAsync(ConnectionContext context, string action, string? externalId, JsonObject fields, string operationId, CancellationToken cancellationToken)
```

Runs one declared action; a retry with the same operation id leaves the vendor as the first run did.

#### Parameters

**context** `ConnectionContext` *required*

The connection.

**action** `string` *required*

The action's key.

**externalId** `string` *required*

The object it runs on, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) for an action on the connection.

**fields** `JsonObject` *required*

What a person filled in, by the keys its fields declare.

**operationId** `string` *required*

Stable across every retry of one run.

**cancellationToken** `CancellationToken` *required*

Stops the run.

#### Returns

`Task<ActionOutcome>`

### ListCatalogAsync()

```csharp
public Task<Page<CatalogValue>> ListCatalogAsync(ConnectionContext context, string source, PageRequest page, CancellationToken cancellationToken)
```

Reads one page of the records of a resource a field points at, by the resource's key, or of a `values_from` lookup list, by its name.

#### Parameters

**context** `ConnectionContext` *required*

**source** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<CatalogValue>>`

### ListChangedPrincipalsAsync()

```csharp
public Task<Page<Principal>> ListChangedPrincipalsAsync(ConnectionContext context, string kind, string watermark, PageRequest page, CancellationToken cancellationToken)
```

Reads one page of what changed since the watermark, answering restart when it is stale.

#### Parameters

**context** `ConnectionContext` *required*

**kind** `string` *required*

**watermark** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<Principal>>`

### ListGrantsAsync()

```csharp
public Task<Page<Grant>> ListGrantsAsync(ConnectionContext context, string entitlementField, GrantFilter filter, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of a field's grants.

#### Parameters

**context** `ConnectionContext` *required*

**entitlementField** `string` *required*

**filter** `GrantFilter` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<Grant>>`

### ListPrincipalsAsync()

```csharp
public Task<Page<Principal>> ListPrincipalsAsync(ConnectionContext context, string kind, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of principals of one kind.

#### Parameters

**context** `ConnectionContext` *required*

**kind** `string` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<Principal>>`

### ListWorkersAsync()

```csharp
public Task<Page<SourceWorker>> ListWorkersAsync(ConnectionContext context, PageRequest page, CancellationToken cancellationToken)
```

Lists one page of workers.

#### Parameters

**context** `ConnectionContext` *required*

**page** `PageRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Page<SourceWorker>>`

### Normalize()

```csharp
public JsonObject Normalize(JsonObject payload)
```

Puts an account's payload in the form the target reports.

#### Parameters

**payload** `JsonObject` *required*

#### Returns

`JsonObject`

### NormalizeAsync()

```csharp
public Task<IReadOnlyList<JsonObject>> NormalizeAsync(ConnectionContext context, IReadOnlyList<JsonObject> payloads, CancellationToken cancellationToken)
```

Puts account payloads in the vendor's form in one call on a connection, which a connector on a runner answers too.

#### Parameters

**context** `ConnectionContext` *required*

**payloads** `IReadOnlyList\<JsonObject\>` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<IReadOnlyList<JsonObject>>`

### PollAsync()

```csharp
public Task<Polled> PollAsync(ConnectionContext context, string? position, CancellationToken cancellationToken)
```

Reads what happened after `position`. On a queue, the position is the last message handled, which the connector removes before reading the next.

#### Parameters

**context** `ConnectionContext` *required*

**position** `string` *required*

Where the last poll stopped, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) at the start.

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Polled>`

### ReadGrantsAsync()

```csharp
public Task<IReadOnlyDictionary<string, FieldGrants>> ReadGrantsAsync(ConnectionContext context, string entitlementField, IReadOnlyCollection<string> values, CancellationToken cancellationToken)
```

Reads who holds the given values.

#### Parameters

**context** `ConnectionContext` *required*

**entitlementField** `string` *required*

**values** `IReadOnlyCollection\<string\>` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<IReadOnlyDictionary<String,FieldGrants>>`

### ReceiveAsync()

```csharp
public Task<Received> ReceiveAsync(ConnectionContext context, ReceiveRequest request, CancellationToken cancellationToken)
```

Answers a request the vendor sent, verifying it with the connection's settings and calling no vendor, within [Deadline](https://klef.ai/docs/connector-sdk/reference/sdk/receiverequest.md).

#### Parameters

**context** `ConnectionContext` *required*

**request** `ReceiveRequest` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<Received>`

### RemoveLinkAsync()

```csharp
public Task RemoveLinkAsync(ConnectionContext context, string externalId, string fieldKey, ObjectLink link, string operationId, CancellationToken cancellationToken)
```

Removes one link from an account's array of links.

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**fieldKey** `string` *required*

**link** `ObjectLink` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

### SetLinkAsync()

```csharp
public Task SetLinkAsync(ConnectionContext context, string externalId, string fieldKey, ObjectLink? link, LocalDate effectiveOn, ElementKey? element, string operationId, CancellationToken cancellationToken)
```

Points a link in a collection element.

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**fieldKey** `string` *required*

**link** `ObjectLink` *required*

**effectiveOn** `LocalDate` *required*

**element** `Nullable\<ElementKey\>` *required*

**Type:** `Nullable<ElementKey>`

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

```csharp
public Task SetLinkAsync(ConnectionContext context, string externalId, string fieldKey, ObjectLink? link, LocalDate effectiveOn, string operationId, CancellationToken cancellationToken)
```

Points an account's link field at an object, or at none when `link` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null).

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**fieldKey** `string` *required*

**link** `ObjectLink` *required*

**effectiveOn** `LocalDate` *required*

**operationId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task`

### SignInUrlAsync()

```csharp
public Task<string> SignInUrlAsync(ConnectionContext context, string externalId, CancellationToken cancellationToken)
```

Gets where an account signs in.

#### Parameters

**context** `ConnectionContext` *required*

**externalId** `string` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<string>`

### TenantIdAsync()

```csharp
public Task<string?> TenantIdAsync(ConnectionContext context, CancellationToken cancellationToken)
```

Reads the vendor's id for the tenant the connection reaches, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when the vendor has none.

#### Parameters

**context** `ConnectionContext` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<string>`

### UpdatePrincipalAsync()

```csharp
public Task<WriteOutcome> UpdatePrincipalAsync(ConnectionContext context, string id, DesiredPrincipal desired, CancellationToken cancellationToken)
```

Updates an existing principal.

#### Parameters

**context** `ConnectionContext` *required*

**id** `string` *required*

**desired** `DesiredPrincipal` *required*

**cancellationToken** `CancellationToken` *required*

#### Returns

`Task<WriteOutcome>`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.