Type alias ArenaBaseBlock

ArenaBaseBlock: {
    attachment?: ArenaAttachment | null;
    base_class: "Block";
    class: "Image" | "Text" | "Link" | "Media" | "Attachment";
    comment_count: number;
    connections?: ArenaChannel[];
    content: string | null;
    content_html: string | null;
    created_at: string;
    description: string | null;
    description_html: string | null;
    embed?: ArenaEmbed | null;
    generated_title: string;
    group?: ArenaGroup | null;
    id: number;
    image: ArenaImage | null;
    source: {
        provider: {
            name: string;
            url: string;
        } | null;
        title?: string;
        url: string;
    } | null;
    state: "available" | "failure" | "processed" | "processing" | "remote_processing";
    title: string | null;
    updated_at: string;
    user: ArenaUserWithDetails;
    visibility?: "private" | "public";
}

Type declaration

  • Optional attachment?: ArenaAttachment | null
  • base_class: "Block"

    (String) This will always be "Block"

  • class: "Image" | "Text" | "Link" | "Media" | "Attachment"

    (String) The type of block. Can be "Image", "Text", "Link", "Media", or "Attachment"

  • comment_count: number

    (Integer) The number of comments on a block

  • Optional connections?: ArenaChannel[]
  • content: string | null

    (String, can be null) If the block is of class "Text", this will be the text content as markdown

  • content_html: string | null

    (String, can be null) If the block is of class "Text", this will be the text content as HTML

  • created_at: string

    (Timestamp) Timestamp when the block was created

  • description: string | null

    (String, can be null) This is used for captioning any type of block. Returns markdown.

  • description_html: string | null

    (String, can be null) This is used for captioning any type of block. Returns HTML

  • Optional embed?: ArenaEmbed | null
  • generated_title: string

    (String) If the title is present on the block, this will be identical to the title. Otherwise it will be a truncated string of the description or content. If neither of those are present, it will be "Untitled"

  • Optional group?: ArenaGroup | null
  • id: number

    (Integer) The internal ID of the block

  • image: ArenaImage | null
  • source: {
        provider: {
            name: string;
            url: string;
        } | null;
        title?: string;
        url: string;
    } | null
  • state: "available" | "failure" | "processed" | "processing" | "remote_processing"

    (String) Represents the state of the blocks processing lifecycle (this will most often "Available" but can also be "Failure", "Processed", "Processing")

  • title: string | null

    (String, can be null) The title of the block

  • updated_at: string

    (Timestamp) Timestamp when the block was last updated

  • user: ArenaUserWithDetails

    (Hash) Representation of the author of the block

  • Optional visibility?: "private" | "public"

Settings

Member Visibility

Theme

Generated using TypeDoc