Type alias ChatMessagePayload

ChatMessagePayload: {
    channelId: string;
    content?: string;
    createdAt: string;
    createdBy: string;
    createdByWebhookId?: string;
    embeds?: ChatEmbedPayload[];
    groupId?: string;
    id: string;
    isPinned?: boolean;
    isPrivate?: boolean;
    isSilent?: boolean;
    mentions?: MentionsPayload;
    replyMessageIds?: string[];
    serverId?: string;
    type: "default" | "system";
    updatedAt?: string;
}

Type declaration

  • channelId: string

    The ID of the channel

  • Optional content?: string

    The content of the message

  • createdAt: string

    The ISO 8601 timestamp that the message was created at

  • createdBy: string

    The ID of the user who created this message (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)

  • Optional createdByWebhookId?: string

    The ID of the webhook who created this message, if it was created by a webhook

  • Optional embeds?: ChatEmbedPayload[]
  • Optional groupId?: string

    The ID of the group

  • id: string

    The ID of the message

  • Optional isPinned?: boolean
  • Optional isPrivate?: boolean

    If set, this message will only be seen by those mentioned or replied to

  • Optional isSilent?: boolean

    If set, this message did not notify mention or reply recipients

  • Optional mentions?: MentionsPayload
  • Optional replyMessageIds?: string[]

    Message IDs that were replied to

  • Optional serverId?: string

    The ID of the server

  • type: "default" | "system"

    The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.

  • Optional updatedAt?: string

    The ISO 8601 timestamp that the message was updated at, if relevant

Generated using TypeDoc