Skip to main content Module groups Copy item path Source Group GroupMatch A person found by query, with the groups they belong to. GroupSummary A group as someone outside it sees it: no balance, no member list. InviteOptions The options argument of invite. InviteResult What invite resolves to: added when the email already had a Fauna
account, invited with the invite token when a pending invite was stored. JoinResult PartialGroup Partial<Group> in the TypeScript SDK.Partnership Two groups with people only chats between them. group is the one of yours
it was listed for. StartedPartnershipChat The { partnership, chat } start_partnership_chat resolves to. InviteStatus accept_invite Join the group an email invite points at, using the token from the invite. create create_partnership_chat Another chat in a partnership. Resolves to its id. delete_partnership_chat Delete a partnership chat, for both groups. edit end_partnership End a partnership. Its chats and their files go with it, for both groups. generate_link get invite Add a user to a group by email. Resolves added if they were added directly
(they have a Fauna account), or invited with a token if a pending invite was
stored instead (no Fauna account for that email yet). Fauna emails the invite
unless notify is false, so an app can send its own email carrying the token. join kick leave list list_partnerships A group’s partnerships, each with their chats and what you haven’t read. An
API key reads them too. query People matching a partial email or name, best first, each with their
groups. Only people in at least one group come back. show_partnership Bring a hidden partnership out of Hidden for your group. start_partnership_chat Start a chat between your group id and partner. The first chat partners
the groups. summaries Name, icon and member count of groups by id, including groups you are not
in. Unknown ids are left out.