getProtectedDataInCollections

Method to get protected data that are in collections.

A protected data can only be in one collection at a time.

Results are ordered by creationTimestamp desc.

Usage

const protectedData =
  await dataProtectorSharing.getProtectedDataInCollections();

Parameters

import { type GetProtectedDataInCollectionsParams } from '@iexec/dataprotector';

protectedData

Type: AddressOrENS

const oneProtectedData =
  await dataProtectorSharing.getProtectedDataInCollections({
    protectedData: '0x123abc...', 
  });

collectionId

Type: number

const protectedDataByCollection =
  await dataProtectorSharing.getProtectedDataInCollections({
    collectionId: 12, 
  });

collectionOwner

Type: AddressOrENS

const protectedDataByOwner =
  await dataProtectorSharing.getProtectedDataInCollections({
    collectionOwner: '0x123...', 
  });

createdAfterTimestamp

Type: number

const latestProtectedData =
  await dataProtectorSharing.getProtectedDataInCollections({
    createdAfterTimestamp: 1707237580, // Feb 6th, 2024 16:39:40 GMT
  });

isRentable

Type: boolean

const rentableProtectedData =
  await dataProtectorSharing.getProtectedDataInCollections({
    isRentable: true, 
  });

isForSale

Type: boolean

const protectedDataForSale =
  await dataProtectorSharing.getProtectedDataInCollections({
    isForSale: true, 
  });

isDistributed

Type: boolean

Used to filter protected data that are either for sale, renting or part of a subscription.

const protectedDataForSale =
  await dataProtectorSharing.getProtectedDataInCollections({
    isDistributed: true, 
  });

page

Type: number

const protectedData = await dataProtectorSharing.getProtectedDataInCollections({
  collectionId: 12,
  page: 3, 
  pageSize: 25,
});

pageSize

Type: number
Range: [10...1000]

const protectedData = await dataProtectorSharing.getProtectedDataInCollections({
  collectionId: 12,
  page: 3,
  pageSize: 25, 
});

Return value

import type { GetProtectedDataInCollectionsResponse } from '@iexec/dataprotector';

// Child types
import type {
  ProtectedDataInCollection,
  RentingParams,
  SellingParams,
} from '@iexec/dataprotector';

See Type ↗️