Class StaffAutomodDMails

Hierarchy (View Summary)

Base
- StaffAutomodDMails

Index

Constructors

Methods

get markRead markUnread search

Constructors

constructor

new StaffAutomodDMails(e621: E621, client: Client): StaffAutomodDMails
Parameters
- e621: E621
- client: Client
Returns StaffAutomodDMails
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

get

get(id: number): Promise<DMail | null>
Requires Api Key Auth
Get Automod DMail

You must be Staff+.
Parameters
- id: number
Returns Promise<DMail | null>

Operation Id
staff/automod_dmails#show

See
Documentation for more details.
- Defined in lib/modules/staff/AutomodDMails.ts:25

markRead

markRead(id: number): Promise<null>
Requires Api Key Auth
Mark Automod DMail As Read

You must be Staff+.
Parameters
- id: number
Returns Promise<null>

Operation Id
staff/automod_dmails#mark_as_read

See
Documentation for more details.
- Defined in lib/modules/staff/AutomodDMails.ts:44

markUnread

markUnread(id: number): Promise<null>
Requires Api Key Auth
Mark Automod DMail As Unread

You must be Staff+.
Parameters
- id: number
Returns Promise<null>

Operation Id
staff/automod_dmails#mark_as_unread

See
Documentation for more details.
- Defined in lib/modules/staff/AutomodDMails.ts:63

search

search(options?: SearchAutomodDMailsOptions): Promise<DMail[]>
Requires Api Key Auth
Get Automod DMails

You must be Staff+.
Parameters
- Optionaloptions: SearchAutomodDMailsOptions
Returns Promise<DMail[]>

Operation Id
staff/automod_dmails#index

See
Documentation for more details.
- Defined in lib/modules/staff/AutomodDMails.ts:82