API: client

client.setLinkedOrb(orb)

指定した orb と link します。
orb.link はこのメソッド内で行われます。

引数

• orb (Orb) : link する orb

戻り値

なし

注意

すでに linkedOrb が存在していた場合、
その orb とは unlink されます。

client.unlink()

client.linkedOrb と unlink します。

引数

なし

戻り値

なし

client.sendMessage(data, id)

外部からは使用しないでください。

client.sendCustomMessage(name, data[, id])

client に customMessage を送信します。

引数

• name (string) : customMessage の名前
• data (object) : customMessage の内容
• id (number) 省略可 : customMessage が client から送られて、この message を 返信とするとき、送られてきた message の ID

戻り値

なし

client.linkedOrb [readonly]

link されている orb を取得します。

型

• link されているとき : Orb
• link されていないとき : null

client.key [readonly]

client に対する key を取得します。

型

string

client.on("message", callback)

customMessage、internalCommand、normalCommand のどれかが受け取られた時に発生します。

コールバックの引数

なし

client.on("arriveCustomMessage", callback)

client から customMessageが届いたときに発生します。

コールバックの引数

• name (string) : customMessage の名前
• data (object) : customMessage の内容
• messageId (number) : customMessage の ID。返信するときに使う。

client.on("arriveNormalCommand", callback)

client から、コマンドが届いた時に発生します。

コールバックの引数

• name (string) : コマンド名
• args (Array) : コマンドに対する引数

client.on("link", callback)

client が link、もしくは unlink した際に発生します。

コールバックの引数

• orb (Orb | null) : link したときは link した Orb、unlink したときは null が入ります。