Class InfringementAssistant

Hierarchy

DeputyModule
- InfringementAssistant

Index

Constructors

constructor

new InfringementAssistant(deputy?): InfringementAssistant
Parameters
- Optional deputy: Deputy
Returns InfringementAssistant
Inherited from DeputyModule.constructor
- Defined in src/modules/DeputyModule.ts:81

Properties

`Readonly` CopyrightProblemsPage

CopyrightProblemsPage: typeof CopyrightProblemsPage = CopyrightProblemsPage

`Readonly` SinglePageWorkflowDialog

SinglePageWorkflowDialog: ((config) => any) = SinglePageWorkflowDialog

Type declaration

- (config): any
- Creates a new SinglePageWorkflowDialog.
  Parameters
  - config: SinglePageWorkflowDialogData
    
    Configuration to be passed to the element.
  Returns any
  A SinglePageWorkflowDialog object

`Protected` `Optional` `Readonly` deputy

deputy?: Deputy

An instance of Deputy. This is commonly window.deputy. Instantiating this class with a Deputy instances enables connection with the Deputy core, which shares the OOUI window manager and API manager for Deputy.

dialog

dialog: any

session

session: CopyrightProblemsSession

`Readonly` static

static: typeof InfringementAssistant = InfringementAssistant

`Static` `Readonly` dependencies

dependencies: string[] = ...

Accessors

config

get config(): UserConfiguration
Returns UserConfiguration
the configuration handler for this module. If Deputy is loaded, this reuses the configuration handler of Deputy.
Inherited from DeputyModule.config
- Defined in src/modules/DeputyModule.ts:59

wikiConfig

get wikiConfig(): WikiConfiguration
Returns WikiConfiguration
the wiki-wide configuration handler for this module. If Deputy is loaded, this reuses the configuration handler of Deputy. Since the wiki config is loaded asynchronously, this may not be populated at runtime. Only use it if you're sure that preInit has already been called and finished.
Inherited from DeputyModule.wikiConfig
- Defined in src/modules/DeputyModule.ts:73

windowManager

get windowManager(): WindowManager
Returns WindowManager
The responsible window manager for this class.
Inherited from DeputyModule.windowManager
- Defined in src/modules/DeputyModule.ts:43

Methods

getModuleKey

getModuleKey(): string
Get the module key for this module. Allows modules to be identified with a different configuration key.

Returns string
The module key. the module name by default.
Inherited from DeputyModule.getModuleKey
- Defined in src/modules/DeputyModule.ts:97

getName

getName(): string
Returns string
the symbolic name of this module. Eventually used for getting translation strings, etc.
Overrides DeputyModule.getName
- Defined in src/modules/ia/InfringementAssistant.ts:44

getWikiConfig

getWikiConfig(): Promise<WikiConfiguration>
Gets the wiki-specific configuration for Deputy.

Returns Promise<WikiConfiguration>
A promise resolving to the loaded configuration
Inherited from DeputyModule.getWikiConfig
- Defined in src/modules/DeputyModule.ts:146

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/modules/ia/InfringementAssistant.ts:109

loadLanguages

loadLanguages(fallback): Promise<void>
Load the language pack for this module, with a fallback in case one could not be loaded.
Parameters
- fallback: Record<string, string>
  
  The fallback to use if a language pack could not be loaded.
Returns Promise<void>
Inherited from DeputyModule.loadLanguages
- Defined in src/modules/DeputyModule.ts:107

openWorkflowDialog

openWorkflowDialog(): Promise<void>
Returns Promise<void>
- Defined in src/modules/ia/InfringementAssistant.ts:150

preInit

preInit(): Promise<boolean>
Perform actions that run before IA starts (prior to execution). This involves adding in necessary UI elements that serve as an entry point to IA.

Returns Promise<boolean>
Overrides DeputyModule.preInit
- Defined in src/modules/ia/InfringementAssistant.ts:52

Class InfringementAssistant

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional deputy: Deputy

Returns InfringementAssistant

Properties

Readonly CopyrightProblemsPage

Readonly SinglePageWorkflowDialog

Type declaration

Parameters

config: SinglePageWorkflowDialogData

Returns any

Protected Optional Readonly deputy

dialog

session

Readonly static

Static Readonly dependencies

Accessors

config

Returns UserConfiguration

wikiConfig

Returns WikiConfiguration

windowManager

Returns WindowManager

Methods

getModuleKey

Returns string

getName

Returns string

getWikiConfig

Returns Promise<WikiConfiguration>

init

Returns Promise<void>

loadLanguages

Parameters

fallback: Record<string, string>

Returns Promise<void>

openWorkflowDialog

Returns Promise<void>

preInit

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

`Optional` deputy: Deputy

`Readonly` CopyrightProblemsPage

`Readonly` SinglePageWorkflowDialog

`Protected` `Optional` `Readonly` deputy

`Readonly` static

`Static` `Readonly` dependencies