GroupStreamWriter interface

パッケージ:

@azure/web-pubsub-client

グループストリームライター抽象化は、1つの論理ストリームをグループに送信するためのものです。

プロパティ

streamId

ストリーム識別子。

メソッド

abort(StreamEndError, AbortGroupStreamOptions)	エラーがあればストリームを中止してください。
end(EndGroupStreamOptions)	ストリームを無事に終了させてください。
onError((error: StreamDataError) => void)	レジスタのアウトバウンドストリームエラーコールバック。 このコールバックの登録解除関数を返します。
write(JSONTypes | ArrayBuffer, WebPubSubDataType, GroupStreamWriteOptions)	ストリームフラグメントを書きます。

プロパティの詳細

streamId

ストリーム識別子。

streamId: string

プロパティ値

string

メソッドの詳細

abort(StreamEndError, AbortGroupStreamOptions)

エラーがあればストリームを中止してください。

function abort(error: StreamEndError, options?: AbortGroupStreamOptions): Promise<void>

パラメーター

error

StreamEndError

options

AbortGroupStreamOptions

返品

Promise<void>

end(EndGroupStreamOptions)

ストリームを無事に終了させてください。

function end(options?: EndGroupStreamOptions): Promise<void>

パラメーター

options

EndGroupStreamOptions

返品

Promise<void>

onError((error: StreamDataError) => void)

レジスタのアウトバウンドストリームエラーコールバック。 このコールバックの登録解除関数を返します。

function onError(listener: (error: StreamDataError) => void): () => void

パラメーター

listener

(error: StreamDataError) => void

返品

() => void

write(JSONTypes | ArrayBuffer, WebPubSubDataType, GroupStreamWriteOptions)

ストリームフラグメントを書きます。

function write(content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: GroupStreamWriteOptions): Promise<void>

パラメーター

content

JSONTypes | ArrayBuffer

dataType

WebPubSubDataType

options

GroupStreamWriteOptions

返品

Promise<void>