Skip to main content

UpdateResourceRecordParams

UpdateResourceRecordParams = { adminUser: AdminUser; extra?: HttpExtra; oldRecord: any; record: any; recordId: any; resource: AdminForthResource; response?: IAdminForthHttpResponse; updates?: never; } | { adminUser: AdminUser; extra?: HttpExtra; oldRecord: any; record?: never; recordId: any; resource: AdminForthResource; response?: IAdminForthHttpResponse; updates: any; }

Parameters for IAdminForth.updateResourceRecord.

Union Members​

Type Literal​

{ adminUser: AdminUser; extra?: HttpExtra; oldRecord: any; record: any; recordId: any; resource: AdminForthResource; response?: IAdminForthHttpResponse; updates?: never; }

adminUser​

adminUser: AdminUser

Admin user performing the action.

extra?​

optional extra?: HttpExtra

Extra HTTP information. Prefer using extra.response over the top-level response field.

oldRecord​

oldRecord: any

Record data before update.

record​

record: any

Full record data with applied changes.

Deprecated​

Since 1.2.9. Will be removed in 2.0.0. Use updates instead.

recordId​

recordId: any

Primary key value of the record to update.

resource​

resource: AdminForthResource

Resource configuration used to update a record.

response?​

optional response?: IAdminForthHttpResponse

HTTP response object.

Deprecated​

Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.

updates?​

optional updates?: never

Partial record data with only changed fields. Mutually exclusive with record.

Type Literal​

{ adminUser: AdminUser; extra?: HttpExtra; oldRecord: any; record?: never; recordId: any; resource: AdminForthResource; response?: IAdminForthHttpResponse; updates: any; }

adminUser​

adminUser: AdminUser

Admin user performing the action.

extra?​

optional extra?: HttpExtra

Extra HTTP information. Prefer using extra.response over the top-level response field.

oldRecord​

oldRecord: any

Record data before update.

record?​

optional record?: never

Full record data with applied changes.

Deprecated​

Since 1.2.9. Will be removed in 2.0.0. Use updates instead.

recordId​

recordId: any

Primary key value of the record to update.

resource​

resource: AdminForthResource

Resource configuration used to update a record.

response?​

optional response?: IAdminForthHttpResponse

HTTP response object.

Deprecated​

Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.

updates​

updates: any

Partial record data with only changed fields. Mutually exclusive with record.