ApiCoreInterfaces
Interface: InviteOptions
Defined in: packages/core/src/node/types.ts:181
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
role? | readonly | string | The role it gives. Default: member when you may assign it, else the first role you may assign, else a view-only invite | packages/core/src/node/types.ts:183 |
short? | readonly | boolean | A short link, the rest sealed in mailboxes (spec 03 §7.7); the long form when no mailbox takes it. Default false | packages/core/src/node/types.ts:187 |
until? | readonly | number | For a short link: when to stop sharing it, ms. Closing the invite is what ends it. | packages/core/src/node/types.ts:189 |
write? | readonly | boolean | False for a view-only invite: the key, and no role. Default true | packages/core/src/node/types.ts:185 |