entity.asKnownBy · Umwelt docs

Reference/Queries/entity.asKnownBy

entity.asKnownByquerysince 0.1

What a holder knows about an entity, under the names they were told.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.asKnownBy '{
  "projectId": "ball",
  "entityId": "bob",
  "holder": "duchess",
  "at": { "tick": 3 }
}'

Request

const result = await client.entityAsKnownBy({
  projectId: 'ball',
  entityId: 'bob',
  holder: 'duchess',
  at: { tick: 3 },
});

Request

var result = engine.EntityAsKnownBy(new EntityKnownPayload
{
    ProjectId = "ball",
    EntityId = "bob",
    Holder = "duchess",
    At = new At { Tick = 3 },
});

Response

{
  "recordIds": ["duchess-mask"],
  "holder": "duchess",
  "aliases": ["the masked guest"],
  "aware": true,
  "entityId": "bob"
}

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`entityId`required	string	The entity, by its engine id.
`holder`required	string	Whose knowledge.
`at`	Atdefault {}	Where to read: `tick`, an optional `axis`, and `asOfVersion`. Defaults to the latest.
`timelineId`	stringdefault "main"	The timeline to read.

Result

Field	Type	Description
`entityId`always	string	The entity.
`holder`always	string	The holder.
`name`	string	The name they know it by, if they were told one.
`title`	string	The title they know, if any.
`aliases`always	string[]	The aliases they know.
`aware`always	boolean	Whether they have an Awareness record of the entity.
`recordIds`always	string[]	The Holdings the name, title and aliases come from.

Rules

Nobody is told a name by canon. Only the holder’s own active, available Holdings count. A holder never told a name gets none, whatever the entity is called.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project, entity, holder or timeline does not exist, or the draft read was purged.

INVALID_STATEThe timeline read is a draft that was promoted. details.promotedInto names the timeline to read instead.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also