Constructors
Properties
Protected Readonlyapplication
Protected Staticname
name: string
Methods
boot
- boot(): Awaitable<void>
Returns Awaitable<void>
createBan
- createBan<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateBanPayload<E>
Returns Promise<InfractionCreateResult<E>>
createBean
- createBean<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateBeanPayload<E>
Returns Promise<InfractionCreateResult<E>>
createClearMessages
- createClearMessages(payload): Promise<MessageBulkDeleteResult>
Parameters
- payload: CreateClearMessagesPayload<false>
Returns Promise<MessageBulkDeleteResult>
createFakeBan
- createFakeBan<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateBanPayload<E>
Returns Promise<InfractionCreateResult<E>>
createInfraction
- createInfraction<E>(options): Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}> Parameters
- options: InfractionCreateOptions<E>
Returns Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}>
createKick
- createKick<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateKickPayload<E>
Returns Promise<InfractionCreateResult<E>>
createModeratorMessage
- createModeratorMessage<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateModeratorMessage<E>
Returns Promise<InfractionCreateResult<E>>
createMute
- createMute<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateMutePayload<E>
Returns Promise<InfractionCreateResult<E>>
createNote
- createNote<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateNotePayload<E>
Returns Promise<InfractionCreateResult<E>>
createRoleModification
- createRoleModification<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateRoleModificationPayload<E>
Returns Promise<InfractionCreateResult<E>>
createShot
- createShot<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateShotPayload<E>
Returns Promise<InfractionCreateResult<E>>
createUnban
- createUnban<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateUnbanPayload<E>
Returns Promise<InfractionCreateResult<E>>
createUnmute
- createUnmute<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateUnmutePayload<E>
Returns Promise<InfractionCreateResult<E>>
createUserMassBan
- createUserMassBan(payload): Promise<{
errorType?: undefined;
status: string;
} | {
errorType: string;
status: string;
}> Parameters
- payload: CreateUserMassBanPayload
Returns Promise<{
errorType?: undefined;
status: string;
} | {
errorType: string;
status: string;
}>
createUserMassKick
- createUserMassKick(payload): Promise<{
status: string;
}> Parameters
- payload: CreateUserMassKickPayload
Returns Promise<{
status: string;
}>
createWarning
- createWarning<E>(payload): Promise<InfractionCreateResult<E>>
Parameters
- payload: CreateWarningPayload<E>
Returns Promise<InfractionCreateResult<E>>
deleteById
- deleteById(guildId, id): Promise<undefined | {
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}> Parameters
- guildId: string
- id: number
Returns Promise<undefined | {
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}>
deleteForUser
- deleteForUser(guildId, userId, type?): Promise<number>
Returns Promise<number>
generatePlainTextExport
- generatePlainTextExport(__namedParameters): Promise<{
count: number;
output: string;
}> Parameters
- __namedParameters: GeneratePlainTextExportOptions
Returns Promise<{
count: number;
output: string;
}>
getById
- getById(guildId, id): Promise<undefined | {
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}> Parameters
- guildId: string
- id: number
Returns Promise<undefined | {
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}>
getInfractionStatistics
- getInfractionStatistics(guildId, userId): Promise<null | InfractionStatistics>
Parameters
- guildId: string
- userId: string
getUserInfractions
- getUserInfractions(guildId, id): Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}[]> Parameters
- guildId: string
- id: string
Returns Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}[]>
getUserValidInfractions
- getUserValidInfractions(guildId, userId): Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}[]> Parameters
- guildId: string
- userId: string
Returns Promise<{
createdAt: Date;
deliveryStatus: InfractionDeliveryStatus;
expiresAt: null | Date;
guildId: string;
id: number;
metadata: unknown;
moderatorId: string;
queueId: null | number;
reason: null | string;
type: InfractionType;
updatedAt: Date;
userId: string;
}[]>
prettifyInfractionType
- prettifyInfractionType(type):
| "Unknown"
| "Ban"
| "Kick"
| "Mute"
| "Warning"
| "Unmute"
| "Timeout"
| "Bean"
| "Note"
| "Bulk Message Deletion"
| "Mass Ban"
| "Mass Kick"
| "Timeout Remove"
| "Role Modification"
| "Moderator Message" Returns
| "Unknown"
| "Ban"
| "Kick"
| "Mute"
| "Warning"
| "Unmute"
| "Timeout"
| "Bean"
| "Note"
| "Bulk Message Deletion"
| "Mass Ban"
| "Mass Kick"
| "Timeout Remove"
| "Role Modification"
| "Moderator Message"
processReason
- processReason(guildId, reason, abortOnNotFound?): null | string
Parameters
- guildId: string
- reason: undefined | string
- abortOnNotFound: boolean = true
Returns null | string
reapplyMuteIfNeeded
- reapplyMuteIfNeeded(member): Promise<void>
Returns Promise<void>
recordMute
- recordMute(member, roles): Promise<void>
Parameters
- member: GuildMember
- roles: string[]
Returns Promise<void>
updateDurationById
- updateDurationById(guildId, id, duration, notify): Promise<DurationUpdateResult>
Parameters
- guildId: string
- id: number
- duration: null | Duration
- notify: boolean
Returns Promise<DurationUpdateResult>
updateReasonById
- updateReasonById(guildId, id, reason, notify?): Promise<boolean>
Parameters
- guildId: string
- id: number
- reason: string
- notify: boolean = true
Returns Promise<boolean>
StaticgetName
- getName(): string
Returns string
Returns the name of the function. Function names are read-only and can not be changed.