Skip to main content

RecordReferenceSource

@gravity-rail/react


@gravity-rail/react / RecordReferenceSource

Interface: RecordReferenceSource

Transport uses the host's existing authorized Form and record APIs. Keep the object stable within one authenticated session to retain search state. Replace it when the actor, workspace, or authorization transport changes; the picker discards transient labels and choices when the object identity changes. Inline objects are supported, but each parent render starts a fresh session.

Properties​

getForm()​

getForm: (id) => Promise<Pick<DataType, "fields">>

Parameters​

id​

number

Returns​

Promise<Pick<DataType, "fields">>


getRecord()​

getRecord: (typeId, id) => Promise<Pick<DataRecord, "id" | "dataTypeId" | "fieldValues">>

Parameters​

typeId​

number

id​

number

Returns​

Promise<Pick<DataRecord, "id" | "dataTypeId" | "fieldValues">>


listRecords()​

listRecords: (typeId, params) => Promise<Pick<Paginated<DataRecord>, "items" | "totalPages">>

Parameters​

typeId​

number

params​
page​

number

pageSize​

number

string

searchField?​

string

Returns​

Promise<Pick<Paginated<DataRecord>, "items" | "totalPages">>