InfinityVault ZSession API Helper
Typical tag name: ivc-zs
Non-visible component with helper functions for interacting with /zs/ endpoint of the InfinityVAULT API. Set itself up with imm_qx at the zs attribute.
See ivc_workspace for utilities regarding workspace authentication and status.
Required Assets
- imm-dom, i18n
- MsgFabric
External Requirements
- KY
WC Dependencies
- (None.)
API
Attributes
| Attribute | Default | Enumerators | Usage |
|---|---|---|---|
stg |
x-zs |
N/A |
sessionStorage key to use. |
workspace |
zs-ws |
N/A |
(Imported from ivc-workspace.) sessionStorage key to look for active workspace in to resume. |
Properties
| Property | Type | Default | Usage |
|---|---|---|---|
id_zs |
array[zsToken,addr] | [] | ZSession ID array. |
x_zs |
string | '' | Comma-separated ZSession ID suitable for API requests. |
iv_api |
KY | KY with prefix /api/ |
For preconfigured KY requests. |
zs_api |
KY | KY with prefix /api/zs |
For preconfigured KY requests. |
mf_hub |
MsgFabricHub | MsgFabricHub with id_prefix: wb- |
For preconfigured MsgFabricHub requests. |
zs_sess |
RPC Target | MsgFabric RPC Target | Remote procedure calls session via MsgFabric. |
Events
| Event | Detail | Usage |
|---|---|---|
ivc-workspace-resume |
(See API spec: /zs/ws_active.) |
(From imported ivc-workspace.) Fired after ws_active info is fetched. |
Methods
| Method | Arguments | Usage |
|---|---|---|
zs_ready |
el, k |
el is target for imm_wcqx. Resolves (or resolves with accessor at k) when API is connected and ready. |
zs_dir_ready |
el, dir_kind |
el is target for imm_wcqx. Resolves with dir_kind) when API is connected and ready plus directory is loaded and ready. |
zs_reset |
Resets zs_ready. |
|
resetUnlock |
ar_id |
Resets Access Record unlock for the given ar via zs_sess |
query |
Shortcut to zs_sess.query |
|
post |
Shortcut to zs_sess.post |
|
rpc_to |
id |
Shortcut to MsgFabric target for id with current ZSession. |
Slots
| Slot | Usage |
|---|---|
| (None.) |
CSS Parts
| Part | Usage |
|---|---|
| (None.) |