Skip to main content
Implements: ITargetConnector, IConnector, ISupportsPrincipalWrites, ISupportsGrants, ISupportsGrantReads, ISupportsActions, ISupportsOperations, ISupportsCatalog, ISupportsDiscovery

Constructors

Guards and records a connector’s writes.

Parameters

required

Properties

required
What the run may spend.
IReadOnlyCollection<string>
required
The writes the guard refused.
IReadOnlyCollection<VendorWrite>
required
Type: VendorWriteEvery write that reached the vendor.

Methods

ByKitAsync()

Runs a write of the kit’s own.

Parameters

Func<Task>
required

Returns

Task

ChangeGrantsAsync()

Adds and removes grants on one field of an account or a principal.

Parameters

required
string
required
IReadOnlyCollection<string>
required
IReadOnlyCollection<string>
required
string
required
CancellationToken
required

Returns

GrantOutcome

CheckConnectionAsync()

Checks the connection.

Parameters

CancellationToken
required

Returns

ConnectionCheck

CleanUpAsync()

Runs the kit’s clean-up, past any budget.

Parameters

Func<Task>
required

Returns

Task

CreatePrincipalAsync()

Creates a principal, or fails when the vendor already holds it.

Parameters

CancellationToken
required

Returns

WriteOutcome

DiscoverAsync()

Reads what the tenant adds to the manifest.

Parameters

CancellationToken
required

Returns

Discovery

FailNext()

Fails the next call to an operation.

Parameters

string
required
required

GetOperationAsync()

Says where a pending write stands.

Parameters

string
required
CancellationToken
required

Returns

OperationState

GetPrincipalAsync()

Reads one principal by its id, with its status as the SDK reads it.

Parameters

string
required
string
required
JsonObject
required
CancellationToken
required

Returns

PrincipalRead

InvokeActionAsync()

Runs a declared action, on a leased object when it runs on one.

Parameters

string
required
string
required
JsonObject
required
string
required
CancellationToken
required

Returns

ActionOutcome

Lease()

Allows writes to one account.

Parameters

string
required

Leased()

Checks whether an account is leased.

Parameters

string
required

Returns

bool

ListCatalogAsync()

Lists one page of a resource’s records, or of a values_from lookup list.

Parameters

string
required
required
CancellationToken
required

Returns

PageCatalogValue

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, each with its status as the SDK reads it.

Parameters

string
required
required
CancellationToken
required

Returns

PagePrincipal

Normalize()

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

Parameters

JsonObject
required

Returns

JsonObject

ReadGrantsAsync()

Reads who holds the given values.

Parameters

string
required
IReadOnlyCollection<string>
required
CancellationToken
required

Returns

FieldGrants

RemoveAsync()

Deletes a leased account through the tenant.

Parameters

string
required
Func<Task>
required

Returns

Task

TenantIdAsync()

Reads the vendor’s id for the tenant.

Parameters

CancellationToken
required

Returns

Task<string>

UpdatePrincipalAsync()

Updates an existing principal.

Parameters

string
required
CancellationToken
required

Returns

WriteOutcome