ISPO SDK
    Preparing search index...

    Variable entitiesConst

    Markdown
    entities: {
        content: {
            append: (
                input: {
                    bytes: Uint8Array<ArrayBuffer>;
                    entityId: string;
                    idempotencyKey?: string;
                    mediaType: string;
                    metadata?: Record<string, CloudSyncJsonValue>;
                    slotId: string;
                    type: string;
                },
            ) => Promise<
                {
                    byteLength: number;
                    contentId: string;
                    createdAt: string;
                    entityId: string;
                    mediaType: string;
                    metadata?: Record<string, CloudSyncJsonValue>;
                    redactedAt?: string;
                    sha256: string;
                    slotId: string;
                    type: string;
                },
            >;
            read: (
                input: {
                    contentId: string;
                    entityId: string;
                    slotId: string;
                    type: string;
                },
            ) => Promise<
                {
                    bytes: Uint8Array<ArrayBuffer>;
                    content: {
                        byteLength: number;
                        contentId: string;
                        createdAt: string;
                        entityId: string;
                        mediaType: string;
                        metadata?: Record<string, CloudSyncJsonValue>;
                        redactedAt?: string;
                        sha256: string;
                        slotId: string;
                        type: string;
                    };
                },
            >;
            redact: (
                input: {
                    contentId: string;
                    entityId: string;
                    idempotencyKey?: string;
                    slotId: string;
                    type: string;
                },
            ) => Promise<
                {
                    byteLength: number;
                    contentId: string;
                    createdAt: string;
                    entityId: string;
                    mediaType: string;
                    metadata?: Record<string, CloudSyncJsonValue>;
                    redactedAt?: string;
                    sha256: string;
                    slotId: string;
                    type: string;
                },
            >;
        };
        create: <T = unknown>(
            type: string,
            data: T,
            options?: EntityCreateOptions,
        ) => Promise<EntityRecord<T>>;
        delete: <T = unknown>(
            type: string,
            id: string,
            options?: EntityDeleteOptions,
        ) => Promise<EntityRecord<T>>;
        get: <T = unknown>(type: string, id: string) => Promise<EntityRecord<T>>;
        grant: (input: EntityGrantInput) => Promise<EntityGrant>;
        listTypes: () => Promise<EntityTypeDefinition[]>;
        query: <T = unknown>(
            type: string,
            query?: EntityQuery,
        ) => Promise<EntityQueryResult<T>>;
        requestAccess: (
            type: string,
            operations: EntityAccessOperation[],
        ) => Promise<EntityAccessRequestResult>;
        revoke: (grantId: string) => Promise<EntityGrant>;
        subscribe: (
            input: EntityWatchInput,
            onChange: EntitySubscriptionChange,
        ) => EntitySubscription;
        subscribeQuery: <T = unknown>(
            type: string,
            query: EntityQuery,
            onChange: EntityQuerySubscriptionChange<T>,
            options?: { recoveryCursor?: string },
        ) => EntityQuerySubscription<T>;
        update: <T = unknown>(
            type: string,
            id: string,
            patch: EntityPatch<NoInfer<T>>,
            options?: EntityUpdateOptions,
        ) => Promise<EntityRecord<T>>;
        watch: (input?: EntityWatchInput) => Promise<EntityWatchResult>;
    } = ...

    Host-owned entity records. These calls go through the same postMessage bridge as fs/shared APIs; the host checks the manifest request envelope and runtime entity grants before touching SQLite.

    Type Declaration

    • content: {
          append: (
              input: {
                  bytes: Uint8Array<ArrayBuffer>;
                  entityId: string;
                  idempotencyKey?: string;
                  mediaType: string;
                  metadata?: Record<string, CloudSyncJsonValue>;
                  slotId: string;
                  type: string;
              },
          ) => Promise<
              {
                  byteLength: number;
                  contentId: string;
                  createdAt: string;
                  entityId: string;
                  mediaType: string;
                  metadata?: Record<string, CloudSyncJsonValue>;
                  redactedAt?: string;
                  sha256: string;
                  slotId: string;
                  type: string;
              },
          >;
          read: (
              input: {
                  contentId: string;
                  entityId: string;
                  slotId: string;
                  type: string;
              },
          ) => Promise<
              {
                  bytes: Uint8Array<ArrayBuffer>;
                  content: {
                      byteLength: number;
                      contentId: string;
                      createdAt: string;
                      entityId: string;
                      mediaType: string;
                      metadata?: Record<string, CloudSyncJsonValue>;
                      redactedAt?: string;
                      sha256: string;
                      slotId: string;
                      type: string;
                  };
              },
          >;
          redact: (
              input: {
                  contentId: string;
                  entityId: string;
                  idempotencyKey?: string;
                  slotId: string;
                  type: string;
              },
          ) => Promise<
              {
                  byteLength: number;
                  contentId: string;
                  createdAt: string;
                  entityId: string;
                  mediaType: string;
                  metadata?: Record<string, CloudSyncJsonValue>;
                  redactedAt?: string;
                  sha256: string;
                  slotId: string;
                  type: string;
              },
          >;
      }
    • create: <T = unknown>(
          type: string,
          data: T,
          options?: EntityCreateOptions,
      ) => Promise<EntityRecord<T>>
    • delete: <T = unknown>(
          type: string,
          id: string,
          options?: EntityDeleteOptions,
      ) => Promise<EntityRecord<T>>
    • get: <T = unknown>(type: string, id: string) => Promise<EntityRecord<T>>
    • grant: (input: EntityGrantInput) => Promise<EntityGrant>
    • listTypes: () => Promise<EntityTypeDefinition[]>
    • query: <T = unknown>(
          type: string,
          query?: EntityQuery,
      ) => Promise<EntityQueryResult<T>>
    • requestAccess: (
          type: string,
          operations: EntityAccessOperation[],
      ) => Promise<EntityAccessRequestResult>
    • revoke: (grantId: string) => Promise<EntityGrant>
    • subscribe: (
          input: EntityWatchInput,
          onChange: EntitySubscriptionChange,
      ) => EntitySubscription
    • subscribeQuery: <T = unknown>(
          type: string,
          query: EntityQuery,
          onChange: EntityQuerySubscriptionChange<T>,
          options?: { recoveryCursor?: string },
      ) => EntityQuerySubscription<T>
    • update: <T = unknown>(
          type: string,
          id: string,
          patch: EntityPatch<NoInfer<T>>,
          options?: EntityUpdateOptions,
      ) => Promise<EntityRecord<T>>
    • watch: (input?: EntityWatchInput) => Promise<EntityWatchResult>