Function: useInviteLink()

function useInviteLink(): object;

Defined in: packages/react/src/use-invite-link.ts:38

The invite this page was opened with, if any, and what it is for: the space's name, the role it gives, who sent it. dismiss takes it out of the address bar, once joined or declined, so a reload doesn't offer it again. problem says why an invite could not be read.

ReturnsCopy Anchor Link

object

dismissCopy Anchor Link

dismiss: () => void;

ReturnsCopy Anchor Link

void

inviteCopy Anchor Link

invite: string | null;

previewCopy Anchor Link

preview: 
  | InvitePreview
  | null;

problemCopy Anchor Link

problem: string | null;