Class Channel

Hierarchy

Transportable
- Channel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Channel(ctx: ChannelKeeper, initialInteraction: Interaction, transportAPI?: TransportAPI): Channel

Overrides Transportable.constructor
- Defined in src/channels/channel.ts:34
Parameters
- ctx: ChannelKeeper
- initialInteraction: Interaction
- Optional transportAPI: TransportAPI
Returns Channel

Properties

Protected Optional _transportAPI

_transportAPI: TransportAPI

authPromise

authPromise: Promise<boolean>

ctx

ctx: ChannelKeeper

id

id: string

initialInteraction

initialInteraction: Interaction

Accessors

authenticated

get authenticated(): boolean

- Defined in src/channels/channel.ts:59
Returns boolean

counterparty

get counterparty(): undefined | Identity

- Defined in src/channels/channel.ts:55
Returns undefined | Identity

transportAPI

get transportAPI(): TransportAPI
set transportAPI(api: TransportAPI): void

Inherited from Transportable.transportAPI
- Defined in src/transports.ts:13
Returns TransportAPI
Inherited from Transportable.transportAPI
- Defined in src/transports.ts:18
Parameters
- api: TransportAPI
Returns void

Methods

getSummary

getSummary(): Promise<ChannelSummary>

- Defined in src/channels/channel.ts:64
Returns Promise<ChannelSummary>

processJWT

processJWT(jwt: string, transportAPI?: TransportAPI): Promise<Interaction<Flow<any>>>

- Defined in src/channels/channel.ts:80
Parameters
- jwt: string
- Optional transportAPI: TransportAPI
Returns Promise<Interaction<Flow<any>>>

send

send(msg: JSONWebToken<any>): Promise<void>

- Defined in src/channels/channel.ts:76
Parameters
- msg: JSONWebToken<any>
Returns Promise<void>

start

start(onInterxnCb?: undefined | ((interxn: Interaction) => Promise<void>)): Promise<void>

- Defined in src/channels/channel.ts:133
Parameters
- Optional onInterxnCb: undefined | ((interxn: Interaction) => Promise<void>)
Returns Promise<void>

startThread

startThread(tokenOrJwt: Interaction | JSONWebToken<any> | string): Promise<JSONWebToken<any>>

- Defined in src/channels/channel.ts:173
Parameters
- tokenOrJwt: Interaction | JSONWebToken<any> | string
Returns Promise<JSONWebToken<any>>

stop

stop(): void

- Defined in src/channels/channel.ts:166
Returns void

Generated using TypeDoc