isReferencedDataItem( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Checks whether a field in a referring item contains a reference to a specified item.

Note: When calling isReferencedDataItem() following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set options.consistentRead to true.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage All Data Resources
Manage Data Items
Read Data Items
Learn more about app permissions.
Method Declaration
Copy
function isReferencedDataItem(
  options: IsReferencedDataItemOptions,
): Promise<IsReferencedDataItemResponse>;
Method Parameters
optionsIsReferencedDataItemOptions

Options for checking whether a field contains a reference to an item.

Returns
Return Type:Promise<IsReferencedDataItemResponse>
JavaScript
import { items } from "@wix/data";

async function isReferencedDataItem(options) {
  const response = await items.isReferencedDataItem(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?