pl-api
    Preparing search index...

    Function shoutboxCategory

    • Parameters

      Returns {
          connect: (
              token: string,
              __namedParameters: {
                  onMessage: (
                      message: {
                          author: {
                              __meta: { pleroma?: any; source?: any };
                              accepts_chat_messages: boolean | null;
                              acct: string;
                              ap_id: string | null;
                              avatar: string;
                              avatar_default: boolean;
                              avatar_description: string;
                              avatar_static: string;
                              background_image: string | null;
                              birthday?: string;
                              bot: boolean;
                              created_at: string;
                              custom_css: string;
                              deactivated?: boolean;
                              discoverable: boolean;
                              display_name: string;
                              domain: string;
                              emojis: {
                                  category: string | null;
                                  shortcode: string;
                                  static_url: string;
                                  url: string;
                                  visible_in_picker: boolean;
                              }[];
                              enable_rss: boolean;
                              favicon?: string;
                              fields: { name: string; value: string; verified_at: string
                              | null }[];
                              followers_count: number;
                              following_count: number;
                              fqn: string;
                              group: boolean;
                              header: string;
                              header_default: boolean;
                              header_description: string;
                              header_static: string;
                              hide_collections?: boolean;
                              hide_favorites: boolean;
                              hide_followers?: boolean;
                              hide_followers_count?: boolean;
                              hide_follows?: boolean;
                              hide_follows_count?: boolean;
                              id: string;
                              identity_proofs: { name: string; value: string; verified_at: string }[];
                              indexable: boolean | null;
                              is_admin?: boolean;
                              is_cat: boolean;
                              is_moderator?: boolean;
                              is_suggested?: boolean;
                              last_status_at: string | null;
                              limited?: boolean;
                              local?: boolean;
                              location?: string;
                              locked: boolean;
                              memorial: boolean | null;
                              mention_policy: "none" | "only_known" | "only_contacts";
                              moved:
                                  | {
                                      __meta: { pleroma?: any; source?: any };
                                      accepts_chat_messages: boolean | null;
                                      acct: string;
                                      ap_id: string | null;
                                      avatar: string;
                                      avatar_default: boolean;
                                      avatar_description: string;
                                      avatar_static: string;
                                      background_image: string | null;
                                      birthday?: string;
                                      bot: boolean;
                                      created_at: string;
                                      custom_css: string;
                                      deactivated?: boolean;
                                      discoverable: boolean;
                                      display_name: string;
                                      domain: string;
                                      emojis: {
                                          category: ...;
                                          shortcode: ...;
                                          static_url: ...;
                                          url: ...;
                                          visible_in_picker: ...;
                                      }[];
                                      enable_rss: boolean;
                                      favicon?: string;
                                      fields: { name: ...; value: ...; verified_at: ... }[];
                                      followers_count: number;
                                      following_count: number;
                                      fqn: string;
                                      group: boolean;
                                      header: string;
                                      header_default: boolean;
                                      header_description: string;
                                      header_static: string;
                                      hide_collections?: boolean;
                                      hide_favorites: boolean;
                                      hide_followers?: boolean;
                                      hide_followers_count?: boolean;
                                      hide_follows?: boolean;
                                      hide_follows_count?: boolean;
                                      id: string;
                                      identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                                      indexable: boolean | null;
                                      is_admin?: boolean;
                                      is_cat: boolean;
                                      is_moderator?: boolean;
                                      is_suggested?: boolean;
                                      last_status_at: string | null;
                                      limited?: boolean;
                                      local?: boolean;
                                      location?: string;
                                      locked: boolean;
                                      memorial: boolean | null;
                                      mention_policy: "none" | "only_known" | "only_contacts";
                                      noindex: boolean | null;
                                      note: string;
                                      payment_options: ((...) | (...))[];
                                      permit_followback?: boolean;
                                      pronouns: string[];
                                      relationship?: {
                                          blocked_by: ...;
                                          blocking: ...;
                                          domain_blocking: ...;
                                          endorsed: ...;
                                          followed_by: ...;
                                          following: ...;
                                          id: ...;
                                          languages: ...;
                                          muting: ...;
                                          muting_notifications: ...;
                                          note: ...;
                                          notifying: ...;
                                          requested: ...;
                                          showing_reblogs: ...;
                                      };
                                      roles: {
                                          color: ...;
                                          highlighted: ...;
                                          id: ...;
                                          name: ...;
                                          permissions: ...;
                                      }[];
                                      speak_as_cat: boolean;
                                      statuses_count: number;
                                      subscribers_count: number;
                                      suspended?: boolean;
                                      url: string;
                                      username: string;
                                      verified?: boolean;
                                  }
                                  | null;
                              noindex: boolean
                              | null;
                              note: string;
                              payment_options: (
                                  | {
                                      href: (...)
                                      | (...);
                                      name: (...) | (...);
                                      object_id: (...) | (...);
                                      type: "link";
                                  }
                                  | {
                                      amount_min: (...)
                                      | (...);
                                      chain_id: (...) | (...);
                                      object_id: (...) | (...);
                                      price: (...) | (...);
                                      type: "monero-subscription";
                                  }
                              )[];
                              permit_followback?: boolean;
                              pronouns: string[];
                              relationship?: {
                                  blocked_by: boolean;
                                  blocking: boolean;
                                  domain_blocking: boolean;
                                  endorsed: boolean;
                                  followed_by: boolean;
                                  following: boolean;
                                  id: string;
                                  languages: (...)[]
                                  | null;
                                  muting: boolean;
                                  muting_notifications: boolean;
                                  note: string;
                                  notifying: boolean;
                                  requested: boolean;
                                  showing_reblogs: boolean;
                              };
                              roles: {
                                  color: string;
                                  highlighted: boolean;
                                  id: string;
                                  name: string;
                                  permissions: string;
                              }[];
                              speak_as_cat: boolean;
                              statuses_count: number;
                              subscribers_count: number;
                              suspended?: boolean;
                              url: string;
                              username: string;
                              verified?: boolean;
                          } & WithMoved;
                          id: number;
                          text: string;
                      },
                  ) => void;
                  onMessages: (
                      messages: {
                          author: {
                              __meta: { pleroma?: any; source?: any };
                              accepts_chat_messages: boolean | null;
                              acct: string;
                              ap_id: string | null;
                              avatar: string;
                              avatar_default: boolean;
                              avatar_description: string;
                              avatar_static: string;
                              background_image: string | null;
                              birthday?: string;
                              bot: boolean;
                              created_at: string;
                              custom_css: string;
                              deactivated?: boolean;
                              discoverable: boolean;
                              display_name: string;
                              domain: string;
                              emojis: {
                                  category: (...) | (...);
                                  shortcode: string;
                                  static_url: string;
                                  url: string;
                                  visible_in_picker: boolean;
                              }[];
                              enable_rss: boolean;
                              favicon?: string;
                              fields: { name: string; value: string; verified_at: (...)
                              | (...) }[];
                              followers_count: number;
                              following_count: number;
                              fqn: string;
                              group: boolean;
                              header: string;
                              header_default: boolean;
                              header_description: string;
                              header_static: string;
                              hide_collections?: boolean;
                              hide_favorites: boolean;
                              hide_followers?: boolean;
                              hide_followers_count?: boolean;
                              hide_follows?: boolean;
                              hide_follows_count?: boolean;
                              id: string;
                              identity_proofs: { name: string; value: string; verified_at: string }[];
                              indexable: boolean | null;
                              is_admin?: boolean;
                              is_cat: boolean;
                              is_moderator?: boolean;
                              is_suggested?: boolean;
                              last_status_at: string | null;
                              limited?: boolean;
                              local?: boolean;
                              location?: string;
                              locked: boolean;
                              memorial: boolean | null;
                              mention_policy: "none" | "only_known" | "only_contacts";
                              moved:
                                  | {
                                      __meta: { pleroma?: ...; source?: ... };
                                      accepts_chat_messages: (...) | (...) | (...);
                                      acct: string;
                                      ap_id: (...) | (...);
                                      avatar: string;
                                      avatar_default: boolean;
                                      avatar_description: string;
                                      avatar_static: string;
                                      background_image: (...) | (...);
                                      birthday?: (...) | (...);
                                      bot: boolean;
                                      created_at: string;
                                      custom_css: string;
                                      deactivated?: (...) | (...) | (...);
                                      discoverable: boolean;
                                      display_name: string;
                                      domain: string;
                                      emojis: (...)[];
                                      enable_rss: boolean;
                                      favicon?: (...) | (...);
                                      fields: (...)[];
                                      followers_count: number;
                                      following_count: number;
                                      fqn: string;
                                      group: boolean;
                                      header: string;
                                      header_default: boolean;
                                      header_description: string;
                                      header_static: string;
                                      hide_collections?: (...) | (...) | (...);
                                      hide_favorites: boolean;
                                      hide_followers?: (...) | (...) | (...);
                                      hide_followers_count?: (...) | (...) | (...);
                                      hide_follows?: (...) | (...) | (...);
                                      hide_follows_count?: (...) | (...) | (...);
                                      id: string;
                                      identity_proofs: (...)[];
                                      indexable: (...) | (...) | (...);
                                      is_admin?: (...) | (...) | (...);
                                      is_cat: boolean;
                                      is_moderator?: (...) | (...) | (...);
                                      is_suggested?: (...) | (...) | (...);
                                      last_status_at: (...) | (...);
                                      limited?: (...) | (...) | (...);
                                      local?: (...) | (...) | (...);
                                      location?: (...) | (...);
                                      locked: boolean;
                                      memorial: (...) | (...) | (...);
                                      mention_policy: (...) | (...) | (...);
                                      noindex: (...) | (...) | (...);
                                      note: string;
                                      payment_options: (...)[];
                                      permit_followback?: (...) | (...) | (...);
                                      pronouns: (...)[];
                                      relationship?: (...) | (...);
                                      roles: (...)[];
                                      speak_as_cat: boolean;
                                      statuses_count: number;
                                      subscribers_count: number;
                                      suspended?: (...) | (...) | (...);
                                      url: string;
                                      username: string;
                                      verified?: (...) | (...) | (...);
                                  }
                                  | null;
                              noindex: boolean
                              | null;
                              note: string;
                              payment_options: (
                                  | { href: ...; name: ...; object_id: ...; type: ... }
                                  | {
                                      amount_min: ...;
                                      chain_id: ...;
                                      object_id: ...;
                                      price: ...;
                                      type: ...;
                                  }
                              )[];
                              permit_followback?: boolean;
                              pronouns: string[];
                              relationship?: {
                                  blocked_by: boolean;
                                  blocking: boolean;
                                  domain_blocking: boolean;
                                  endorsed: boolean;
                                  followed_by: boolean;
                                  following: boolean;
                                  id: string;
                                  languages: (...)
                                  | (...);
                                  muting: boolean;
                                  muting_notifications: boolean;
                                  note: string;
                                  notifying: boolean;
                                  requested: boolean;
                                  showing_reblogs: boolean;
                              };
                              roles: {
                                  color: string;
                                  highlighted: boolean;
                                  id: string;
                                  name: string;
                                  permissions: string;
                              }[];
                              speak_as_cat: boolean;
                              statuses_count: number;
                              subscribers_count: number;
                              suspended?: boolean;
                              url: string;
                              username: string;
                              verified?: boolean;
                          } & WithMoved;
                          id: number;
                          text: string;
                      }[],
                  ) => void;
              },
          ) => { close: () => void; message: (text: string) => void };
      }