ISPO SDK
    Preparing search index...

    Interface EntityPrivateContentApi

    Markdown

    Private Entity bytes never surface through Files selectors or URLs.

    interface EntityPrivateContentApi {
        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;
            },
        >;
    }
    Index
    • Parameters

      • input: {
            bytes: Uint8Array<ArrayBuffer>;
            entityId: string;
            idempotencyKey?: string;
            mediaType: string;
            metadata?: Record<string, CloudSyncJsonValue>;
            slotId: string;
            type: string;
        }

      Returns Promise<
          {
              byteLength: number;
              contentId: string;
              createdAt: string;
              entityId: string;
              mediaType: string;
              metadata?: Record<string, CloudSyncJsonValue>;
              redactedAt?: string;
              sha256: string;
              slotId: string;
              type: string;
          },
      >

    • Parameters

      • input: { contentId: string; entityId: string; slotId: string; type: string }

      Returns 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;
              };
          },
      >

    • Parameters

      • input: {
            contentId: string;
            entityId: string;
            idempotencyKey?: string;
            slotId: string;
            type: string;
        }

      Returns Promise<
          {
              byteLength: number;
              contentId: string;
              createdAt: string;
              entityId: string;
              mediaType: string;
              metadata?: Record<string, CloudSyncJsonValue>;
              redactedAt?: string;
              sha256: string;
              slotId: string;
              type: string;
          },
      >