JavaScript SDK
わんコメAPIをテンプレート等から呼び出す際に便利なJavaScript SDKについて
概要
JavaScript SDKはわんコメのテンプレートフォルダにあるJavaScript向けSDKです
このSDKを使うことでJavaScriptから簡単にコメント等の取得が可能です
利用上の注意
APIドキュメントは一部不完全です
Discrodサーバーの開発者専用チャンネルにて追加や最新情報をやり取りしています
開発者の方はぜひDiscordに参加して開発者であることをお知らせください
利用規約を再度ご確認ください
連携アプリケーション・サービスにもわんコメの利用規約が適用されます
クレジットの表記について
HTTP APIを利用したアプリケーション・サービスを使用する際にも無料利用の場合はクレジット表示が必要となります
アプリケーションを配布する際はクレジット表記に関する注釈を必ず記入してください
外部IPやドメインからの参照について
わんコメのAPIは安全上の理由からローカルIP以外でのアクセスに制限があります
外部IPやドメインからAPIへアクセスするためには「設定 > APIタブ」（設定ページ）にてアクセス許可するホスト名の登録が必要です
使い方
テンプレートフォルダにあるpreset/origin/js/onesdk.jsを使用します
サーバーへのアップロードやテンプレートフォルダから複製などする場合はご相談ください
API
ready():Promise< void >
ページの読み込みが完了した際にPromiseをresolveします
既に完了している場合は即座にresolveします
setup(config: Partial< OneSDKConfig >): void
SDKの初期設定を行います
この関数の呼び出しは必須です
| config | Partial< OneSDKConfig > |
subscribe(subscriber: Subscriber): number
わんコメで変更があった際のイベントを購読します
解除に必要な購読IDが返却されます
| subscriber | Subscriber |
unsubscribe(subscriberId: number): void
購読IDをもとにイベントの購読を停止します
| subscriberId | number |
reset():void
取得したコメント等のデータを初期化します
getStyleVariable< T = any >(name: string, defaultValue: T, parser: (val:string) => T): T
CSSの:rootに定義されたCSS変数の値を取得する関数です
| name | string |
| defaultValue | T |
| parser | (val: string) ⇒ T |
getCommentStyle(comment: Comment): \{\[key: string\]: string\}
YouTube等のスパチャやメンバーシップの色情報をコメントをもとに返却します
| comment | Comment |
checkLicensed(): Promise< boolean >
PRO版を利用しているかどうかのフラグを返却します
connect(): Promise< void >
わんコメAPIサーバーに接続します
この関数の呼び出しは必須です
getInfo(): Promise< AppInfo >
わんコメアプリの基本情報を返却します
| AppInfo | AppInfo |
getComments(): Promise< Comment[] >
最新のコメントを返却します
| Comment[] | Comment[] |
searchComments(params: { services: string[]; comments: string[] }): Promise< Comment[] >
条件に一致したコメントを返却します
| Comment[] | Comment[] |
getPinnedComment(): Promise< Comment | null >
ピン留めされたコメント情報を返却します
| Comment | Comment |
getTemplates(): Promise< TemplateData[] >
テンプレート一覧情報を返却します
| TemplateData[] | TemplateData[] |
getServices(): Promise< Service[] >
わんコメに登録された枠情報一覧を返却します
| Service | Service[] |
getConfig(): Promise< Config >
わんコメの設定を返却します
| Config | Config |
getOrders(): Promise< OrderItem[] >
参加型の順番待ち情報一覧を返却します
| OrderItem[] | OrderItem[] |
cancelOrder(orderId: string): Promise< OrderItem[] >
参加IDをもとに順番待ちをキャンセルします
キャンセル後の最新の順番待ちリストが返却されます
| OrderItem[] | OrderItem[] |
completeOrder(orderId: string): Promise< OrderItem[] >
参加IDをもとに順番待ちを完了します
完了後の最新の順番待ちリストが返却されます
| OrderItem[] | OrderItem[] |
getSetList(): Promise< SetListAPIResponse >
【仮実装】セットリスト一覧を返却します
| SetListAPIResponse | SetListAPIResponse |
get< T = any >(url: string, config: AxiosRequestConfig< T >)
指定のURLにGETリクエストを送信します
post< T = any >(url: string, config: AxiosRequestConfig< T >)
指定のURLにPOSTリクエストを送 信します
put< T = any >(url: string, config: AxiosRequestConfig< T >)
指定のURLにPUTリクエストを送信します
delete< T = any >(url: string, config: AxiosRequestConfig< T >)
指定のURLにDELETEリクエストを送信します