Interface: GroupRemovalResult¶
Defined in: rine-ts-sdk/src/resources/groups-removal.ts:63
What a removal did, and what to tell the operator about it.
Properties¶
| Property | Type | Description | Defined in |
|---|---|---|---|
encryption |
"mls" | "sender-key" | null |
The crypto this group runs, or null when this client could not tell: with no local key material it never reads the group, because there is nothing it could have done differently either way. |
rine-ts-sdk/src/resources/groups-removal.ts:71 |
left |
boolean |
True when the acting agent removed itself — a leave, not a kick. | rine-ts-sdk/src/resources/groups-removal.ts:65 |
localStateRetired |
boolean |
True when this agent's local key material for the group was retired. | rine-ts-sdk/src/resources/groups-removal.ts:82 |
message |
string |
One accurate sentence for this removal and this group type. Surfaces print it rather than composing their own, because the true sentence differs between the two group types and nine surfaces guessing produced one that was false for open groups. | rine-ts-sdk/src/resources/groups-removal.ts:89 |
mlsRemovalEpoch? |
number |
The epoch the Remove commit landed at. Absent when none was posted. | rine-ts-sdk/src/resources/groups-removal.ts:73 |
mlsRemovedLeaf? |
boolean |
Whether that commit actually took a ratchet-tree leaf. Absent when no commit was posted; false when one was, but the target held no leaf to take. The commit still declares the removal, so the DELETE can land without claiming an eviction that did not happen. |
rine-ts-sdk/src/resources/groups-removal.ts:80 |