• ------------------------------
  • JS API Reference

    Class: RentalModuleImpl

    resource-rental/rental.module.RentalModuleImpl

    Implements

    Table of contents

    Constructors

    Properties

    Methods

    Constructors

    constructor

    new RentalModuleImpl(deps): RentalModuleImpl

    Parameters

    NameType
    depsObject
    deps.marketModuleMarketModule
    deps.paymentModulePaymentModule
    deps.activityModuleActivityModule
    deps.networkModuleNetworkModule
    deps.storageProviderStorageProvider
    deps.loggerLogger

    Returns

    RentalModuleImpl

    Defined in

    src/resource-rental/rental.module.ts:39

    Properties

    events

    events: EventEmitter<ResourceRentalModuleEvents, any>

    Implementation of

    RentalModule.events

    Defined in

    src/resource-rental/rental.module.ts:38

    Methods

    createResourceRental

    createResourceRental(agreement, allocation, options?): ResourceRental

    Factory that creates a new resource rental that's fully configured. This method will also create the payment process for the agreement.

    Parameters

    NameType
    agreementAgreement
    allocationAllocation
    options?ResourceRentalOptions

    Returns

    ResourceRental

    Implementation of

    RentalModule.createResourceRental

    Defined in

    src/resource-rental/rental.module.ts:50


    createResourceRentalPool

    createResourceRentalPool(draftPool, allocation, options?): ResourceRentalPool

    Factory that creates new resource rental pool that's fully configured

    Parameters

    NameType
    draftPoolDraftOfferProposalPool
    allocationAllocation
    options?ResourceRentalPoolOptions

    Returns

    ResourceRentalPool

    Implementation of

    RentalModule.createResourceRentalPool

    Defined in

    src/resource-rental/rental.module.ts:69

    Was this helpful?