Interface: PrincipalActionPort<P>

Defined in: src/action/types.ts:866

Principal-scoped offer and invocation authority. The principal belongs to the reader, never to a live binding: one control may be offered to a person while being withheld from an agent.

Type Parameters

P

P extends Principal = Principal

Properties

principal

readonly principal: P

Defined in: src/action/types.ts:867

Methods

invoke()

Call Signature

invoke<F, Id>(offer): ActionInvocation<Awaited<ReturnType<F>>, Id, "mutation">

Defined in: src/action/types.ts:869

Invoke an exact retained bound or inputless offer minted for this principal.

Type Parameters

F

F extends (...args) => any

Id

Id extends string = string

Parameters

offer

BoundActionOffer<Id, F, P> | InputlessActionOffer<Id, F, P>

Returns

ActionInvocation<Awaited<ReturnType<F>>, Id, "mutation">

Call Signature

invoke<F, Id>(offer, input): ActionInvocation<Awaited<ReturnType<F>>, Id, "mutation">

Defined in: src/action/types.ts:873

Invoke an exact retained open offer with its one required caller payload.

Type Parameters

F

F extends (...args) => any

Id

Id extends string = string

Parameters

offer

OpenActionOffer<Id, F, P>

input

Parameters<F>[0]

Returns

ActionInvocation<Awaited<ReturnType<F>>, Id, "mutation">

---

offers()

Call Signature

offers<F, Id, Mode>(definition): readonly ActionOfferFor<DefinedAction<F, Id, Mode>, Id, Mode, P>[]

Defined in: src/action/types.ts:878

Enumerate exact retained offers this principal is permitted to invoke.

Type Parameters

F

F extends (...args) => any

Id

Id extends string = string

Mode

Mode extends ActionInvocationMode = ActionInvocationMode

Parameters

definition

DefinedAction<F, Id, Mode>

Returns

readonly ActionOfferFor<DefinedAction<F, Id, Mode>, Id, Mode, P>[]

Call Signature

offers<Ref>(definition): readonly ActionOffer<Ref["definitionId"], (...args) => any, P>[]

Defined in: src/action/types.ts:885

Type Parameters

Ref

Ref extends ActionDefinitionRef<string>

Parameters

definition

Ref

Returns

readonly ActionOffer<Ref["definitionId"], (...args) => any, P>[]

Call Signature

offers(): readonly ActionOffer<string, (...args) => any, P>[]

Defined in: src/action/types.ts:888

Returns

readonly ActionOffer<string, (...args) => any, P>[]