API Reference¶
このセクションではMi.pyのAPIについて説明します
注釈
このライブラリではloggingを用いてdebug出力が可能です。標準設定では出ないため、起動時の引数として debug を渡すようにしてください
抽象基底クラス¶
abstract base class はメソッドなどの一覧を取得するために継承することが可能なクラスです。抽象基底クラスはインスタンス化することはできません。
Misskey モデル¶
危険
下記のクラスは、 ユーザーによって作成されることを考慮していません 。 独自のインスタンスは作成するべきではなく、値を変更するべきではありません。
Note¶
- defemoji_count
- asyncreply
- class mi.Note[ソース]¶
- await reply(content, cw=None, extract_mentions=True, extract_hashtags=True, extract_emojis=True, renote_id=None, channel_id=None, file_ids=None, poll=None)[ソース]¶
ノートに対して返信を送信します
- パラメータ
content (Optional[str]) -- 返信内容
cw (Optional[str]) -- 閲覧注意
extract_mentions (bool, optional) -- メンションを展開するか, by default False
extract_hashtags (bool, optional) -- ハッシュタグを展開するか, by default False
extract_emojis (bool, optional) -- 絵文字を展開するか, by default False
renote_id (Optional[str], optional) -- リノート先のid, by default None
channel_id (Optional[str], optional) -- チャンネルid, by default None
file_ids ([type], optional) -- 添付するファイルのid, by default None
poll (Optional[Poll], optional) -- アンケート, by default None
Renote¶
- defemoji_count
Follow¶
データクラス¶
例外処理¶
Low-Level API¶
- class mi.ConnectionState[ソース]¶
- parse_channel(message)[ソース]¶
parse_channel is a function to parse channel event
チャンネルタイプのデータを解析後適切なパーサーに移動させます
- パラメータ
message (Dict[str, Any]) -- Received message
- parse_unread_notification(message)[ソース]¶
未読の通知を解析する関数
- パラメータ
message (Dict[str, Any]) -- Received message
- await get_user(user_id=None, username=None, host=None)[ソース]¶
ユーザーのプロフィールを取得します。一度のみサーバーにアクセスしキャッシュをその後は使います。 fetch_userを使った場合はキャッシュが廃棄され再度サーバーにアクセスします。
- パラメータ
user_id (str) -- 取得したいユーザーのユーザーID
username (str) -- 取得したいユーザーのユーザー名
host (str, default=None) -- 取得したいユーザーがいるインスタンスのhost
- 戻り値
ユーザー情報
- 戻り値の型
dict
- await post_chat(content, *, user_id=None, group_id=None, file_id=None)[ソース]¶
チャットを送信します。
- パラメータ
content (str) -- 送信する内容
user_id (str, optional) -- ユーザーid, default=None
group_id (str, optional) -- グループid, default=None
file_id (str, optional) -- 添付するファイルid, efault=None
- 戻り値
チャットの内容
- 戻り値の型
- await delete_chat(message_id)[ソース]¶
指定したidのメッセージを削除します。
- パラメータ
message_id (str) -- メッセージid
- 戻り値
成功したか否か
- 戻り値の型
bool
- async for ... in get_followers(user_id=None, username=None, host=None, since_id=None, until_id=None, limit=10, get_all=False)[ソース]¶
与えられたユーザーのフォロワーを取得します
- パラメータ
user_id (str, default=None) -- ユーザーのid
username (str, default=None) -- ユーザー名
host (str, default=None) -- ユーザーがいるインスタンスのhost名
since_id (str, default=None) --
until_id (str, default=None) -- 前回の最後の値を与える(既に実行し取得しきれない場合に使用)
limit (int, default=10) -- 取得する情報の最大数 max: 100
get_all (bool, default=False) -- 全てのフォロワーを取得する
- 列挙
dict -- フォロワーの情報
- 例外
InvalidParameters -- limit引数が不正な場合