Class NewsUpdates

Hierarchy (View Summary)

Base
- NewsUpdates

Index

Constructors

Methods

create delete edit search

Constructors

constructor

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

Methods

create

create(options: CreateNewsUpdateOptions): Promise<NewsUpdate>
Requires Api Key Auth
Create News Update

You must be Admin+.
Parameters
- options: CreateNewsUpdateOptions
Returns Promise<NewsUpdate>
Operation Id
createNewsUpdate

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:28

delete

delete(id: number): Promise<null>
Requires Api Key Auth
Delete News Update

You must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
deleteNewsUpdate

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:47

edit

edit(id: number, options: EditNewsUpdateOptions): Promise<null>
Requires Api Key Auth
Edit News Update

You must be Admin+
Parameters
- id: number
- options: EditNewsUpdateOptions
Returns Promise<null>
Operation Id
editNewsUpdate

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:66

search

search(options?: SearchNewsUpdatesOptions): Promise<NewsUpdate[]>
List News Updates
Parameters
- Optionaloptions: SearchNewsUpdatesOptions
Returns Promise<NewsUpdate[]>
Operation Id
listNewsUpdates

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