Jido.Messaging.Instance (Jido Messaging v1.0.0)

Copy Markdown View Source

Represents a channel instance (e.g., a Telegram bot, Discord connection).

Instances manage connections to external messaging platforms and maintain their own credentials and settings.

Summary

Functions

Creates a new instance with generated ID and timestamp

Returns the Zoi schema for Instance

Types

t()

@type t() :: %Jido.Messaging.Instance{
  channel_type: :telegram | :discord | :slack | :whatsapp | :internal,
  credentials: map(),
  id: binary(),
  inserted_at:
    nil
    | nil
    | %DateTime{
        calendar: term(),
        day: term(),
        hour: term(),
        microsecond: term(),
        minute: term(),
        month: term(),
        second: term(),
        std_offset: term(),
        time_zone: term(),
        utc_offset: term(),
        year: term(),
        zone_abbr: term()
      },
  name: binary(),
  settings: map(),
  status: :connected | :disconnected | :connecting | :error
}

Functions

new(attrs)

Creates a new instance with generated ID and timestamp

schema()

Returns the Zoi schema for Instance