gluon
    Preparing search index...

    Class AuditLog

    Represents an audit log entry.

    https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object

    Implements

    • AuditLog
    Index

    Constructors

    constructor

    Accessors

    actionType changes channel channelId count deleteMemberDays executor executorId guild guildId id membersRemoved reason specialId specialType status target targetId

    Methods

    [custom] toJSON toString shouldCache

    Constructors

    • Creates a structure for an audit log entry.

      Parameters

      • client: Client

        The client instance.

      • data: APIAuditLogEntry | AuditLogStorageJSON

        Audit log data from Discord.

      • options: { guildId: string; nocache?: boolean; users?: APIUser[] }

        Additional options for this structure.

        • guildId: string

          The ID of the guild that this audit log belongs to.

        • Optionalnocache?: boolean
        • Optionalusers?: APIUser[]

          Resolved users who are involved with the audit log entries.

      Returns AuditLog

    Accessors

    • get actionType(): number

      The type of action that occurred.

      Returns number

    • get changes(): undefined | APIAuditLogChange[]

      The changes in this audit log entry.

      Returns undefined | APIAuditLogChange[]

    • get channel(): null | AllChannels

      The channel involved with this audit log entry.

      Returns null | AllChannels

    • get channelId(): null | string

      The channel id involved with this audit log entry.

      Returns null | string

    • get count(): undefined | number

      The count of this type of audit log entry.

      Returns undefined | number

    • get deleteMemberDays(): undefined | number

      The inactivity period for when members are purged.

      Returns undefined | number

    • get executorId(): null | string

      The executor user involved with this audit log entry.

      Returns null | string

    • get guild(): null | Guild

      The guild that this audit log belongs to.

      Returns null | Guild

    • get guildId(): string

      The ID of the guild that this audit log belongs to.

      Returns string

    • get membersRemoved(): undefined | number

      The number of members removed for when members are purged.

      Returns undefined | number

    • get reason(): null | string

      The reason for this audit log entry.

      Returns null | string

    • get specialId(): null | string

      The id of the overwritten entity.

      Returns null | string

    • get specialType(): AuditLogOptionsType

      The type of the overwritten entity - role ("0") or member ("1")

      Returns AuditLogOptionsType

    • get status(): undefined | string

      The new voice channel status.

      Returns undefined | string

    • get targetId(): null | string

      The id of the target user.

      Returns null | string

    Methods

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns AuditLogStorageJSON

    • Determines whether the emoji should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods