Jido.Chat.Attachment (Jido Chat v1.0.0)

Copy Markdown View Source

Normalized outbound attachment used by post payloads and sent-message handles.

Summary

Types

input()
t()

Functions

new(attachment)

Creates an attachment struct from normalized map input.

normalize(attachment)

Normalizes supported outbound attachment inputs into a canonical attachment struct.

normalize_many(attachments)

Normalizes a list of attachment inputs.

schema()

Returns the Zoi schema for Attachment.

Types

input()

@type input() ::
  t()
  | Jido.Chat.FileUpload.t()
  | Jido.Chat.Media.t()
  | Jido.Chat.Content.Image.t()
  | Jido.Chat.Content.Audio.t()
  | Jido.Chat.Content.Video.t()
  | Jido.Chat.Content.File.t()
  | map()
  | String.t()

t()

@type t() :: %Jido.Chat.Attachment{
  data: nil | nil | binary(),
  duration: nil | nil | integer(),
  filename: nil | nil | binary(),
  height: nil | nil | integer(),
  kind: :image | :audio | :video | :file,
  media_type: nil | nil | binary(),
  metadata: map(),
  path: nil | nil | binary(),
  size_bytes: nil | nil | integer(),
  url: nil | nil | binary(),
  width: nil | nil | integer()
}

Functions

new(attachment)

Creates an attachment struct from normalized map input.

normalize(attachment)

@spec normalize(input()) :: t()

Normalizes supported outbound attachment inputs into a canonical attachment struct.

normalize_many(attachments)

@spec normalize_many([input()]) :: [t()]

Normalizes a list of attachment inputs.

schema()

Returns the Zoi schema for Attachment.