@openiap/nodeapi / Exports / iclient

Interface: iclient

Implemented by

Table of contents

Properties

Methods

Properties

agent

• agent: clientAgent

Defined in

src/client.ts:16

call

• call: any

Defined in

src/client.ts:36

connected

• connected: boolean

Defined in

src/client.ts:27

connecting

• connecting: boolean

Defined in

src/client.ts:28

created

• created: Date

Defined in

src/client.ts:20

doping

• doping: boolean

Defined in

src/client.ts:19

exchanges

• exchanges: any[]

Defined in

src/client.ts:30

grpc

• grpc: FlowService

Defined in

src/client.ts:35

grpcStream

• grpcStream: any

Defined in

src/client.ts:37

id

• id: string

Defined in

src/client.ts:13

jwt

• jwt: string

Defined in

src/client.ts:25

lastheartbeat

• lastheartbeat: Date

Defined in

src/client.ts:21

lastheartbeatsec

• lastheartbeatsec: string

Defined in

src/client.ts:23

lastheartbeatstr

• lastheartbeatstr: string

Defined in

src/client.ts:22

protocol

• protocol: clientType

Defined in

src/client.ts:17

queues

• queues: any[]

Defined in

src/client.ts:29

remoteip

• remoteip: string

Defined in

src/client.ts:15

replies

• replies: any

Defined in

src/client.ts:38

seq

• seq: number

Defined in

src/client.ts:14

signedin

• signedin: boolean

Defined in

src/client.ts:26

stream

• stream: any

Defined in

src/client.ts:34

streams

• streams: any

Defined in

src/client.ts:39

url

• url: string

Defined in

src/client.ts:32

user

• user: any

Defined in

src/client.ts:24

version

• version: string

Defined in

src/client.ts:18

watches

• watches: changestream[]

Defined in

src/client.ts:31

ws

• ws: any

Defined in

src/client.ts:33

Methods

Close

▸ Close(): void

Returns

void

Defined in

src/client.ts:49

Initialize

▸ Initialize(ws, stream, call, req): Promise<boolean>

Parameters

Name Type
ws any
stream any
call any
req any

Returns

Promise<boolean>

Defined in

src/client.ts:40

SendWatch

▸ SendWatch(watch, next, span): void

Parameters

Name Type
watch any
next any
span any

Returns

void

Defined in

src/client.ts:48

UnWatch

▸ UnWatch(id, jwt): Promise<void>

Parameters

Name Type
id string
jwt string

Returns

Promise<void>

Defined in

src/client.ts:47

Watch

▸ Watch(aggregates, collectionname, jwt): Promise<string>

Parameters

Name Type
aggregates object[]
collectionname string
jwt string

Returns

Promise<string>

Defined in

src/client.ts:46

onConnected

▸ onConnected(client): void

Parameters

Name Type
client client

Returns

void

Defined in

src/client.ts:41

onDisconnected

▸ onDisconnected(client, error): void

Parameters

Name Type
client client
error Error

Returns

void

Defined in

src/client.ts:42

onMessage

▸ onMessage(client, message): Promise<Envelope>

Parameters

Name Type
client client
message any

Returns

Promise<Envelope>

Defined in

src/client.ts:43

ping

▸ ping(span): void

Parameters

Name Type
span any

Returns

void

Defined in

src/client.ts:44

queuecount

▸ queuecount(): number

Returns

number

Defined in

src/client.ts:45