ConversationStream
Defined in: sdks/node/dist/runtime/public/streams.d.ts:56
Conversations as the client joins or creates them.
Extends
Section titled “Extends”ReaderStream<Conversation>
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterableIterator<Conversation>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:26
Returns
Section titled “Returns”AsyncIterableIterator<Conversation>
Inherited from
Section titled “Inherited from”ReaderStream.[asyncIterator]
end():
Promise<void>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:41
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.end
next()
Section titled “next()”next():
Promise<IteratorResult<Conversation,any>>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:33
Reads run one at a time. For messages, the next read acknowledges the prior message. Await app processing before requesting the next message. Sharing this iterator with an app queue does not extend the acknowledgement boundary.
Returns
Section titled “Returns”Promise<IteratorResult<Conversation, any>>
Inherited from
Section titled “Inherited from”ReaderStream.next
onValue()
Section titled “onValue()”onValue(
callback):Promise<void>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:39
Await each callback before the next read. For messages, that read acknowledges the prior message. Await all processing in the callback. Work sent to an app queue or an unawaited task can continue after acknowledgement.
Parameters
Section titled “Parameters”callback
Section titled “callback”(value) => void | Promise<void>
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.onValue
ready()
Section titled “ready()”ready():
Promise<void>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:27
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.ready
return()
Section titled “return()”return():
Promise<IteratorResult<Conversation,any>>
Defined in: sdks/node/dist/runtime/streams/reader.d.ts:40
Returns
Section titled “Returns”Promise<IteratorResult<Conversation, any>>
Inherited from
Section titled “Inherited from”ReaderStream.return