tangl.service methods¶
Canonical service behavior is exposed as explicit
tangl.service.ServiceManager methods.
This page is generated from live tangl.service.service_method()
metadata attached to those methods.
Related design docs
Related pages
Related notes
Catalog¶
ServiceManager¶
story.create / create_story
Create a story session and return the initial runtime envelope.
- Service method:
tangl.service.service_manager.ServiceManager.create_story()- Operation id:
story.create- Access level:
client- Context:
user- Writeback:
session- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID', world_id: 'str', user_auth: "'UserAuthInfo | None'" = None, **kwargs: 'Any') -> RuntimeEnvelope
story.do / resolve_choice
Resolve one choice edge and return the newest runtime envelope.
- Service method:
tangl.service.service_manager.ServiceManager.resolve_choice()- Operation id:
story.do- Access level:
client- Context:
session- Writeback:
session- Blocking:
sync- Capability:
none
- Call signature:
(choice_id: 'UUID', user_id: 'UUID | None' = None, ledger_id: 'UUID | None' = None, user_auth: "'UserAuthInfo | None'" = None, choice_payload: 'Any' = None) -> RuntimeEnvelope
story.update / get_story_update
Return ordered runtime fragments for the active story session.
- Service method:
tangl.service.service_manager.ServiceManager.get_story_update()- Operation id:
story.update- Access level:
client- Context:
session- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID | None' = None, ledger_id: 'UUID | None' = None, user_auth: "'UserAuthInfo | None'" = None, since_step: 'int | None' = None, limit: 'int' = 0) -> RuntimeEnvelope
story.info / get_story_info
Return projected current-state sections for the active story.
- Service method:
tangl.service.service_manager.ServiceManager.get_story_info()- Operation id:
story.info- Access level:
client- Context:
session- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID | None' = None, ledger_id: 'UUID | None' = None, user_auth: "'UserAuthInfo | None'" = None) -> ProjectedState
story.drop / drop_story
Clear the active story and optionally delete the persisted ledger.
- Service method:
tangl.service.service_manager.ServiceManager.drop_story()- Operation id:
story.drop- Access level:
client- Context:
session- Writeback:
explicit- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID | None' = None, ledger_id: 'UUID | None' = None, user_auth: "'UserAuthInfo | None'" = None, archive: 'bool' = False) -> RuntimeInfo
user.create / create_user
Create and persist a service user.
- Service method:
tangl.service.service_manager.ServiceManager.create_user()- Operation id:
user.create- Access level:
public- Context:
none- Writeback:
explicit- Blocking:
sync- Capability:
none
- Call signature:
(secret: 'str | None' = None, **kwargs: 'Any') -> RuntimeInfo
user.update / update_user
Update one persisted user record.
- Service method:
tangl.service.service_manager.ServiceManager.update_user()- Operation id:
user.update- Access level:
client- Context:
user- Writeback:
user- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID', user_auth: "'UserAuthInfo | None'" = None, **kwargs: 'Any') -> RuntimeInfo
user.info / get_user_info
Return persisted user profile information.
- Service method:
tangl.service.service_manager.ServiceManager.get_user_info()- Operation id:
user.info- Access level:
client- Context:
user- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID', user_auth: "'UserAuthInfo | None'" = None, **kwargs: 'Any') -> UserInfo
user.drop / drop_user
Delete one persisted user record.
- Service method:
tangl.service.service_manager.ServiceManager.drop_user()- Operation id:
user.drop- Access level:
client- Context:
user- Writeback:
explicit- Blocking:
sync- Capability:
none
- Call signature:
(user_id: 'UUID', user_auth: "'UserAuthInfo | None'" = None) -> RuntimeInfo
user.key / get_key_for_secret
Encode a user secret as an API key.
- Service method:
tangl.service.service_manager.ServiceManager.get_key_for_secret()- Operation id:
user.key- Access level:
public- Context:
none- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
(secret: 'str') -> UserSecret
world.list / list_worlds
List available worlds as typed info models.
- Service method:
tangl.service.service_manager.ServiceManager.list_worlds()- Operation id:
world.list- Access level:
public- Context:
none- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
() -> list[WorldInfo]
world.info / get_world_info
Return metadata for one resolved world.
- Service method:
tangl.service.service_manager.ServiceManager.get_world_info()- Operation id:
world.info- Access level:
public- Context:
world- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
(world_id: 'str') -> WorldInfo
world.media / get_world_media
Return implementation-specific media content for one world asset.
- Service method:
tangl.service.service_manager.ServiceManager.get_world_media()- Operation id:
world.media- Access level:
public- Context:
world- Writeback:
none- Blocking:
sync- Capability:
media- Call signature:
(world_id: 'str', media: "'MediaRIT | Identifier'", **kwargs: 'Any') -> Any
world.load / load_world
Load one ad hoc world into the process-local manual registry.
- Service method:
tangl.service.service_manager.ServiceManager.load_world()- Operation id:
world.load- Access level:
dev- Context:
none- Writeback:
explicit- Blocking:
may_block- Capability:
world_mutation- Call signature:
(script_path: 'str | Path | None' = None, script_data: 'UnstructuredData' = None) -> RuntimeInfo
world.unload / unload_world
Unload one process-local manual world.
- Service method:
tangl.service.service_manager.ServiceManager.unload_world()- Operation id:
world.unload- Access level:
dev- Context:
world- Writeback:
explicit- Blocking:
sync- Capability:
world_mutation- Call signature:
(world_id: 'str') -> RuntimeInfo
system.info / get_system_info
Return service/system metadata.
- Service method:
tangl.service.service_manager.ServiceManager.get_system_info()- Operation id:
system.info- Access level:
public- Context:
none- Writeback:
none- Blocking:
sync- Capability:
none
- Call signature:
() -> SystemInfo
system.reset / reset_system
Implementation-specific system reset hook.
- Service method:
tangl.service.service_manager.ServiceManager.reset_system()- Operation id:
system.reset- Access level:
dev- Context:
none- Writeback:
none- Blocking:
sync- Capability:
dev_tools- Call signature:
(hard: 'bool' = False) -> RuntimeInfo