setSubscriptionParams

Method to set subscription parameters for a given collection of yours.

Usage

const setSubscriptionParamsResult =
  await dataProtectorSharing.setSubscriptionParams({
    collectionId: 12,
    price: 2, // 2 nRLC
    duration: 60 * 60 * 24 * 30, // 30 days
  });

Parameters

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

collectionId Required *

Type: number

Collection ID to which you'd like to set the subscription params.

const setSubscriptionParamsResult =
  await dataProtectorSharing.setSubscriptionParams({
    collectionId: 12,
    price: 2, // 2 nRLC
    duration: 60 * 60 * 24 * 30, // 30 days
  });

price Required *

Type: number

The price in nano RLC (nRLC) it's going to cost a subscriber to access your collection.

const setSubscriptionParamsResult =
  await dataProtectorSharing.setSubscriptionParams({
    collectionId: 12,
    price: 2, // 2 nRLC
    duration: 60 * 60 * 24 * 30, // 30 days
  });

duration Required *

Type: number

The duration (in seconds) for a period of subscription.

const setSubscriptionParamsResult =
  await dataProtectorSharing.setSubscriptionParams({
    collectionId: 12,
    price: 2, // 2 nRLC
    duration: 60 * 60 * 24 * 30, // 30 days
  });

Return value

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

See SuccessWithTransactionHash