minca
ApiCoreInterfaces

Interface: HostClient

Defined in: packages/core/src/session/hosting.ts:771

A host's calls, signed as one subscription

Methods

attach()

attach(account, invite): Promise<{
  receipt: SignedStatus;
  status: HostStatus;
}>;

Defined in: packages/core/src/session/hosting.ts:775

Hands the host the account's carry space

Parameters

ParameterType
accountstring
invitestring

Returns

Promise<{ receipt: SignedStatus; status: HostStatus; }>


detach()

detach(): Promise<void>;

Defined in: packages/core/src/session/hosting.ts:779

Returns

Promise<void>


pay()

pay(payment): Promise<PayAnswer>;

Defined in: packages/core/src/session/hosting.ts:781

Starts adding to the subscription's balance

Parameters

ParameterType
paymentFundPayment

Returns

Promise<PayAnswer>


remind()

remind(email): Promise<void>;

Defined in: packages/core/src/session/hosting.ts:783

Asks for reminders by email before paid time runs out; the host mails a link to confirm first

Parameters

ParameterType
emailstring

Returns

Promise<void>


status()

status(): Promise<{
  receipt: SignedStatus;
  status: HostStatus;
}>;

Defined in: packages/core/src/session/hosting.ts:773

How the subscription stands, checked as signed by the host; and the signed original, to keep

Returns

Promise<{ receipt: SignedStatus; status: HostStatus; }>

On this page