メインコンテンツまでスキップ

インスタンス・サーバー

サーバーのメタデータ、カスタム絵文字、お知らせ、ヘルスチェック、ユーザー設定、プロフィールディレクトリ、oEmbed、タイムラインマーカーを扱う API を説明します。

インスタンス情報​

現在のインスタンス（v2）​

final instance = await client.instance.fetch();
print(instance.title);
print(instance.description);
print(instance.version);

設定言語・ルール・連絡先情報を含む v2 メタデータを持つ MastodonInstance を返します。

ピアドメイン一覧​

final peers = await client.instance.fetchPeers();
// 連合済みドメインの List<String>

週次アクティビティ​

final activity = await client.instance.fetchActivity();
for (final week in activity) {
  print('投稿数: ${week.statuses}');
}

最大 12 週分の MastodonWeeklyActivity オブジェクトを返します。

インスタンスルール​

final rules = await client.instance.fetchRules();
for (final rule in rules) {
  print(rule.text);
}

ドメインブロック​

final blocked = await client.instance.fetchDomainBlocks();

インスタンスがブロックしているドメインの一覧を返します。これはサーバーレベルのリストです。ユーザーレベルのドメインブロックについてはモデレーションのページを参照してください。

詳細説明​

final description = await client.instance.fetchExtendedDescription();
print(description.content);

プライバシーポリシーと利用規約​

final policy = await client.instance.fetchPrivacyPolicy();
final tos = await client.instance.fetchTermsOfService();

// 日付を指定して過去バージョンの利用規約を取得
final old = await client.instance.fetchTermsOfServiceByDate('2024-01-01');

翻訳対応言語​

final languages = await client.instance.fetchTranslationLanguages();
// Map<String, List<String>> — ソース言語 → 対応ターゲット言語
languages.forEach((source, targets) {
  print('$source → $targets');
});

レガシー v1（非推奨）​

// ignore: deprecated_member_use
final instanceV1 = await client.instance.fetchV1();

fetchV1() は Mastodon 4.0.0 以降で非推奨です。古いサーバーとの互換性が必要な場合を除き、fetch() を使用してください。

カスタム絵文字​

final emojis = await client.customEmojis.fetch();
for (final emoji in emojis) {
  print(':${emoji.shortcode}: → ${emoji.url}');
}

認証不要です。サーバーで利用可能なすべてのカスタム絵文字を List<MastodonCustomEmoji> で返します。

お知らせ​

お知らせの一覧取得​

final announcements = await client.announcements.fetch();
for (final a in announcements) {
  print(a.text);
}

お知らせを既読にする​

await client.announcements.dismiss('announcement-id');

認証ユーザーに対して、指定したお知らせを既読としてマークします。

リアクション​

// リアクションを追加（Unicode 絵文字またはカスタム絵文字のショートコード）
await client.announcements.addReaction('announcement-id', '👍');
await client.announcements.addReaction('announcement-id', 'blobcat');

// リアクションを削除
await client.announcements.removeReaction('announcement-id', '👍');

ヘルスチェック​

final healthy = await client.health.check();
// Web プロセス・データベース・キャッシュがすべて正常なら true を返す。
// いずれかが異常な場合は MastodonException をスローする。

認証不要です。監視やレディネスプローブに活用できます。

ユーザー設定​

final prefs = await client.preferences.fetch();
print(prefs.postingDefaultVisibility);
print(prefs.postingDefaultLanguage);
print(prefs.expandSpoilers);

認証ユーザーの MastodonPreferences を返します。設定を変更するには client.accounts.updateCredentials() を使用してください。

プロフィールディレクトリ​

// 最近アクティブなアカウント（全サーバー対象）
final active = await client.directory.fetch(
  order: 'active',
  limit: 40,
);

// 新規登録のローカルアカウントのみ
final newLocal = await client.directory.fetch(
  order: 'new',
  local: true,
);

パラメーター:

パラメーターデフォルト最大値説明
limit4080取得件数
offset——先頭からスキップする件数
order——active（最終投稿順）または new（作成日順）
local——true でローカルアカウントのみ取得

認証不要です。

oEmbed​

final embed = await client.oembed.fetch(
  'https://mastodon.social/@user/12345',
  maxwidth: 500,
);
print(embed.html);

ステータス URL の埋め込み用 HTML を含む MastodonOEmbed を返します。認証不要です。

タイムラインマーカー​

マーカーを使うと、ホームタイムラインと通知タイムラインの既読位置をセッションやデバイスをまたいで保持できます。

マーカーの取得​

final markers = await client.markers.fetch(['home', 'notifications']);
final home = markers['home'];
print(home?.lastReadId);

'home'・'notifications' のいずれか、または両方を含むリストを渡します。何も指定しない場合は空のマップを返します。

マーカーの保存​

final updated = await client.markers.save(
  homeLastReadId: '109876543210',
  notificationsLastReadId: '987654321',
);

homeLastReadId と notificationsLastReadId のうち少なくとも一方を指定してください。別のデバイスからの書き込みと競合した場合、サーバーは 409 Conflict を返します。その際はリトライしてください。

// 競合時のリトライ例
Map<String, MastodonMarker> result;
while (true) {
  try {
    result = await client.markers.save(homeLastReadId: lastId);
    break;
  } on MastodonConflictException {
    await Future.delayed(const Duration(milliseconds: 500));
  }
}