APIでの利用方法
目次
グローバルシグナル
グローバルシグナルの送信
メソッド | window.RPGAtsumaru.signal.sendSignalToGlobal(data: string) |
---|
説明 | ゲームのグローバルシグナルとして data で指定した文字列を送信します。 |
引数 | data : シグナルとして、任意の文字列を100byte以内で送信できます。 |
戻り値 | Promise<void> |
- グローバルシグナルは1ゲームあたり1,000件まで保存されます。
起こりうるエラーの種類
グローバルシグナルの取得
メソッド | window.RPGAtsumaru.signal.getGlobalSignals() |
---|
説明 | 送信されたゲームのグローバルシグナルを取得します。 |
引数 | なし |
戻り値 | Promise<GlobalSignal[]> |
- グローバルシグナルは1ゲームあたり1,000件まで保存されます。
戻り値の型 GlobalSignal について
戻り値で取得できる GlobalSignal
は以下のような型です。
interface GlobalSignal {
id: number;
senderId: number;
senderName: string;
data: string;
createdAt: number;
}
プロパティの内容は次のようになっています。
プロパティ | 型 | 内容 |
---|
d | number | シグナルそれぞれでユニークなID値 |
senderId | number | シグナルを送信したユーザーのニコニコユーザーID |
senderName | string | シグナルを送信したユーザーのユーザー名 |
data | string | 送信したシグナル文字列 |
createdAt | number | シグナルが送信された日時(秒単位のunix timestamp)。すでに処理済みのシグナルを判別するために用います。 |
戻り値の例
// window.RPGAtsumaru.signal.getGlobalSignals().then(function(v) { console.log(v) }) を実行
[
{
createdAt: 1543397700,
data: "test data",
id: 3,
senderId: 12345,
senderName: "user1"
},
{
createdAt: 1543397701,
data: "test data2",
id: 4,
senderId: 12346,
senderName: "user2"
},
]
起こりうるエラーの種類
ユーザーシグナル
ユーザーシグナルの送信
メソッド | window.RPGAtsumaru.signal.sendSignalToUser(receiverId: number, data: string) |
---|
説明 | ユーザーシグナルとして receiverId で指定したユーザーIDのユーザーに data で指定した文字列を送信します。 |
引数 | receiverId : 送信先のニコニコユーザーIDを指定します。data : シグナルとして、任意の文字列を100byte以内で送信できます。
|
戻り値 | Promise<void> |
- ユーザーシグナルは、ユーザーあたり100KBまで保存されます。
- 他のゲームからのシグナル送信によっても消える可能性があります。
- また、ゲームあたり1ユーザー10KBまたは1000件までとなります。
- ゲームからのシグナル送信によって、古いシグナルから消えていきます。
起こりうるエラーの種類
ユーザーシグナルの取得
メソッド | window.RPGAtsumaru.signal.getUserSignals() |
---|
説明 | プレイしているユーザーのユーザーシグナルを取得します。 |
引数 | なし |
戻り値 | Promise<UserSignal[]> |
- ユーザーシグナルは、ユーザーあたり100KBまで保存されます。
- 他のゲームからのシグナル送信によっても消える可能性があります。
- また、ゲームあたり1ユーザー10KBまたは1000件までとなります。
- ゲームからのシグナル送信によって、古いシグナルから消えていきます。
戻り値の型 UserSignal について
戻り値で取得できる UserSignal
は以下のような型です。
interface UserSignal {
id: number;
senderId: number;
senderName: string;
data: string;
createdAt: number;
}
プロパティの内容は次のようになっています。
プロパティ | 型 | 内容 |
---|
id | number | シグナルそれぞれでユニークなID値 |
senderId | number | シグナルを送信したユーザーのニコニコユーザーID |
senderName | string | シグナルを送信したユーザーのユーザー名 |
data | string | 送信したシグナル文字列 |
createdAt | number | シグナルが送信された日時(秒単位のunix timestamp)。すでに処理済みのシグナルを判別するために用います。 |
戻り値の例
// window.RPGAtsumaru.signal.getUserSignals().then(function(v) { console.log(v) }) を実行
[
{
createdAt: 1543397700,
data: "test data",
id: 3,
senderId: 12345,
senderName: "user1"
},
{
createdAt: 1543397701,
data: "test data2",
id: 4,
senderId: 12346,
senderName: "user2"
},
]
起こりうるエラーの種類
関連ドキュメント
最終更新日