API

好きでつながるバーチャルワールド - Yay!（イェイ）API ライブラリ 📚

---

yaylib で利用可能な API 関数一覧を紹介します。

API とは Yay! のサーバーにアクセスするための入り口となるインターフェースのことです。yaylib では、その API に Python 関数を通して簡単にアクセスすることができます。

API 関数にアクセスするには、以下のように yaylib.Client クラスを使用します。

main.py

import yaylib

client = yaylib.Client()

# タイムラインを取得する API にアクセス
client.get_timeline()

また、yaylib.Client.[APIの種類] のようにアクセスを行うことで非同期処理が可能です。

main.py

import yaylib

client = yaylib.Client()

# API の種類を指定してタイムラインを取得（非同期）
client.post.get_timeline()

非同期処理については こちらを参照 してください。

API 関数

種類別に分類した yaylib で利用可能な API 関数一覧です。

新しく追加してほしい機能などがありましたら、 GitHub や Discord にてお伝えください。

認証

./auth.html

ユーザー

./user.html

投稿

./post.html

スレッド

./thread.html

通知

./notification.html

チャット

./chat.html

レター

./review.html

サークル

./group.html

通話

./call.html

その他

./misc.html

例外クラス

yaylib では、実行中に発生しうる例外（エラー）を細かく定義しています。これにより利用者は特定の状況に応じて細かく処理を分岐することが可能です。

クライアント例外

ClientError を継承するサーバーレスポンスの error_code に基づいたエラークラスです。

./errors.html

HTTP 例外

HTTPError を継承するクライアント例外に該当しない、HTTP 通信上のエラークラスです。

./errors.html