Type alias ServerPayload

ServerPayload: {
    about?: string;
    avatar?: string;
    banner?: string;
    createdAt: string;
    defaultChannelId?: string;
    id: string;
    isVerified?: boolean;
    name: string;
    ownerId: string;
    timezone?: string;
    type?: "team" | "organization" | "community" | "clan" | "guild" | "friends" | "streaming" | "other";
    url?: string;
}

Type declaration

  • Optional about?: string

    The description associated with the server

  • Optional avatar?: string

    The avatar image associated with the server

  • Optional banner?: string

    The banner image associated with the server

  • createdAt: string

    The ISO 8601 timestamp that the server was created at

  • Optional defaultChannelId?: string

    The channel ID of the default channel of the server. This channel is defined as the first chat or voice channel in the left sidebar of a server in our UI. This channel is useful for sending welcome messages, though note that a bot may not have permissions to interact with this channel depending on how the server is configured.

  • id: string

    The ID of the server

  • Optional isVerified?: boolean

    The verified status of the server

  • name: string

    The name given to the server

  • ownerId: string

    The ID of the user who created this server

  • Optional timezone?: string

    The timezone associated with the server

  • Optional type?: "team" | "organization" | "community" | "clan" | "guild" | "friends" | "streaming" | "other"

    The type of server designated from the server's settings page

  • Optional url?: string

    The URL that the server can be accessible from. For example, a value of "Guilded-Official" means the server can be accessible from https://www.guilded.gg/Guilded-Official

Settings

Member Visibility

Theme

Generated using TypeDoc