Type alias ServerChannelPayload

ServerChannelPayload: {
    archivedAt?: string;
    archivedBy?: string;
    categoryId?: number;
    createdAt: string;
    createdBy: string;
    groupId: string;
    id: string;
    messageId?: string;
    name: string;
    parentId?: string;
    priority?: number;
    rootId?: string;
    serverId: string;
    topic?: string;
    type: "announcements" | "chat" | "calendar" | "forums" | "media" | "docs" | "voice" | "list" | "scheduling" | "stream";
    updatedAt?: string;
    visibility?: "private" | "public" | null;
}

Type declaration

  • Optional archivedAt?: string

    The ISO 8601 timestamp that the channel was archived at, if relevant

  • Optional archivedBy?: string

    The ID of the user who archived this channel

  • Optional categoryId?: number

    The category that the channel exists in. Only relevant for server channels

  • createdAt: string

    The ISO 8601 timestamp that the channel was created at

  • createdBy: string

    The ID of the user who created this channel

  • groupId: string

    The ID of the group

  • id: string

    The ID of the channel

  • Optional messageId?: string

    The ID of the message that this channel was created off of. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

  • name: string

    The name of the channel

  • Optional parentId?: string

    ID of the immediate parent channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

  • Optional priority?: number

    The priority of the channel will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in ascending order. Due to legacy issues, sending a null value is not possible

  • Optional rootId?: string

    ID of the root channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

  • serverId: string

    The ID of the server

  • Optional topic?: string

    The topic of the channel. Not applicable to threads

  • type: "announcements" | "chat" | "calendar" | "forums" | "media" | "docs" | "voice" | "list" | "scheduling" | "stream"

    The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages

  • Optional updatedAt?: string

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

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

    What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message

Settings

Member Visibility

Theme

Generated using TypeDoc