JS API Reference
Interface: RentalModule
resource-rental/rental.module.RentalModule
Implemented by
Table of contents
Properties
Methods
Properties
events
• events: EventEmitter<ResourceRentalModuleEvents, any>
Defined in
src/resource-rental/rental.module.ts:20
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
| Name | Type | 
|---|---|
| agreement | Agreement | 
| allocation | Allocation | 
| options? | ResourceRentalOptions | 
Returns
Defined in
src/resource-rental/rental.module.ts:26
createResourceRentalPool
▸ createResourceRentalPool(draftPool, allocation, options): ResourceRentalPool
Factory that creates new resource rental pool that's fully configured
Parameters
| Name | Type | 
|---|---|
| draftPool | DraftOfferProposalPool | 
| allocation | Allocation | 
| options | ResourceRentalPoolOptions |