Type Alias FileOptions

FileOptions: {
    collection?: Snowflake;
    collectionToken?: Token;
    noEmbed?: boolean;
    openGraphProperties?: {
        color?: string | false;
        description?: string | false;
        discordHideUrl?: boolean;
        siteName?: string | false;
        title?: string | false;
    };
    selfDestruct?: boolean;
    token?: Token;
}

Represents file options which can be utilized in uploadFile.

Type declaration

  • Optionalcollection?: Snowflake

    The ID of a collection to upload the image to.

  • OptionalcollectionToken?: Token

    The upload token of the collection. Only required if it's private.

  • OptionalnoEmbed?: boolean

    If true, the url will directly link to the image instead of an embed.

  • OptionalopenGraphProperties?: {
        color?: string | false;
        description?: string | false;
        discordHideUrl?: boolean;
        siteName?: string | false;
        title?: string | false;
    }

    Open Graph properties for this file.

    • Optionalcolor?: string | false

      Configures the value for the 'theme-color' OpenGraph meta tag. If set to false, the tag will be omitted entirely.

    • Optionaldescription?: string | false

      Configures the value for the 'description' OpenGraph meta tag. If set to false, the tag will be omitted entirely.

    • OptionaldiscordHideUrl?: boolean

      If false, discord will not hide the url of the file when sent as a direct link.

    • OptionalsiteName?: string | false

      Configures the value for the 'site-name' OpenGraph meta tag. If set to false, the tag will be omitted entirely.

    • Optionaltitle?: string | false

      Configures the value for the 'title' OpenGraph meta tag. If set to false, the tag will be omitted entirely.

  • OptionalselfDestruct?: boolean

    If true, the file will be automatically deleted after 24 hours.

  • Optionaltoken?: Token

    Subdomain upload token.