Class Transport

Hierarchy

Base
- Transport

Index

Constructors

constructor

Properties

Accessors

fromAddress

Methods

Constructors

constructor

new Transport(web3: default, _fromAddress: string, factoryContract: any, contractName: BaseContracts, contractAbi: any[]): Transport

Inherited from Base.constructor
- Defined in Base.ts:13
Parameters
- web3: default
- _fromAddress: string
- factoryContract: any
- contractName: BaseContracts
- contractAbi: any[]
Returns Transport

Properties

TransportStatusEnum

TransportStatusEnum: typeof TransportStatusEnum = ...

contract

contract: any = null

Protected contractAbi

contractAbi: any[]

Protected contractName

contractName: BaseContracts

Protected factoryContract

factoryContract: any

Protected web3

web3: default

Accessors

fromAddress

get fromAddress(): string

- Defined in Base.ts:22
Returns string

Methods

all

all(options?: { receiver?: string; sender?: string; transportCompany?: string }): Promise<ITransport[]>

- Defined in Transport.ts:191
Get all transports

Parameters
- options: { receiver?: string; sender?: string; transportCompany?: string } = {}
  
  Fetch filters
  - Optional receiver?: string
    
    The receiver of the transport
  - Optional sender?: string
    
    The sender of the transport
  - Optional transportCompany?: string
    
    The tranport company associated with this transport
Returns Promise<ITransport[]>

Fetched transports

ensureContract

ensureContract(): Promise<any>

Inherited from Base.ensureContract
- Defined in Base.ts:38
Returns Promise<any>

finaliseTransport

finaliseTransport(options: { password?: string; transportId: number }): Transaction<{ TransportStatus: TransportStatusEvent }>

- Defined in Transport.ts:141
Sets a transport as finalised

Parameters
- options: { password?: string; transportId: number }
  
  Transport finalisation options
  - Optional password?: string
    
    Transport password
  - transportId: number
    
    Traget transport id
Returns Transaction<{ TransportStatus: TransportStatusEvent }>

Transport finalised event

getBatchIds

getBatchIds(transportId: number): Promise<number[]>

- Defined in Transport.ts:177
Get transport batches

Parameters
- transportId: number
  
  Transport id
Returns Promise<number[]>

Transport batches

getById

getById(transportId: number): Promise<ITransport>

- Defined in Transport.ts:165
Get a transport by id

Parameters
- transportId: number
  
  Transport id
Returns Promise<ITransport>

Transport data

getContractAddress

getContractAddress(): Promise<any>

Inherited from Base.getContractAddress
- Defined in Base.ts:26
Returns Promise<any>

getPastEvents

getPastEvents<T>(eventName: string, filter?: object, includeBlockData?: boolean): Promise<T[]>

Inherited from Base.getPastEvents
- Defined in Base.ts:62
Type parameters
- T
Parameters
- eventName: string
- filter: object = {}
- includeBlockData: boolean = false
Returns Promise<T[]>

getRawPastEvents

getRawPastEvents(eventName: string, filter?: object): Promise<default[]>

Inherited from Base.getRawPastEvents
- Defined in Base.ts:50
Parameters
- eventName: string
- filter: object = {}
Returns Promise<default[]>

getStatusEvents

getStatusEvents(transportId: number): Promise<TransportStatusEvent[]>

- Defined in Transport.ts:219
Get all status events from a transport

Parameters
- transportId: number
  
  Transport id
Returns Promise<TransportStatusEvent[]>

Transport status events

initiate

initiate(options: { batchIds: number[]; password?: string; receiver: string; transportCompany: string }): Transaction<{ TransportCreated: TransportCreatedEvent }>

- Defined in Transport.ts:86
Creates a new transport

Parameters
- options: { batchIds: number[]; password?: string; receiver: string; transportCompany: string }
  
  Transport options
  - batchIds: number[]
    
    Transport batches
  - Optional password?: string
    
    Transport password
  - receiver: string
    
    Transport receiver
  - transportCompany: string
    
    Transport company
Returns Transaction<{ TransportCreated: TransportCreatedEvent }>

Transport created event

setTransportStatus

setTransportStatus(options: { status: TransportStatusEnum; transportId: number }): Transaction<{ TransportStatus: TransportStatusEvent }>

- Defined in Transport.ts:120
Set a new status to a transport

Parameters
- options: { status: TransportStatusEnum; transportId: number }
  
  Transport status options
  - status: TransportStatusEnum
    
    Transport status to be set
  - transportId: number
    
    Traget transport id
Returns Transaction<{ TransportStatus: TransportStatusEvent }>

Transport status chaged event

Generated using TypeDoc