Class ExtensionData

Hierarchy

ExtensionData

Index

Constructors

constructor

Properties

state

Methods

Constructors

constructor

new ExtensionData(): ExtensionData

Returns ExtensionData

Properties

Protected state

state: InnerDataActiveExtension | InnerDataNoActiveExtension = ...

Methods

extensionHasPermissions

extensionHasPermissions(extension: string): boolean

- Defined in src/admin/utils/ExtensionData.ts:176
Checks whether a given extension has registered permissions.

Parameters
- extension: string
Returns boolean

for

for(extension: string): ExtensionData

- Defined in src/admin/utils/ExtensionData.ts:54
This function simply takes the extension id

example
app.extensionData.for('flarum-tags')

flarum/flags -> flarum-flags | acme/extension -> acme-extension

Parameters
- extension: string
Returns ExtensionData

getAllExtensionPermissions

getAllExtensionPermissions(type: PermissionType): ItemList<PermissionConfig>

- Defined in src/admin/utils/ExtensionData.ts:148
Get an ItemList of all extensions' registered permissions

Parameters
- type: PermissionType
Returns ItemList<PermissionConfig>

getExtensionPermissions

getExtensionPermissions(extension: string, type: PermissionType): ItemList<PermissionConfig>

- Defined in src/admin/utils/ExtensionData.ts:164
Get a singular extension's registered permissions

Parameters
- extension: string
- type: PermissionType
Returns ItemList<PermissionConfig>

getPage

getPage<Attrs>(extension: string): undefined | CustomExtensionPage<Attrs>

- Defined in src/admin/utils/ExtensionData.ts:183
Returns an extension's custom page component if it exists.

Type parameters
- Attrs: ExtensionPageAttrs = ExtensionPageAttrs
Parameters
- extension: string
Returns undefined | CustomExtensionPage<Attrs>

getSettings

getSettings(extensionId: string): undefined | SettingConfigInternal[]

- Defined in src/admin/utils/ExtensionData.ts:141
Get an extension's registered settings

Parameters
- extensionId: string
Returns undefined | SettingConfigInternal[]

registerPage

registerPage(component: CustomExtensionPage<ExtensionPageAttrs>): ExtensionData

- Defined in src/admin/utils/ExtensionData.ts:128
Replace the default extension page with a custom component. This component would typically extend ExtensionPage

Parameters
- component: CustomExtensionPage<ExtensionPageAttrs>
Returns ExtensionData

registerPermission

registerPermission(content: PermissionConfig, permissionType: PermissionType, priority?: number): ExtensionData

- Defined in src/admin/utils/ExtensionData.ts:108
This function registers your permission with Flarum

example
.registerPermission('permissions', { icon: 'fas fa-flag', label: app.translator.trans('flarum-flags.admin.permissions.view_flags_label'), permission: 'discussion.viewFlags' }, 'moderate', 65)

Parameters
- content: PermissionConfig
- permissionType: PermissionType
- priority: number = 0
Returns ExtensionData

registerSetting

registerSetting(content: SettingConfigInput, priority?: number): ExtensionData

- Defined in src/admin/utils/ExtensionData.ts:74
This function registers your settings with Flarum

It takes either a settings object or a callback.

example
.registerSetting({ setting: 'flarum-flags.guidelines_url', type: 'text', // This will be inputted into the input tag for the setting (text/number/etc) label: app.translator.trans('flarum-flags.admin.settings.guidelines_url_label') }, 15) // priority is optional (ItemList)

Parameters
- content: SettingConfigInput
- priority: number = 0
Returns ExtensionData

Generated using TypeDoc version 0.22.10