ContentStream class

パッケージ:

botframework-streaming

デコードするコンテンツを含む固定長または無限長のストリーム。

コンストラクター

ContentStream(string, PayloadAssembler)

ContentStream クラスの新しいインスタンスを初期化します。

プロパティ

contentType	この ContentStreamに含まれるオブジェクトの型の名前を取得します。
id
length	この ContentStreamの長さを取得します。

メソッド

cancel()	アセンブラーを閉じます。
getStream()	この ContentStreamに含まれるデータを取得します。
readAsJson<T>()	型指定された JSON オブジェクトとしてコンテンツ SubscriptionableStream を取得します。
readAsString()	のサブスクライブ可能なStream コンテンツを文字列として取得します。

コンストラクターの詳細

ContentStream(string, PayloadAssembler)

ContentStream クラスの新しいインスタンスを初期化します。

new ContentStream(id: string, assembler: PayloadAssembler)

パラメーター

id

string

このインスタンスに割り当てられた ID。

assembler

PayloadAssembler

PayloadAssembler このインスタンスに割り当てられます。

プロパティの詳細

contentType

この ContentStreamに含まれるオブジェクトの型の名前を取得します。

string | PayloadTypes contentType

プロパティ値

string | PayloadTypes

この ContentStreamの PayloadType。

id

id: string

プロパティ値

string

length

この ContentStreamの長さを取得します。

number length

プロパティ値

number

この ContentStreamの長さを表す数値。

メソッドの詳細

cancel()

アセンブラーを閉じます。

function cancel()

getStream()

この ContentStreamに含まれるデータを取得します。

function getStream(): SubscribableStream

戻り値

SubscribableStream

この ContentStream のSubscribableStreamです。

readAsJson<T>()

型指定された JSON オブジェクトとしてコンテンツ SubscriptionableStream を取得します。

function readAsJson<T>(): Promise<T>

戻り値

Promise<T>

SubscribableStream コンテンツを含む型指定されたオブジェクト Promise。

readAsString()

のサブスクライブ可能なStream コンテンツを文字列として取得します。

function readAsString(): Promise<string>

戻り値

Promise<string>

サブスクライブ可能なStream コンテンツを含む文字列 Promise。