Client

A Client is one enrolled device in one tenant, returned by SealdHealthcare.connect(tenantId) or resolved from an Enrollment. Every other namespace, such as client.objects and client.domains, is a property of it.

lock

lock locks the device key. It ends nothing on the Seald Healthcare Cloud. The next call that needs the key unlocks it again through the unlock adapter.

lock(): void

func lock()

fun lock()

Returns: Nothing.

Records: Nothing. Not a decision.

on

Subscribes to a ClientEvent. See Events for the full list of events and their fields.

on<E extends ClientEvent['type']>(event: E, handler: (e: Extract<ClientEvent, { type: E }>) => void): Unsubscribe

func on<Payload>(_ event: ClientEvent.Kind<Payload>) -> AsyncStream<Payload>

fun <E : ClientEvent> on(): Flow<E>

Parameters

Name	Type	Description
`event`	one of `ClientEvent`’s tags	Which event to subscribe to, such as `session` or `revoked`.
`handler`	a function of that event’s fields	Called on every occurrence of the event.

Returns: Unsubscribe, a function that stops the subscription. In Swift and Kotlin, an AsyncStream and a Flow you stop by ending the loop or canceling the collector.

Records: Nothing. Not a decision.

Types

Client

interface Client {
  readonly tenantId: TenantId;
  readonly hostname: string;
  readonly recipientId: RecipientId;
  readonly person: Person;
  readonly card: Card;
  readonly locked: boolean;

  lock(): void;

  session: Sessions;
  objects: Objects;
  folders: Folders;
  domains: Domains;
  holds: Holds;
  worklist: Worklist;
  offline: Offline;
  people: People;
  policies: Policies;
  datasets: Datasets;
  backupKey: BackupKey;
  recovery: Recovery;
  evidence: Evidence;
  support: Support;

  on<E extends ClientEvent['type']>(event: E, handler: (e: Extract<ClientEvent, { type: E }>) => void): Unsubscribe;
}

class Client {
  let tenantId: TenantId
  let hostname: String
  let recipientId: RecipientId
  let person: Person
  let card: Card
  var locked: Bool { get }

  func lock()

  let session: Sessions
  let objects: Objects
  let folders: Folders
  let domains: Domains
  let holds: Holds
  let worklist: Worklist
  let offline: Offline
  let people: People
  let policies: Policies
  let datasets: Datasets
  let backupKey: BackupKey
  let recovery: Recovery
  let evidence: Evidence
  let support: Support

  func on<Payload>(_ event: ClientEvent.Kind<Payload>) -> AsyncStream<Payload>
}

class Client {
  val tenantId: TenantId
  val hostname: String
  val recipientId: RecipientId
  val person: Person
  val card: Card
  val locked: Boolean

  fun lock()

  val session: Sessions
  val objects: Objects
  val folders: Folders
  val domains: Domains
  val holds: Holds
  val worklist: Worklist
  val offline: Offline
  val people: People
  val policies: Policies
  val datasets: Datasets
  val backupKey: BackupKey
  val recovery: Recovery
  val evidence: Evidence
  val support: Support

  fun <E : ClientEvent> on(): Flow<E>
}

Field	Type	Description
`tenantId`	`TenantId`	The tenant this device is enrolled in.
`hostname`	`string`	The Seald Healthcare Cloud hostname this device enrolled with, such as `records.example-health.com`.
`recipientId`	`RecipientId`	This device’s own recipient id. Every part of the SDK names this device by it.
`person`	`Person`	The person this device is enrolled as.
`card`	`Card`	This device’s device certificate (card), signed by the tenant’s identity authority.
`locked`	`boolean`	Whether the device key is currently locked.
`lock`	`() => void`	Locks the device key. See above.
`session`	`Sessions`	Sign in, resume, sign out. See session.
`objects`	`Objects`	Open, save, create, delete. See objects.
`folders`	`Folders`	List and search. See folders.
`domains`	`Domains`	Share, unshare, domain owners, sub-domains, the recycle bin. See domains.
`holds`	`Holds`	Legal holds. See holds.
`worklist`	`Worklist`	What the person’s Seald Healthcare Client shows as theirs to work on. See worklist.
`offline`	`Offline`	The offline lease, drafts, and what the device still waits for (`waiting()`). See offline.
`people`	`People`	Devices, revoke, offboard, roles, groups. See people.
`policies`	`Policies`	The floor, the overlay’s versions, submit, approve. See policies.
`datasets`	`Datasets`	Registrations, and registering one. See datasets.
`backupKey`	`BackupKey`	Create the backup key, a custodian’s share, the yearly proof, or replace a custodian. See backupKey.
`recovery`	`Recovery`	Break-glass: ask, agree, take part, cancel. See recovery.
`evidence`	`Evidence`	Export a pack, resolve refs. See evidence.
`support`	`Support`	Grant and end customer operator access. See support.
`on`	`(event, handler) => Unsubscribe`	Subscribes to a `ClientEvent`. See above and Events.