`useCreateEntity`

Overview

The useCreateEntity hook is used to create a new entity within the project. It handles all required parameters for the creation process and associates the entity with the currently logged-in user.

Usage Example

import { useCreateEntity } from "@replyke/react-js";
 
function CreateEntityForm() {
  const createEntity = useCreateEntity();
 
  const handleCreateEntity = async () => {
    try {
      const result = await createEntity({
        title: "My New Entity",
        content: "This is the content of the entity.",
        media: ["https://example.com/image.jpg"],
        keywords: ["example", "entity"],
        location: { latitude: 40.7128, longitude: -74.0060 },
        metadata: { category: "blog" },
      });
 
      console.log("Entity created successfully:", result);
    } catch (error) {
      console.error("Failed to create entity:", error.message);
    }
  };
 
  return <button onClick={handleCreateEntity}>Create Entity</button>;
}

Parameters & Returns

Parameters

The hook returns a function that accepts an object with the following fields:

Parameter	Type	Required	Description
`foreignId`	`string`	No	An optional foreign ID to associate with the entity.
`sourceId`	`string`	No	An optional free-form source ID to group entities into separate entity “pools”.
`title`	`string`	No	The title of the entity.
`content`	`string`	No	The main content of the entity.
`attachments`	`any[]`	No	An array of objects representing attachments (e.g., images, videos, files) associated with the entity, with data about those attachments.
`keywords`	`string[]`	No	An array of keywords to tag the entity.
`mentions`	`Mention[]`	No	An array of user mentions in the entity.
`location`	`object`	No	The geographic location (latitude, longitude) associated with the entity.
`metadata`	`Record<string, any>`	No	Additional metadata to store with the entity.
`excludeUserId`	`boolean`	No	By default, when this function is called, the ID of the logged in user is attached as the author, but it could be omitted by passing this flag as ‘false’.

Returns

The function resolves with an object representing the newly created entity:

Return Value	Type	Description
`Entity`	`object`	The details of the created entity, including its ID, title, and other attributes.

useUserData useFetchEntity