RegisterReq class

Constructors

RegisterReq({String? account, String? actor, String? agent, String? cwd, String? host, String? parentSessionId, String? project, String? provider, bool? published, String? repo, String? room, String? status, String? target, String? taskRunId, String? taskWorkflowId, String? terminal, String? title})

Returns a new RegisterReq instance.

Properties

account ↔ String?

Account is which subscription or API account under that provider served the run, up to 256 characters. It is what lets a revoke of that login stop exactly the sessions it was paying for.

getter/setter pair

actor ↔ String?

Actor is the "org/sub" identity to record the session under, up to 256 characters. Omit it and the calling principal is used, which is almost always what you want: it is what a login revoke matches on to stop this session.

getter/setter pair

agent ↔ String?

Agent is the label the surface opening this session calls itself by ("hanzo-dev"). REQUIRED, up to 128 characters, and free text — nothing resolves it against a defined agent.

getter/setter pair

cwd ↔ String?

Cwd is the directory the session starts in, up to 1024 characters. It can be moved later, because a linked shell walks around.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

host ↔ String?

Execution context — where this session runs (all optional).

getter/setter pair

parentSessionId ↔ String?

ParentSessionID makes this a subagent of that session: it inherits the parent's root, so one flow stays one tree. The parent must exist IN THE SAME ORG — a foreign or unknown id is a 400, never a tree across tenants. Empty opens a root session.

getter/setter pair

project ↔ String?

The readable build (provenance.go): which product this session builds, and whether its story may be read by the world.

getter/setter pair

provider ↔ String?

Account tag — the linked AI account this session ran under (login manager).

getter/setter pair

published ↔ bool?

Published opens this session's story to the public build route. It is refused without a Project, because that route is keyed on (org, project) — a build with no product is not a story anyone can open. False keeps it org-only.

getter/setter pair

repo ↔ String?

Repo is the code being worked on, up to 512 characters. A label the surface states; nothing resolves it against the forge.

getter/setter pair

room ↔ String?

Room is the collaborative room this run was started in (HIP-0523), so a workspace view can list the sessions of one room. It is PROVENANCE and is set only here: there is deliberately no way to move a session to another room, so it is absent from the patch input and from UpdateSession's SET list.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status ↔ String?

Status opens the session in one of running, paused, done or error. Empty means running. A TERMINAL status here (done, error) records a session that has already finished — its end time is stamped now — and nothing can move it afterwards.

getter/setter pair

target ↔ String?

Target names a run-target the org has registered. Unlike Host and Repo it IS resolved: a target that does not exist in this org is a 400, so a session can never claim to run on another tenant's machine. Empty names no machine.

getter/setter pair

taskRunId ↔ String?

TaskRunID is that workflow's particular run, same bound. Recorded, not resolved: this surface does not check the workflow exists.

getter/setter pair

taskWorkflowId ↔ String?

TaskWorkflowID links this session to the hanzoai/tasks workflow that executes it, up to 256 characters. Set it and control commands are forwarded to that engine; leave it and the running surface polls for them instead.

getter/setter pair

terminal ↔ String?

Terminal is the URL this session's live terminal is published at, so the console can watch it. Optional — a session that publishes nothing is still a session.

getter/setter pair

title ↔ String?

Title is the human line a card shows, up to 512 characters. Optional, and changeable later.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → RegisterReq?

Returns a new RegisterReq instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<RegisterReq>

mapFromJson(dynamic json) → Map<String, RegisterReq>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<RegisterReq>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.