Skip to main content
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

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

Methods

AddLinkAsync()

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

Parameters

string
required
string
required
string
required
CancellationToken
required

Returns

Task

ChangeGrantsAsync()

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

Parameters

The connection.
required
The account or principal, of a kind the field is grantable to.
string
required
The field.
IReadOnlyCollection<string>
required
The values to grant.
IReadOnlyCollection<string>
required
The values to take away.
string
required
Stable across every retry of one change.
CancellationToken
required
Stops the change.

Returns

GrantOutcome

CheckAsync()

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

Parameters

JsonObject
required
CancellationToken
required

Returns

CheckAnswer

CheckConnectionAsync()

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

Parameters

CancellationToken
required

Returns

ConnectionCheck

CompleteOAuthAsync()

Reads what a new authorization reaches.

Parameters

CancellationToken
required

Returns

OAuthCompletion

CreatePrincipalAsync()

Creates a principal, touching nothing the vendor already holds.

Parameters

CancellationToken
required

Returns

WriteOutcome

DiscoverAsync()

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

Parameters

CancellationToken
required

Returns

Discovery

EndElementAsync()

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

Parameters

string
required
required
LocalDate
required
string
required
CancellationToken
required

Returns

Task

GetOperationAsync()

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

Parameters

string
required
CancellationToken
required

Returns

OperationState

GetPrincipalAsync()

Reads one principal by its id.

Parameters

string
required
string
required
JsonObject
required
CancellationToken
required

Returns

PrincipalRead

GetWorkersAsync()

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

Parameters

IReadOnlyCollection<string>
required
CancellationToken
required

Returns

SourceWorker

InMemory()

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

Parameters

object
required

Returns

ConnectorClient

InvokeActionAsync()

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

Parameters

The connection.
string
required
The action’s key.
string
required
The object it runs on, or null for an action on the connection.
JsonObject
required
What a person filled in, by the keys its fields declare.
string
required
Stable across every retry of one run.
CancellationToken
required
Stops the run.

Returns

ActionOutcome

ListCatalogAsync()

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

string
required
required
CancellationToken
required

Returns

PageCatalogValue

ListChangedPrincipalsAsync()

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

Parameters

string
required
string
required
required
CancellationToken
required

Returns

PagePrincipal

ListGrantsAsync()

Lists one page of a field’s grants.

Parameters

string
required
required
required
CancellationToken
required

Returns

PageGrant

ListPrincipalsAsync()

Lists one page of principals of one kind.

Parameters

string
required
required
CancellationToken
required

Returns

PagePrincipal

ListWorkersAsync()

Lists one page of workers.

Parameters

required
CancellationToken
required

Returns

PageSourceWorker

Normalize()

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

Parameters

JsonObject
required

Returns

JsonObject

NormalizeAsync()

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

Parameters

IReadOnlyList<JsonObject>
required
CancellationToken
required

Returns

Task<IReadOnlyList<JsonObject>>

PollAsync()

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

Parameters

string
required
Where the last poll stopped, or null at the start.
CancellationToken
required

Returns

Polled

ReadGrantsAsync()

Reads who holds the given values.

Parameters

string
required
IReadOnlyCollection<string>
required
CancellationToken
required

Returns

FieldGrants

ReceiveAsync()

Answers a request the vendor sent, verifying it with the connection’s settings and calling no vendor, within Deadline.

Parameters

CancellationToken
required

Returns

Received

RemoveLinkAsync()

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

Parameters

string
required
string
required
string
required
CancellationToken
required

Returns

Task

SetLinkAsync()

Points a link in a collection element.

Parameters

string
required
string
required
LocalDate
required
Nullable<ElementKey>
required
string
required
CancellationToken
required

Returns

Task
Points an account’s link field at an object, or at none when link is null.

Parameters

string
required
string
required
LocalDate
required
string
required
CancellationToken
required

Returns

Task

SignInUrlAsync()

Gets where an account signs in.

Parameters

string
required
CancellationToken
required

Returns

Task<string>

TenantIdAsync()

Reads the vendor’s id for the tenant the connection reaches, or null when the vendor has none.

Parameters

CancellationToken
required

Returns

Task<string>

UpdatePrincipalAsync()

Updates an existing principal.

Parameters

string
required
CancellationToken
required

Returns

WriteOutcome