ArchAstro.Types.UserInvite (archastro v0.2.0)

Copy Markdown

A shareable invite created by a user, optionally scoped to a thread. Recipients can use the invite key to join or start a conversation.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.Types.UserInvite{
  created_at: DateTime.t() | ArchAstro.Unset.t(),
  id: String.t(),
  key: String.t() | ArchAstro.Unset.t(),
  metadata: %{optional(String.t()) => ArchAstro.JSON.t()} | ArchAstro.Unset.t(),
  thread: String.t() | ArchAstro.Unset.t(),
  user: ArchAstro.Types.InviteCreator.t() | ArchAstro.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.JSON.object()