AdminForthActionInput

Properties

action()?

optional action: (params) => Promise<{ error?: string; message?: string; ok: boolean; }>

Parameters

Parameter	Type
params	{ adminforth: IAdminForth; adminUser: AdminUser; extra?: HttpExtra; recordId: string; resource: AdminForthResource; tr: Function; }
params.adminforth	IAdminForth
params.adminUser	AdminUser
params.extra?	HttpExtra
params.recordId	string
params.resource	AdminForthResource
params.tr	Function

Returns

Promise<{ error?: string; message?: string; ok: boolean; }>

---

allowed()?

optional allowed: (params) => boolean

Parameters

Parameter	Type
params	{ adminUser: AdminUser; standardAllowedActions: AllowedActions; }
params.adminUser	AdminUser
params.standardAllowedActions	AllowedActions

Returns

boolean

---

customComponent?

optional customComponent: AdminForthComponentDeclaration

---

icon?

optional icon: string

---

id?

optional id: string

---

name

name: string

---

showIn?

optional showIn: object

list?

optional list: boolean

showButton?

optional showButton: boolean

showThreeDotsMenu?

optional showThreeDotsMenu: boolean

---

url?

optional url: string