OutboundContent

Type alias exported by @botmesh/core.

type OutboundContent = 
  | {
  kind: "text";
  text: string;
}
  | {
  kind: "image";
  media: MediaSource;
  caption?: string;
  viewOnce?: boolean;
}
  | {
  kind: "video";
  media: MediaSource;
  caption?: string;
  gifPlayback?: boolean;
  ptv?: boolean;
  viewOnce?: boolean;
}
  | {
  kind: "audio";
  media: MediaSource;
}
  | {
  kind: "voice";
  media: MediaSource;
}
  | {
  kind: "document";
  media: MediaSource;
  filename?: string;
  caption?: string;
  mimetype?: string;
}
  | {
  kind: "sticker";
  media: MediaSource;
  pack?: string;
  author?: string;
}
  | {
  kind: "location";
  lat: number;
  lng: number;
  name?: string;
  address?: string;
}
  | {
  kind: "contact";
  phone: string;
  displayName?: string;
}
  | {
  kind: "poll";
  question: string;
  options: string[];
  multiSelect?: boolean;
}
  | {
  kind: "reaction";
  emoji: string;
  target: MessageRef;
}
  | {
  kind: "buttons";
  text: string;
  buttons: Button[];
  footer?: string;
}
  | {
  kind: "list";
  text: string;
  buttonText: string;
  sections: ListSection[];
  footer?: string;
}
  | {
  kind: "card";
  title: string;
  body?: string;
  imageUrl?: string;
  buttons?: Button[];
}
  | {
  kind: "template";
  name: string;
  language: string;
  components?: unknown;
}
  | {
  kind: "native";
  provider: string;
  payload: unknown;
}
  | FormContent;

Defined in: core/provider.ts:498

Tagged union of transport-neutral content. Each provider maps a kind to its native primitive, and MUST reject a kind it cannot honor with UnsupportedContentError (or degrade explicitly, as Baileys maps buttons to numbered text). The template and native kinds are the escape hatches for transport-specific features (Cloud API templates, Discord components, Telegram inline keyboards) without polluting the neutral kinds.

Union Members

Type Literal

{
  kind: "text";
  text: string;
}

---

Type Literal

{
  kind: "image";
  media: MediaSource;
  caption?: string;
  viewOnce?: boolean;
}

---

Type Literal

{
  kind: "video";
  media: MediaSource;
  caption?: string;
  gifPlayback?: boolean;
  ptv?: boolean;
  viewOnce?: boolean;
}

---

Type Literal

{
  kind: "audio";
  media: MediaSource;
}

---

Type Literal

{
  kind: "voice";
  media: MediaSource;
}

---

Type Literal

{
  kind: "document";
  media: MediaSource;
  filename?: string;
  caption?: string;
  mimetype?: string;
}

---

Type Literal

{
  kind: "sticker";
  media: MediaSource;
  pack?: string;
  author?: string;
}

---

Type Literal

{
  kind: "location";
  lat: number;
  lng: number;
  name?: string;
  address?: string;
}

---

Type Literal

{
  kind: "contact";
  phone: string;
  displayName?: string;
}

---

Type Literal

{
  kind: "poll";
  question: string;
  options: string[];
  multiSelect?: boolean;
}

---

Type Literal

{
  kind: "reaction";
  emoji: string;
  target: MessageRef;
}

---

Type Literal

{
  kind: "buttons";
  text: string;
  buttons: Button[];
  footer?: string;
}

---

Type Literal

{
  kind: "list";
  text: string;
  buttonText: string;
  sections: ListSection[];
  footer?: string;
}

---

Type Literal

{
  kind: "card";
  title: string;
  body?: string;
  imageUrl?: string;
  buttons?: Button[];
}

---

Type Literal

{
  kind: "template";
  name: string;
  language: string;
  components?: unknown;
}

---

Type Literal

{
  kind: "native";
  provider: string;
  payload: unknown;
}

---

FormContent

A native form (only sent to providers with capabilities.forms === 'native').