API Docs for:
Show:

CommentProvider Class

Defined in: src/live/CommentProvider.coffee:1

放送中の番組のコメントの取得と投稿を行うクラスです。

Methods

_canContinue

() private

Defined in src/live/CommentProvider.coffee:103

_didCloseSocket

() private

Defined in src/live/CommentProvider.coffee:404

コネクションが閉じられた時の処理

_didErrorOnSocket

() private

Defined in src/live/CommentProvider.coffee:394

コネクション上のエラー処理

_didReceiveData

(
  • xml
)
private

Defined in src/live/CommentProvider.coffee:344

コメント受信処理

Parameters:

  • xml String

_didRefreshLiveInfo

() private

Defined in src/live/CommentProvider.coffee:417

コメントサーバのスレッドID変更を監視するリスナ

_ferchPostKey

() Promise private

Defined in src/live/CommentProvider.coffee:211

APIからpostkeyを取得します。

Returns:

Promise:

_onDidReceivePostResult

(
  • listener
)
Disposable private

Defined in src/live/CommentProvider.coffee:437

Parameters:

  • listener Function

Returns:

Disposable:

_pourXMLData

(
  • xml
)
private

Defined in src/live/CommentProvider.coffee:113

[Method for testing] Stream given xml data as socket received data.

Parameters:

  • xml String

connect

(
  • [options]
)
Promise

Defined in src/live/CommentProvider.coffee:123

コメントサーバーへ接続します。

既に接続済みの場合は接続を行いません。 再接続する場合は CommentProvider#reconnectを利用してください。

Parameters:

  • [options] Object optional
    • [firstGetComments=100] Number optional

      接続時に取得するコメント数

    • [timeoutMs=5000] Number optional

      タイムアウトまでのミリ秒

Returns:

Promise:

disconnect

()

Defined in src/live/CommentProvider.coffee:194

コメントサーバから切断します。

dispose

()

Defined in src/live/CommentProvider.coffee:329

インスタンスを破棄します。

getLiveInfo

() NicoLiveInfo

Defined in src/live/CommentProvider.coffee:94

このインスタンスが保持しているNicoLiveInfoオブジェクトを取得します。

Returns:

NicoLiveInfo:

onDidCloseConnection

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:507

Parameters:

  • listener Function

Returns:

Disposable:

onDidEndLive

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:520

Parameters:

  • listener Function

Returns:

Disposable:

onDidError

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:494

Parameters:

  • listener Function

Returns:

Disposable:

onDidProcessFirstResponse

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:452

Parameters:

  • listener Function

Returns:

Disposable:

onDidReceiveComment

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:480

Parameters:

  • listener Function

Returns:

Disposable:

onDidReceiveData

(
  • listener
)
Disposable

Defined in src/live/CommentProvider.coffee:466

Parameters:

  • listener Function

Returns:

Disposable:

postComment

(
  • msg
  • [command]
  • [timeoutMs]
)
Promise

Defined in src/live/CommentProvider.coffee:244

コメントを投稿します。

Parameters:

  • msg String

    投稿するコメント

  • [command] String | Array. optional

    コマンド(184, bigなど)

  • [timeoutMs] Number optional

Returns:

Promise:

reconnect

(
  • options
)
Promise

Defined in src/live/CommentProvider.coffee:181

Parameters:

  • options Object

    接続設定（connectメソッドと同じ）

Returns:

Promise:

Properties

_live

NicoLiveInfo private

Defined in src/live/CommentProvider.coffee:54

_postInfo

Object private

Defined in src/live/CommentProvider.coffee:66

_socket

net.Socket private

Defined in src/live/CommentProvider.coffee:60

isFirstResponseProsessed

Boolean

Defined in src/live/CommentProvider.coffee:75

Events

CommentProvider#did-close-connection

Defined in src/live/CommentProvider.coffee:503

Fire on connection closed

CommentProvider#did-end-live

Defined in src/live/CommentProvider.coffee:516

Fire on live ended

CommentProvider#did-error

Defined in src/live/CommentProvider.coffee:489

Fire on error raised on Connection

Event Payload:

  • error Error

CommentProvider#did-process-first-response

Defined in src/live/CommentProvider.coffee:447

Fire on received and processed thread info and comments first

Event Payload:

  • UNKNOWN Array.

CommentProvider#did-receive-comment

Defined in src/live/CommentProvider.coffee:475

Fire on comment received

Event Payload:

  • comment NicoLiveComment

CommentProvider#did-receive-data

Defined in src/live/CommentProvider.coffee:461

Fire on raw response received

Event Payload:

  • data String

CommentProvider#did-receive-post-result

private

Defined in src/live/CommentProvider.coffee:432

Event Payload:

  • status Number