Class AdminRegistry

Index

Constructors

Properties

Methods

extensionHasPermissions for getAllPermissions getData getExtensionPermissions getPage getSettings registerPage registerPermission registerSetting removePermission removeSetting setPermission setPermissionPriority setSetting setSettingPriority

Constructors

constructor

new AdminRegistry(): AdminRegistry
Returns AdminRegistry

Properties

`Protected`state

state: InnerDataActiveExtension | InnerDataNoActiveExtension = ...

Methods

extensionHasPermissions

extensionHasPermissions(extension: string): boolean
Checks whether a given extension has registered permissions.
Parameters
- extension: string
Returns boolean
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:295

for

for(extension: string): AdminRegistry
This function simply takes the extension id
Parameters
- extension: string
Returns AdminRegistry
Example
```
app.registry.for('flarum-tags')

flarum/flags -> flarum-flags | acme/extension -> acme-extension
```
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:54

getAllPermissions

getAllPermissions(type: PermissionType): ItemList<PermissionConfig>
Get an ItemList of all extensions' registered permissions
Parameters
- type: PermissionType
Returns ItemList<PermissionConfig>
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:267

getData

getData(): | { [key: string]: ExtensionConfig }
| { [key: string]: ExtensionConfig | undefined }
Returns
| { [key: string]: ExtensionConfig }
| { [key: string]: ExtensionConfig | undefined }
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:306

getExtensionPermissions

getExtensionPermissions(
extension: string,
type: PermissionType,
): ItemList<PermissionConfig>
Get a singular extension's registered permissions
Parameters
- extension: string
- type: PermissionType
Returns ItemList<PermissionConfig>
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:283

getPage

getPage<Attrs extends ExtensionPageAttrs = ExtensionPageAttrs>(
extension: string,
): CustomExtensionPage<Attrs> | undefined
Returns an extension's custom page component if it exists.
Type Parameters
- Attrs extends ExtensionPageAttrs = ExtensionPageAttrs
Parameters
- extension: string
Returns CustomExtensionPage<Attrs> | undefined
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:302

getSettings

getSettings(extensionId: string): SettingConfigInternal[] | undefined
Get an extension's registered settings
Parameters
- extensionId: string
Returns SettingConfigInternal[] | undefined
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:260

registerPage

registerPage(component: CustomExtensionPage): this
Replace the default extension page with a custom component. This component would typically extend ExtensionPage
Parameters
- component: CustomExtensionPage
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:247

registerPermission

registerPermission(
    content: PermissionConfig,
    permissionType: PermissionType,
    priority?: number,
): this
This function registers your permission with Flarum
Parameters
- content: PermissionConfig
- permissionType: PermissionType
- priority: number = 0
Returns this
Example
```
.registerPermission('permissions', {
    icon: 'fas fa-flag',
    label: app.translator.trans('flarum-flags.admin.permissions.view_flags_label'),
    permission: 'discussion.viewFlags'
}, 'moderate', 65)
```
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:164

registerSetting

registerSetting(
    content: SettingConfigInput,
    priority?: number,
    key?: string | null,
): this
This function registers your settings with Flarum

It takes either a settings object or a callback.
Parameters
- content: SettingConfigInput
- priority: number = 0
- key: string | null = null
Returns this
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)
```
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:74

removePermission

removePermission(key: string, permissionType: PermissionType): this
This function allows you to remove a permission.
Parameters
- key: string
- permissionType: PermissionType
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:228

removeSetting

removeSetting(key: string): this
This function allows you to remove a setting.
Parameters
- key: string
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:139

setPermission

setPermission(
    key: string,
    content:
        | PermissionConfig
        | ((original: PermissionConfig) => PermissionConfig),
    permissionType: PermissionType,
): this
This function allows you to change the configuration of a permission.
Parameters
- key: string
- content: PermissionConfig | ((original: PermissionConfig) => PermissionConfig)
- permissionType: PermissionType
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:187

setPermissionPriority

setPermissionPriority(
    key: string,
    permissionType: PermissionType,
    priority: number,
): this
This function allows you to change the priority of a permission.
Parameters
- key: string
- permissionType: PermissionType
- priority: number
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:210

setSetting

setSetting(
    key: string,
    content:
        | SettingConfigInput
        | ((original: SettingConfigInput) => SettingConfigInput),
): this
This function allows you to change the configuration of a setting.
Parameters
- key: string
- content: SettingConfigInput | ((original: SettingConfigInput) => SettingConfigInput)
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:100

setSettingPriority

setSettingPriority(key: string, priority: number): this
This function allows you to change the priority of a setting.
Parameters
- key: string
- priority: number
Returns this
- Defined in flarum/framework/core/js/src/admin/utils/AdminRegistry.ts:122

Class AdminRegistry

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AdminRegistry

Properties

Protectedstate

Methods

extensionHasPermissions

Parameters

Returns boolean

for

Parameters

Returns AdminRegistry

Example

getAllPermissions

Parameters

Returns ItemList<PermissionConfig>

getData

Returns | { [key: string]: ExtensionConfig } | { [key: string]: ExtensionConfig | undefined }

getExtensionPermissions

Parameters

Returns ItemList<PermissionConfig>

getPage

Type Parameters

Parameters

Returns CustomExtensionPage<Attrs> | undefined

getSettings

Parameters

Returns SettingConfigInternal[] | undefined

registerPage

Parameters

Returns this

registerPermission

Parameters

Returns this

Example

registerSetting

Parameters

Returns this

Example

removePermission

Parameters

Returns this

removeSetting

Parameters

Returns this

setPermission

Parameters

Returns this

setPermissionPriority

Parameters

Returns this

setSetting

Parameters

Returns this

setSettingPriority

Parameters

Returns this

Settings

On This Page

`Protected`state

Returns
| { [key: string]: ExtensionConfig }
| { [key: string]: ExtensionConfig | undefined }