APIリファレンス¶
ここではdiscord.pyのAPIの概要を説明します。
注釈
このモジュールはPythonのloggingモジュールを使用して、出力に依存しない方法でエラーや診断の内容を記録します。loggingモジュールが設定されていない場合、これらのログはどこにも出力されません。discord.pyでloggingモジュールを使用する方法の詳細は ログの設定 を参照してください。
クライアント¶
Client¶
- defadd_dynamic_items
- defadd_view
- asyncapplication_info
- asyncbefore_identify_hook
- asyncchange_presence
- defclear
- asyncclose
- asyncconnect
- asynccreate_dm
- asynccreate_entitlement
- asynccreate_guild
- asyncdelete_invite
- async forentitlements
- @event
- asyncfetch_channel
- asyncfetch_entitlement
- asyncfetch_guild
- async forfetch_guilds
- asyncfetch_invite
- asyncfetch_premium_sticker_packs
- asyncfetch_skus
- asyncfetch_stage_instance
- asyncfetch_sticker
- asyncfetch_template
- asyncfetch_user
- asyncfetch_webhook
- asyncfetch_widget
- defget_all_channels
- defget_all_members
- defget_channel
- defget_emoji
- defget_guild
- defget_partial_messageable
- defget_stage_instance
- defget_sticker
- defget_user
- defis_closed
- defis_ready
- defis_ws_ratelimited
- asynclogin
- asyncon_error
- defremove_dynamic_items
- defrun
- asyncsetup_hook
- asyncstart
- asyncwait_for
- asyncwait_until_ready
- class discord.Client(*, intents, **options)¶
Discordに接続するクライアント接続です。このクラスはDiscordのWebSocket、及びAPIとの対話に使用されます。
- async with x
非同期的にクライアントを初期化し自動でクリーンアップします。
バージョン 2.0 で追加.
Client
には多くのオプションを渡すことが可能です。- パラメータ
max_messages (Optional[
int
]) --内部のメッセージキャッシュに保存するメッセージの最大数。デフォルトは
1000
です。None
が渡されるとメッセージキャッシュは無効化されます。バージョン 1.3 で変更: メッセージキャッシュの無効化が可能になり、デフォルトのキャッシュサイズが
1000
になりました。proxy (Optional[
str
]) -- プロキシのURL。proxy_auth (Optional[
aiohttp.BasicAuth
]) -- プロキシのHTTP Basic認証を表すオブジェクト。shard_id (Optional[
int
]) --0
から始まり、shard_count
より小さい整数。shard_count (Optional[
int
]) -- シャードの総数。application_id (
int
) -- クライアントのアプリケーションID。intents (
Intents
) --セッションで有効にするインテント。これは特定のゲートウェイイベントの発火、またはその送信を無効化できます。
バージョン 1.5 で追加.
バージョン 2.0 で変更: パラメータが必須になりました。
member_cache_flags (
MemberCacheFlags
) --ライブラリのメンバーのキャッシュ方法をより詳細に制御することができます。指定されていない場合、デフォルトでは現在のインテントに応じて可能な限りキャッシュを行います。
バージョン 1.5 で追加.
chunk_guilds_at_startup (
bool
) --必要に応じて、
on_ready()
を遅延させ、すべてのギルドをチャンク化するかどうかを設定します。この操作は大量のギルドに参加している場合、非常に低速になります。Intents.members
がTrue
である場合、これはデフォルトでTrue
になります。バージョン 1.5 で追加.
status (Optional[
Status
]) -- Discordにログインした際の、開始時ステータス。activity (Optional[
BaseActivity
]) -- Discordにログインした際の、開始時アクティビティ。allowed_mentions (Optional[
AllowedMentions
]) --送信されるすべてのメッセージにおいて、クライアントがメンションを処理するかどうかを制御します。
バージョン 1.4 で追加.
heartbeat_timeout (
float
) -- HEARTBEAT_ACKを受信できない際に、WebSocketをタイムアウトさせて再起動するまでの最大秒数。最初のパケットの処理に時間がかかり、接続を切断できないというような状況時に便利です。デフォルトでは60秒に設定されています。guild_ready_timeout (
float
) --メンバーキャッシュの準備を行い、READYを実行する前にGUILD_CREATEストリームが終了するのを待機する最大秒数。デフォルトは2秒です。
バージョン 1.4 で追加.
assume_unsync_clock (
bool
) --システム時計が同期されていない可能性を考慮するかどうかを設定します。これはレートリミットの処理コードに適用されます。デフォルトでは
True
が設定されており、この場合、ライブラリはDiscordから受け取ったレートリミットバケットをリセットするため内部で時間を処理します。False
に設定されている場合は、システム時計を利用してどれくらいの時間スリープするかを計算します。もし、これをFalse
に設定するのであれば、システム時計をGoogleのNTPサーバーと同期させることを推奨します。バージョン 1.3 で追加.
enable_debug_events (
bool
) --ゲートウェイ関連情報のデバッグにのみ役立つイベントを有効にするかどうかを設定します。
現在は
on_socket_raw_receive()
とon_socket_raw_send()
がそのイベントです。 もしFalse
にしたのならこれらのイベントは呼ばれません。 (パフォーマンスを考慮したためです) これを有効にする場合はTrue
にしましょう。 デフォルトはFalse
です。バージョン 2.0 で追加.
http_trace (
aiohttp.TraceConfig
) --ライブラリが
aiohttp
を使用して行うHTTPリクエストの追跡に使用する設定。これを使用するとライブラリが行うリクエストを確認できます。詳細は aiohttp documentation を確認してください。バージョン 2.0 で追加.
max_ratelimit_timeout (Optional[
float
]) --グローバル以外のレート制限が発生したときに待機する最大秒数。 渡された秒数以上待たないといけない場合、
RateLimited
が発生します。デフォルトではタイムアウト制限はありません。 誤用や不要なBANを防ぐため、最小値は30.0
秒です。バージョン 2.0 で追加.
- ws¶
クライアントが現在接続しているWebSocketゲートウェイ。
None
でもかまいません。
- @event¶
受け取るイベントを登録するデコレータ。
イベントの詳細については 以下のドキュメント を参照してください。
イベントは coroutine でなければいけません。違う場合は
TypeError
が送出されます。サンプル
@client.event async def on_ready(): print('Ready!')
バージョン 2.0 で変更:
coro
引数は位置限定引数になりました。- 例外
TypeError -- 渡された関数がコルーチンでない場合。
- property latency¶
HEARTBEATとHEARTBEAT_ACK間の待ち時間を秒単位で測定します。
これはDiscord WebSocketプロトコルの待ち時間とも言えます。
- 型
- is_ws_ratelimited()¶
bool
: WebSocketにレート制限が課されているかどうかを指します。これはメンバーを取得する際、HTTPを利用するか、ゲートウェイを介して行うかを決定するときに知っておくと役立ちます。
バージョン 1.6 で追加.
- property user¶
接続されたクライアント。ログインしていない場合は
None
です。- 型
Optional[
ClientUser
]
- property stickers¶
接続したクライアントが持つスタンプ。
バージョン 2.0 で追加.
- 型
Sequence[
GuildSticker
]
- property private_channels¶
接続したクライアントが参加しているプライベートチャンネル。
注釈
Discordでのプライベートチャンネルの取扱いは内部的に処理されているため、これは最新のプライベートチャンネルから最大128個までしか取得できません。
- 型
Sequence[
abc.PrivateChannel
]
- property voice_clients¶
ボイス接続のリストを表します。
通常、
VoiceClient
インスタンスです。- 型
List[
VoiceProtocol
]
- property application_id¶
クライアントのアプリケーションID。
これが
__init__
で渡されなかった場合、データを含むイベントが発生した際にゲートウェイを介して、またはlogin()
の後に取得されます。通常はon_connect()
が呼び出された後です。バージョン 2.0 で追加.
- 型
Optional[
int
]
- property application_flags¶
クライアントのアプリケーションフラグ。
バージョン 2.0 で追加.
- property application¶
クライアントのアプリケーション情報。
これは
login()
で取得され、その後更新されません。これによりゲートウェイ接続を行わずにapplication_idを取得できます。もし
login()
の呼び出し前にアクセスされた場合はNone
です。参考
application_info()
API呼び出しバージョン 2.0 で追加.
- 型
Optional[
AppInfo
]
- await on_error(event_method, /, *args, **kwargs)¶
This function is a coroutine.
クライアントによって提供されるデフォルトのエラーハンドラ。
デフォルトでは、これはライブラリロガーに出力されますが、異なる実装によって上書きされる可能性があります。詳細については
on_error()
を確認してください。バージョン 2.0 で変更:
event_method
パラメータが位置限定引数になり、sys.stderr
に出力するのではなくログに記録するようになりました。
- await before_identify_hook(shard_id, *, initial=False)¶
This function is a coroutine.
セッションの識別前に呼び出されるフック。複数の識別クライアントの同期をより細かく制御したい場合に役立ちます。
デフォルトの実装では5秒間スリープします。
バージョン 1.4 で追加.
- await setup_hook()¶
This function is a coroutine.
ボットのセットアップのためのコルーチンです。デフォルトでは空です。
ボットがログインした後で、ウェブソケットに接続する前に非同期のセットアップを行いたい場合は、このコルーチンを上書きしてください。
これは
login()
にて一度だけ呼び出され、イベントが呼び出される前に呼び出されるため、on_ready()
より優れています。警告
これはWebSocket接続の 前に 呼ばれるため、WebSocketを待つ関数の呼び出しはデッドロックします。これには
wait_for()
やwait_until_ready()
が含まれます。バージョン 2.0 で追加.
- await login(token)¶
This function is a coroutine.
指定した資格情報を使用してクライアントにログインし、
setup_hook()
を呼び出します。- パラメータ
token (
str
) -- 認証用のトークン。このライブラリが処理するため、トークンの頭に何も付けないでください。- 例外
LoginFailure -- 不正な認証情報が渡された場合。
HTTPException -- 不明なHTTP関連のエラーが発生した場合。通常、ステータスコードが200でないか、既知の誤った資格情報が渡された場合です。
- await connect(*, reconnect=True)¶
This function is a coroutine.
WebSocket接続を作成し、Discordからのメッセージを受け取れるようにします。これはイベントシステム全体とライブラリの様々な機能を実行するループです。WebSocket接続が終了するまで、制御は再開されません。
- パラメータ
reconnect (
bool
) -- インターネットの障害やDiscord側の特定の障害が発生した際に再接続を試みるかどうか。不正な状態による特定の切断 (無効なシャーディングペイロードや不正なトークンなど) は処理されません。- 例外
GatewayNotFound -- Discordに接続するためのゲートウェイが見つからない場合。通常、この例外はDiscord APIの停止によって引き起こされます。
ConnectionClosed -- WebSocket接続が終了した場合。
- clear()¶
Botの内部状態をクリアします。
これが実行されると、Botは「再オープン」されたとみなされます。そのため、
is_closed()
やis_ready()
はFalse
を返し、内部のキャッシュもクリアされます。
- run(token, *, reconnect=True, log_handler=..., log_formatter=..., log_level=..., root_logger=False)¶
イベントループの初期化を抽象化するブロッキングコール。
イベントループをより詳細に制御するには、この関数を使用しないでください。
start()
またはconnect()
+login()
を使用してください。またこの関数は、初心者がライブラリの仕組みを知ることが簡単にできるよう logging ライブラリを設定します。より高度なユーザーは、
log_handler
にNone
を渡してこれを無効化することもできます。警告
この関数はブロッキングを行うため、必ず最後に呼び出してください。この関数を呼び出した後に呼び出されるイベントや関数は、Botが停止するまで実行されません。
- パラメータ
token (
str
) -- 認証用のトークン。このライブラリが処理するため、トークンの頭に何も付けないでください。reconnect (
bool
) -- インターネットの障害やDiscord側の特定の障害が発生した際に再接続を試みるかどうか。不正な状態による特定の切断 (無効なシャーディングペイロードや不正なトークンなど) は処理されません。log_handler (Optional[
logging.Handler
]) --ライブラリロガーにて使用すべきログハンドラ。もしこれが
None
の場合ライブラリはログ関連のセットアップを一切行いません。None
を渡してもログは記録されますが、設定は自己責任となります。渡されない場合のデフォルトは
logging.StreamHandler
です。バージョン 2.0 で追加.
log_formatter (
logging.Formatter
) --指定されたログハンドラで使用するフォーマッタ。渡されない場合は、既定で色ベースのログフォーマッタが使用されます (使用可能な場合)。
バージョン 2.0 で追加.
log_level (
int
) --ライブラリロガーの既定のログレベル。これは
log_handler
がNone
でない場合のみ適用されます。デフォルトはlogging.INFO
です。バージョン 2.0 で追加.
root_logger (
bool
) --ライブラリロガーではなくルートロガーを設定するかどうか。デフォルトではライブラリロガー (
'discord'
) のみが設定されています。 これがTrue
に設定されている場合、ルートロガーも設定されます。デフォルトでは
False
です。バージョン 2.0 で追加.
- property activity¶
ログイン時に使用されるアクティビティ。
- 型
Optional[
BaseActivity
]
- property allowed_mentions¶
許可されたメンションの設定。
バージョン 1.4 で追加.
- 型
Optional[
AllowedMentions
]
- get_channel(id, /)¶
与えられたIDに合致するチャンネルまたはスレッドを返します。
バージョン 2.0 で変更:
id
引数は位置限定引数になりました。- パラメータ
id (
int
) -- 検索するID。- 戻り値
チャンネル、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[Union[
abc.GuildChannel
,Thread
,abc.PrivateChannel
]]
- get_partial_messageable(id, *, guild_id=None, type=None)¶
与えられたチャンネルIDのPartialMessageableを返します。
これはチャンネルIDがあるがメッセージを送信するためにAPI呼び出しをしたくない、という場合に便利です。
バージョン 2.0 で追加.
- パラメータ
id (
int
) -- PartialMessageableを作成するためのチャンネルID。guild_id (Optional[
int
]) -- 部分的なメッセージ可能チャンネルを作成するためのオプションのギルドID。これはメッセージの送信には必須ではありませんが、jump_url()
やguild
プロパティが適切に動作するようになります。type (Optional[
ChannelType
]) -- PartialMessageableの基礎となるチャンネルタイプ。
- 戻り値
PartialMessageable
- 戻り値の型
- get_stage_instance(id, /)¶
与えられたステージチャンネルのIDを持つステージインスタンスを返します。
バージョン 2.0 で追加.
- パラメータ
id (
int
) -- 検索するID。- 戻り値
ステージインスタンス、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[
StageInstance
]
- get_guild(id, /)¶
与えられたIDのギルドを返します。
バージョン 2.0 で変更:
id
引数は位置限定引数になりました。
- get_user(id, /)¶
与えられたIDのユーザーを返します。
バージョン 2.0 で変更:
id
引数は位置限定引数になりました。
- get_emoji(id, /)¶
与えられたIDの絵文字を返します。
バージョン 2.0 で変更:
id
引数は位置限定引数になりました。
- get_sticker(id, /)¶
与えられたIDに合致するギルドスタンプを返します。
バージョン 2.0 で追加.
注釈
標準スタンプを取得するには、
fetch_sticker()
かfetch_premium_sticker_packs()
を使用してください。- 戻り値
スタンプが返ります。見つからなかった場合は
None
が返ります。- 戻り値の型
Optional[
GuildSticker
]
- for ... in get_all_channels()¶
クライアントが「アクセス」できるすべての
abc.GuildChannel
のジェネレータを取得します。使用例:
for guild in client.guilds: for channel in guild.channels: yield channel
注釈
abc.GuildChannel
を受け取ったからと言って、そのチャンネルで発言ができるという意味ではありません。発言可能なチャンネルのみを取得したいのなら、abc.GuildChannel.permissions_for()
を使いましょう。- 列挙
abc.GuildChannel
-- クライアントが「アクセスする」ことができるチャンネル。
- for ... in get_all_members()¶
クライアントが参照可能なすべての
Member
のジェネレータを返します。使用例:
for guild in client.guilds: for member in guild.members: yield member
- 列挙
Member
-- クライアントが見ることができるメンバー。
- await wait_until_ready()¶
This function is a coroutine.
クライアントの内部キャッシュの準備が完了するまで待機します。
警告
setup_hook()
内で呼び出すとデッドロックが起こります。
- wait_for(event, /, *, check=None, timeout=None)¶
This function is a coroutine.
WebSocketイベントがディスパッチされるまで待機します。
メッセージの送信者が、メッセージに返信したり、リアクションをつけたり、編集したりする、自己完結型の処理に利用できます。
timeout
パラメータはasyncio.wait_for()
に渡されます。デフォルトではタイムアウトしません。タイムアウトした際にasyncio.TimeoutError
が送出されるのは、使いやすさを考慮したためです。イベントが複数の引数を返す場合は、それらを含む
tuple
が代わりに返ります。イベントとそのパラメーターについては ドキュメント を参照してください。この関数は 条件を満たす最初のイベント を返します。
サンプル
ユーザーからの返信を待つ場合:
@client.event async def on_message(message): if message.content.startswith('$greet'): channel = message.channel await channel.send('Say hello!') def check(m): return m.content == 'hello' and m.channel == channel msg = await client.wait_for('message', check=check) await channel.send(f'Hello {msg.author}!')
メッセージ送信者がサムズアップリアクションを付けるのを待つ場合:
@client.event async def on_message(message): if message.content.startswith('$thumb'): channel = message.channel await channel.send('Send me that 👍 reaction, mate') def check(reaction, user): return user == message.author and str(reaction.emoji) == '👍' try: reaction, user = await client.wait_for('reaction_add', timeout=60.0, check=check) except asyncio.TimeoutError: await channel.send('👎') else: await channel.send('👍')
バージョン 2.0 で変更:
event
引数は位置限定引数になりました。- パラメータ
event (
str
) -- イベント名は イベントリファレンス に似ていますが接頭詞のon_
が必要ありません。check (Optional[Callable[...,
bool
]]) -- 待っているものに該当するかを確認する関数。引数は待機しているイベントのパラメータを満たしている必要があります。timeout (Optional[
float
]) -- タイムアウトしてasyncio.TimeoutError
が送出されるまでの秒数。
- 例外
asyncio.TimeoutError -- タイムアウトが設定されていて、かつその時間が経過した場合。
- 戻り値
単一の引数、あるいは イベントリファレンス のパラメータを反映した複数の引数の値を含む
tuple
が返ります。返る引数がない場合もあります。- 戻り値の型
Any
- await change_presence(*, activity=None, status=None)¶
This function is a coroutine.
クライアントのプレゼンスを変更します。
サンプル
game = discord.Game("with the API") await client.change_presence(status=discord.Status.idle, activity=game)
バージョン 2.0 で変更: キーワード専用引数
afk
を削除しました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
activity (Optional[
BaseActivity
]) -- 実行中のアクティビティ。何も実行していない場合はNone
です。status (Optional[
Status
]) -- 変更するステータスを示します。None
の場合、Status.online
となります。
- 例外
TypeError --
activity
パラメータが適切な型でない場合。
- async for ... in fetch_guilds(*, limit=200, before=None, after=None, with_counts=True)¶
Botが所属するGuildを取得できる、 asynchronous iterator を取得します。
注釈
これを使用した場合、各
Guild
のGuild.owner
、Guild.icon
、Guild.id
、Guild.name
、Guild.approximate_member_count
、およびGuild.approximate_presence_count
のみ受け取ります。注釈
これはAPIを呼び出します。通常は
guilds
を代わりに使用してください。サンプル
使い方
async for guild in client.fetch_guilds(limit=150): print(guild.name)
リストへフラット化
guilds = [guild async for guild in client.fetch_guilds(limit=150)] # guilds is now a list of Guild...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) --取得するギルドの数。
None
の場合、Botがアクセスできるギルドすべてを取得します。ただし、これには時間が掛かることに注意してください。デフォルトは200です。バージョン 2.0 で変更: デフォルトが200に変更されました。
before (Union[
abc.Snowflake
,datetime.datetime
]) -- 渡された日付、またはギルドより前のギルドを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Union[
abc.Snowflake
,datetime.datetime
]) -- 渡された日付、またはギルドより後のギルドを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。with_counts (
bool
) --ギルドにカウント情報を含めるかどうか。これを使うことで特権インテントがなくても
Guild.approximate_member_count
とGuild.approximate_presence_count
属性が設定されます。デフォルトはTrue
です。バージョン 2.3 で追加.
- 例外
HTTPException -- ギルドの取得に失敗した場合。
- 列挙
Guild
-- データを解析したGuild。
- await fetch_template(code)¶
This function is a coroutine.
discord.new URL またはコードから
Template
を取得します。- パラメータ
code (Union[
Template
,str
]) -- DiscordテンプレートコードまたはURL (discord.new URLである必要があります)。- 例外
NotFound -- 無効なテンプレートである場合。
HTTPException -- テンプレートの取得に失敗した場合。
- 戻り値
URL/コードからのテンプレート。
- 戻り値の型
- await fetch_guild(guild_id, /, *, with_counts=True)¶
This function is a coroutine.
IDから
Guild
を取得します。注釈
これを使用した場合、
Guild.channels
、Guild.members
及び、各Member
のMember.activity
とMember.voice
を取得することはできません。注釈
このメソッドはAPIを呼び出します。通常は
get_guild()
を代わりとして使用してください。バージョン 2.0 で変更: 引数
guild_id
は位置専用引数となりました。- パラメータ
guild_id (
int
) -- 取得したいギルドのID。with_counts (
bool
) --ギルドにカウント情報を含めるかどうか。これを使うことで特権インテントがなくても
Guild.approximate_member_count
とGuild.approximate_presence_count
属性が設定されます。デフォルトはTrue
です。バージョン 2.0 で追加.
- 例外
NotFound -- The guild doesn't exist or you got no access to it.
HTTPException -- ギルドの取得に失敗した場合。
- 戻り値
IDから取得したギルド。
- 戻り値の型
- await create_guild(*, name, icon=..., code=...)¶
This function is a coroutine.
Guild
を作成します。10以上のギルドに参加しているBotアカウントはギルドの作成ができません。
バージョン 2.0 で変更:
name
とicon
パラメータはキーワード限定引数になりました。region
パラメータは削除されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
name (
str
) -- ギルドの名前。icon (Optional[
bytes
]) -- アイコンを表す bytes-like object です。ClientUser.edit()
で、予期されるデータの詳細を確認してください。code (
str
) --Guildを作成するためのテンプレートのコード。
バージョン 1.4 で追加.
- 例外
HTTPException -- ギルドの作成に失敗した場合。
ValueError -- Guildのアイコンの画像形式が無効だった時。画像は、PNGまたはJPGである必要があります。
- 戻り値
作成されたギルド。キャッシュに追加されるギルドとは別物です。
- 戻り値の型
- await fetch_stage_instance(channel_id, /)¶
This function is a coroutine.
ステージチャンネルのIDの
StageInstance
を取得します。バージョン 2.0 で追加.
- パラメータ
channel_id (
int
) -- ステージチャンネルのID- 例外
NotFound -- ステージインスタンスまたはチャンネルが見つからなかった場合
HTTPException -- ステージインスタンスの取得に失敗した場合
- 戻り値
ステージチャンネルIDで取得したステージインスタンス
- 戻り値の型
- await fetch_invite(url, *, with_counts=True, with_expiration=True, scheduled_event_id=None)¶
This function is a coroutine.
Invite
をdiscord.gg URLやIDから取得します。注釈
もしBotがInviteのGuildに参加していない場合、
Invite
のguildとchannel属性はそれぞれPartialInviteGuild
とPartialInviteChannel
になります。- パラメータ
url (Union[
Invite
,str
]) -- Discordの招待ID、またはURL (discord.gg URLである必要があります)。with_counts (
bool
) -- 招待にカウントの情報を含めるかどうか。これによりInvite.approximate_member_count
とInvite.approximate_presence_count
が追加されます。with_expiration (
bool
) --招待の有効期限を含めるかどうか。有効期限は
Invite.expires_at
に代入されます。バージョン 2.0 で追加.
scheduled_event_id (Optional[
int
]) --招待に紐づいたスケジュールイベントのID。
注釈
このパラメーターを使用している場合は、
event_url
パラメーターを含むURLを渡すことはできません。バージョン 2.0 で追加.
- 例外
ValueError -- URLに
event_id
が含まれているのに、scheduled_event_id
も渡された場合。NotFound -- 招待の有効期限が切れたか無効の場合。
HTTPException -- 招待の取得に失敗した場合。
- 戻り値
URL/IDから取得した招待。
- 戻り値の型
- await delete_invite(invite, /)¶
This function is a coroutine.
Invite
や、招待のURL、IDを削除します。これを行うには、関連付けられたGuildにて、
manage_channels
が必要です。バージョン 2.0 で変更:
invite
引数は位置限定引数になりました。- パラメータ
- 例外
Forbidden -- 削除する権限がない場合。
NotFound -- 招待が無効または期限切れの場合。
HTTPException -- 招待の取り消しに失敗した場合。
- await fetch_widget(guild_id, /)¶
This function is a coroutine.
ギルドIDから
Widget
を取得します。注釈
この情報を取得するためには、ギルドのウィジェットを有効化しておく必要があります。
バージョン 2.0 で変更: 引数
guild_id
は位置専用引数となりました。- パラメータ
guild_id (
int
) -- ギルドのID。- 例外
Forbidden -- Guildのウィジェットが無効になっている場合。
HTTPException -- ウィジェットの取得に失敗した場合。
- 戻り値
ギルドのウィジェット。
- 戻り値の型
- await application_info()¶
This function is a coroutine.
Botのアプリケーション情報を取得します。
- 例外
HTTPException -- 情報の取得に失敗した場合。
- 戻り値
Botのアプリケーション情報。
- 戻り値の型
- await fetch_user(user_id, /)¶
This function is a coroutine.
IDをもとに
User
を取得します。そのユーザーとギルドを共有する必要はありませんが、操作の多くはそれを必要とします。注釈
このメソッドはAPIを呼び出します。
discord.Intents.members
とメンバーキャッシュを有効化している場合は、get_user()
の使用を検討してください。バージョン 2.0 で変更:
user_id
引数は位置限定引数になりました。- パラメータ
user_id (
int
) -- 取得したいユーザーのID。- 例外
NotFound -- この ID を持つユーザーが存在しない場合。
HTTPException -- ユーザーの取得に失敗した場合。
- 戻り値
あなたがリクエストしたユーザー。
- 戻り値の型
- await fetch_channel(channel_id, /)¶
This function is a coroutine.
指定されたIDを持つ
abc.GuildChannel
、abc.PrivateChannel
、またはThread
を取得します。注釈
このメソッドはAPIを呼び出します。通常は
get_channel()
を代わりとして使用してください。バージョン 1.2 で追加.
バージョン 2.0 で変更:
channel_id
引数は位置限定引数になりました。- 例外
InvalidData -- まだ定義されていないチャンネルタイプがDiscord Apiから受信された場合。
HTTPException -- チャンネルの取得に失敗した場合。
NotFound -- 引数が無効なチャンネル IDである場合。
Forbidden -- このチャンネルからメッセージを取得する権限がない場合。
- 戻り値
IDから取得したチャンネル。
- 戻り値の型
Union[
abc.GuildChannel
,abc.PrivateChannel
,Thread
]
- await fetch_webhook(webhook_id, /)¶
This function is a coroutine.
特定のIDの
Webhook
を取得します。バージョン 2.0 で変更:
webhook_id
引数は位置限定引数になりました。- 例外
HTTPException -- Webhookの取得に失敗した場合。
NotFound -- 無効なWebhookのIDだった場合。
Forbidden -- Webhookを取得する権限がない場合。
- 戻り値
要求したWebhook。
- 戻り値の型
- await fetch_sticker(sticker_id, /)¶
This function is a coroutine.
特定のIDの
Sticker
を取得します。バージョン 2.0 で追加.
- 例外
HTTPException -- スタンプの取得に失敗した場合。
NotFound -- スタンプIDが無効な場合。
- 戻り値
要求されたスタンプ。
- 戻り値の型
Union[
StandardSticker
,GuildSticker
]
- await fetch_skus()¶
This function is a coroutine.
Retrieves the bot's available SKUs.
バージョン 2.4 で追加.
- 例外
MissingApplicationID -- The application ID could not be found.
HTTPException -- Retrieving the SKUs failed.
- 戻り値
The bot's available SKUs.
- 戻り値の型
List[
SKU
]
- await fetch_entitlement(entitlement_id, /)¶
This function is a coroutine.
Retrieves a
Entitlement
with the specified ID.バージョン 2.4 で追加.
- パラメータ
entitlement_id (
int
) -- The entitlement's ID to fetch from.- 例外
NotFound -- An entitlement with this ID does not exist.
MissingApplicationID -- The application ID could not be found.
HTTPException -- Fetching the entitlement failed.
- 戻り値
The entitlement you requested.
- 戻り値の型
- async for ... in entitlements(*, limit=100, before=None, after=None, skus=None, user=None, guild=None, exclude_ended=False)¶
Retrieves an asynchronous iterator of the
Entitlement
that applications has.バージョン 2.4 で追加.
サンプル
使い方
async for entitlement in client.entitlements(limit=100): print(entitlement.user_id, entitlement.ends_at)
リストへフラット化
entitlements = [entitlement async for entitlement in client.entitlements(limit=100)] # entitlements is now a list of Entitlement...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- The number of entitlements to retrieve. IfNone
, it retrieves every entitlement for this application. Note, however, that this would make it a slow operation. Defaults to100
.before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- Retrieve entitlements before this date or entitlement. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- Retrieve entitlements after this date or entitlement. If a datetime is provided, it is recommended to use a UTC aware datetime. If the datetime is naive, it is assumed to be local time.skus (Optional[Sequence[
Snowflake
]]) -- A list of SKUs to filter by.user (Optional[
Snowflake
]) -- The user to filter by.guild (Optional[
Snowflake
]) -- The guild to filter by.exclude_ended (
bool
) -- Whether to exclude ended entitlements. Defaults toFalse
.
- 例外
MissingApplicationID -- The application ID could not be found.
HTTPException -- Fetching the entitlements failed.
TypeError --
after
とbefore
の両方が渡された場合。Discordはこのタイプのページネーションをサポートしていません。
- 列挙
Entitlement
-- The entitlement with the application.
- await create_entitlement(sku, owner, owner_type)¶
This function is a coroutine.
Creates a test
Entitlement
for the application.バージョン 2.4 で追加.
- パラメータ
sku (
Snowflake
) -- The SKU to create the entitlement for.owner (
Snowflake
) -- The ID of the owner.owner_type (
EntitlementOwnerType
) -- The type of the owner.
- 例外
MissingApplicationID -- The application ID could not be found.
NotFound -- The SKU or owner could not be found.
HTTPException -- Creating the entitlement failed.
This function is a coroutine.
利用可能なプレミアムスタンプパックをすべて取得します。
バージョン 2.0 で追加.
- 例外
HTTPException -- スタンプパックの取得に失敗した場合。
- 戻り値
利用可能なプレミアムスタンプパックすべて。
- 戻り値の型
List[
StickerPack
]
- await create_dm(user)¶
This function is a coroutine.
このユーザーと
DMChannel
を作成します。これは、ほとんどの人にとっては自動で行われるため、呼び出す必要はめったにありません。
バージョン 2.0 で追加.
- add_dynamic_items(*items)¶
Registers
DynamicItem
classes for persistent listening.This method accepts class types rather than instances.
バージョン 2.4 で追加.
- パラメータ
*items (Type[
DynamicItem
]) -- The classes of dynamic items to add.- 例外
TypeError -- A class is not a subclass of
DynamicItem
.
- remove_dynamic_items(*items)¶
Removes
DynamicItem
classes from persistent listening.This method accepts class types rather than instances.
バージョン 2.4 で追加.
- パラメータ
*items (Type[
DynamicItem
]) -- The classes of dynamic items to remove.- 例外
TypeError -- A class is not a subclass of
DynamicItem
.
- add_view(view, *, message_id=None)¶
View
を永続的にインタラクションを受け取るために登録します。このメソッドは、ビューがプログラムのライフサイクルを超えて存在するコンポーネントで構成されている場合に利用すべきです。
バージョン 2.0 で追加.
- パラメータ
view (
discord.ui.View
) -- ディスパッチするために登録するビュー。message_id (Optional[
int
]) -- ビューが添付されたメッセージID。これは現在、ビューの状態をメッセージ更新のイベント後に更新するのに使用されています。与えられていない場合はメッセージ更新のイベントはビューに伝播されません。
- 例外
TypeError -- ビューが渡されない場合。
ValueError -- ビューが永続しないか、すでに終了している場合。永続するビューにはタイムアウトがなく、すべてのコンポーネントに明示的に渡された custom_id があります。
AutoShardedClient¶
- asyncchange_presence
- asyncclose
- asyncconnect
- defget_shard
- defis_ws_ratelimited
- class discord.AutoShardedClient(*args, intents, **kwargs)¶
このクライアントは
Client
に似ていますが、複雑なシャーディングの処理をユーザーに変わって処理し、管理しやすく、かつ透過的なシングルプロセスのボットとして動かせるようにするという点が異なります。このクライアントは、実装に関して内部的に複数のシャードに分割されていても、単一のシャードの通常の
Client
のように使用することができます。これにより、IPCやその他の複雑なインフラストラクチャへの対処を行う必要がなくなります。少なくとも1000を超えるギルドに参加していいる場合にのみ、このクライアントを使用することを推奨します。
shard_count
が指定されていない場合、ライブラリはBot Gatewayのエンドポイント呼び出しを使用して使用するシャードの数を見つけ出します。shard_ids
パラメータが指定されている場合、それらのシャードIDが内部シャードの起動時に使用されます。これを使用する場合shard_count
の指定が必須です。このパラメータを省略した場合は、クライアントは0からshard_count - 1
までのシャードを起動します。- async with x
非同期的にクライアントを初期化し自動でクリーンアップします。
バージョン 2.0 で追加.
- shard_connect_timeout¶
The maximum number of seconds to wait before timing out when launching a shard. Defaults to 180 seconds.
バージョン 2.4 で追加.
- 型
Optional[
float
]
- property latency¶
HEARTBEATとHEARTBEAT_ACK間の待ち時間を秒単位で測定します。
これは
Client.latency()
と同様に機能しますが、すべてのシャードの平均待ち時間を使用する点が異なります。シャードの待ち時間のリストを取得するにはlatencies
プロパティを参照してください。準備ができていない場合はnan
を返します。- 型
- property latencies¶
HEARTBEATとHEARTBEAT_ACK間の待ち時間を秒単位で測定したもののリストです。
これは、
(shard_id, latency)
の要素を持つタプルのリストを返します。
- get_shard(shard_id, /)¶
渡されたシャードIDのシャード情報を取得します。見つからない場合は
None
が返ります。バージョン 2.0 で変更: 引数
shard_id
は位置専用引数となりました。- 戻り値
渡されたシャードIDのシャード情報。見つからない場合は
None
が返ります。- 戻り値の型
Optional[
ShardInfo
]
- await connect(*, reconnect=True)¶
This function is a coroutine.
WebSocket接続を作成し、Discordからのメッセージを受け取れるようにします。これはイベントシステム全体とライブラリの様々な機能を実行するループです。WebSocket接続が終了するまで、制御は再開されません。
- パラメータ
reconnect (
bool
) -- インターネットの障害やDiscord側の特定の障害が発生した際に再接続を試みるかどうか。不正な状態による特定の切断 (無効なシャーディングペイロードや不正なトークンなど) は処理されません。- 例外
GatewayNotFound -- Discordに接続するためのゲートウェイが見つからない場合。通常、この例外はDiscord APIの停止によって引き起こされます。
ConnectionClosed -- WebSocket接続が終了した場合。
- await change_presence(*, activity=None, status=None, shard_id=None)¶
This function is a coroutine.
クライアントのプレゼンスを変更します。
例:
game = discord.Game("with the API") await client.change_presence(status=discord.Status.idle, activity=game)
バージョン 2.0 で変更: キーワード専用引数
afk
を削除しました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
activity (Optional[
BaseActivity
]) -- 実行中のアクティビティ。何も実行していない場合はNone
です。status (Optional[
Status
]) -- 変更するステータスを示します。None
の場合、Status.online
となります。shard_id (Optional[
int
]) -- プレゼンスを変更したいシャードのshard_id。指定されていない、またはNone
が渡された場合はBotがアクセスできるすべてのシャードのプレゼンスが変更されます。
- 例外
TypeError --
activity
パラメータが適切な型でない場合。
- is_ws_ratelimited()¶
bool
: WebSocketにレート制限が課されているかどうかを指します。これはメンバーを取得する際、HTTPを利用するか、ゲートウェイを介して行うかを決定するときに知っておくと役立ちます。
この実装は、シャードのいずれかがレート制限下にあるかどうかを確認します。より細かな制御が行いたい場合は
ShardInfo.is_ws_ratelimited()
の使用を検討してください。バージョン 1.6 で追加.
アプリケーション情報¶
AppInfo¶
- asyncedit
- class discord.AppInfo¶
Discordが提供するBotのアプリケーション情報。
- primary_sku_id¶
このアプリケーションがDiscord上で販売されているゲームの場合、この属性は作成された「Game SKU」が存在する場合は、そのIDになります。
バージョン 1.3 で追加.
- 型
Optional[
int
]
- slug¶
このアプリケーションがDiscord上で販売されているゲームの場合、この属性はストアページにリンクするURLのスラッグになります。
バージョン 1.3 で追加.
- 型
Optional[
str
]
- install_params¶
有効な場合、アプリケーションのカスタム認可URLの設定。
バージョン 2.0 で追加.
- 型
Optional[
AppInstallParams
]
- role_connections_verification_url¶
アプリケーションをギルドのロール紐づけ設定にて紐づけ方法として扱うようにするための、アプリケーションの接続確認URL。
バージョン 2.2 で追加.
- 型
Optional[
str
]
- interactions_endpoint_url¶
設定されている場合、ゲートウェイではなくエンドポイントからインタラクションを受け取るアプリケーションの、インタラクションエンドポイントのURI。
バージョン 2.4 で追加.
- 型
Optional[
str
]
- property cover_image¶
存在する場合は、ストアの埋め込みのカバー画像を取得します。
これはアプリケーションがDiscordで販売されているゲームの場合にのみ利用できます。
- 型
Optional[
Asset
]
- property guild¶
このアプリケーションがDiscord上で販売されているゲームの場合、この属性は紐づけられたギルドになります。
バージョン 1.3 で追加.
- 型
Optional[
Guild
]
- property flags¶
アプリケーションのフラグ。
バージョン 2.0 で追加.
- await edit(*, reason=..., custom_install_url=..., description=..., role_connections_verification_url=..., install_params_scopes=..., install_params_permissions=..., flags=..., icon=..., cover_image=..., interactions_endpoint_url=..., tags=...)¶
This function is a coroutine.
Edits the application info.
バージョン 2.4 で追加.
- パラメータ
custom_install_url (Optional[
str
]) -- The new custom authorization URL for the application. Can beNone
to remove the URL.description (Optional[
str
]) -- The new application description. Can beNone
to remove the description.role_connections_verification_url (Optional[
str
]) -- The new application’s connection verification URL which will render the application as a verification method in the guild’s role verification configuration. Can beNone
to remove the URL.install_params_scopes (Optional[List[
str
]]) -- The new list of OAuth2 scopes of theinstall_params
. Can beNone
to remove the scopes.install_params_permissions (Optional[
Permissions
]) -- The new permissions of theinstall_params
. Can beNone
to remove the permissions.flags (Optional[
ApplicationFlags
]) --The new application’s flags. Only limited intent flags (
gateway_presence_limited
,gateway_guild_members_limited
,gateway_message_content_limited
) can be edited. Can beNone
to remove the flags.警告
Editing the limited intent flags leads to the termination of the bot.
icon (Optional[
bytes
]) -- The new application’s icon as a bytes-like object. Can beNone
to remove the icon.cover_image (Optional[
bytes
]) -- The new application’s cover image as a bytes-like object on a store embed. The cover image is only available if the application is a game sold on Discord. Can beNone
to remove the image.interactions_endpoint_url (Optional[
str
]) -- The new interactions endpoint url of the application to receive interactions over this endpoint rather than over the gateway. Can beNone
to remove the URL.tags (Optional[List[
str
]]) -- The new list of tags describing the functionality of the application. Can beNone
to remove the tags.reason (Optional[
str
]) -- The reason for editing the application. Shows up on the audit log.
- 例外
HTTPException -- Editing the application failed
ValueError -- The image format passed in to
icon
orcover_image
is invalid. This is also raised wheninstall_params_scopes
andinstall_params_permissions
are incompatible with each other.
- 戻り値
The newly updated application info.
- 戻り値の型
PartialAppInfo¶
- class discord.PartialAppInfo¶
create_invite()
により与えられた部分的なAppInfo。バージョン 2.0 で追加.
- interactions_endpoint_url¶
設定されている場合、ゲートウェイではなくエンドポイントからインタラクションを受け取るアプリケーションの、インタラクションエンドポイントのURI。
バージョン 2.3 で追加.
- 型
Optional[
str
]
- role_connections_verification_url¶
アプリケーションをギルドのロール紐づけ設定にて紐づけ方法として扱うようにするための、アプリケーションの接続確認URL。
バージョン 2.3 で追加.
- 型
Optional[
str
]
- property cover_image¶
存在する場合は、アプリケーションの既定のリッチプレゼンスのカバー画像を取得します。
これはアプリケーションがDiscordで販売されているゲームの場合にのみ利用できます。
バージョン 2.3 で追加.
- 型
Optional[
Asset
]
- property flags¶
アプリケーションのフラグ。
バージョン 2.0 で追加.
AppInstallParams¶
- class discord.AppInstallParams¶
アプリケーションのカスタム認可URLの設定。
バージョン 2.0 で追加.
- scopes¶
アプリケーションをギルドに追加するときの OAuth2 スコープ のリスト。
- 型
List[
str
]
- permissions¶
ギルドに追加するアプリケーションに与える権限。
Team¶
TeamMember¶
- defmentioned_in
- class discord.TeamMember¶
チームのメンバー。
- x == y
二つのチームメンバーが等しいかを比較します。
- x != y
二つのチームメンバーが等しくないかを比較します。
- hash(x)
チームメンバーのハッシュ値を返します。
- str(x)
チームメンバーのハンドル(例えば
name
やname#discriminator
など)を返します。
バージョン 1.3 で追加.
- membership_state¶
メンバーの参加状態 (例:招待されたか、承認されたか)
- role¶
The role of the member within the team.
バージョン 2.4 で追加.
- property accent_color¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_colour
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property accent_colour¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_color
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property avatar¶
ユーザーのアバターの
Asset
を返します。ユーザーがグローバルのアバターをアップロードしていない場合は、
None
が返されます。ユーザーが表示しているアバターを取得したい場合は、display_avatar
を検討してください。- 型
Optional[
Asset
]
- property avatar_decoration¶
Returns an
Asset
for the avatar decoration the user has.If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
Asset
]
- property avatar_decoration_sku_id¶
Returns the SKU ID of the avatar decoration the user has.
If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
int
]
- property banner¶
利用できる場合、ユーザーのバナーのアセットを返します。
バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Asset
]
- property color¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。colour
という名前のエイリアスが存在します。- 型
- property colour¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。color
という名前のエイリアスが存在します。- 型
- property created_at¶
ユーザーの作成された時間をUTCで返します。
これはユーザーのDiscordアカウントが作成された時間です。
- property display_avatar¶
ユーザーの表示されるアバターを返します。
通常のユーザーの場合は、これはデフォルトのアバターか、アップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- property display_name¶
ユーザーの表示名を返します。
通常であれば、これはグローバル表示名またはユーザー名がそのまま返りますが、ギルドにてニックネームを設定している場合は、代替としてニックネームが返ります。
- 型
- mentioned_in(message)¶
指定のメッセージにユーザーに対するメンションが含まれているかを確認します。
- property public_flags¶
ユーザーが持っている公開のフラグ。
イベントリファレンス¶
この項目では Client
が受け取る様々なイベントについて説明します。
イベントを登録する方法は二通りあります。一つ目は Client.event()
を使用する方法です。二つ目は Client
を継承してサブクラスを作り、イベントをオーバーライドする方法です。この方法を用いた場合は以下のようになります:
import discord
class MyClient(discord.Client):
async def on_message(self, message):
if message.author == self.user:
return
if message.content.startswith('$hello'):
await message.channel.send('Hello World!')
イベントハンドラが例外を発生させると、それを処理するために on_error()
が呼び出されます。 デフォルトではトレースバックがログに記録され、例外は無視されます。
警告
すべてのイベントは coroutine である必要があります。 coroutine でない場合、予期せぬエラーが発生する可能性があります。関数をコルーチンにするには、関数定義の際に async def
を使用してください。
アプリケーションコマンド¶
- discord.on_raw_app_command_permissions_update(payload)¶
アプリケーションコマンドの権限が更新されたときに呼び出されます。
バージョン 2.0 で追加.
- パラメータ
payload (
RawAppCommandPermissionsUpdateEvent
) -- 生のイベントペイロードデータ。
- discord.on_app_command_completion(interaction, command)¶
app_commands.Command
またはapp_commands.ContextMenu
がエラーなく正常に実行したときに呼び出されます。バージョン 2.0 で追加.
- パラメータ
interaction (
Interaction
) -- コマンドのインタラクション。command (Union[
app_commands.Command
,app_commands.ContextMenu
]) -- 正常に実行されたコマンド。
AutoMod¶
- discord.on_automod_rule_create(rule)¶
AutoModRule
が作成されたときに呼び出されます。 受け取るにはmanage_guild
が必要です。Intents.auto_moderation_configuration
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
rule (
AutoModRule
) -- 作成されたルール。
- discord.on_automod_rule_update(rule)¶
AutoModRule
が更新されたときに呼び出されます。 受け取るにはmanage_guild
が必要です。Intents.auto_moderation_configuration
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
rule (
AutoModRule
) -- 変更されたルール。
- discord.on_automod_rule_delete(rule)¶
AutoModRule
が削除されたときに呼び出されます。 受け取るにはmanage_guild
が必要です。Intents.auto_moderation_configuration
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
rule (
AutoModRule
) -- 削除されたルール。
- discord.on_automod_action(execution)¶
AutoModAction
が作成/実行されたときに呼び出されます。 受け取るにはmanage_guild
が必要です。Intents.auto_moderation_execution
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
execution (
AutoModAction
) -- 行われたルールの実行。
Channels¶
- discord.on_guild_channel_delete(channel)¶
- discord.on_guild_channel_create(channel)¶
ギルドのチャンネルが削除・作成されたとき呼び出されます。
ギルドは
guild
で取得できます。Intents.guilds
を有効にする必要があります。- パラメータ
channel (
abc.GuildChannel
) -- 作成、または削除されたギルドチャンネル。
- discord.on_guild_channel_update(before, after)¶
ギルドチャンネルが更新されるたびに呼び出されます。例えば名前、トピック、権限の変更などです。
Intents.guilds
を有効にする必要があります。- パラメータ
before (
abc.GuildChannel
) -- 更新されたギルドの更新前情報。after (
abc.GuildChannel
) -- 更新されたギルドの更新後情報。
- discord.on_guild_channel_pins_update(channel, last_pin)¶
ギルドチャンネルのメッセージがピン留めされたり、解除されたりしたときに呼び出されます。
Intents.guilds
を有効にする必要があります。- パラメータ
channel (Union[
abc.GuildChannel
,Thread
]) -- ピン留めが更新されたギルドチャンネル。last_pin (Optional[
datetime.datetime
]) -- 最後にピン留めされたメッセージがピン留めされたUTC aware datetime。None
の場合もあります。
- discord.on_private_channel_update(before, after)¶
プライベートグループDMが更新されたとき呼び出されます。 例: 名前やトピックの変更。
Intents.messages
を有効にする必要があります。- パラメータ
before (
GroupChannel
) -- 更新されたグループチャンネルの更新前情報。after (
GroupChannel
) -- 更新されたグループチャンネルの更新後情報。
- discord.on_private_channel_pins_update(channel, last_pin)¶
プライベートチャンネルのメッセージがピン留めされたりはずされたりしたときに呼ばれます。
- パラメータ
channel (
abc.PrivateChannel
) -- ピン留めが更新されたプライベートチャンネル。last_pin (Optional[
datetime.datetime
]) -- 最後にピン留めされたメッセージがピン留めされたUTC aware datetime。None
の場合もあります。
- discord.on_typing(channel, user, when)¶
誰かがメッセージを入力し始めたときに呼び出されます。
channel
パラメータはabc.Messageable
インスタンスにすることができます。TextChannel
、GroupChannel
、またはDMChannel
のいずれかです。channel
がTextChannel
である場合、user
パラメータはMember
、それ以外の場合はUser
です。チャンネルまたはユーザーが内部キャッシュで見つからない場合、このイベントは呼び出されません。代わりに
on_raw_typing()
を使用してください。Intents.typing
を有効にする必要があります。- パラメータ
channel (
abc.Messageable
) -- 入力が行われたチャンネル。when (
datetime.datetime
) -- UTCのaware datetimeでの、タイピングの開始時刻。
- discord.on_raw_typing(payload)¶
誰かがメッセージを入力し始めたときに呼び出されます。
on_typing()
とは異なり、これはチャンネルやユーザーが内部キャッシュに存在するかどうかに関係なく呼び出されます。Intents.typing
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawTypingEvent
) -- 生のイベントペイロードデータ。
Connection¶
- discord.on_connect()¶
クライアントがDiscordに正常に接続できたときに呼び出されます。クライアントの準備が完了していることと同義ではありません。
on_ready()
を参照してください。on_ready()
での警告も適用されます。
- discord.on_disconnect()¶
クライアントがDiscordから切断したときと、Discordへの接続の試行が失敗した場合に呼び出されます。これはインターネットが切断された、明示的にcloseメソッドを呼び出した、またはDiscord側から何らかの方法で切断されたというような場合に呼び出される可能性があります。
この関数は対応する
on_connect()
なしで複数回呼び出されることがあります。
- discord.on_shard_connect(shard_id)¶
特定のシャードIDを持つシャードがDiscordに接続したかどうかを確認するために
AutoShardedClient
で使用されることを除けばon_connect()
とほとんど同じです。バージョン 1.4 で追加.
- パラメータ
shard_id (
int
) -- 接続したシャードのID。
- discord.on_shard_disconnect(shard_id)¶
特定のシャードIDを持つシャードがDiscordから切断したかどうかを確認するために
AutoShardedClient
で使用されることを除けばon_disconnect()
とほとんど同じです。バージョン 1.4 で追加.
- パラメータ
shard_id (
int
) -- 切断したシャードのID。
Debug¶
- discord.on_error(event, *args, **kwargs)¶
イベントがキャッチされない例外を発生させた場合、通常はトレースバックがstderrに記録され、その例外は無視されます。何らかの理由でこの動作を変更して、自分自身で例外処理を行いたい場合は、このイベントをオーバーライドすることができます。これを行った場合、トレースバックを出力するというデフォルトの動作は行われません。
発生した例外の情報と、例外事態は
sys.exc_info()
への標準呼び出しで取得できます。注釈
on_error
はClient.event()
でのみディスパッチされます。Client.wait_for()
や、使用している場合はlisten()
やlistener()
といった Bot のリスナーでは受信されません。バージョン 2.0 で変更: トレースバックが出力されず、ログに記録されるようになりました。
- パラメータ
event (
str
) -- 例外を発生させたイベントの名前。args -- 例外を発生させたイベントの位置引数。
kwargs -- 例外を発生させたイベントのキーワード引数。
- discord.on_socket_event_type(event_type)¶
WebSocketからWebSocketイベントが受信されるたびに呼び出されます。
これは主にDiscordゲートウェイから受け取るイベントの数を記録するのに便利です。
バージョン 2.0 で追加.
- パラメータ
event_type (
str
) -- Discordから受信されたイベントの種類。例:'READY'
。
- discord.on_socket_raw_receive(msg)¶
メッセージが処理され、パースされる前、WebSocketからメッセージが完全に受信されるたびに呼び出されます。このイベントは完全なメッセージを受信した場合に呼び出され、渡されたデータは一切パースされていません。
これはWebSocketストリームを取得してデバッグする時のみに役に立ちます。
使用する場合は
Client
にてenable_debug_events
を設定しないといけません。注釈
これは、クライアントWebSocketから受信したメッセージ専用です。音声WebSocketではこのイベントは実行されません。
- パラメータ
msg (
str
) -- WebSocketライブラリから渡されたメッセージ。
Entitlements¶
- discord.on_entitlement_create(entitlement)¶
Called when a user subscribes to a SKU.
バージョン 2.4 で追加.
- パラメータ
entitlement (
Entitlement
) -- The entitlement that was created.
- discord.on_entitlement_update(entitlement)¶
Called when a user updates their subscription to a SKU. This is usually called when the user renews or cancels their subscription.
バージョン 2.4 で追加.
- パラメータ
entitlement (
Entitlement
) -- The entitlement that was updated.
- discord.on_entitlement_delete(entitlement)¶
Called when a users subscription to a SKU is cancelled. This is typically only called when:
Discord issues a refund for the subscription.
Discord removes an entitlement from a user.
警告
This event won't be called if the user cancels their subscription manually, instead
on_entitlement_update()
will be called withEntitlement.ends_at
set to the end of the current billing period.バージョン 2.4 で追加.
- パラメータ
entitlement (
Entitlement
) -- The entitlement that was deleted.
Gateway¶
- discord.on_ready()¶
クライアントがDiscordから受信したデータの準備を完了した際に呼び出されます。通常はログインが成功したあと、
Client.guilds
とそれに関連するものの準備が完了したときです。警告
このイベントは、最初に呼び出されるイベントとは限りません。同時に、このイベントは 一度だけ呼ばれるという保証もできません 。このライブラリは、再接続ロジックを実装しているためリジューム要求が失敗するたびにこのイベントが呼び出されることになります。
- discord.on_resumed()¶
クライアントがセッションを再開したときに呼び出されます。
- discord.on_shard_ready(shard_id)¶
特定の Shard IDが準備完了になったかを確認するために
AutoShardedClient
で使用される以外はon_ready()
とほとんど同じです。- パラメータ
shard_id (
int
) -- 準備が完了したShard ID。
- discord.on_shard_resumed(shard_id)¶
特定のシャードIDを持つシャードがセッションを再開したかどうかを確認するために
AutoShardedClient
で使用されることを除けばon_resumed()
とほとんど同じです。バージョン 1.4 で追加.
- パラメータ
shard_id (
int
) -- セッションが再開したシャードのID。
Guilds¶
- discord.on_guild_available(guild)¶
ギルドが利用可能・不可能になったときに呼び出されます。ギルドは
Client.guilds
キャッシュに存在していないといけません。Intents.guilds
を有効にする必要があります。- パラメータ
guild -- 利用状況が変わった
Guild
。
- discord.on_guild_join(guild)¶
Client
によってGuild
が作成された。またはClient
がギルドに参加したときに呼び出されます。Intents.guilds
を有効にする必要があります。- パラメータ
guild (
Guild
) -- 参加したギルド。
- discord.on_guild_remove(guild)¶
Client
がGuild
から削除されたときに呼び出されます。これは以下の状況時に呼び出されますが、これに限ったものではありません:
クライアントがBANされた。
クライアントがキックされた。
クライアントがギルドから脱退した。
クライアント、またはギルドオーナーがギルドを削除した。
このイベントが呼び出されるためには、
Client
がギルドに参加している必要があります。(つまり、Client.guilds
にギルドが存在しなければならない)Intents.guilds
を有効にする必要があります。- パラメータ
guild (
Guild
) -- 削除されたギルド。
- discord.on_guild_update(before, after)¶
Guild
が更新されたときに呼び出されます。例えば:名前が変更された
AFKチャンネルが変更された
AFKのタイムアウト時間が変更された
その他
Intents.guilds
を有効にする必要があります。
- discord.on_guild_emojis_update(guild, before, after)¶
Guild
にEmoji
が追加、または削除されたときに呼び出されます。Intents.emojis_and_stickers
を有効にする必要があります。
- discord.on_guild_stickers_update(guild, before, after)¶
Guild
のスタンプが更新されたときに呼び出されます。Intents.emojis_and_stickers
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
guild (
Guild
) -- スタンプが更新されたギルド。before (Sequence[
GuildSticker
]) -- 更新前のスタンプのリスト。after (Sequence[
GuildSticker
]) -- 更新後のスタンプのリスト。
- discord.on_audit_log_entry_create(entry)¶
Guild
に新しい監査ログ項目が追加されたときに呼び出されます。これを受け取るにはview_audit_log
が必要です。Intents.moderation
を有効にする必要があります。バージョン 2.2 で追加.
警告
ゲートウェイ経由で取得した監査ログ項目はデータをRESTではなくキャッシュから取得します。このため、一部のデータが不足している場合があります。例えば、
AuditLogEntry.target
属性は多くの場合discord.Object
になり、AuditLogEntry.user
属性はユーザーとメンバーキャッシュに依存します。項目のユーザーIDを取得するには、代わりに
AuditLogEntry.user_id
を使用できます。- パラメータ
entry (
AuditLogEntry
) -- 作成された監査ログの項目。
- discord.on_invite_create(invite)¶
Invite
が作成されたときに呼び出されます。 受け取るにはmanage_channels
が必要です。バージョン 1.3 で追加.
注釈
まれに
Invite.guild
とInvite.channel
属性がそれぞれの本来のモデルではなくObject
になることがあります。Intents.invites
を有効にする必要があります。- パラメータ
invite (
Invite
) -- 作成された招待。
- discord.on_invite_delete(invite)¶
Invite
が削除されたときに呼び出されます。 受け取るにはmanage_channels
が必要です。バージョン 1.3 で追加.
注釈
まれに
Invite.guild
とInvite.channel
属性がそれぞれの本来のモデルではなくObject
になることがあります。これらの属性以外では、Discordゲートウェイによってこのイベントに与えられているのが保証されている属性は
Invite.code
のみです。Intents.invites
を有効にする必要があります。- パラメータ
invite (
Invite
) -- 削除された招待。
Integrations¶
- discord.on_integration_create(integration)¶
連携サービスが作成されたときに呼び出されます。
Intents.integrations
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
integration (
Integration
) -- 作成された連携サービス。
- discord.on_integration_update(integration)¶
連携サービスが更新されたときに呼び出されます。
Intents.integrations
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
integration (
Integration
) -- 更新された連携サービス。
- discord.on_guild_integrations_update(guild)¶
ギルドの連携サービスが作成、更新、削除されるたびに呼び出されます。
Intents.integrations
を有効にする必要があります。バージョン 1.4 で追加.
- パラメータ
guild (
Guild
) -- 連携サービスが更新されたギルド。
- discord.on_webhooks_update(channel)¶
ギルドチャンネルのWebhookが作成、更新、削除されたときに呼び出されます。
Intents.webhooks
を有効にする必要があります。- パラメータ
channel (
abc.GuildChannel
) -- Webhookが更新されたチャンネル。
- discord.on_raw_integration_delete(payload)¶
連携サービスが削除されたときに呼び出されます。
Intents.integrations
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawIntegrationDeleteEvent
) -- 生のイベントペイロードデータ。
Interactions¶
- discord.on_interaction(interaction)¶
インタラクションが発生したときに呼び出されます。
これは、現在はスラッシュコマンドの呼び出しやコンポーネントの使用により起こります。
警告
これは、一般的な使用を意図していない低レベル関数です。コンポーネントを使用している場合は、よりよいユーザーエクスペリエンスを提供する
View
のコールバックの使用を検討してください。バージョン 2.0 で追加.
- パラメータ
interaction (
Interaction
) -- インタラクションデータ。
Members¶
- discord.on_member_join(member)¶
Member
がGuild
に参加したときに呼び出されます。Intents.members
を有効にする必要があります。- パラメータ
member (
Member
) -- 参加したメンバー。
- discord.on_member_remove(member)¶
Member
がGuild
から脱退したときに呼び出されます。ギルドまたはメンバーが内部キャッシュで見つからない場合、このイベントは呼び出されません。代わりに
on_raw_member_remove()
を使用してください。Intents.members
を有効にする必要があります。- パラメータ
member (
Member
) -- 脱退したメンバー。
- discord.on_raw_member_remove(payload)¶
Member
がGuild
から脱退したときに呼び出されます。on_member_remove()
とは異なり、ギルドやメンバーが内部キャッシュに存在するかどうかに関係なく呼び出されます。Intents.members
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawMemberRemoveEvent
) -- 生のイベントペイロードデータ。
- discord.on_member_update(before, after)¶
Member
のプロフィールが更新されたときに呼び出されます。これらのうちひとつ以上が変更されたとき呼び出されます:
ニックネーム
roles
ペンディング状態
タイムアウト
ギルドアバター
flags
Discordの制限により、このイベントはメンバーのタイムアウト期間が満了した場合には発生しません。
Intents.members
を有効にする必要があります。
- discord.on_user_update(before, after)¶
User
がプロフィールを編集したとき呼び出されます。これらのうちひとつ以上が変更されたとき呼び出されます:
アバター
ユーザー名
タグ
Intents.members
を有効にする必要があります。
- discord.on_member_ban(guild, user)¶
Called when a user gets banned from a
Guild
.Intents.moderation
を有効にする必要があります。
- discord.on_member_unban(guild, user)¶
User
がGuild
のBANを解除されたとき呼び出されます。Intents.moderation
を有効にする必要があります。
- discord.on_presence_update(before, after)¶
Member
がプレゼンスを変更したとき呼び出されます。これらのうちひとつ以上が変更されたとき呼び出されます:
ステータス
アクティビティ
これを使用するには
Intents.presences
とIntents.members
を有効にしないといけません。バージョン 2.0 で追加.
Messages¶
- discord.on_message(message)¶
Message
が作成され送信されたときに呼び出されます。Intents.messages
を有効にする必要があります。警告
Botのメッセージとプライベートメッセージはこのイベントを通して送信されます。Botのプログラムによっては「再帰呼び出し」を続けることになります。Botが自分自身に返信しないようにするためにはユーザーIDを確認する方法が考えられます。
Bot
にはこの問題は存在しません。- パラメータ
message (
Message
) -- 現在のメッセージ。
- discord.on_message_edit(before, after)¶
Message
が更新イベントを受け取ったときに呼び出されます。メッセージが内部のメッセージキャッシュに見つからない場合、このイベントは呼び出されません。これはメッセージが古すぎるか、クライアントが通信の多いギルドに参加している場合に発生します。発生する場合は
max_messages
パラメータの値を増加させるかon_raw_message_edit()
イベントを使用してください。以下の非網羅的ケースがこのイベントを発生させます:
メッセージをピン留め、または解除した。
メッセージの内容を変更した。
メッセージが埋め込みを受け取った。
パフォーマンス上の理由から、埋め込みのサーバーはこれを「一貫した」方法では行いません。
メッセージの埋め込みが削除されたり、復元されたりした。
通話呼び出しメッセージの参加者や終了時刻が変わった。
Intents.messages
を有効にする必要があります。
- discord.on_message_delete(message)¶
メッセージが削除された際に呼び出されます。メッセージが内部のメッセージキャッシュに見つからない場合、このイベントは呼び出されません。これはメッセージが古すぎるか、クライアントが通信の多いギルドに参加している場合に発生します。
発生する場合は
max_messages
パラメータの値を増加させるかon_raw_message_delete()
イベントを使用してください。Intents.messages
を有効にする必要があります。- パラメータ
message (
Message
) -- 削除されたメッセージ。
- discord.on_bulk_message_delete(messages)¶
メッセージが一括削除されたときに呼び出されます。メッセージが内部のメッセージキャッシュに見つからない場合、このイベントは呼び出されません。個々のメッセージが見つからない場合でも、このイベントは呼び出されますが、見つからなかったメッセージはメッセージのリストに含まれません。これはメッセージが古すぎるか、クライアントが通信の多いギルドに参加している場合に発生します。
発生する場合は
max_messages
パラメータの値を増加させるかon_raw_bulk_message_delete()
イベントを使用してください。Intents.messages
を有効にする必要があります。- パラメータ
messages (List[
Message
]) -- 削除されたメッセージのリスト。
- discord.on_raw_message_edit(payload)¶
メッセージが編集されたときに呼び出されます。
on_message_edit()
とは異なり、これは内部のメッセージキャッシュの状態に関係なく呼び出されます。メッセージがメッセージキャッシュに存在した場合、
RawMessageUpdateEvent.cached_message
を介してそのメッセージにアクセスすることができます。キャッシュされていたメッセージは編集前のメッセージです。たとえば、メッセージの内容が編集され、on_raw_message_edit()
が発火された場合、RawMessageUpdateEvent.cached_message
は内容が編集される前の情報を持つMessage
オブジェクトを返します。Due to the inherently raw nature of this event, the data parameter coincides with the raw data given by the gateway.
データのペイロードが部分的であるため、データにアクセスするときは気をつけてください。部分的なデータの主な場合のひとつは、
'content'
にアクセスできない場合です。Discordの埋め込みサーバーによって、埋め込みが更新される、"埋め込み"しか変わっていない編集がそうです。Intents.messages
を有効にする必要があります。- パラメータ
payload (
RawMessageUpdateEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_message_delete(payload)¶
メッセージが削除されたときに呼び出されます。
on_message_delete()
とは異なり、削除されたメッセージが内部キャッシュに存在するか否かにかかわらず呼び出されます。メッセージがメッセージキャッシュ内に見つかった場合、
RawMessageDeleteEvent.cached_message
を介してアクセスすることができます。Intents.messages
を有効にする必要があります。- パラメータ
payload (
RawMessageDeleteEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_bulk_message_delete(payload)¶
メッセージが一括削除されたときに呼び出されます。
on_bulk_message_delete()
とは異なり、削除されたメッセージが内部キャッシュに存在するか否かにかかわらず呼び出されます。メッセージがメッセージキャッシュ内に見つかった場合、
RawBulkMessageDeleteEvent.cached_messages
を介してアクセスすることができます。Intents.messages
を有効にする必要があります。- パラメータ
payload (
RawBulkMessageDeleteEvent
) -- 生のイベントペイロードデータ。
Reactions¶
- discord.on_reaction_add(reaction, user)¶
メッセージにリアクションが追加されたときに呼び出されます。
on_message_edit()
と同様に内部メッセージキャッシュにメッセージが見つからない場合は、このイベントは呼び出されません。代わりにon_raw_reaction_add()
の利用を検討してください。注釈
リアクションの付いた
Message
を取得するには、Reaction.message
を使ってください。Intents.reactions
を有効にする必要があります。注釈
ギルド内では
Intents.members
は有効にしなくてもよいですが、DiscordがDM内では更新されたユーザーの情報を提供しないため、DMではこのインテントが必要です。 このイベントが必要でメンバーインテントを有効化したくない場合はon_raw_reaction_add()
の使用を検討してください。警告
This event does not have a way of differentiating whether a reaction is a burst reaction (also known as "super reaction") or not. If you need this, consider using
on_raw_reaction_add()
instead.
- discord.on_reaction_remove(reaction, user)¶
メッセージのリアクションが取り除かれたときに呼び出されます。on_message_editのように、内部のメッセージキャッシュにメッセージがないときには、このイベントは呼び出されません。
注釈
リアクションの付いたメッセージを取得するには、
Reaction.message
を使ってください。これを使用するには
Intents.reactions
とIntents.members
の両方を有効にしないといけません。注釈
このイベントが必要でメンバーインテントを有効化したくない場合は
on_raw_reaction_remove()
の使用を検討してください。警告
This event does not have a way of differentiating whether a reaction is a burst reaction (also known as "super reaction") or not. If you need this, consider using
on_raw_reaction_remove()
instead.
- discord.on_reaction_clear(message, reactions)¶
メッセージからすべてのリアクションが削除されたときに呼び出されます。
on_message_edit()
と同様に内部メッセージキャッシュにメッセージが見つからない場合は、このイベントは呼び出されません。代わりにon_raw_reaction_clear()
の利用を検討してください。Intents.reactions
を有効にする必要があります。
- discord.on_reaction_clear_emoji(reaction)¶
メッセージから特定の絵文字のリアクションが除去されたときに呼び出されます。
on_message_edit()
と同様に内部メッセージキャッシュにメッセージが見つからない場合は、このイベントは呼び出されません。代わりにon_raw_reaction_clear_emoji()
の利用を検討してください。Intents.reactions
を有効にする必要があります。バージョン 1.3 で追加.
- パラメータ
reaction (
Reaction
) -- 除去されたリアクション。
- discord.on_raw_reaction_add(payload)¶
メッセージにリアクションが追加されたときに呼び出されます。
on_reaction_add()
とは異なり、これは内部のメッセージキャッシュの状態に関係なく呼び出されます。Intents.reactions
を有効にする必要があります。- パラメータ
payload (
RawReactionActionEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_reaction_remove(payload)¶
メッセージからリアクションが削除されたときに呼び出されます。
on_reaction_remove()
とは異なり、これは内部メッセージキャッシュの状態に関係なく呼び出されます。Intents.reactions
を有効にする必要があります。- パラメータ
payload (
RawReactionActionEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_reaction_clear(payload)¶
メッセージからリアクションがすべて削除されたときに呼び出されます。
on_reaction_clear()
とは異なり、これは内部メッセージキャッシュの状態に関係なく呼び出されます。Intents.reactions
を有効にする必要があります。- パラメータ
payload (
RawReactionClearEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_reaction_clear_emoji(payload)¶
メッセージから特定の絵文字のリアクションがすべて除去されたときに呼び出されます。
on_reaction_clear_emoji()
とは異なり、これは内部メッセージキャッシュの状態に関係なく呼び出されます。Intents.reactions
を有効にする必要があります。バージョン 1.3 で追加.
- パラメータ
payload (
RawReactionClearEmojiEvent
) -- 生のイベントペイロードデータ。
Roles¶
- discord.on_guild_role_create(role)¶
- discord.on_guild_role_delete(role)¶
Guild
でRole
が新しく作成されたか、削除されたときに呼び出されます。ギルドを取得するには
Role.guild
を使用してください。Intents.guilds
を有効にする必要があります。- パラメータ
role (
Role
) -- 作成、または削除されたロール。
- discord.on_guild_role_update(before, after)¶
Role
がギルド全体で変更されたときに呼び出されます。Intents.guilds
を有効にする必要があります。
Scheduled Events¶
- discord.on_scheduled_event_create(event)¶
- discord.on_scheduled_event_delete(event)¶
ScheduledEvent
が作成または削除されたときに呼び出されます。Intents.guild_scheduled_events
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
event (
ScheduledEvent
) -- 作成、または削除されたスケジュールイベント。
- discord.on_scheduled_event_update(before, after)¶
ScheduledEvent
が変更されたときに呼び出されます。Intents.guild_scheduled_events
を有効にする必要があります。これらの場合に限りませんが、例を挙げると、以下の場合に呼び出されます:
スケジュールされた開始・終了時刻が変更された。
チャンネルが変更された時。
説明が変更された時。
ステータスが変更された時。
画像が変更された時。
バージョン 2.0 で追加.
- パラメータ
before (
ScheduledEvent
) -- 変更前のスケジュールイベント。after (
ScheduledEvent
) -- 変更後のスケジュールイベント。
- discord.on_scheduled_event_user_add(event, user)¶
- discord.on_scheduled_event_user_remove(event, user)¶
ScheduledEvent
からユーザーが追加または削除されたときに呼び出されます。Intents.guild_scheduled_events
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
event (
ScheduledEvent
) -- ユーザーが追加または削除されたスケジュールイベント。user (
User
) -- 追加・削除されたユーザー。
Stages¶
- discord.on_stage_instance_create(stage_instance)¶
- discord.on_stage_instance_delete(stage_instance)¶
StageChannel
のStageInstance
が作成または削除されたときに呼び出されます。バージョン 2.0 で追加.
- パラメータ
stage_instance (
StageInstance
) -- 作成、または削除されたステージインスタンス。
- discord.on_stage_instance_update(before, after)¶
StageInstance
が変更されたときに呼び出されます。これらの場合に限りませんが、例を挙げると、以下の場合に呼び出されます:
トピックが変更された時。
プライバシーレベルが変更された時。
バージョン 2.0 で追加.
- パラメータ
before (
StageInstance
) -- 更新前のステージインスタンス。after (
StageInstance
) -- 更新後のステージインスタンス。
Threads¶
- discord.on_thread_create(thread)¶
スレッドが作成されたときに発生します。
ギルドは
Thread.guild
から取得できます。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
thread (
Thread
) -- 作成されたスレッド。
- discord.on_thread_join(thread)¶
スレッドに参加したときに呼び出されます。
ギルドは
Thread.guild
から取得できます。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
thread (
Thread
) -- 参加したスレッド。
- discord.on_thread_update(before, after)¶
スレッドが更新されたときに呼び出されます。スレッドが内部キャッシュに見つからなかった場合、このイベントは呼び出されません。 スレッドがアーカイブされている場合、キャッシュには含まれません。
この情報が必要な場合は、代わりに
on_raw_thread_update()
を使用してください。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- discord.on_thread_remove(thread)¶
スレッドが除去されたときに呼び出されます。これはスレッドの削除とは異なります。
ギルドは
Thread.guild
から取得できます。Intents.guilds
を有効にする必要があります。警告
技術的な制約のためこのイベントは期待通りの早さで呼び出されない場合があります。ライブラリーがスレッドの参加をローカルで追跡するため、APIは更新されたスレッドの参加状態をスレッドの参加時にのみ同期します。
バージョン 2.0 で追加.
- パラメータ
thread (
Thread
) -- 削除されたスレッド。
- discord.on_thread_delete(thread)¶
スレッドが削除されたときに呼び出されます。スレッドが内部キャッシュに見つからなかった場合、このイベントは呼び出されません。 スレッドがアーカイブされている場合、キャッシュには含まれません。
この情報が必要な場合は、代わりに
on_raw_thread_delete()
を使用してください。ギルドは
Thread.guild
から取得できます。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
thread (
Thread
) -- 削除されたスレッド。
- discord.on_raw_thread_update(payload)¶
スレッドが更新されたときに呼び出されます。
on_thread_update()
とは異なり、更新されたスレッドが内部キャッシュに存在するか否かにかかわらず呼び出されます。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawThreadUpdateEvent
) -- 生のイベントペイロードデータ。
- discord.on_raw_thread_delete(payload)¶
スレッドが削除されたときに呼び出されます。
on_thread_delete()
とは異なり、削除されたスレッドが内部キャッシュに存在するか否かにかかわらず呼び出されます。Intents.guilds
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawThreadDeleteEvent
) -- 生のイベントペイロードデータ。
- discord.on_thread_member_join(member)¶
- discord.on_thread_member_remove(member)¶
ThreadMember
がThread
に参加したり退出したりしたときに呼び出されます。メンバーが所属するスレッドは
ThreadMember.thread
から取得できます。Intents.members
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
member (
ThreadMember
) -- 参加、または脱退したメンバー。
- discord.on_raw_thread_member_remove(payload)¶
ThreadMember
がThread
を退出したときに呼び出されます。on_thread_member_remove()
とは異なり、メンバーが内部スレッドメンバーキャッシュに存在するかどうかに関係なく呼び出されます。Intents.members
を有効にする必要があります。バージョン 2.0 で追加.
- パラメータ
payload (
RawThreadMembersUpdate
) -- 生のイベントペイロードデータ。
Voice¶
- discord.on_voice_state_update(member, before, after)¶
Member
がVoiceState
を変更したとき呼び出されます。これらの場合に限りませんが、例を挙げると、以下の場合に呼び出されます:
メンバーがボイスチャンネルやステージチャンネルに参加したとき。
メンバーがボイスチャンネルやステージチャンネルから退出したとき。
メンバーが自身でマイクやスピーカーをミュートしたとき。
メンバーがギルドの管理者によってマイクやスピーカーをミュートされたとき。
Intents.voice_states
を有効にする必要があります。- パラメータ
member (
Member
) -- ボイスの状態が変わった Member 。before (
VoiceState
) -- 更新前のボイス状態。after (
VoiceState
) -- 更新後のボイス状態。
ユーティリティ関数¶
- discord.utils.find(predicate, iterable, /)¶
与えられた関数を満たす最初の要素を返すヘルパー。例:
member = discord.utils.find(lambda m: m.name == 'Mighty', channel.guild.members)
は、名前が'Mighty'である最初に見つかった
Member
を返します。見つからない場合はNone
を返します。これは、適切な値を見つけると止まる点で、
filter()
と異なります。バージョン 2.0 で変更: 両方の引数は位置限定引数になりました。
バージョン 2.0 で変更:
iterable
パラメータが asynchronous iterable をサポートするようになりました。- パラメータ
predicate -- 真偽値を返す関数。
iterable (Union[
collections.abc.Iterable
,collections.abc.AsyncIterable
]) -- 検索する反復可能オブジェクト。collections.abc.AsyncIterable
を使用する場合は、この関数は coroutine を返します。
- discord.utils.get(iterable, /, **attrs)¶
attrs
に渡されたすべての条件を満たす最初の要素を返すヘルパー。find()
の代替案です。複数の条件が指定されている場合、またはではなくかつでチェックされます。つまり、どれかではなく、すべての条件を満たさないといけません。
ネストされている属性で検索するとき (例:
x.y
で検索) は、キーワード引数にx__y
を渡してください。与えられた属性にマッチする項目がない場合、
None
を返します。バージョン 2.0 で変更:
iterable
引数は位置限定引数になりました。バージョン 2.0 で変更:
iterable
パラメータが asynchronous iterable をサポートするようになりました。サンプル
基本的な使用法:
member = discord.utils.get(message.guild.members, name='Foo')
複数の属性のマッチ:
channel = discord.utils.get(guild.voice_channels, name='Foo', bitrate=64000)
ネストされた属性のマッチ:
channel = discord.utils.get(client.get_all_channels(), guild__name='Cool', name='general')
非同期イテラブル:
msg = await discord.utils.get(channel.history(), author__name='Dave')
- パラメータ
iterable (Union[
collections.abc.Iterable
,collections.abc.AsyncIterable
]) -- 検索する反復可能オブジェクト。collections.abc.AsyncIterable
を使用する場合は、この関数は coroutine を返します。**attrs -- 検索用の属性を表すキーワード引数。
- discord.utils.setup_logging(*, handler=..., formatter=..., level=..., root=True)¶
logging をセットアップするためのヘルパー関数。
これは見た目は
logging.basicConfig()
に似ていますが、異なる既定値と、ストリームが色を表示できる場合は、カラーフォーマッタを使用します。これは
Client
にてlog_handler
がNone
でない場合に、logging を設定するため使用されます。バージョン 2.0 で追加.
- パラメータ
handler (
logging.Handler
) -- ライブラリのロガーに使用するログハンドラ。指定されていない場合のデフォルトのログハンドラはlogging.StreamHandler
です。formatter (
logging.Formatter
) -- 指定されたログハンドラで使用するフォーマッタ。指定されていない場合は、既定で色ベースのログフォーマッタが使用されます (使用可能な場合)。 色が使用できない場合は、単純な logging フォーマッタが使用されます。level (
int
) -- ライブラリのロガーのデフォルトのログレベル。デフォルトはlogging.INFO
です。root (
bool
) -- ライブラリロガーではなくルートロガーを設定するかどうか。Client
のデフォルトとは異なり、このデフォルトはTrue
です。
- await discord.utils.maybe_coroutine(f, *args, **kwargs)¶
This function is a coroutine.
コルーチンの場合は関数の結果を待ち、そうでない場合は結果を返すヘルパー関数。
これは、コルーチンかもしれない関数と一緒に使用すると役立ちます。
バージョン 2.2 で追加.
- パラメータ
f (Callable[..., Any]) -- 呼び出す関数またはコルーチン。
*args -- 関数に渡す引数。
**kwargs -- 関数に渡すキーワード引数。
- 戻り値
関数またはコルーチンの結果。
- 戻り値の型
Any
- discord.utils.snowflake_time(id, /)¶
与えられたスノーフレークの生成時刻を返します。
バージョン 2.0 で変更:
id
引数は位置限定引数になりました。- パラメータ
id (
int
) -- スノーフレークID。- 戻り値
スノーフレークの作成時間を表すUTC aware datetime。
- 戻り値の型
- discord.utils.time_snowflake(dt, /, *, high=False)¶
指定された時刻に作成されるスノーフレークの数値を返します。
範囲の下端として使用する場合は、
time_snowflake(dt, high=False) - 1
を使用するとこの時刻を含み、high=True
を使用した場合は含まなくなります。範囲の上限として使用する場合は、
time_snowflake(dt, high=True) + 1
を使用するとこの時刻を含み、high=False
を使用した場合は含まなくなります。バージョン 2.0 で変更:
high
パラメータがキーワード専用引数になり、dt
パラメータは位置限定引数になりました。- パラメータ
dt (
datetime.datetime
) -- スノーフレークに変換するdatetimeオブジェクト。日付が「naive」である場合、これは地域時間であるとみなされます。high (
bool
) -- 下位22ビットをセットするか。
- 戻り値
与えられた時刻を表すスノーフレーク。
- 戻り値の型
- discord.utils.oauth_url(client_id, *, permissions=..., guild=..., redirect_uri=..., scopes=..., disable_guild_select=False, state=...)¶
ボットをギルドに招待するOAuth2 URLを返すヘルパー関数。
バージョン 2.0 で変更:
permissions
、guild
、redirect_uri
、scopes
、state
引数はキーワード限定引数になりました。- パラメータ
permissions (
Permissions
) -- 要求する権限。もし与えられていない場合、権限を要求しません。guild (
Snowflake
) -- 利用できる場合は、認証画面であらかじめ選択されるギルド。redirect_uri (
str
) -- 任意の有効なリダイレクトURI。scopes (Iterable[
str
]) --省略可能な有効なスコープのリスト。既定値は
('bot', 'applications.commands')
。バージョン 1.7 で追加.
disable_guild_select (
bool
) --ユーザーがギルドのドロップダウンを変更できないようにするか。
バージョン 2.0 で追加.
state (
str
) --認可後に返すステート。
バージョン 2.0 で追加.
- 戻り値
Botをギルドに招待するためのOAuth2 URL。
- 戻り値の型
- discord.utils.remove_markdown(text, *, ignore_links=True)¶
マークダウン文字を除去するヘルパー関数。
バージョン 1.7 で追加.
注釈
この関数はマークダウンを解釈するものでないため、元のテキストから意味のある文字を除去する場合があります。たとえば、入力に
10 * 5
が含まれる場合、10 5
に変換されます。
- discord.utils.escape_markdown(text, *, as_needed=False, ignore_links=True)¶
Discordのマークダウンをエスケープするヘルパー関数。
- パラメータ
text (
str
) -- マークダウンをエスケープするテキスト。as_needed (
bool
) -- 必要に応じてマークダウンをエスケープするかどうか。必要でなければ無関係な文字をエスケープしません。**hello**
は\*\*hello\*\*
ではなく\*\*hello**
にエスケープされます。ただし、これによって巧妙な構文の乱用が発生する可能性があります。デフォルトはFalse
です。ignore_links (
bool
) -- マークダウンをエスケープするときにリンクを残すかどうか。たとえば、テキスト中のURLが_
のような文字を含む場合、これは残されます。これはas_needed
と併用できません。デフォルトはTrue
です。
- 戻り値
マークダウンの特殊文字をスラッシュでエスケープしたテキスト。
- 戻り値の型
- discord.utils.escape_mentions(text)¶
everyone、here、ロールとユーザーのメンションをエスケープするヘルパー関数。
注釈
チャンネルのメンションはエスケープしません。
注釈
メッセージ内でエスケープされるべきメンションを詳細に制御するには、
AllowedMentions
クラスを参照してください。
- class discord.ResolvedInvite¶
discord.utils.resolve_invite()
から返された解決済みの招待を表すデータクラス。
- discord.utils.resolve_invite(invite)¶
Invite
やURL、コードから招待を解決します。バージョン 2.0 で変更:
str
の代わりにResolvedInvite
を返すようになりました。- パラメータ
- 戻り値
招待コードとイベントIDを含むデータクラス。
- 戻り値の型
- await discord.utils.sleep_until(when, result=None)¶
This function is a coroutine.
指定された時間までスリープします。
過去の時間が与えられた場合この関数は即座に返します。
バージョン 1.3 で追加.
- パラメータ
when (
datetime.datetime
) -- スリープを終了するタイムスタンプ。datetimeがnaiveである場合は、ローカル時間であると推定されます。result (Any) -- 渡された場合、コルーチンが完了した場合に返されます。
- discord.utils.utcnow()¶
現在時刻を表す UTC aware datetime を返すヘルパー関数。
これは、naive datetimeを返す標準ライブラリと異なりaware datetimeを返すため、
datetime.datetime.utcnow()
より推奨されています。バージョン 2.0 で追加.
- 戻り値
現在のUTC aware datetime。
- 戻り値の型
- discord.utils.format_dt(dt, /, style=None)¶
Discord内での表示用に
datetime.datetime
をフォーマットするヘルパー関数。これにより、Discord特有のMarkdownを使用したロケールに依存しないデータの表示が可能になります。
スタイル
出力例
説明
t
22:57
短縮された時間
T
22:57:58
短縮しない時間
d
17/05/2016
短縮された日付
D
17 May 2016
短縮しない日付
f (デフォルト)
17 May 2016 22:57
短縮された日時
F
Tuesday, 17 May 2016 22:57
短縮しない日時
R
5 years ago
相対時間
なお、正確な出力はユーザーのクライアントのローケル設定によります。この例は
en-GB
ローケルを使用しています。バージョン 2.0 で追加.
- パラメータ
dt (
datetime.datetime
) -- フォーマットするdatetime。style (
str
) -- datetimeをフォーマットするスタイル。
- 戻り値
フォーマットされた文字列。
- 戻り値の型
- discord.utils.as_chunks(iterator, max_size)¶
イテレーターを与えられたサイズのチャンクにまとめるヘルパー関数。
バージョン 2.0 で追加.
- パラメータ
iterator (Union[
collections.abc.Iterable
,collections.abc.AsyncIterable
]) -- チャンクするイテレーター。同期でも非同期でもよいです。max_size (
int
) -- チャンクの最大サイズ。
警告
最後のチャンクのサイズは
max_size
未満の場合があります。- 戻り値
指定されたサイズのチャンクを生成する新しいイテレータ。
- 戻り値の型
Union[
Iterator
,AsyncIterator
]
- discord.utils.MISSING¶
ライブラリで見つからないものを表現するために使用されるタイプセーフなセンチネル型。
None
値と区別するために使用されます。バージョン 2.0 で追加.
列挙型¶
APIは、文字列が将来変わることに備え、文字列を直書きするのを防ぐために、いくらかの文字列の列挙型を提供します。
列挙型はすべて enum.Enum
の動作を模倣した内部クラスのサブクラスです。
- class discord.ChannelType¶
特定チャンネルのチャンネルタイプ。
- text¶
テキストチャンネル。
- voice¶
ボイスチャンネル。
- private¶
プライベートのテキストチャンネル。ダイレクトメッセージとも呼ばれています。
- group¶
プライベートのグループDM。
- category¶
カテゴリチャンネル。
- news¶
ギルドのニュースチャンネル。
- stage_voice¶
ギルドのステージボイスチャンネル。
バージョン 1.7 で追加.
- news_thread¶
ニューススレッド。
バージョン 2.0 で追加.
- public_thread¶
パブリックスレッド。
バージョン 2.0 で追加.
- private_thread¶
プライベートスレッド。
バージョン 2.0 で追加.
- forum¶
フォーラムチャンネル。
バージョン 2.0 で追加.
- media¶
A media channel.
バージョン 2.4 で追加.
- class discord.MessageType¶
Message
のタイプを指定します。これは、メッセージが通常のものかシステムメッセージかを判断するのに使用できます。- x == y
二つのメッセージが等しいかを比較します。
- x != y
二つのメッセージが等しくないかを比較します。
- default¶
デフォルトのメッセージ。これは通常のメッセージと同じです。
- recipient_add¶
ユーザーがグループプライベートメッセージまたはスレッドに追加されたときのシステムメッセージ。
- recipient_remove¶
ユーザーがグループプライベートメッセージまたはスレッドから削除されたときのシステムメッセージ。
- call¶
通話の状態を示すシステムメッセージ。例: 不在着信、通話の開始、その他。
- channel_name_change¶
チャンネル名の変更を示すシステムメッセージ。
- channel_icon_change¶
チャンネルのアイコンの変更を示すシステムメッセージ。
- pins_add¶
ピン留めの追加を示すシステムメッセージ。
- new_member¶
ギルドの新規メンバーの参加を示すシステムメッセージ。
メンバーがギルドを「ニトロブースト」したことを表すシステムメッセージ。
メンバーがギルドを「ニトロブースト」し、それによってギルドがレベル1に到達したことを表すシステムメッセージ。
メンバーがギルドを「ニトロブースト」し、それによってギルドがレベル2に到達したことを表すシステムメッセージ。
メンバーがギルドを「ニトロブースト」し、それによってギルドがレベル3に到達したことを表すシステムメッセージ。
- channel_follow_add¶
アナウンスチャンネルがフォローされたことを表すシステムメッセージ。
バージョン 1.3 で追加.
- guild_stream¶
メンバーがギルドでストリーミングしていることを表すシステムメッセージ。
バージョン 1.7 で追加.
- guild_discovery_disqualified¶
ギルドがサーバー発見の資格を持たなくなったことを示すシステムメッセージ。
バージョン 1.7 で追加.
- guild_discovery_requalified¶
ギルドがサーバー発見の資格を再び持ったことを示すシステムメッセージ。
バージョン 1.7 で追加.
- guild_discovery_grace_period_initial_warning¶
ギルドが1週間サーバー発見の要件を満たすことに失敗したことを示すシステムメッセージ。
バージョン 1.7 で追加.
- guild_discovery_grace_period_final_warning¶
ギルドが連続で3週間サーバー発見の要件を満たすことに失敗したというシステムメッセージ。
バージョン 1.7 で追加.
- thread_created¶
スレッドが作成されたことを示すシステムメッセージ。これはスレッドが古いメッセージから作成されたときにのみ送信されます。メッセージが古いものとされる時間の閾値は信頼できずDiscord次第です。
バージョン 2.0 で追加.
- reply¶
送信者がメッセージに返信したことを示すシステムメッセージ。
バージョン 2.0 で追加.
- chat_input_command¶
スラッシュコマンドを実行したことを示すシステムメッセージ。
バージョン 2.0 で追加.
- guild_invite_reminder¶
人々をギルドに招待することのリマインダーとして送信されたシステムメッセージ。
バージョン 2.0 で追加.
- thread_starter_message¶
スレッドの会話を始めたメッセージであるスレッド内のメッセージを示すシステムメッセージ。
バージョン 2.0 で追加.
コンテキストメニューコマンドを実行したことを示すシステムメッセージ。
バージョン 2.0 で追加.
- auto_moderation_action¶
自動管理ルールが発動されたときに送信されるシステムメッセージ。ルールが発動されたときにアラートを送信するように設定されている場合にのみ送信されます。
バージョン 2.0 で追加.
- role_subscription_purchase¶
ユーザーがロールサブスクリプションを購入または更新したときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
ユーザーに対し、インタラクション中にアプリケーションのプレミアム版を購入する広告を表示するときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
- stage_start¶
ステージ開始時に送信されるシステムメッセージ。
バージョン 2.2 で追加.
- stage_end¶
ステージ終了時に送信されるシステムメッセージ。
バージョン 2.2 で追加.
- stage_speaker¶
ステージの発言者が変わるときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
- stage_raise_hand¶
ユーザーが挙手して発言許可を求めているときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
- stage_topic¶
ステージのトピックが変わるときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
アプリケーションのプレミアムサブスクリプションがギルドで購入されたときに送信されるシステムメッセージ。
バージョン 2.2 で追加.
- guild_incident_alert_mode_enabled¶
The system message sent when security actions is enabled.
バージョン 2.4 で追加.
- guild_incident_alert_mode_disabled¶
The system message sent when security actions is disabled.
バージョン 2.4 で追加.
- guild_incident_report_raid¶
The system message sent when a raid is reported.
バージョン 2.4 で追加.
- guild_incident_report_false_alarm¶
The system message sent when a false alarm is reported.
バージョン 2.4 で追加.
- class discord.UserFlags¶
Discordユーザーフラグを表します。
- staff¶
ユーザーはDiscordの従業員です。
- partner¶
ユーザーはDiscordパートナーです。
- hypesquad¶
ユーザーはHypeSquad Eventsメンバーです。
- bug_hunter¶
ユーザーはバグハンターです。
- mfa_sms¶
ユーザーの多要素認証のSMSリカバリーが有効になっています。
ユーザーはDiscord Nitroプロモーションを無視しました。
- hypesquad_bravery¶
ユーザーはHypeSquad Braveryのメンバーです。
- hypesquad_brilliance¶
ユーザーはHypeSquad Brillianceのメンバーです。
- hypesquad_balance¶
ユーザーはHypeSquad Balanceのメンバーです。
- early_supporter¶
ユーザーは早期サポーターです。
- team_user¶
ユーザーはチームユーザーです。
- system¶
ユーザーはシステムユーザーです。(つまり、Discord公式を表しています)
- has_unread_urgent_messages¶
ユーザーに未読のシステムメッセージがあります。
- bug_hunter_level_2¶
ユーザーはバグハンターレベル2です。
- verified_bot¶
ユーザーは認証済みボットです。
- verified_bot_developer¶
ユーザーは早期認証Botデベロッパーです。
- discord_certified_moderator¶
ユーザーはモデレータープログラム卒業生です。
- bot_http_interactions¶
ユーザーはHTTPインタラクションのみを使用し、オンラインメンバーのリストに表示されるボットです。
バージョン 2.0 で追加.
- spammer¶
ユーザーはDiscordよりスパマーとフラグ付けされました。
バージョン 2.0 で追加.
- active_developer¶
ユーザーはアクティブな開発者です。
バージョン 2.1 で追加.
- class discord.ActivityType¶
Activity
のタイプを指定します。これはアクティビティをどう解釈するか確認するために使われます。- unknown¶
不明なアクティビティタイプ。これは通常起こらないはずです。
- playing¶
プレイ中のアクティビティタイプ。
- streaming¶
放送中のアクティビティタイプ。
- listening¶
再生中のアクティビティタイプ。
- watching¶
視聴中のアクティビティタイプ。
- custom¶
カスタムのアクティビティタイプ。
- competing¶
競争中のアクティビティタイプ。
バージョン 1.5 で追加.
- class discord.VerificationLevel¶
Guild
の認証レベルを指定します。これは、メンバーがギルドにメッセージを送信できるようになるまでの条件です。バージョン 2.0 で追加.
- x == y
認証レベルが等しいか確認します。
- x != y
認証レベルが等しくないか確認します。
- x > y
認証レベルがあるレベルより厳しいか確認します。
- x < y
認証レベルがあるレベルより緩いか確認します。
- x >= y
認証レベルがあるレベルと同じ、又は厳しいか確認します。
- x <= y
認証レベルがあるレベルと同じ、又は緩いか確認します。
- none¶
無制限。
- low¶
メンバーはDiscordアカウントのメール認証を済ませないといけません。
- medium¶
メンバーはメール認証をし、かつアカウント登録から5分経過しないといけません。
- high¶
メンバーはメール認証をし、Discordのアカウント登録から5分経過し、かつ10分以上ギルドに所属していないといけません。
- highest¶
メンバーはDiscordアカウントの電話番号認証を済ませないといけません。
- class discord.NotificationLevel¶
Guild
の通知対象のデフォルト設定をすべてのメッセージ、またはメンションのみに指定します。バージョン 2.0 で追加.
- x == y
通知レベルが等しいか確認します。
- x != y
通知レベルが等しくないか確認します。
- x > y
通知レベルがあるレベルより高いか確認します。
- x < y
通知レベルがあるレベルより低いか確認します。
- x >= y
通知レベルがあるレベルと同じ、又は高いか確認します。
- x <= y
通知レベルがあるレベルと同じ、又は低いか確認します。
- all_messages¶
メンバーは、メンションされているかどうかに関わらず、すべてのメッセージの通知を受け取ります。
- only_mentions¶
メンバーは自分がメンションされているメッセージの通知のみ受け取ります。
- class discord.ContentFilter¶
Guild
の不適切な表現のフィルターを指定します。これはDiscordがポルノ画像や不適切な表現を検出するために使用している機械学習アルゴリズムです。バージョン 2.0 で追加.
- x == y
表現のフィルターのレベルが等しいか確認します。
- x != y
表現のフィルターのレベルが等しくないか確認します。
- x > y
表現のフィルターのレベルが他のレベルより大きいか確認します。
- x < y
表現のフィルターのレベルが他のレベルより小さいか確認します。
- x >= y
表現のフィルターのレベルが他のレベルより大きい、または等しいか確認します。
- x <= y
表現のフィルターのレベルが他のレベルより小さい、または等しいか確認します。
- disabled¶
ギルドで表現のフィルターが有効ではない。
- no_role¶
ギルドでロールを持たないメンバーに対して表現のフィルターが有効化されている。
- all_members¶
ギルドで、すべてのメンバーに対して表現のフィルターが有効化されている。
- class discord.Status¶
Member
のステータスを指定します。- online¶
メンバーがオンライン。
- offline¶
メンバーがオフライン。
- idle¶
メンバーが退席中。
- dnd¶
メンバーが取り込み中。
- invisible¶
メンバーがオンライン状態を隠す。実際には、これは
Client.change_presence()
でプレゼンスを送信する時のみ使用します。ユーザーのプレゼンスを受け取った場合、これはoffline
に置き換えられます。
- class discord.AuditLogAction¶
AuditLogEntry
で行われた動作の種類を取得します。AuditLogEntryはGuild.audit_logs()
で取得可能です。- guild_update¶
ギルドの更新。このトリガーとなるものは以下のとおりです。
ギルドのvanity URLの変更
ギルドの招待時のスプラッシュ画像の変更
ギルドのAFKチャンネル、またはタイムアウトの変更
ギルドの音声通話のサーバーリージョンの変更
ギルドのアイコン、バナー、ディスカバリースプラッシュの変更
ギルドの管理設定の変更
ギルドのウィジェットに関連するものの変更
これが上記のactionならば、
target
の型はGuild
になります。AuditLogDiff
から、以下の属性を参照できます:
- channel_create¶
チャンネルの作成。
これが上記のactionならば、
target
の型は、IDが設定されているabc.GuildChannel
か、Object
のいずれかになります。Object
の場合、after
を使用して、より詳細な情報を持つオブジェクトを見つけることができます。AuditLogDiff
から、以下の属性を参照できます:
- channel_update¶
チャンネルの更新。これのトリガーとなるものは以下の通りです。
チャンネルのチャンネルトピックの変更、または名前の変更。
チャンネルのビットレートの変更。
これが上記のactionならば、
target
の型は、IDが設定されているabc.GuildChannel
か、Object
のいずれかになります。Object
の場合、after
またはbefore
を使用して、より詳細な情報を持つオブジェクトを見つけることができます。AuditLogDiff
から、以下の属性を参照できます:
- channel_delete¶
チャンネルの削除。
これが上記のactionならば、
target
の型は、IDが設定されているObject
になります。before
オブジェクトを使用すると、より詳細な情報が見つかります。AuditLogDiff
から、以下の属性を参照できます:
- overwrite_create¶
チャンネルにおける権限の上書き設定の作成。
これが上記のactionならば、
target
の型は、IDが設定されているabc.GuildChannel
か、Object
のいずれかになります。この場合には、
extra
はRole
かMember
です。もしオブジェクトが見つからない場合はid、name、'role'
か'member'
であるtype
属性があるObject
です。AuditLogDiff
から、以下の属性を参照できます:
- overwrite_update¶
チャンネルの権限の上書きの変更。典型的な例は、権限が変更された場合です。
overwrite_create
に、target
とextra
についての説明があります。AuditLogDiff
から、以下の属性を参照できます:
- overwrite_delete¶
チャンネルにおける権限の上書き設定の削除。
overwrite_create
に、target
とextra
についての説明があります。AuditLogDiff
から、以下の属性を参照できます:
- kick¶
メンバーのキック。
これが上記のactionならば、
target
の型は、キックされたUser
あるいはObject
になります。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:integration_type
: An optional string that denotes the type of integration that did the action.
これが上記のactionなら、
changes
は空になります。
- member_prune¶
非アクティブメンバーの一括キック。
これが上記のactionならば、
target
の型はNone
に設定されます。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:delete_members_days
: 一括キック対象の期間を示す整数。members_removed
: 除去されたメンバーの数を示す整数。
これが上記のactionなら、
changes
は空になります。
- ban¶
メンバーのBAN。
これが上記のactionならば、
target
の型は、BANされたUser
あるいはObject
になります。これが上記のactionなら、
changes
は空になります。
- unban¶
メンバーのBANの解除。
これが上記のactionならば、
target
の型は、BAN解除されたUser
あるいはObject
になります。これが上記のactionなら、
changes
は空になります。
- member_update¶
メンバーの何らかの更新。これのトリガーとなるのは以下の場合です:
メンバーのニックネームの変更。
サーバー側でミュートやスピーカーミュートされた(あるいは解除された)場合。
これが上記のactionならば、
target
の型は、更新の行われたMember
、User
、またはObject
になります。AuditLogDiff
から、以下の属性を参照できます:
- member_role_update¶
メンバーのロールの更新。これは、メンバーがロールを得たり、失った場合に発生します。
これが上記のactionならば、
target
の型は、ロールの更新が行われたMember
、User
、またはObject
になります。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:integration_type
: An optional string that denotes the type of integration that did the action.
AuditLogDiff
から、以下の属性を参照できます:
- member_move¶
メンバーのボイスチャンネルの更新。これは、メンバーが他のボイスチャンネルに移動させられた時に発生します。
これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:channel
: メンバーの移動先のTextChannel
か チャンネルIDを持つObject
。count
: 移動されたメンバーの数を示す整数。
バージョン 1.3 で追加.
- member_disconnect¶
メンバーのボイス状態の変更。これはメンバーがボイスから強制的に切断された場合に発生します。
これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:count
: 切断されたメンバーの数を示す整数。
バージョン 1.3 で追加.
- bot_add¶
ボットのギルドへの追加。
これが上記のactionならば、
target
の型は、ギルドに追加されたMember
、User
、またはObject
になります。バージョン 1.3 で追加.
- role_create¶
新しいロールの作成。
これが上記のactionならば、
target
の型は、IDが設定されているRole
か、Object
のいずれかになります。AuditLogDiff
から、以下の属性を参照できます:
- role_update¶
ロールの何らかの更新。これのトリガーとなるのは以下の場合です:
名前の更新。
権限の更新。
色の更新。
ロールアイコン (または Unicode 絵文字)の変更。
ロールメンバーのオンライン表示、ロールへのメンションの許可の変更。
これが上記のactionならば、
target
の型は、IDが設定されているRole
か、Object
のいずれかになります。AuditLogDiff
から、以下の属性を参照できます:
- role_delete¶
ロールの削除。
これが上記のactionならば、
target
の型は、IDが設定されているRole
か、Object
のいずれかになります。AuditLogDiff
から、以下の属性を参照できます:
- invite_create¶
招待の作成。
これが上記のactionならば、
target
の型は作成された招待に該当するInvite
になります。AuditLogDiff
から、以下の属性を参照できます:
- invite_delete¶
招待の削除。
これが上記のactionならば、
target
のタイプは削除された招待に該当するInvite
になります。AuditLogDiff
から、以下の属性を参照できます:
- webhook_create¶
Webhookの作成。
これが上記のactionならば、
target
のタイプは、webhook IDが設定されているObject
になります。AuditLogDiff
から、以下の属性を参照できます:
- webhook_update¶
Webhookの更新。これのトリガーとなるのは以下の場合です。
Webhook名が変更されたとき
Webhookチャンネルが変更されたとき
これが上記のactionならば、
target
のタイプは、webhook IDが設定されているObject
になります。AuditLogDiff
から、以下の属性を参照できます:
- webhook_delete¶
Webhookの削除。
これが上記のactionならば、
target
のタイプは、webhook IDが設定されているObject
になります。AuditLogDiff
から、以下の属性を参照できます:
- emoji_create¶
絵文字の作成。
これが上記のactionならば、
target
の型は、Emoji
または 絵文字IDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:
- emoji_update¶
絵文字に対する何らかの更新。これは名前が変更されたときに発生します。
これが上記のactionならば、
target
の型は、Emoji
または 絵文字IDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:
- emoji_delete¶
絵文字の削除。
これが上記のactionならば、
target
の型は、絵文字IDが設定されているObject
になります。AuditLogDiff
から、以下の属性を参照できます:
- message_delete¶
管理者によるメッセージの削除。なお、これのトリガーとなるのは、メッセージが投稿者以外によって削除された場合のみです。
これが上記のactionならば、
target
の型は、削除されたメッセージの送信者であるMember
、User
、またはObject
になります。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:count
: 削除されたメッセージの数を示す整数。channel
: メッセージが削除されたTextChannel
か チャンネルIDを持つObject
。
- message_bulk_delete¶
管理者によるメッセージの一括削除。
これが上記のactionならば、
target
の型は、TextChannel
またはメッセージが一括削除されたチャンネルIDが設定されたObject
です。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:count
: 削除されたメッセージの数を示す整数。
バージョン 1.3 で追加.
- message_pin¶
チャンネルへのメッセージのピン留め。
これが上記のactionならば、
target
の型は、ピン留めされたメッセージの送信者であるMember
、User
、またはObject
になります。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:channel
: メッセージがピン留めされたTextChannel
か チャンネルIDを持つObject
。message_id
: ピン留めされたメッセージのID。
バージョン 1.3 で追加.
- message_unpin¶
チャンネルからのメッセージのピン留め解除。
これが上記のactionならば、
target
の型は、ピン留めが外されたメッセージの送信者であるMember
、User
、またはObject
になります。これが上記のactionならば、
extra
は以下の属性を持つプロキシオブジェクトになります:channel
: メッセージのピン留めが外されたTextChannel
か チャンネルIDを持つObject
。message_id
: ピン留めが外されたメッセージのID。
バージョン 1.3 で追加.
- integration_create¶
ギルドの連携サービスの作成。
これが上記のactionならば、
target
の型は、PartialIntegration
または作成されたインテグレーションのIDを持つObject
になります。バージョン 1.3 で追加.
- integration_update¶
ギルド連携サービスの更新。
これが上記のactionならば、
target
の型は、PartialIntegration
または更新されたインテグレーションのIDを持つObject
になります。バージョン 1.3 で追加.
- integration_delete¶
ギルド連携サービスの削除。
これが上記のactionならば、
target
の型は、PartialIntegration
または削除されたインテグレーションのIDを持つObject
になります。バージョン 1.3 で追加.
- stage_instance_create¶
ステージインスタンスの開始。
これが上記のactionならば、
target
の型は、StageInstance
または作成されたステージインスタンスのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- stage_instance_update¶
ステージインスタンスの更新。
これが上記のactionならば、
target
の型は、StageInstance
または更新されたステージインスタンスのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- stage_instance_delete¶
ステージインスタンスの終了。
バージョン 2.0 で追加.
- sticker_create¶
スタンプの作成。
これが上記のactionならば、
target
の型は、GuildSticker
または作成されたスタンプのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- sticker_update¶
スタンプの更新。
これが上記のactionならば、
target
の型は、GuildSticker
または更新されたスタンプのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- sticker_delete¶
スタンプの削除。
これが上記のactionならば、
target
の型は、GuildSticker
または更新されたスタンプのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- scheduled_event_create¶
スケジュールイベントの作成。
これが上記のactionならば、
target
の型は、ScheduledEvent
または作成されたスケジュールイベントのIDが設定されたObject
です。AuditLogDiff
の可能な属性: -name
-channel
-description
-privacy_level
-status
-entity_type
-cover_image
バージョン 2.0 で追加.
- scheduled_event_update¶
スケジュールイベントの作成。
これが上記のactionならば、
target
の型は、ScheduledEvent
または更新されたスケジュールイベントのIDが設定されたObject
です。AuditLogDiff
の可能な属性: -name
-channel
-description
-privacy_level
-status
-entity_type
-cover_image
バージョン 2.0 で追加.
- scheduled_event_delete¶
スケジュールイベントの作成。
これが上記のactionならば、
target
の型は、ScheduledEvent
または削除されたスケジュールイベントのIDが設定されたObject
です。AuditLogDiff
の可能な属性: -name
-channel
-description
-privacy_level
-status
-entity_type
-cover_image
バージョン 2.0 で追加.
- thread_create¶
スレッドの作成。
これが上記のactionならば、
target
の型は、Thread
または作成されたスレッドのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- thread_update¶
スレッドの更新。
これが上記のactionならば、
target
の型は、Thread
または更新されたスレッドのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- thread_delete¶
スレッドの削除。
これが上記のactionならば、
target
の型は、Thread
または削除されたスレッドのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- app_command_permission_update¶
アプリケーションコマンドまたはインテグレーションアプリケーションコマンドの権限の更新。
これが上記のactionならば、
target
の型は、 インテグレーション一般の権限の場合PartialIntegration
、特定のコマンドの権限の場合AppCommand
、あるいは更新されたコマンドまたはインテグレーションのIDが設定されたObject
です。これが上記のactionならば、
extra
の型は、PartialIntegration
またはコマンドまたはインテグレーションが属するアプリケーションのIDを持つObject
になります。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- automod_rule_create¶
自動管理ルールの作成。
これが上記のactionならば、
target
のtypeは、AutoModRule
または作成された自動管理ルールのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- automod_rule_update¶
自動管理ルールの更新。
これが上記のactionならば、
target
のtypeは、AutoModRule
または作成された自動管理ルールのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- automod_rule_delete¶
自動管理ルールの削除。
これが上記のactionならば、
target
のtypeは、AutoModRule
または作成された自動管理ルールのIDが設定されたObject
です。AuditLogDiff
から、以下の属性を参照できます:バージョン 2.0 で追加.
- automod_block_message¶
自動管理ルールによる送信されたメッセージのブロック。
これが上記のactionならば、
target
のtypeは、自動管理ルールを発動させたMember
になります。これが上記のactionならば、
extra
は以下の3つの属性を持つプロキシオブジェクトになります:automod_rule_name
: 発動した自動管理ルールの名前。automod_rule_trigger_type
: AAutoModRuleTriggerType
representation of the rule type that was triggered.channel
: 自動管理ルールが発動されたチャンネル。
これが上記のactionなら、
changes
は空になります。バージョン 2.0 で追加.
- automod_flag_message¶
自動管理ルールによる送信されたメッセージのフラグ付け。
これが上記のactionならば、
target
のtypeは、自動管理ルールを発動させたMember
になります。これが上記のactionならば、
extra
は以下の3つの属性を持つプロキシオブジェクトになります:automod_rule_name
: 発動した自動管理ルールの名前。automod_rule_trigger_type
: AAutoModRuleTriggerType
representation of the rule type that was triggered.channel
: 自動管理ルールが発動されたチャンネル。
これが上記のactionなら、
changes
は空になります。バージョン 2.1 で追加.
- automod_timeout_member¶
自動管理ルールによるメンバーのタイムアウト。
これが上記のactionならば、
target
のtypeは、自動管理ルールを発動させたMember
になります。これが上記のactionならば、
extra
は以下の3つの属性を持つプロキシオブジェクトになります:automod_rule_name
: 発動した自動管理ルールの名前。automod_rule_trigger_type
: AAutoModRuleTriggerType
representation of the rule type that was triggered.channel
: 自動管理ルールが発動されたチャンネル。
これが上記のactionなら、
changes
は空になります。バージョン 2.1 で追加.
- creator_monetization_request_created¶
A request to monetize the server was created.
バージョン 2.4 で追加.
- creator_monetization_terms_accepted¶
The terms and conditions for creator monetization were accepted.
バージョン 2.4 で追加.
- class discord.AuditLogActionCategory¶
AuditLogAction
が属するカテゴリ。これは
AuditLogEntry.category
で取得できます。- create¶
アクションは何かの作成です。
- delete¶
アクションは何かの削除です。
- update¶
アクションは何かの更新です。
- class discord.TeamMembershipState¶
Client.application_info()
で取得したチームメンバーのメンバーシップ状態。バージョン 1.3 で追加.
- invited¶
招待されたメンバー。
- accepted¶
現在チームにいるメンバー。
- class discord.TeamMemberRole¶
Represents the type of role of a team member retrieved through
Client.application_info()
.バージョン 2.4 で追加.
- admin¶
The team member is an admin. This allows them to invite members to the team, access credentials, edit the application, and do most things the owner can do. However they cannot do destructive actions.
- developer¶
The team member is a developer. This allows them to access information, like the client secret or public key. They can also configure interaction endpoints or reset the bot token. Developers cannot invite anyone to the team nor can they do destructive actions.
- read_only¶
The team member is a read-only member. This allows them to access information, but not edit anything.
- class discord.WebhookType¶
受け取れるWebhookの種類。
バージョン 1.3 で追加.
- incoming¶
トークンでチャンネルにメッセージを投稿できるWebhook。
- channel_follower¶
チャンネルのフォローのためDiscord内部で管理されるWebhook。
- application¶
インタラクションやアプリケーションに用いられるWebhook。
バージョン 2.0 で追加.
- class discord.ExpireBehaviour¶
ユーザーのサブスクリプションが終了した後の
Integration
の動作。ExpireBehavior
という名のエイリアスがあります。バージョン 1.4 で追加.
- remove_role¶
サブスクリプションが終了したユーザーから
StreamIntegration.role
を除去します。
- kick¶
サブスクリプションが終了したユーザーをキックします。
- class discord.DefaultAvatar¶
Discord
User
のデフォルトのアバター。- blurple¶
ブループル色のデフォルトのアバター。
Colour.blurple
も参照してください。
- grey¶
灰色のデフォルトのアバター。
Colour.greyple
も参照してください。
- green¶
緑色のデフォルトのアバター。
Colour.green
も参照してください。
- orange¶
オレンジ色のデフォルトのアバター。
Colour.orange
も参照してください。
- red¶
赤色のデフォルトのアバター。
Colour.red
も参照してください。
- pink¶
ピンク色のデフォルトのアバター。
Colour.pink
も参照してください。バージョン 2.3 で追加.
- class discord.StickerType¶
スタンプの種類。
バージョン 2.0 で追加.
- standard¶
Nitroユーザー全員が使用できる標準スタンプ。
- guild¶
ギルドで作成されたカスタムスタンプ。
- class discord.StickerFormatType¶
スタンプ画像の種類。
バージョン 1.6 で追加.
- png¶
PNG画像のスタンプ。
- apng¶
APNG画像のスタンプ。
- lottie¶
ロッティー画像のスタンプ。
- gif¶
GIF画像のスタンプ。
バージョン 2.2 で追加.
- class discord.InviteTarget¶
ボイスチャンネル招待の招待タイプ。
バージョン 2.0 で追加.
- unknown¶
招待の対象がないもの。
- stream¶
ユーザーを対象とするもの。
- embedded_application¶
埋め込まれたアプリケーションを対象とするもの。
- class discord.VideoQualityMode¶
ボイスチャンネル参加者のカメラビデオの画質モード。
バージョン 2.0 で追加.
- auto¶
自動のカメラビデオ画質。
- full¶
フルのカメラビデオ画質。
- class discord.PrivacyLevel¶
ステージインスタンスやスケジュールイベントのプライバシーレベル。
バージョン 2.0 で追加.
- guild_only¶
ステージインスタンスやスケジュールイベントはギルド内でのみアクセスできます。
- class discord.NSFWLevel¶
ギルドの年齢制限レベル。
バージョン 2.0 で追加.
- x == y
二つの年齢制限レベルが等しいかを比較します。
- x != y
二つの年齢制限レベルが等しくないかを比較します。
- x > y
年齢制限レベルがあるレベルより高いか確認します。
- x < y
年齢制限レベルがあるレベルより低いか確認します。
- x >= y
年齢制限レベルがあるレベルと同じ、又は高いか確認します。
- x <= y
年齢制限レベルがあるレベルと同じ、又は低いか確認します。
- default¶
未分類のギルド。
- explicit¶
年齢制限されたコンテンツを含むギルド。
- safe¶
年齢制限されたコンテンツを一切含まないギルド。
- age_restricted¶
年齢制限されたコンテンツを含む可能性のあるギルド。
- class discord.Locale¶
Discordでサポートされているロケール。主にアプリケーションコマンドの多言語化に使用されます。
バージョン 2.0 で追加.
- american_english¶
en-US
ロケール。
- british_english¶
en-GB
ロケール。
- bulgarian¶
bg
ロケール。
- chinese¶
zh-CN
ロケール。
- taiwan_chinese¶
zh-TW
ロケール。
- croatian¶
hr
ロケール。
- czech¶
cs
ロケール。
- indonesian¶
id
ロケール。バージョン 2.2 で追加.
- danish¶
da
ロケール。
- dutch¶
nl
ロケール。
- finnish¶
fi
ロケール。
- french¶
fr
ロケール。
- german¶
de
ロケール。
- greek¶
el
ロケール。
- hindi¶
hi
ロケール。
- hungarian¶
hu
ロケール。
- italian¶
it
ロケール。
- japanese¶
ja
ロケール。
- korean¶
ko
ロケール。
- latin_american_spanish¶
The
es-419
locale.バージョン 2.4 で追加.
- lithuanian¶
lt
ロケール。
- norwegian¶
no
ロケール。
- polish¶
pl
ロケール。
- brazil_portuguese¶
pt-BR
ロケール。
- romanian¶
ro
ロケール。
- russian¶
ru
ロケール。
- spain_spanish¶
es-ES
ロケール。
- swedish¶
sv-SE
ロケール。
- thai¶
th
ロケール。
- turkish¶
tr
ロケール。
- ukrainian¶
uk
ロケール。
- vietnamese¶
vi
ロケール。
- class discord.MFALevel¶
ギルドの多要素認証要件レベル。
バージョン 2.0 で追加.
- x == y
二つのMFAレベルが等しいかを比較します。
- x != y
二つのMFAレベルが等しくないかを比較します。
- x > y
多要素認証レベルがあるレベルより厳しいか確認します。
- x < y
多要素認証レベルがあるレベルより緩いか確認します。
- x >= y
多要素認証レベルがあるレベルと同じ、又は厳しいか確認します。
- x <= y
多要素認証レベルがあるレベルと同じ、又は緩いか確認します。
- disabled¶
多要素認証要件がないギルド。
- require_2fa¶
二要素認証を必須とするギルド。
- class discord.EntityType¶
スケジュールイベントの開催場所の種類。
バージョン 2.0 で追加.
- stage_instance¶
ステージインスタンスで起こるスケジュールイベント。
- voice¶
ボイスチャンネルで起こるスケジュールイベント。
- external¶
外部で起こるスケジュールイベント。
- class discord.EventStatus¶
イベントの状態。
バージョン 2.0 で追加.
- scheduled¶
予定されたイベント。
- active¶
開催中のイベント。
- completed¶
終了したイベント。
- cancelled¶
キャンセルされたイベント。
- class discord.AutoModRuleTriggerType¶
自動管理ルールの発動条件の種類を表します。
バージョン 2.0 で追加.
- keyword¶
キーワードに言及したときに発動されるルール。
- harmful_link¶
有害なリンクを投稿したときに発動されるルール。
- spam¶
スパムメッセージを投稿したときに発動されるルール。
- keyword_preset¶
事前に定められたキーワードプリセットに基づき発動したときに発動されるルール。
- mention_spam¶
ロールとユーザーのメンションの合計数が設定された制限よりも多い場合に発動されるルール。
- member_profile¶
The rule will trigger when a user's profile contains a keyword.
バージョン 2.4 で追加.
- class discord.AutoModRuleEventType¶
自動管理ルールのイベントの種類を表します。
バージョン 2.0 で追加.
- message_send¶
メッセージを投稿したときにルールが発動します。
- member_update¶
The rule will trigger when a member's profile is updated.
バージョン 2.4 で追加.
- class discord.AutoModRuleActionType¶
自動管理ルールの対応の種類を表します。
バージョン 2.0 で追加.
- block_message¶
メッセージを送信できないようにします。
- send_alert_message¶
事前に指定したチャンネルに警告メッセージを送信します。
- timeout¶
ユーザーをタイムアウトします。
- class discord.ForumLayoutType¶
フォーラムの投稿がクライアントでどのように配列されるかを表します。
バージョン 2.2 で追加.
- not_set¶
デフォルトが設定されていないので、配列方法はクライアントによります。
- list_view¶
投稿を一覧として表示します。
- gallery_view¶
投稿をタイルの集まりとして表示します。
- class discord.ForumOrderType¶
フォーラムの投稿がクライアントでどのように並び替えられるかを表します。
バージョン 2.3 で追加.
- latest_activity¶
最終更新日時順でフォーラム投稿を並び替えます。
- creation_date¶
作成日時順 (新しいものから古いものの順) でフォーラム投稿を並び替えます。
- class discord.SelectDefaultValueType¶
Represents the default value of a select menu.
バージョン 2.4 で追加.
- user¶
The underlying type of the ID is a user.
- role¶
The underlying type of the ID is a role.
- channel¶
The underlying type of the ID is a channel or thread.
- class discord.SKUType¶
Represents the type of a SKU.
バージョン 2.4 で追加.
- subscription¶
The SKU is a recurring subscription.
- subscription_group¶
The SKU is a system-generated group which is created for each
SKUType.subscription
.
監査ログデータ¶
Guild.audit_logs()
の使用は複雑なプロセスです。このライブラリーはこれを使いやすくフレンドリーにしようと試みています。この目標の達成のためにいくつかのデータクラスを使用しています。
AuditLogEntry¶
- class discord.AuditLogEntry(*, users, integrations, app_commands, automod_rules, webhooks, data, guild)¶
監査ログの項目。
これらは
Guild.audit_logs()
から取得できます。- x == y
二つの項目が等しいかを比較します。
- x != y
二つの項目が等しくないかを比較します。
- hash(x)
エントリーのハッシュを返します。
バージョン 1.7 で変更: 監査ログの項目が比較・ハッシュ可能になりました。
- action¶
行われたアクション。
- target¶
変更の対象。正確な型は、実行されるアクションによって異なります。
- 型
Any
- extra¶
役立つかもしれない項目の追加の情報。ほとんどのアクションでは
None
ですが、場合により追加の情報が含まれます。どのアクションが対応しているかはAuditLogAction
にて確認してください。- 型
Any
- created_at¶
項目の作成された時間をUTCで返します。
- category¶
該当する場合、アクションのカテゴリ。
- 型
Optional[
AuditLogActionCategory
]
- changes¶
この項目の変更の一覧。
- before¶
対象の前の状態。
- after¶
対象の直後の状態。
AuditLogChanges¶
- class discord.AuditLogChanges¶
監査ログの変更のセット。
- before¶
以前の値。この属性は
AuditLogDiff
型です。category
で取得されるAuditLogActionCategory
によりこの属性の値が異なります:
- after¶
新しい値。この属性は
AuditLogDiff
型です。category
で取得されるAuditLogActionCategory
によりこの属性の値が異なります:
AuditLogDiff¶
- actions
- afk_channel
- afk_timeout
- allow
- app_command_permissions
- applied_tags
- archived
- auto_archive_duration
- available
- available_tags
- avatar
- banner
- bitrate
- channel
- code
- color
- colour
- cover_image
- deaf
- default_auto_archive_duration
- default_notifications
- default_reaction_emoji
- default_thread_slowmode_delay
- deny
- description
- discovery_splash
- emoji
- enable_emoticons
- enabled
- entity_type
- event_type
- exempt_channels
- exempt_roles
- expire_behavior
- expire_behaviour
- expire_grace_period
- explicit_content_filter
- flags
- format_type
- guild
- hoist
- icon
- id
- invitable
- inviter
- locked
- max_age
- max_uses
- mentionable
- mfa_level
- mute
- name
- nick
- nsfw
- overwrites
- owner
- permissions
- position
- preferred_locale
- premium_progress_bar_enabled
- privacy_level
- prune_delete_days
- public_updates_channel
- roles
- rtc_region
- rules_channel
- slowmode_delay
- splash
- status
- system_channel
- system_channel_flags
- temporary
- timed_out_until
- topic
- trigger
- trigger_type
- type
- unicode_emoji
- user_limit
- uses
- vanity_url_code
- verification_level
- video_quality_mode
- widget_channel
- widget_enabled
- class discord.AuditLogDiff¶
監査ログの「変更」オブジェクト。変更オブジェクトには、行われたアクションの種類によって異なる属性があります。特定のアクションが行われた場合に特定の属性が設定されます。
指定されたアクションに一致しない属性にアクセスすると、AttributeErrorが発生することに注意してください。
設定された属性のリストを取得するには、イテレートすることができます。 行われたアクションに対応した可能な属性の一覧は、
AuditLogAction
の説明を確認してください。あるいは、可能なすべての属性について、以下の説明を確認してください。- iter(diff)
差分の(属性、値)タプルのイテレーターを返します。
- icon¶
ギルドまたはロールのアイコン。
Guild.icon
とRole.icon
も参照してください。- 型
- splash¶
ギルドの招待のスプラッシュ。
Guild.splash
も参照してください。- 型
- discovery_splash¶
ギルドのディスカバリースプラッシュ。
Guild.discovery_splash
も参照してください。- 型
- banner¶
ギルドのバナー。
Guild.banner
も参照してください。- 型
- owner¶
ギルドの所有者。
Guild.owner
も参照してください。
- afk_channel¶
ギルドのAFKチャンネル。
見つからない場合は、IDが設定された
Object
になります。Guild.afk_channel
を参照してください。- 型
Union[
VoiceChannel
,Object
]
- system_channel¶
ギルドのシステムチャンネル。
見つからない場合は、IDが設定された
Object
になります。Guild.system_channel
を参照してください。- 型
Union[
TextChannel
,Object
]
- rules_channel¶
ギルドのルールチャンネル。
見つからない場合は、IDが設定された
Object
になります。Guild.rules_channel
を参照してください。- 型
Union[
TextChannel
,Object
]
- public_updates_channel¶
ギルドのパブリックアップデートチャンネル。
見つからない場合は、IDが設定された
Object
になります。Guild.public_updates_channel
を参照してください。- 型
Union[
TextChannel
,Object
]
- afk_timeout¶
ギルドのAFKタイムアウト。
Guild.afk_timeout
も参照してください。- 型
- mfa_level¶
ギルドの多要素認証レベル。
Guild.mfa_level
も参照してください。- 型
- widget_channel¶
ウィジェットのチャンネル。
見つからない場合は、IDが設定された
Object
になります。- 型
Union[
TextChannel
,Object
]
- verification_level¶
ギルドの認証レベル。
Guild.verification_level
も参照してください。
- default_notifications¶
ギルドのデフォルト通知レベル。
Guild.default_notifications
も参照してください。
- explicit_content_filter¶
ギルドのコンテンツフィルター。
Guild.explicit_content_filter
も参照してください。
- vanity_url_code¶
ギルドのバニティURL。
Guild.vanity_invite()
とGuild.edit()
も参照してください。- 型
- position¶
Role
やabc.GuildChannel
の位置。- 型
- type¶
チャンネル、スタンプ、Webhookまたは連携サービスのタイプ。
- 型
Union[
ChannelType
,StickerType
,WebhookType
,str
]
- topic¶
TextChannel
またはStageChannel
のトピック。TextChannel.topic
またはStageChannel.topic
も参照してください。- 型
- bitrate¶
VoiceChannel
のビットレート。VoiceChannel.bitrate
も参照してください。- 型
- overwrites¶
対象とその
PermissionOverwrite
のタプルで示された権限の上書きのリスト。最初の要素は対象のオブジェクトで、
Member
かUser
かRole
です。このオブジェクトが見つからない場合はこれはIDが設定され、type
属性が'role'
か'member'
に設定されたObject
になります。- 型
List[Tuple[target,
PermissionOverwrite
]]
- privacy_level¶
ステージインスタンスやスケジュールイベントのプライバシーレベル。
- nick¶
メンバーのニックネーム。
Member.nick
も参照してください。- 型
Optional[
str
]
- deaf¶
メンバーがサーバーでスピーカーミュートされているかどうか。
VoiceState.deaf
も参照してください。- 型
- mute¶
メンバーがサーバーでミュートされているかどうか。
VoiceState.mute
も参照してください。- 型
- permissions¶
ロールの権限。
Role.permissions
も参照してください。
- colour¶
- color¶
ロールの色。
Role.colour
も参照してください。- 型
- hoist¶
役割が別に表示されるかどうか。
Role.hoist
も参照してください。- 型
- mentionable¶
役割がメンションできるかどうか。
Role.mentionable
も参照してください。- 型
- code¶
招待のコード。
Invite.code
も参照してください。- 型
- channel¶
ギルドのチャンネル。
チャンネルが見つからない場合は、IDが設定された
Object
になります。 場合によっては、チャンネル名も設定されています。- 型
Union[
abc.GuildChannel
,Object
]
- inviter¶
招待を作成したユーザー。
Invite.inviter
も参照してください。- 型
Optional[
User
]
- max_uses¶
招待の最大使用回数。
Invite.max_uses
も参照してください。- 型
- uses¶
招待の現在の使用回数。
Invite.uses
も参照してください。- 型
- max_age¶
招待者の最大時間は秒数です。
Invite.max_age
も参照してください。- 型
- temporary¶
招待が一時的な招待であるか。
Invite.temporary
も参照してください。- 型
- avatar¶
メンバーのアバター。
User.avatar
も参照してください。- 型
- slowmode_delay¶
メンバーが別のメッセージをチャンネルに送信するまでの秒単位の待ち時間。
TextChannel.slowmode_delay
も参照してください。- 型
- rtc_region¶
ボイスチャンネルの音声通信のためのリージョン。値が
None
の場合は自動で検出されます。VoiceChannel.rtc_region
も参照してください。- 型
- video_quality_mode¶
ボイスチャンネル参加者のカメラビデオの画質。
VoiceChannel.video_quality_mode
も参照してください。
- format_type¶
変更されたスタンプのフォーマットの種類。
GuildSticker.format
も参照してください。
- emoji¶
変更されたスタンプを示す絵文字の名前。
GuildSticker.emoji
も参照してください。- 型
- unicode_emoji¶
変更されたロールのアイコンとして使用されるUnicode絵文字。
Role.unicode_emoji
も参照してください。- 型
- description¶
ギルド、スタンプ、またはスケジュールイベントの説明。
Guild.description
、GuildSticker.description
、またはScheduledEvent.description
も参照してください。- 型
- available¶
変更されたスタンプの利用可能かどうかの状態。
GuildSticker.available
も参照してください。- 型
- auto_archive_duration¶
変更されたスレッドの自動アーカイブ期間。
Thread.auto_archive_duration
も参照してください。- 型
- timed_out_until¶
ユーザーがタイムアウトされているかどうか、そしてその場合はいつまでか。
- 型
Optional[
datetime.datetime
]
- enable_emoticons¶
連携サービスの絵文字が有効化され、または無効化されたか。
StreamIntegration.enable_emoticons
も参照してください。- 型
- expire_behaviour¶
- expire_behavior¶
変更された期限切れのサブスクライバーの動作。
StreamIntegration.expire_behaviour
も参照してください。
- expire_grace_period¶
変更された期限切れのサブスクライバーの猶予期間。
StreamIntegration.expire_grace_period
も参照してください。- 型
- preferred_locale¶
変更されたギルドの優先ローケル。
Guild.preferred_locale
も参照してください。- 型
- status¶
スケジュールイベントのステータス。
- entity_type¶
スケジュールイベントの開催場所の種類。
- cover_image¶
スケジュールイベントのカバー画像。
ScheduledEvent.cover_image
も参照してください。- 型
- app_command_permissions¶
アプリケーションコマンドの権限のリスト。
- 型
List[
AppCommandPermissions
]
- event_type¶
自動管理ルールを発動させるイベントの種類。
- trigger_type¶
自動管理ルールの発動条件の種類。
- trigger¶
自動管理ルールの発動条件。
注釈
The
type
of the trigger may be incorrect. Some attributes such askeyword_filter
,regex_patterns
, andallow_list
will only have the added or removed values.
- actions¶
自動管理ルールの発動時の対応。
- 型
List[AutoModRuleAction]
- exempt_channels¶
自動管理ルールの除外対象のチャンネルまたはスレッドのリスト。
- 型
List[
abc.GuildChannel
,Thread
,Object
]
ギルドのブーストの進捗バーを表示するかの設定。
- 型
- system_channel_flags¶
ギルドのシステムチャンネルの設定。
Guild.system_channel_flags
を参照してください。
- user_limit¶
ボイスまたはステージチャンネルに参加できるメンバー数の制限。
VoiceChannel.user_limit
とStageChannel.user_limit
も参照してください。- 型
- flags¶
このスレッドやフォーラム投稿に関連付けられたチャンネルフラグ。
ForumChannel.flags
とThread.flags
も参照してください。
- default_thread_slowmode_delay¶
このテキストチャンネルやフォーラムで作成されたスレッドのデフォルトの低速モードのレート制限。
TextChannel.default_thread_slowmode_delay
とForumChannel.default_thread_slowmode_delay
も参照してください。- 型
- applied_tags¶
フォーラム投稿に適用されたタグ。
Thread.applied_tags
も参照してください。
- available_tags¶
フォーラムにて利用可能なタグ。
ForumChannel.available_tags
も参照してください。- 型
Sequence[
ForumTag
]
- default_reaction_emoji¶
フォーラム投稿の default_reaction_emoji。
ForumChannel.default_reaction_emoji
も参照してください。- 型
Optional[
PartialEmoji
]
Webhookサポート¶
discord.pyは、 Webhook
クラスからWebhookの作成、編集、実行をサポートします。
Webhook¶
- clsWebhook.from_url
- clsWebhook.partial
- asyncdelete
- asyncdelete_message
- asyncedit
- asyncedit_message
- asyncfetch
- asyncfetch_message
- defis_authenticated
- defis_partial
- asyncsend
- class discord.Webhook¶
非同期のDiscord Webhook。
Webhookはボットユーザーや認証なしでDiscordチャンネルにメッセージを送信する方法です。
Webhookの使用法は主に二つあります。一つ目は
Guild.webhooks()
やTextChannel.webhooks()
、VoiceChannel.webhooks()
、ForumChannel.webhooks()
といったライブラリーのメソッドから受け取るものです。これらは自動的にライブラリー内部のHTTPセッションを使用します。二つ目は、
from_url()
やpartial()
クラスメソッドでWebhookオブジェクトを手動で作成する方法です。例えば、URLからWebhookを作成し、 aiohttp を使用する場合は:
from discord import Webhook import aiohttp async def foo(): async with aiohttp.ClientSession() as session: webhook = Webhook.from_url('url-here', session=session) await webhook.send('Hello World', username='Foo')
同期バージョンは、
SyncWebhook
を参照してください。- x == y
二つのWebhookが等しいか比較します。
- x != y
二つのWebhookが等しいものでないか比較します。
- hash(x)
Webhookのハッシュを返します。
バージョン 1.4 で変更: Webhookが比較・ハッシュ可能になりました。
- type¶
Webhookのタイプ。
バージョン 1.3 で追加.
- source_guild¶
Webhookがフォローしているチャンネルのギルド。
type
がWebhookType.channel_follower
のときのみ与えられます。バージョン 2.0 で追加.
- 型
Optional[
PartialWebhookGuild
]
- source_channel¶
Webhookがフォローしているチャンネル。
type
がWebhookType.channel_follower
のときのみ与えられます。バージョン 2.0 で追加.
- 型
Optional[
PartialWebhookChannel
]
- classmethod partial(id, token, *, session=..., client=..., bot_token=None)¶
部分的な
Webhook
を作成します。- パラメータ
id (
int
) -- WebhookのID。token (
str
) -- Webhookの認証トークン。session (
aiohttp.ClientSession
) --リクエストを送信するために使用するセッション。ライブラリはセッションを管理しておらず、閉じないことに注意してください。
バージョン 2.0 で追加.
client (
Client
) --このWebhookを初期化するためのクライアント。これによりクライアントの内部状態を付属できます。このとき、
session
が指定されていない場合は、クライアントの内部セッションが使用されます。バージョン 2.2 で追加.
bot_token (Optional[
str
]) --Webhook関連の認証が必要なリクエストに使用するボットの認証トークン。
バージョン 2.0 で追加.
- 例外
TypeError --
session
とclient
のどちらも指定されていない場合。- 戻り値
部分的な
Webhook
。部分的なWebhookはただのIDとトークンのみを持つWebhookオブジェクトです。- 戻り値の型
- classmethod from_url(url, *, session=..., client=..., bot_token=None)¶
WebhookのURLから部分的な
Webhook
を作成します。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
url (
str
) -- WebhookのURL。session (
aiohttp.ClientSession
) --リクエストを送信するために使用するセッション。ライブラリはセッションを管理しておらず、閉じないことに注意してください。
バージョン 2.0 で追加.
client (
Client
) --このWebhookを初期化するためのクライアント。これによりクライアントの内部状態を付属できます。このとき、
session
が指定されていない場合は、クライアントの内部セッションが使用されます。バージョン 2.2 で追加.
bot_token (Optional[
str
]) --Webhook関連の認証が必要なリクエストに使用するボットの認証トークン。
バージョン 2.0 で追加.
- 例外
ValueError -- URLが無効な場合。
TypeError --
session
とclient
のどちらも指定されていない場合。
- 戻り値
部分的な
Webhook
。部分的なWebhookはただのIDとトークンのみを持つWebhookオブジェクトです。- 戻り値の型
- await fetch(*, prefer_auth=True)¶
This function is a coroutine.
現在のWebhookを取得します。
これは部分的なWebhookから完全なWebhookを取得するのに利用できます。
バージョン 2.0 で追加.
注釈
認証されていないWebhook、つまり
is_authenticated()
がFalse
を返すものでは、返されたWebhookにはユーザー情報が含まれません。- パラメータ
prefer_auth (
bool
) -- 利用可能な場合にWebhookトークンではなくボットトークンを使用するか。既定ではTrue
。- 例外
HTTPException -- Webhookを取得できなかった場合。
NotFound -- このIDを持つWebhookが見つからない場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- 戻り値
フェッチしたWebhook。
- 戻り値の型
- await delete(*, reason=None, prefer_auth=True)¶
This function is a coroutine.
この Webhook を削除します。
- パラメータ
- 例外
HTTPException -- Webhookの削除に失敗した場合。
NotFound -- Webhookが存在しない場合。
Forbidden -- Webhookを削除する権限がない場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- await edit(*, reason=None, name=..., avatar=..., channel=None, prefer_auth=True)¶
This function is a coroutine.
このWebhookを編集します。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
name (Optional[
str
]) -- Webhookの新しい既定の名前。avatar (Optional[
bytes
]) -- Webhookの新しい既定のアバターを示す bytes-like object 。channel (Optional[
abc.Snowflake
]) --Webhookの新しいチャンネル。設定するには認証済みWebhookが必要です。
バージョン 2.0 で追加.
reason (Optional[
str
]) --Webhookを編集する理由。監査ログに表示されます。
バージョン 1.4 で追加.
prefer_auth (
bool
) --利用可能な場合にWebhookトークンではなくボットトークンを使用するか。既定では
True
。バージョン 2.0 で追加.
- 例外
HTTPException -- Webhookの編集に失敗した場合。
NotFound -- Webhookが存在しない場合。
ValueError -- Webhookに紐づいたトークンがない場合や、認証せずにチャンネルを編集しようとした場合。
- property avatar¶
Webhookのアバターの
Asset
を返します。Webhookが従来のアバターを設定していない場合は、
None
が返されます。Webhookが表示しているアバターを取得したい場合は、display_avatar
を検討してください。- 型
Optional[
Asset
]
- property channel¶
このWebhookが属するチャンネル。
これが部分的なWebhookの場合は常に
None
を返します。- 型
Optional[Union[
ForumChannel
,VoiceChannel
,TextChannel
]]
- property created_at¶
Webhookの作成時刻をUTCで返します。
- property display_avatar¶
Webhookの表示されるアバターを返します。
これはWebhookのデフォルトアバターまたはアップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- await send(content=..., *, username=..., avatar_url=..., tts=False, ephemeral=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., view=..., thread=..., thread_name=..., wait=False, suppress_embeds=False, silent=False, applied_tags=...)¶
This function is a coroutine.
Webhookを使用してメッセージを送信します。
contentは
str(content)
で文字列に変換できるものでなければなりません。ファイルを一つだけアップロードするには、
file
パラメータにFile
オブジェクトを渡します。embed
パラメータが渡された場合は、型がEmbed
であり、その種類はrichでないといけません。embed
パラメータは、送信するEmbed
のlist
であるembeds
パラメータと同時に使用できません。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
content (
str
) -- 送信するメッセージの内容。wait (
bool
) -- サーバーが応答を送信するまで待つべきかどうか。これは、True
に設定された場合にこの関数の返り値がNone
からWebhookMessage
に変わることを意味します。もしこのWebhookの種類がWebhookType.application
の場合はこれは常にTrue
に設定されます。username (
str
) -- このメッセージを送信するユーザー名。ユーザー名が指定されていない場合、Webhookのデフォルトのユーザー名が使用されます。avatar_url (
str
) -- このメッセージと共に送信するアバターのURL。アバターURLが指定されていない場合、Webhookのデフォルトアバターが使用されます。 これが文字列でない場合は、str
を使って明示的にキャストされます。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。ephemeral (
bool
) --メッセージがユーザーにのみ表示されるべきかを示します。これは
WebhookType.application
Webhookでのみ利用できます。もしビューが一時的なメッセージとともに送信されタイムアウトが設定されていない場合、タイムアウトは15分に設定されます。バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files
パラメータと同時に使用できません。files (List[
File
]) -- コンテンツといっしょに送信するファイルのリスト。file
パラメータと同時に使用できません。embed (
Embed
) -- 送信するリッチな埋め込み。embeds
パラメータと同時に使用できません。embeds (List[
Embed
]) -- 送信するリッチな埋め込みのリスト。最大10個です。embed
パラメータと同時に使用できません。allowed_mentions (
AllowedMentions
) --メッセージ内で処理されるべきメンションを制御します。
バージョン 1.4 で追加.
view (
discord.ui.View
) --メッセージとともに送信するビュー。Webhookが部分的でなく、ステートが付属している場合にのみビューを送信できます。Webhookがライブラリーにて管理されている場合にステートが付属しています。
バージョン 2.0 で追加.
thread (
Snowflake
) --このWebhookを送信するスレッド。
バージョン 2.0 で追加.
thread_name (
str
) --Webhookが
ForumChannel
に属する場合、このWebhookで作成するスレッドの名前。なお、これは与えられた名前の新しいスレッドを作成するため、thread
パラメータと同時に使用できません。バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
applied_tags (List[
ForumTag
]) --Tags to apply to the thread if the webhook belongs to a
ForumChannel
.バージョン 2.4 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
NotFound -- Webhookが見つからなかった場合。
Forbidden -- Webhookの認証トークンが正しくない場合。
TypeError --
embed
とembeds
またはfile
とfiles
またはthread
とthread_name
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、Webhookにトークンが紐づいていない場合、ephemeral
が適切でない種類のWebhookに渡された場合、またはステートが付属していないWebhookにビューを渡した場合。
- 戻り値
wait
がTrue
のとき、送信されたメッセージ、それ以外の場合はNone
。- 戻り値の型
Optional[
WebhookMessage
]
- await fetch_message(id, /, *, thread=...)¶
This function is a coroutine.
このWebhookが送信した
WebhookMessage
をひとつ取得します。バージョン 2.0 で追加.
- パラメータ
- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- await edit_message(message_id, *, content=..., embeds=..., embed=..., attachments=..., view=..., allowed_mentions=None, thread=...)¶
This function is a coroutine.
このWebhookが所有するメッセージを編集します。
これは、IDしか持っていない場合のための、
WebhookMessage.edit()
より低レベルなインターフェースです。バージョン 1.6 で追加.
バージョン 2.0 で変更: 編集はメッセージを置き換えず、編集された新しいメッセージが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
message_id (
int
) -- 編集するメッセージ ID。content (Optional[
str
]) -- メッセージの内容を編集する場合はそのメッセージを、内容を削除する際は、None
を指定します。embeds (List[
Embed
]) -- メッセージを編集するための埋め込みのリスト。embed (Optional[
Embed
]) -- メッセージを編集するための埋め込み。None
を渡すと埋め込みが除去されます。embeds
パラメータと同時に使用できません。attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。バージョン 2.0 で追加.
allowed_mentions (
AllowedMentions
) -- このメッセージで処理されるメンションを制御します。詳細はabc.Messageable.send()
を参照してください。view (Optional[
View
]) --メッセージを編集するための更新されたビュー。
None
を渡すとビューが除去されます。send()
と同様にWebhookにはステートが付属していないといけません。バージョン 2.0 で追加.
thread (
Snowflake
) --Webhookメッセージが属するスレッド。
バージョン 2.0 で追加.
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、Webhookに紐づいたトークンが存在しない場合、またはWebhookにステートが付属していない場合。
- 戻り値
編集された新しいWebhookメッセージ。
- 戻り値の型
- await delete_message(message_id, /, *, thread=...)¶
This function is a coroutine.
このWebhookが所有するメッセージを削除します。
これは、IDしか持っていない場合のための、
WebhookMessage.delete()
より低レベルなインターフェースです。バージョン 1.6 で追加.
バージョン 2.0 で変更: 引数
message_id
は位置専用引数となりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
- 例外
HTTPException -- メッセージの削除に失敗した場合。
Forbidden -- 自分以外のメッセージを削除しようとした場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
WebhookMessage¶
- asyncadd_files
- asyncadd_reaction
- asyncclear_reaction
- asyncclear_reactions
- asynccreate_thread
- asyncdelete
- asyncedit
- asyncfetch
- asyncfetch_thread
- defis_system
- asyncpin
- asyncpublish
- asyncremove_attachments
- asyncremove_reaction
- asyncreply
- defto_reference
- asyncunpin
- class discord.WebhookMessage¶
Webhookから送信されたメッセージです。
これにより、webhookから送信されたメッセージを編集、または削除できます。
これは
edit()
とdelete()
が機能するように変更された上でdiscord.Message
を継承しています。バージョン 1.6 で追加.
- await edit(*, content=..., embeds=..., embed=..., attachments=..., view=..., allowed_mentions=None)¶
This function is a coroutine.
メッセージを編集します。
バージョン 1.6 で追加.
バージョン 2.0 で変更: 編集はメッセージを置き換えず、編集された新しいメッセージが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
content (Optional[
str
]) -- メッセージの内容を編集する場合はそのメッセージを、内容を削除する際は、None
を指定します。embeds (List[
Embed
]) -- メッセージを編集するための埋め込みのリスト。embed (Optional[
Embed
]) -- メッセージを編集するための埋め込み。None
を渡すと埋め込みが除去されます。embeds
パラメータと同時に使用できません。attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。注釈
新しいファイルは常に現在の添付ファイルのあとに表示されます。
バージョン 2.0 で追加.
allowed_mentions (
AllowedMentions
) -- このメッセージで処理されるメンションを制御します。詳細はabc.Messageable.send()
を参照してください。view (Optional[
View
]) --このメッセージを更新するために更新されたビュー。
None
が渡された場合、ビューは削除されます。バージョン 2.0 で追加.
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、もしくはこのwebhookに紐付けられたトークンがない場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await add_files(*files)¶
This function is a coroutine.
メッセージの添付ファイルの末尾に新しいファイルを追加します。
バージョン 2.0 で追加.
- パラメータ
*files (
File
) -- メッセージに追加する新しいファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await remove_attachments(*attachments)¶
This function is a coroutine.
メッセージの添付ファイルを削除します。
バージョン 2.0 で追加.
- パラメータ
*attachments (
Attachment
) -- メッセージから削除する添付ファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await delete(*, delay=None)¶
This function is a coroutine.
メッセージを削除します。
- パラメータ
delay (Optional[
float
]) -- 指定された場合、メッセージを削除するまでの待機秒数。待機はバックグラウンドで行われ、削除の失敗は無視されます。- 例外
Forbidden -- メッセージを削除するための適切な権限がない場合。
NotFound -- メッセージがすでに削除されている場合。
HTTPException -- メッセージの削除に失敗した場合。
- await add_reaction(emoji, /)¶
This function is a coroutine.
メッセージにリアクションを追加します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うためには、そのチャンネルにて
read_message_history
が必要です。 もし、他の人がその絵文字でリアクションしていない場合、さらにadd_reactions
が必要です。バージョン 2.0 で変更:
emoji
引数は位置限定引数になりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- リアクションとして追加する絵文字。- 例外
HTTPException -- リアクションの追加に失敗した場合。
Forbidden -- メッセージにリアクションを付けるのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- clean_content¶
クリーンアップされたメッセージ内容を返すプロパティ。基本的に、これはメンションをクライアントが表示するようなものに変換にする、という意味です。例えば、
<#id>
は#name
に変換されます。また、これは @everyone メンション や @here メンションを、メンション機能の無いメッセージに変換します。
注釈
これはマークダウンには影響 しません 。マークダウンをエスケープまたは削除したい場合は、この関数とともに
utils.escape_markdown()
かutils.remove_markdown()
を使用してください。- 型
- await clear_reaction(emoji)¶
This function is a coroutine.
メッセージから特定のリアクションを除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うには、
manage_messages
が必要です。バージョン 1.3 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションを除去するのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await clear_reactions()¶
This function is a coroutine.
メッセージからリアクションをすべて除去します。
これを行うには、
manage_messages
が必要です。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
- await create_thread(*, name, auto_archive_duration=..., slowmode_delay=None, reason=None)¶
This function is a coroutine.
メッセージからパブリックスレッドを作成します。
メッセージからパブリックスレッドを作成するには、
create_public_threads
権限が必要です。このメッセージが属するチャンネルは、
TextChannel
でなければなりません。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- スレッドの名前。auto_archive_duration (
int
) -- スレッドがチャンネルリストから自動的に非表示になるまでの分単位の時間。 指定されていない場合、チャンネルのデフォルトの自動アーカイブ期間が使用されます。指定された場合は、60
、1440
、4320
、または10080
のいずれかでないといけません。slowmode_delay (Optional[
int
]) -- このチャンネルの秒単位での低速モードレート制限。 最大値は21600
です。デフォルトはNone
でこの場合は低速モードレート制限が無しとなります。reason (Optional[
str
]) -- スレッドを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- スレッドを作成する権限を持っていない場合。
HTTPException -- スレッドの作成に失敗した場合。
ValueError -- メッセージがギルド情報を持っていない場合。
- 戻り値
作成されたスレッド。
- 戻り値の型
- property created_at¶
UTCの、メッセージが作成された時刻。
- property edited_at¶
メッセージの編集時間を含んだ、awareなUTCのdatetimeオブジェクト。
- 型
Optional[
datetime.datetime
]
- await fetch()¶
This function is a coroutine.
部分的なメッセージを完全な
Message
に変換します。- 例外
NotFound -- メッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
完全なメッセージ。
- 戻り値の型
- await fetch_thread()¶
This function is a coroutine.
Retrieves the public thread attached to this message.
注釈
This method is an API call. For general usage, consider
thread
instead.バージョン 2.4 で追加.
- 例外
InvalidData -- An unknown channel type was received from Discord or the guild the thread belongs to is not the same as the one in this object points to.
HTTPException -- Retrieving the thread failed.
NotFound -- There is no thread attached to this message.
Forbidden -- このチャンネルからメッセージを取得する権限がない場合。
- 戻り値
The public thread attached to this message.
- 戻り値の型
- is_system()¶
bool
: メッセージがシステムメッセージかどうか。システムメッセージは、何かの応答としてDiscord APIによって構築されるメッセージです。
バージョン 1.3 で追加.
- await pin(*, reason=None)¶
This function is a coroutine.
メッセージをピン留めします。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージをピン留めする理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージをピン留めする権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- チャンネルにすでに50個ピン留めされたメッセージがあるなどの理由で、メッセージのピン留めに失敗した場合。
- await publish()¶
This function is a coroutine.
このメッセージをチャンネルのフォロワーに公開します。
メッセージはニュースチャンネルで送信されている必要があります。これを行うには、
send_messages
が必要です。自身のメッセージ以外の場合は
manage_messages
も必要です。- 例外
Forbidden -- このメッセージを公開するための適切な権限がないか、チャンネルがニュースチャンネルでない場合。
HTTPException -- メッセージの公開に失敗した場合。
- raw_mentions¶
メッセージ内容から、
<@user_id>
の構文に一致したもののuser_idのリストを返すプロパティです。これによって、メッセージがプライベートチャンネル内のものであってもメンションされたユーザーのIDを受け取ることができます。
- 型
List[
int
]
- await remove_reaction(emoji, member)¶
This function is a coroutine.
メッセージからあるメンバーによるリアクションをすべて除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。もしリアクションがあなたのものではなければ(つまり、
member
パラメーターがあなたでないなら)、manage_messages
も必要になります。member
パラメータはメンバーを示しabc.Snowflake
抽象基底クラスを満たす必要があります。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。member (
abc.Snowflake
) -- リアクションを除去すべきメンバー。
- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
NotFound -- 指定されたメンバーや絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await reply(content=None, **kwargs)¶
This function is a coroutine.
Message
に返信するためのabc.Messageable.send()
のショートカットメソッド。バージョン 1.6 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
リストの大きさが適切でない場合。TypeError --
file
とfiless
の両方を指定した場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- system_content¶
Message.type
に関わらず、レンダリングされた際のメッセージ内容を返すプロパティ。MessageType.default
とMessageType.reply
の場合、これはMessage.content
と同じものを返すだけです。しかしそれ以外の場合は、システムメッセージの英語版を返します。- 型
- property thread¶
The public thread created from this message, if it exists.
注釈
For messages received via the gateway this does not retrieve archived threads, as they are not retained in the internal cache. Use
fetch_thread()
instead.バージョン 2.4 で追加.
- 型
Optional[
Thread
]
- to_reference(*, fail_if_not_exists=True)¶
現在のメッセージから
MessageReference
を作成します。バージョン 1.6 で追加.
- パラメータ
fail_if_not_exists (
bool
) --メッセージ参照を使用して返信するとき、メッセージが存在しなくなった場合、またはDiscordがメッセージを取得できなかった場合、
HTTPException
を送出させるかどうか。バージョン 1.7 で追加.
- 戻り値
メッセージへの参照。
- 戻り値の型
- await unpin(*, reason=None)¶
This function is a coroutine.
メッセージのピン留めを外します。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージのピン留めを解除した理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージのピン留めを外す権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- メッセージのピン留め解除に失敗した場合。
SyncWebhook¶
- clsSyncWebhook.from_url
- clsSyncWebhook.partial
- defdelete
- defdelete_message
- defedit
- defedit_message
- deffetch
- deffetch_message
- defis_authenticated
- defis_partial
- defsend
- class discord.SyncWebhook¶
同期的なDiscord webhookです。
非同期対応については、
Webhook
を参照してください。- x == y
二つのWebhookが等しいか比較します。
- x != y
二つのWebhookが等しいものでないか比較します。
- hash(x)
Webhookのハッシュを返します。
バージョン 1.4 で変更: Webhookが比較・ハッシュ可能になりました。
- type¶
Webhookのタイプ。
バージョン 1.3 で追加.
- source_guild¶
Webhookがフォローしているチャンネルのギルド。
type
がWebhookType.channel_follower
のときのみ与えられます。バージョン 2.0 で追加.
- 型
Optional[
PartialWebhookGuild
]
- source_channel¶
Webhookがフォローしているチャンネル。
type
がWebhookType.channel_follower
のときのみ与えられます。バージョン 2.0 で追加.
- 型
Optional[
PartialWebhookChannel
]
- classmethod partial(id, token, *, session=..., bot_token=None)¶
部分的な
Webhook
を作成します。- パラメータ
id (
int
) -- WebhookのID。token (
str
) -- Webhookの認証トークン。session (
requests.Session
) -- リクエストを送信するために使うセッション。ライブラリはセッションを管理しておらず、セッションを閉じないことに注意してください。指定されていない場合は、代わりにrequests
の自動セッション作成関数が使用されます。bot_token (Optional[
str
]) -- Webhook関連の認証が必要なリクエストに使用するボットの認証トークン。
- 戻り値
部分的な
SyncWebhook
。部分的なSyncWebhook
はただのIDとトークンのみを持つSyncWebhook
オブジェクトです。- 戻り値の型
- classmethod from_url(url, *, session=..., bot_token=None)¶
WebhookのURLから部分的な
Webhook
を作成します。- パラメータ
url (
str
) -- WebhookのURL。session (
requests.Session
) -- リクエストを送信するために使うセッション。ライブラリはセッションを管理しておらず、セッションを閉じないことに注意してください。指定されていない場合は、代わりにrequests
の自動セッション作成関数が使用されます。bot_token (Optional[
str
]) -- Webhook関連の認証が必要なリクエストに使用するボットの認証トークン。
- 例外
ValueError -- URLが無効な場合。
- 戻り値
部分的な
SyncWebhook
。部分的なSyncWebhook
はただのIDとトークンのみを持つSyncWebhook
オブジェクトです。- 戻り値の型
- fetch(*, prefer_auth=True)¶
現在のWebhookを取得します。
これは部分的なWebhookから完全なWebhookを取得するのに利用できます。
注釈
認証されていないWebhook、つまり
is_authenticated()
がFalse
を返すものでは、返されたWebhookにはユーザー情報が含まれません。- パラメータ
prefer_auth (
bool
) -- 利用可能な場合にWebhookトークンではなくボットトークンを使用するか。既定ではTrue
。- 例外
HTTPException -- Webhookを取得できなかった場合。
NotFound -- このIDを持つWebhookが見つからない場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- 戻り値
フェッチしたWebhook。
- 戻り値の型
- delete(*, reason=None, prefer_auth=True)¶
この Webhook を削除します。
- パラメータ
- 例外
HTTPException -- Webhookの削除に失敗した場合。
NotFound -- Webhookが存在しない場合。
Forbidden -- Webhookを削除する権限がない場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- edit(*, reason=None, name=..., avatar=..., channel=None, prefer_auth=True)¶
このWebhookを編集します。
- パラメータ
name (Optional[
str
]) -- Webhookの新しい既定の名前。avatar (Optional[
bytes
]) -- Webhookの新しい既定のアバターを示す bytes-like object 。channel (Optional[
abc.Snowflake
]) -- Webhookの新しいチャンネル。設定するには認証済みWebhookが必要です。reason (Optional[
str
]) --Webhookを編集する理由。監査ログに表示されます。
バージョン 1.4 で追加.
prefer_auth (
bool
) -- 利用可能な場合にWebhookトークンではなくボットトークンを使用するか。既定ではTrue
。
- 例外
HTTPException -- Webhookの編集に失敗した場合。
NotFound -- Webhookが存在しない場合。
ValueError -- Webhookに紐づいたトークンがない場合や、認証せずにチャンネルを編集しようとした場合。
- 戻り値
編集された新しいWebhook。
- 戻り値の型
- send(content=..., *, username=..., avatar_url=..., tts=False, file=..., files=..., embed=..., embeds=..., allowed_mentions=..., thread=..., thread_name=..., wait=False, suppress_embeds=False, silent=False, applied_tags=...)¶
Webhookを使用してメッセージを送信します。
contentは
str(content)
で文字列に変換できるものでなければなりません。ファイルを一つだけアップロードするには、
file
パラメータにFile
オブジェクトを渡します。embed
パラメータが渡された場合は、型がEmbed
であり、その種類はrichでないといけません。embed
パラメータは、送信するEmbed
のlist
であるembeds
パラメータと同時に使用できません。- パラメータ
content (
str
) -- 送信するメッセージの内容。wait (
bool
) -- サーバーが応答を送信するまで待機するかどうか。True
が指定された場合、これは基本的にこの関数の戻り値の型がNone
からWebhookMessage
に変更されることを意味します。username (
str
) -- このメッセージを送信するユーザー名。ユーザー名が指定されていない場合、Webhookのデフォルトのユーザー名が使用されます。avatar_url (
str
) -- このメッセージと共に送信するアバターのURL。アバターURLが指定されていない場合、Webhookのデフォルトアバターが使用されます。 これが文字列でない場合は、str
を使って明示的にキャストされます。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。file (
File
) -- アップロードするファイル。files
パラメータと同時に使用できません。files (List[
File
]) -- コンテンツといっしょに送信するファイルのリスト。file
パラメータと同時に使用できません。embed (
Embed
) -- 送信するリッチな埋め込み。embeds
パラメータと同時に使用できません。embeds (List[
Embed
]) -- 送信するリッチな埋め込みのリスト。最大10個です。embed
パラメータと同時に使用できません。allowed_mentions (
AllowedMentions
) --メッセージ内で処理されるべきメンションを制御します。
バージョン 1.4 で追加.
thread (
Snowflake
) --このメッセージを送信するスレッド。
バージョン 2.0 で追加.
thread_name (
str
) --Webhookが
ForumChannel
に属する場合、このWebhookで作成するスレッドの名前。なお、これは与えられた名前の新しいスレッドを作成するため、thread
パラメータと同時に使用できません。バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
NotFound -- Webhookが見つからなかった場合。
Forbidden -- Webhookの認証トークンが正しくない場合。
TypeError --
embed
とembeds
またはfile
とfiles
またはthread
とthread_name
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、もしくはこのwebhookに紐付けられたトークンがない場合。
- 戻り値
wait
がTrue
のとき、送信されたメッセージ、それ以外の場合はNone
。- 戻り値の型
Optional[
SyncWebhookMessage
]
- fetch_message(id, /, *, thread=...)¶
このwebhookが送信した
SyncWebhookMessage
を1つ取得します。バージョン 2.0 で追加.
- パラメータ
- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- property avatar¶
Webhookのアバターの
Asset
を返します。Webhookが従来のアバターを設定していない場合は、
None
が返されます。Webhookが表示しているアバターを取得したい場合は、display_avatar
を検討してください。- 型
Optional[
Asset
]
- property channel¶
このWebhookが属するチャンネル。
これが部分的なWebhookの場合は常に
None
を返します。- 型
Optional[Union[
ForumChannel
,VoiceChannel
,TextChannel
]]
- property created_at¶
Webhookの作成時刻をUTCで返します。
- property display_avatar¶
Webhookの表示されるアバターを返します。
これはWebhookのデフォルトアバターまたはアップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- edit_message(message_id, *, content=..., embeds=..., embed=..., attachments=..., allowed_mentions=None, thread=...)¶
このWebhookが所有するメッセージを編集します。
これは、IDしか持っていない場合のための、
WebhookMessage.edit()
より低レベルなインターフェースです。バージョン 1.6 で追加.
- パラメータ
message_id (
int
) -- 編集するメッセージ ID。content (Optional[
str
]) -- メッセージの内容を編集する場合はそのメッセージを、内容を削除する際は、None
を指定します。embeds (List[
Embed
]) -- メッセージを編集するための埋め込みのリスト。embed (Optional[
Embed
]) -- メッセージを編集するための埋め込み。None
を渡すと埋め込みが除去されます。embeds
パラメータと同時に使用できません。attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。バージョン 2.0 で追加.
allowed_mentions (
AllowedMentions
) -- このメッセージで処理されるメンションを制御します。詳細はabc.Messageable.send()
を参照してください。thread (
Snowflake
) --Webhookメッセージが属するスレッド。
バージョン 2.0 で追加.
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、もしくはこのwebhookに紐付けられたトークンがない場合。
- delete_message(message_id, /, *, thread=...)¶
このWebhookが所有するメッセージを削除します。
これは、IDしか持っていない場合のための、
WebhookMessage.delete()
より低レベルなインターフェースです。バージョン 1.6 で追加.
- パラメータ
- 例外
HTTPException -- メッセージの削除に失敗した場合。
Forbidden -- 自分以外のメッセージを削除しようとした場合。
ValueError -- Webhookに紐づいたトークンが存在しない場合。
SyncWebhookMessage¶
- defadd_files
- defdelete
- defedit
- defremove_attachments
- class discord.SyncWebhookMessage¶
Webhookから送信されたメッセージです。
これにより、webhookから送信されたメッセージを編集、または削除できます。
これは
edit()
とdelete()
が機能するように変更された上でdiscord.Message
を継承しています。バージョン 2.0 で追加.
- edit(*, content=..., embeds=..., embed=..., attachments=..., allowed_mentions=None)¶
メッセージを編集します。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- メッセージの内容を編集する場合はそのメッセージを、内容を削除する際は、None
を指定します。embeds (List[
Embed
]) -- メッセージを編集するための埋め込みのリスト。embed (Optional[
Embed
]) -- メッセージを編集するための埋め込み。None
を渡すと埋め込みが除去されます。embeds
パラメータと同時に使用できません。attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。注釈
新しいファイルは常に現在の添付ファイルのあとに表示されます。
バージョン 2.0 で追加.
allowed_mentions (
AllowedMentions
) -- このメッセージで処理されるメンションを制御します。詳細はabc.Messageable.send()
を参照してください。
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。ValueError --
embeds
の長さが不正な場合、もしくはこのwebhookに紐付けられたトークンがない場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- add_files(*files)¶
メッセージの添付ファイルの末尾に新しいファイルを追加します。
バージョン 2.0 で追加.
- パラメータ
*files (
File
) -- メッセージに追加する新しいファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- remove_attachments(*attachments)¶
メッセージの添付ファイルを削除します。
バージョン 2.0 で追加.
- パラメータ
*attachments (
Attachment
) -- メッセージから削除する添付ファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- delete(*, delay=None)¶
メッセージを削除します。
- パラメータ
delay (Optional[
float
]) -- 指定された場合、メッセージを削除するまでの待機秒数。これはスレッドをブロックします。- 例外
Forbidden -- メッセージを削除するための適切な権限がない場合。
NotFound -- メッセージがすでに削除されている場合。
HTTPException -- メッセージの削除に失敗した場合。
抽象基底クラス¶
abstract base class ( abc
という名称でも知られています)はモデルが振る舞いを得るために継承するクラスです。 抽象基底クラスはインスタンス化されるべきではありません。 これらは主に isinstance()
や issubclass()
で使用するために存在します。
このライブラリには抽象基底クラスに関連するモジュールがあり、その中の抽象基底クラスは全て typing.Protocol
のサブクラスです。
Snowflake¶
- class discord.abc.Snowflake¶
Discordモデルに共通する処理を説明するABC。
ほぼすべての Discord models がこの抽象基底クラスを満たしています。
スノーフレークを自分で作成したい場合は、
Object
を使用することを検討してください。
User¶
- defmentioned_in
- class discord.abc.User¶
Discordユーザーに共通する処理を説明するABC。
以下のクラスがこのABCを実装しています:
この抽象基底クラスは
Snowflake
も実装しなければなりません。- property avatar_decoration¶
Returns an Asset that represents the user's avatar decoration, if present.
バージョン 2.4 で追加.
- 型
Optional[
Asset
]
- property avatar_decoration_sku_id¶
Returns an integer that represents the user's avatar decoration SKU ID, if present.
バージョン 2.4 で追加.
- 型
Optional[
int
]
- property display_avatar¶
ユーザーの表示されるアバターを返します。
通常のユーザーの場合は、これはデフォルトのアバターか、アップロードされたアバターです。
バージョン 2.0 で追加.
- 型
PrivateChannel¶
GuildChannel¶
- asyncclone
- asynccreate_invite
- asyncdelete
- asyncinvites
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncset_permissions
- class discord.abc.GuildChannel¶
Discordのギルドチャンネルに共通する処理を説明するABC。
以下のクラスがこのABCを実装しています:
この抽象基底クラスは
Snowflake
も実装しなければなりません。- property created_at¶
チャンネルの作成された時間をUTCで返します。
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
Messageable¶
- asyncfetch_message
- async forhistory
- asyncpins
- asyncsend
- deftyping
- class discord.abc.Messageable¶
メッセージを送信できるモデルに共通する操作を説明するABC。
以下のクラスがこのABCを実装しています:
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
Connectable¶
- asyncconnect
- class discord.abc.Connectable¶
ボイスサーバーに接続できるチャンネルに共通する操作を説明するABC。
以下のクラスがこのABCを実装しています:
- await connect(*, timeout=30.0, reconnect=True, cls=<class 'discord.voice_client.VoiceClient'>, self_deaf=False, self_mute=False)¶
This function is a coroutine.
ボイスに接続し
VoiceClient
を作成してボイスサーバーへの接続を確立します。voice_states
が必要です。- パラメータ
timeout (
float
) -- The timeout in seconds to wait the connection to complete.reconnect (
bool
) -- ハンドシェイクの一部が失敗し、またはゲートウェイが使用できない場合に、ボットが自動で再接続を試みるべきか。cls (Type[
VoiceProtocol
]) --VoiceProtocol
をサブクラスする型。既定値はVoiceClient
。self_mute (
bool
) --クライアントをセルフミュートすべきか。
バージョン 2.0 で追加.
self_deaf (
bool
) --クライアントをセルフスピーカーミュートすべきか。
バージョン 2.0 で追加.
- 例外
asyncio.TimeoutError -- 時間内にボイスチャンネルに接続できなかった場合。
ClientException -- すでにボイスチャンネルに接続している場合。
OpusNotLoaded -- opusライブラリが読み込まれていない場合。
- 戻り値
ボイスサーバーに完全に接続されたボイスクライアント。
- 戻り値の型
Discordモデル¶
モデルはDiscordから受け取るクラスであり、ユーザーによって作成されることを想定していません。
危険
下記のクラスは、 ユーザーによって作成されることを想定しておらず 、中には 読み取り専用 のものもあります。
つまり、独自の User
を作成したりするべきではなく、また、 User
インスタンスの値の変更もするべきではありません。
このようなモデルクラスのインスタンスを取得したい場合は、 キャッシュを経由して取得する必要があります。一般的な方法としては utils.find()
関数を用いるか、 イベントリファレンス の特定のイベントから受け取る方法が挙げられます。
注釈
ほぼすべてのクラスに __slots__ が定義されています。つまり、データクラスに動的に変数を追加することは不可能です。
ClientUser¶
- asyncedit
- defmentioned_in
- class discord.ClientUser¶
あなたのDiscordユーザー。
- x == y
二つのユーザーが等しいかを比較します。
- x != y
二つのユーザーが等しいものではないか比較します。
- hash(x)
ユーザーのハッシュ値を返します。
- str(x)
ユーザーのハンドル(例えば
name
やname#discriminator
など)を返します。
- await edit(*, username=..., avatar=..., banner=...)¶
This function is a coroutine.
現在のクライアントのプロフィールを編集します。
注釈
アバターをアップロードする際には、アップロードする画像を表す bytes-like object を渡す必要があります。これをファイルを介して行う場合、ファイルを
open('some_filename', 'rb')
で開き、 bytes-like object はfp.read()
で取得できます。バージョン 2.0 で変更: 編集はクライアントユーザーを置き換えず、編集された新しいクライアントユーザーが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
username (
str
) -- 変更する際の新しいユーザー名。avatar (Optional[
bytes
]) -- A bytes-like object representing the image to upload. Could beNone
to denote no avatar. Only image formats supported for uploading are JPEG, PNG, GIF, and WEBP.banner (Optional[
bytes
]) --A bytes-like object representing the image to upload. Could be
None
to denote no banner. Only image formats supported for uploading are JPEG, PNG, GIF and WEBP.バージョン 2.4 で追加.
- 例外
HTTPException -- プロフィールの編集に失敗した場合。
ValueError --
avatar
に渡された画像のフォーマットが間違っている場合。
- 戻り値
新しく編集されたクライアントユーザー。
- 戻り値の型
- property mutual_guilds¶
ユーザーがクライアントと共有するギルド。
注釈
クライアントの内部キャッシュ内に存在する共通のサーバーのみが返されます。
バージョン 1.7 で追加.
- 型
List[
Guild
]
- property accent_color¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_colour
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property accent_colour¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_color
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property avatar¶
ユーザーのアバターの
Asset
を返します。ユーザーがグローバルのアバターをアップロードしていない場合は、
None
が返されます。ユーザーが表示しているアバターを取得したい場合は、display_avatar
を検討してください。- 型
Optional[
Asset
]
- property avatar_decoration¶
Returns an
Asset
for the avatar decoration the user has.If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
Asset
]
- property avatar_decoration_sku_id¶
Returns the SKU ID of the avatar decoration the user has.
If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
int
]
- property banner¶
利用できる場合、ユーザーのバナーのアセットを返します。
バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Asset
]
- property color¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。colour
という名前のエイリアスが存在します。- 型
- property colour¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。color
という名前のエイリアスが存在します。- 型
- property created_at¶
ユーザーの作成された時間をUTCで返します。
これはユーザーのDiscordアカウントが作成された時間です。
- property display_avatar¶
ユーザーの表示されるアバターを返します。
通常のユーザーの場合は、これはデフォルトのアバターか、アップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- property display_name¶
ユーザーの表示名を返します。
通常であれば、これはグローバル表示名またはユーザー名がそのまま返りますが、ギルドにてニックネームを設定している場合は、代替としてニックネームが返ります。
- 型
- mentioned_in(message)¶
指定のメッセージにユーザーに対するメンションが含まれているかを確認します。
- property public_flags¶
ユーザーが持っている公開のフラグ。
User¶
- asynccreate_dm
- asyncfetch_message
- async forhistory
- defmentioned_in
- asyncpins
- asyncsend
- deftyping
- class discord.User¶
Discordユーザー。
- x == y
二つのユーザーが等しいかを比較します。
- x != y
二つのユーザーが等しいものではないか比較します。
- hash(x)
ユーザーのハッシュ値を返します。
- str(x)
ユーザーのハンドル(例えば
name
やname#discriminator
など)を返します。
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property dm_channel¶
存在する場合は、そのユーザーに関連付けられたチャンネルを返します。
これが
None
を返すなら、あなたはcreate_dm()
コルーチン関数を使って、DMチャンネルを作ることができます。- 型
Optional[
DMChannel
]
- property mutual_guilds¶
ユーザーがクライアントと共有するギルド。
注釈
クライアントの内部キャッシュ内に存在する共通のサーバーのみが返されます。
バージョン 1.7 で追加.
- 型
List[
Guild
]
- property accent_color¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_colour
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property accent_colour¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_color
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property avatar¶
ユーザーのアバターの
Asset
を返します。ユーザーがグローバルのアバターをアップロードしていない場合は、
None
が返されます。ユーザーが表示しているアバターを取得したい場合は、display_avatar
を検討してください。- 型
Optional[
Asset
]
- property avatar_decoration¶
Returns an
Asset
for the avatar decoration the user has.If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
Asset
]
- property avatar_decoration_sku_id¶
Returns the SKU ID of the avatar decoration the user has.
If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
int
]
- property banner¶
利用できる場合、ユーザーのバナーのアセットを返します。
バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Asset
]
- property color¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。colour
という名前のエイリアスが存在します。- 型
- property colour¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。color
という名前のエイリアスが存在します。- 型
- await create_dm()¶
This function is a coroutine.
このユーザーと
DMChannel
を作ります。これは、ほとんどの人にとっては自動で行われるため、呼び出す必要はめったにありません。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- property created_at¶
ユーザーの作成された時間をUTCで返します。
これはユーザーのDiscordアカウントが作成された時間です。
- property display_avatar¶
ユーザーの表示されるアバターを返します。
通常のユーザーの場合は、これはデフォルトのアバターか、アップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- property display_name¶
ユーザーの表示名を返します。
通常であれば、これはグローバル表示名またはユーザー名がそのまま返りますが、ギルドにてニックネームを設定している場合は、代替としてニックネームが返ります。
- 型
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- mentioned_in(message)¶
指定のメッセージにユーザーに対するメンションが含まれているかを確認します。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- property public_flags¶
ユーザーが持っている公開のフラグ。
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
AutoMod¶
- class discord.AutoModRule¶
自動管理ルールを表します。
バージョン 2.0 で追加.
- trigger¶
ルールの発動条件。
- event_type¶
The type of event that will trigger the the rule.
- exempt_channels¶
このルールの除外対象のチャンネル。
- 型
List[Union[
abc.GuildChannel
,Thread
]]
- actions¶
このルールの発動時の対応。
- 型
List[
AutoModRuleAction
]
- is_exempt(obj, /)¶
オブジェクトが自動管理ルールから除外されているかどうかを確認します。
- パラメータ
obj (
abc.Snowflake
) -- チェックするロール、チャンネル、またはスレッド。- 戻り値
オブジェクトが自動管理ルールから除外されているかどうか。
- 戻り値の型
- await edit(*, name=..., event_type=..., actions=..., trigger=..., enabled=..., exempt_roles=..., exempt_channels=..., reason=...)¶
This function is a coroutine.
この自動管理ルールを編集します。
ルールを編集するには、
Permissions.manage_guild
権限が必要です。- パラメータ
name (
str
) -- 新しい名前。event_type (
AutoModRuleEventType
) -- 新しいイベントの種類。actions (List[
AutoModRuleAction
]) -- 新しいルールの対応。trigger (
AutoModTrigger
) -- 新しい発動条件。種類は変更できず、メタデータのみ変更できます。enabled (
bool
) -- ルールを有効化するか。exempt_roles (Sequence[
abc.Snowflake
]) -- ルールの除外対象とする新しいロール。exempt_channels (Sequence[
abc.Snowflake
]) -- ルールの除外対象とする新しいチャンネル。reason (
str
) -- ルールを編集する理由。監査ログに表示されます。
- 例外
Forbidden -- ルールを編集する権限がない場合。
HTTPException -- ルールの編集に失敗した場合。
- 戻り値
更新された自動管理ルール。
- 戻り値の型
- await delete(*, reason=...)¶
This function is a coroutine.
自動管理ルールを削除します。
ルールを削除するには、
Permissions.manage_guild
権限が必要です。- パラメータ
reason (
str
) -- ルールを削除する理由。監査ログに表示されます。- 例外
Forbidden -- ルールを削除する権限がない場合。
HTTPException -- ルールの削除に失敗した場合。
- asyncfetch_rule
- class discord.AutoModAction¶
自動管理ルールの結果として取られた対応を表します。
バージョン 2.0 で追加.
- action¶
行われた対応。
- rule_trigger_type¶
発動されたルールの発動条件の種類。
- content¶
ルールを発動させたメッセージの内容。
Intents.message_content
が必要で、ない場合は空文字列を返します。- 型
- matched_content¶
ルールを発動させたメッセージのマッチした内容。
Intents.message_content
が必要で、ない場合はNone
を返します。- 型
Optional[
str
]
- property channel¶
この対応がとられたチャンネル。
- 型
Optional[Union[
abc.GuildChannel
,Thread
]]
- await fetch_rule()¶
This function is a coroutine.
対応がとられたルールを取得します。
これを行うには、
Permissions.manage_guild
が必要です。- 例外
Forbidden -- ルールを取得する権限がない場合。
HTTPException -- ルールの取得に失敗した場合。
- 戻り値
発動されたルール。
- 戻り値の型
Attachment¶
- defis_spoiler
- defis_voice_message
- asyncread
- asyncsave
- asyncto_file
- class discord.Attachment¶
Discordの添付ファイル。
- str(x)
添付ファイルの URL を返します。
- x == y
添付ファイルが別の添付ファイルと等しいか確認します。
- x != y
添付ファイルが別の添付ファイルと等しくないか確認します。
- hash(x)
添付ファイルの ハッシュ を返します。
バージョン 1.7 で変更: 添付ファイルが
str
にキャスト可能になり、ハッシュ可能になりました。- property flags¶
The attachment's flags.
- await save(fp, *, seek_begin=True, use_cached=False)¶
This function is a coroutine.
この添付ファイルをファイルライクオブジェクトに保存します。
- パラメータ
fp (Union[
io.BufferedIOBase
,os.PathLike
]) -- この添付ファイルを保存するファイルライクオブジェクト、または使用するファイル名。 ファイル名が渡された場合、そのファイル名でファイルが作成され、代わりに使用されます。seek_begin (
bool
) -- 正常に保存した後にファイルの先頭にシークすべきか。use_cached (
bool
) -- 添付ファイルのダウンロード時にurl
の代わりにproxy_url
を使用すべきか。これを使うと、一般的にメッセージの削除直後に削除される通常のURLと比較して、削除後の添付ファイルの保存がより頻繁にできるようになります。なお、時間がたつと削除された添付ファイルのダウンロードに失敗することがあり、添付ファイルの種類によっては動かないことがあります。
- 例外
HTTPException -- 添付ファイルの保存に失敗した場合。
NotFound -- 添付ファイルが削除された場合。
- 戻り値
書き込まれたバイト数。
- 戻り値の型
- await read(*, use_cached=False)¶
This function is a coroutine.
この添付ファイルの内容を
bytes
オブジェクトとして取得します。バージョン 1.1 で追加.
- パラメータ
use_cached (
bool
) -- 添付ファイルのダウンロード時にurl
の代わりにproxy_url
を使用すべきか。これを使うと、一般的にメッセージの削除直後に削除される通常のURLと比較して、削除後の添付ファイルの保存がより頻繁にできるようになります。なお、時間がたつと削除された添付ファイルのダウンロードに失敗することがあり、添付ファイルの種類によっては動かないことがあります。- 例外
HTTPException -- 添付ファイルのダウンロードに失敗した場合。
Forbidden -- この添付ファイルにアクセスする権限がない場合。
NotFound -- 添付ファイルが削除された場合。
- 戻り値
添付ファイルの内容。
- 戻り値の型
- await to_file(*, filename=..., description=..., use_cached=False, spoiler=False)¶
This function is a coroutine.
この添付ファイルを
abc.Messageable.send()
で送信できるFile
に変換します。バージョン 1.3 で追加.
- パラメータ
filename (Optional[
str
]) --ファイルに使用するファイル名。指定しない場合は、添付ファイルのファイル名が代わりに使用されます。
バージョン 2.0 で追加.
description (Optional[
str
]) --ファイルに使用する説明。指定しない場合は、添付ファイルの説明が代わりに使用されます。
バージョン 2.0 で追加.
use_cached (
bool
) --添付ファイルのダウンロード時に
url
の代わりにproxy_url
を使用すべきか。これを使うと、一般的にメッセージの削除直後に削除される通常のURLと比較して、削除後の添付ファイルの保存がより頻繁にできるようになります。なお、時間がたつと削除された添付ファイルのダウンロードに失敗することがあり、添付ファイルの種類によっては動かないことがあります。バージョン 1.4 で追加.
spoiler (
bool
) --このファイルがスポイラーを含むか。
バージョン 1.4 で追加.
- 例外
HTTPException -- 添付ファイルのダウンロードに失敗した場合。
Forbidden -- この添付ファイルにアクセスする権限がない場合。
NotFound -- 添付ファイルが削除された場合。
- 戻り値
送信に適したファイルに変換された添付ファイル。
- 戻り値の型
Asset¶
- defis_animated
- asyncread
- defreplace
- asyncsave
- asyncto_file
- defwith_format
- defwith_size
- defwith_static_format
- class discord.Asset¶
DiscordのCDNアセット。
- str(x)
CDNアセットのURLを返します。
- len(x)
CDNアセットのURLの長さを返します。
- x == y
アセットが別のアセットと等しいか確認します。
- x != y
アセットが別のアセットと等しくないか確認します。
- hash(x)
アセットの ハッシュ を返します。
- replace(*, size=..., format=..., static_format=...)¶
渡された部分を置き換えた新しいアセットを返します。
バージョン 2.0 で変更:
static_format
とformat
が両方存在してアセットがアニメーション付きでない場合に前者が優先されるようになりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
- 例外
ValueError -- 不正な大きさまたはフォーマットが渡された場合。
- 戻り値
新しく更新されたアセット。
- 戻り値の型
- with_size(size, /)¶
指定されたサイズの新しいアセットを返します。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
size (
int
) -- アセットの新しいサイズ。- 例外
ValueError -- アセットのサイズが無効な場合。
- 戻り値
新しく更新されたアセット。
- 戻り値の型
- with_format(format, /)¶
指定されたフォーマットの新しいアセットを返します。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
format (
str
) -- アセットの新しいフォーマット。- 例外
ValueError -- アセットのフォーマットが無効な場合。
- 戻り値
新しく更新されたアセット。
- 戻り値の型
- with_static_format(format, /)¶
指定された静的フォーマットの新しいアセットを返します。
これは、アセットがアニメーションを含まない場合のみフォーマットを変更します。それ以外の場合はアセットは変更されません。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
format (
str
) -- アセットの新しい静的フォーマット。- 例外
ValueError -- アセットのフォーマットが無効な場合。
- 戻り値
新しく更新されたアセット。
- 戻り値の型
- await read()¶
This function is a coroutine.
このアセットの内容を
bytes
オブジェクトとして取得します。- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
アセットの内容。
- 戻り値の型
- await save(fp, *, seek_begin=True)¶
This function is a coroutine.
このアセットをファイルライクオブジェクトに保存します。
- パラメータ
fp (Union[
io.BufferedIOBase
,os.PathLike
]) -- このアセットの保存先となるファイルのようなオブジェクト、または使用するファイル名。ファイル名を指定すると、そのファイル名でファイルが作成され、代わりに使用されます。seek_begin (
bool
) -- 正常に保存した後にファイルの先頭にシークすべきか。
- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
書き込まれたバイト数。
- 戻り値の型
- await to_file(*, filename=..., description=None, spoiler=False)¶
This function is a coroutine.
アセットを
abc.Messageable.send()
を介して送信するのに適したFile
に変換します。バージョン 2.0 で追加.
- パラメータ
- 例外
DiscordException -- アセットにステートが付属していない場合。
ValueError -- アセットがユニコード絵文字である場合。
TypeError -- アセットがロッティータイプのスタンプであった場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
送信に適したファイルとしてのアセット。
- 戻り値の型
Message¶
- activity
- application
- application_id
- attachments
- author
- channel
- channel_mentions
- clean_content
- components
- content
- created_at
- edited_at
- embeds
- flags
- guild
- id
- interaction
- jump_url
- mention_everyone
- mentions
- nonce
- pinned
- position
- raw_channel_mentions
- raw_mentions
- raw_role_mentions
- reactions
- reference
- role_mentions
- role_subscription
- stickers
- system_content
- thread
- tts
- type
- webhook_id
- asyncadd_files
- asyncadd_reaction
- asyncclear_reaction
- asyncclear_reactions
- asynccreate_thread
- asyncdelete
- asyncedit
- asyncfetch
- asyncfetch_thread
- defis_system
- asyncpin
- asyncpublish
- asyncremove_attachments
- asyncremove_reaction
- asyncreply
- defto_reference
- asyncunpin
- class discord.Message¶
Discordのメッセージ。
- x == y
二つのメッセージが等しいかを比較します。
- x != y
二つのメッセージが等しくないかを比較します。
- hash(x)
メッセージのハッシュ値を返します。
- tts¶
メッセージが音声合成で行われたかどうかを指定します。これはDiscordの制約上
on_message()
でのみ正確に受信できます。- 型
- type¶
メッセージの種類。ほとんどの場合これを確認する必要はありませんが、システムメッセージの場合に
system_content
を確認するのに便利です。
- content¶
メッセージの実際の内容。
Intents.message_content
が有効化されていない場合は、ボットがメンションされている場合とDMである場合を除き、これは常に空文字列となります。- 型
- nonce¶
Discordのギルドとクライアントがメッセージが正常に送信されたことを検証するのに使用する値。これはDiscordサーバーに長期間保管されるものではなく、一時的に使用されるだけです。
- embeds¶
メッセージの埋め込みのリスト。
Intents.message_content
が有効化されていない場合は、ボットがメンションされている場合とDMである場合を除き、これは常に空文字列となります。- 型
List[
Embed
]
- channel¶
メッセージの送信された
TextChannel
やThread
。もしメッセージがプライベートチャンネルで送信されたなら、これはDMChannel
かGroupChannel
になります。- 型
Union[
TextChannel
,StageChannel
,VoiceChannel
,Thread
,DMChannel
,GroupChannel
,PartialMessageable
]
- reference¶
このメッセージが参照するメッセージ。これは、種類が
MessageType.pins_add
のメッセージ、チャンネルのフォローによってクロスポストされたメッセージ、または返信のメッセージのみに適用されます。バージョン 1.5 で追加.
- 型
Optional[
MessageReference
]
- mention_everyone¶
メッセージに、全員に対するメンションが含まれているかどうか。
注釈
これは、メッセージ内に
@everyone
や@here
テキストが含まれているどうかをチェックするわけではありません。このブール値は、メッセージに@everyone
や@here
が含まれていて、それが最終的に全員に対するメンションになったかを示しています。- 型
- mentions¶
メンションされた
Member
のリスト。もしメッセージがプライベートチャンネル内のメッセージなら、このリストは代わりにUser
のリストになります。もしメッセージのtypeがMessageType.default
でないなら、このリストはシステムメッセージを支援するために使えます。詳しい情報は、system_content
を参照してください。警告
メンションのリストにおける順序は特定の順序ではないので、順序には依存しないでください。これはライブラリによる制限ではなく、Discord側による制限です。
- 型
List[
abc.User
]
- channel_mentions¶
メンションされた
abc.GuildChannel
とThread
のリスト。もしメッセージがプライベートチャンネル内のものなら、このリストは常に空になります。- 型
List[Union[
abc.GuildChannel
,Thread
]]
- attachments¶
メッセージの添付ファイルのリスト。
Intents.message_content
が有効化されていない場合は、ボットがメンションされている場合とDMである場合を除き、これは常に空文字列となります。- 型
List[
Attachment
]
- flags¶
メッセージの追加機能。
バージョン 1.3 で追加.
- activity¶
このメッセージに関連付けられたアクティビティ。リッチプレゼンスに関連するメッセージとともに送信されます。たとえば、参加リクエスト、観戦、音楽へのリスニングや他のメンバーとのリスニングなどです。
以下のオプションのキーを含む辞書です。
type
: リクエストされたメッセージのアクティビティの種類を示す整数。party_id
: パーティーに関連付けられたパーティーID。
- 型
Optional[
dict
]
- application¶
メッセージに関連付けられたリッチプレゼンスが有効化されたアプリケーション。
バージョン 2.0 で変更: 型が
dict
からMessageApplication
に変更されました。- 型
Optional[
MessageApplication
]
- stickers¶
メッセージのスタンプアイテムのリスト。
バージョン 1.6 で追加.
- 型
List[
StickerItem
]
- components¶
メッセージ内のコンポーネントのリスト。
Intents.message_content
が有効化されていない場合は、ボットがメンションされている場合とDMである場合を除き、これは常に空文字列となります。バージョン 2.0 で追加.
- 型
List[Union[
ActionRow
,Button
,SelectMenu
]]
- interaction¶
このメッセージの応答先のインタラクション。
バージョン 2.0 で追加.
- 型
Optional[
MessageInteraction
]
- role_subscription¶
MessageType.role_subscription_purchase
メッセージを促すきっかけとなったロールサブスクリプションの購入または更新のデータ。バージョン 2.2 で追加.
- 型
Optional[
RoleSubscriptionInfo
]
- application_id¶
このメッセージがアプリケーション所有のWebhookまたはインタラクションによって送信された場合、そのアプリケーションのID。
バージョン 2.2 で追加.
- 型
Optional[
int
]
- await add_reaction(emoji, /)¶
This function is a coroutine.
メッセージにリアクションを追加します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うためには、そのチャンネルにて
read_message_history
が必要です。 もし、他の人がその絵文字でリアクションしていない場合、さらにadd_reactions
が必要です。バージョン 2.0 で変更:
emoji
引数は位置限定引数になりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- リアクションとして追加する絵文字。- 例外
HTTPException -- リアクションの追加に失敗した場合。
Forbidden -- メッセージにリアクションを付けるのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await clear_reaction(emoji)¶
This function is a coroutine.
メッセージから特定のリアクションを除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うには、
manage_messages
が必要です。バージョン 1.3 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションを除去するのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await clear_reactions()¶
This function is a coroutine.
メッセージからリアクションをすべて除去します。
これを行うには、
manage_messages
が必要です。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
- await create_thread(*, name, auto_archive_duration=..., slowmode_delay=None, reason=None)¶
This function is a coroutine.
メッセージからパブリックスレッドを作成します。
メッセージからパブリックスレッドを作成するには、
create_public_threads
権限が必要です。このメッセージが属するチャンネルは、
TextChannel
でなければなりません。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- スレッドの名前。auto_archive_duration (
int
) -- スレッドがチャンネルリストから自動的に非表示になるまでの分単位の時間。 指定されていない場合、チャンネルのデフォルトの自動アーカイブ期間が使用されます。指定された場合は、60
、1440
、4320
、または10080
のいずれかでないといけません。slowmode_delay (Optional[
int
]) -- このチャンネルの秒単位での低速モードレート制限。 最大値は21600
です。デフォルトはNone
でこの場合は低速モードレート制限が無しとなります。reason (Optional[
str
]) -- スレッドを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- スレッドを作成する権限を持っていない場合。
HTTPException -- スレッドの作成に失敗した場合。
ValueError -- メッセージがギルド情報を持っていない場合。
- 戻り値
作成されたスレッド。
- 戻り値の型
- await delete(*, delay=None)¶
This function is a coroutine.
メッセージを削除します。
自身が送信したメッセージは適切な権限が無くとも削除できます。しかし、他人の送信したメッセージを削除する場合には、
manage_messages
が必要です。バージョン 1.1 で変更:
delay
キーワード引数が追加されました。- パラメータ
delay (Optional[
float
]) -- 指定したなら、これはメッセージを削除前に待機する秒数となります。もし削除が失敗しても、それは静かに無視されます。- 例外
Forbidden -- メッセージを削除するための適切な権限がない場合。
NotFound -- メッセージがすでに削除されている場合。
HTTPException -- メッセージの削除に失敗した場合。
- await fetch()¶
This function is a coroutine.
部分的なメッセージを完全な
Message
に変換します。- 例外
NotFound -- メッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
完全なメッセージ。
- 戻り値の型
- await fetch_thread()¶
This function is a coroutine.
Retrieves the public thread attached to this message.
注釈
This method is an API call. For general usage, consider
thread
instead.バージョン 2.4 で追加.
- 例外
InvalidData -- An unknown channel type was received from Discord or the guild the thread belongs to is not the same as the one in this object points to.
HTTPException -- Retrieving the thread failed.
NotFound -- There is no thread attached to this message.
Forbidden -- このチャンネルからメッセージを取得する権限がない場合。
- 戻り値
The public thread attached to this message.
- 戻り値の型
- await pin(*, reason=None)¶
This function is a coroutine.
メッセージをピン留めします。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージをピン留めする理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージをピン留めする権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- チャンネルにすでに50個ピン留めされたメッセージがあるなどの理由で、メッセージのピン留めに失敗した場合。
- await publish()¶
This function is a coroutine.
このメッセージをチャンネルのフォロワーに公開します。
メッセージはニュースチャンネルで送信されている必要があります。これを行うには、
send_messages
が必要です。自身のメッセージ以外の場合は
manage_messages
も必要です。- 例外
Forbidden -- このメッセージを公開するための適切な権限がないか、チャンネルがニュースチャンネルでない場合。
HTTPException -- メッセージの公開に失敗した場合。
- raw_mentions¶
メッセージ内容から、
<@user_id>
の構文に一致したもののuser_idのリストを返すプロパティです。これによって、メッセージがプライベートチャンネル内のものであってもメンションされたユーザーのIDを受け取ることができます。
- 型
List[
int
]
- await remove_reaction(emoji, member)¶
This function is a coroutine.
メッセージからあるメンバーによるリアクションをすべて除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。もしリアクションがあなたのものではなければ(つまり、
member
パラメーターがあなたでないなら)、manage_messages
も必要になります。member
パラメータはメンバーを示しabc.Snowflake
抽象基底クラスを満たす必要があります。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。member (
abc.Snowflake
) -- リアクションを除去すべきメンバー。
- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
NotFound -- 指定されたメンバーや絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await reply(content=None, **kwargs)¶
This function is a coroutine.
Message
に返信するためのabc.Messageable.send()
のショートカットメソッド。バージョン 1.6 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
リストの大きさが適切でない場合。TypeError --
file
とfiless
の両方を指定した場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- to_reference(*, fail_if_not_exists=True)¶
現在のメッセージから
MessageReference
を作成します。バージョン 1.6 で追加.
- パラメータ
fail_if_not_exists (
bool
) --メッセージ参照を使用して返信するとき、メッセージが存在しなくなった場合、またはDiscordがメッセージを取得できなかった場合、
HTTPException
を送出させるかどうか。バージョン 1.7 で追加.
- 戻り値
メッセージへの参照。
- 戻り値の型
- await unpin(*, reason=None)¶
This function is a coroutine.
メッセージのピン留めを外します。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージのピン留めを解除した理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージのピン留めを外す権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- メッセージのピン留め解除に失敗した場合。
- clean_content¶
クリーンアップされたメッセージ内容を返すプロパティ。基本的に、これはメンションをクライアントが表示するようなものに変換にする、という意味です。例えば、
<#id>
は#name
に変換されます。また、これは @everyone メンション や @here メンションを、メンション機能の無いメッセージに変換します。
注釈
これはマークダウンには影響 しません 。マークダウンをエスケープまたは削除したい場合は、この関数とともに
utils.escape_markdown()
かutils.remove_markdown()
を使用してください。- 型
- property created_at¶
UTCの、メッセージが作成された時刻。
- property edited_at¶
メッセージの編集時間を含んだ、awareなUTCのdatetimeオブジェクト。
- 型
Optional[
datetime.datetime
]
- property thread¶
The public thread created from this message, if it exists.
注釈
For messages received via the gateway this does not retrieve archived threads, as they are not retained in the internal cache. Use
fetch_thread()
instead.バージョン 2.4 で追加.
- 型
Optional[
Thread
]
- is_system()¶
bool
: メッセージがシステムメッセージかどうか。システムメッセージは、何かの応答としてDiscord APIによって構築されるメッセージです。
バージョン 1.3 で追加.
- system_content¶
Message.type
に関わらず、レンダリングされた際のメッセージ内容を返すプロパティ。MessageType.default
とMessageType.reply
の場合、これはMessage.content
と同じものを返すだけです。しかしそれ以外の場合は、システムメッセージの英語版を返します。- 型
- await edit(*, content=..., embed=..., embeds=..., attachments=..., suppress=False, delete_after=None, allowed_mentions=..., view=...)¶
This function is a coroutine.
メッセージを編集します。
内容は
str(content)
によって文字列に変換できる必要があります。バージョン 1.3 で変更:
suppress
キーワード引数が追加されました。バージョン 2.0 で変更: 編集はメッセージを置き換えず、編集された新しいメッセージが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
content (Optional[
str
]) -- 現在のメッセージと置き換える新しい内容。内容を削除するためにNone
を指定することもできます。embed (Optional[
Embed
]) -- オリジナルのメッセージと置き換える新しい埋め込み。埋め込みを削除するためにNone
を指定することもできます。embeds (List[
Embed
]) --オリジナルのメッセージと置き換える新しい埋め込み。最大で10個まで指定できます。埋め込みをすべて削除するためには
[]
を指定してください。バージョン 2.0 で追加.
attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。注釈
新しいファイルは常に現在の添付ファイルのあとに表示されます。
バージョン 2.0 で追加.
suppress (
bool
) -- メッセージの埋め込みを除去すべきか。True
に設定するとすべての埋め込みが除去されます。False
に設定すると除去された埋め込みが元に戻ります。このパラメータの使用にはmanage_messages
権限が必要です。delete_after (Optional[
float
]) -- もし指定したなら、これはメッセージを編集したあと待機し削除するまでの秒数です。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (Optional[
AllowedMentions
]) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
view (Optional[
View
]) -- このメッセージを更新するために更新されたビュー。None
が渡された場合、ビューは削除されます。
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 権限なしに埋め込みを除去しようとした場合や、他人のメッセージの内容や埋め込みを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await add_files(*files)¶
This function is a coroutine.
メッセージの添付ファイルの末尾に新しいファイルを追加します。
バージョン 2.0 で追加.
- パラメータ
*files (
File
) -- メッセージに追加する新しいファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await remove_attachments(*attachments)¶
This function is a coroutine.
メッセージの添付ファイルを削除します。
バージョン 2.0 で追加.
- パラメータ
*attachments (
Attachment
) -- メッセージから削除する添付ファイル。- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 自分以外のメッセージを編集しようとした場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
DeletedReferencedMessage¶
- class discord.DeletedReferencedMessage¶
解決されたメッセージ参照が削除されたメッセージを指し示すときに与えられる特別なセンチネルタイプ。
このクラスの目的は、取得できなかった参照されたメッセージと、以前に取得されその後削除されたメッセージを区別することです。
バージョン 1.6 で追加.
Reaction¶
- asyncclear
- defis_custom_emoji
- asyncremove
- async forusers
- class discord.Reaction¶
メッセージのリアクション。
このオブジェクトの作成方法によって、属性の一部が
None
の値になることがあります。- x == y
二つのリアクションが等しいかを比較します。これは絵文字が同一か確認しているため、二つのメッセージの同じリアクションは同一とされます。
- x != y
二つのリアクションが等しくないかを比較します。
- hash(x)
リアクションのハッシュ値を返します。
- str(x)
リアクションの絵文字を表す文字列を返します。
- emoji¶
リアクションの絵文字。カスタム絵文字か、ユニコード絵文字です。
- 型
Union[
Emoji
,PartialEmoji
,str
]
- count¶
Number of times this reaction was made. This is a sum of
normal_count
andburst_count
.- 型
- normal_count¶
The number of times this reaction was made using normal reactions. This is not available in the gateway events such as
on_reaction_add()
oron_reaction_remove()
.バージョン 2.4 で追加.
- 型
- burst_count¶
The number of times this reaction was made using super reactions. This is not available in the gateway events such as
on_reaction_add()
oron_reaction_remove()
.バージョン 2.4 で追加.
- 型
- await remove(user)¶
This function is a coroutine.
指定された
User
からのリアクションをメッセージから除去します。もしリアクションがあなたのものではなければ(つまり、
user
パラメーターがあなたでないなら)、manage_messages
も必要になります。user
パラメータはユーザーを示しabc.Snowflake
抽象基底クラスを満たす必要があります。- パラメータ
user (
abc.Snowflake
) -- リアクションを除去すべきユーザーやメンバー。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
NotFound -- 指定したユーザーかリアクションのメッセージが見つからなかった場合。
- await clear()¶
This function is a coroutine.
メッセージからこのリアクションを除去します。
これを行うには、
manage_messages
が必要です。バージョン 1.3 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションを除去するのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- async for ... in users(*, limit=None, after=None)¶
メッセージにリアクションを付けたユーザーを示す asynchronous iterator を返します。
after
パラメータはメンバーを示しabc.Snowflake
抽象基底クラスを満たす必要があります。バージョン 2.0 で変更:
limit
とafter
パラメータがキーワード専用引数になりました。サンプル
使い方
# I do not actually recommend doing this. async for user in reaction.users(): await channel.send(f'{user} has reacted with {reaction.emoji}!')
リストにフラット化:
users = [user async for user in reaction.users()] # users is now a list of User... winner = random.choice(users) await channel.send(f'{winner} has won the raffle.')
- パラメータ
limit (Optional[
int
]) -- 返す結果の最大数。与えられていない場合は、リアクションを付けたユーザー全員を返します。after (Optional[
abc.Snowflake
]) -- リアクションはメンバーごとにソートされます。
- 例外
HTTPException -- リアクションを付けたユーザーの取得に失敗した場合。
- 列挙
Union[
User
,Member
] -- リアクションを付けたメンバー(取得できる場合)かユーザー。ギルド内ではMember
となります。メンバーがギルドを脱退した場合はUser
になります。
Guild¶
- afk_channel
- afk_timeout
- approximate_member_count
- approximate_presence_count
- banner
- bitrate_limit
- categories
- channels
- chunked
- created_at
- default_notifications
- default_role
- description
- discovery_splash
- dms_paused_until
- emoji_limit
- emojis
- explicit_content_filter
- features
- filesize_limit
- forums
- icon
- id
- invites_paused_until
- large
- max_members
- max_presences
- max_stage_video_users
- max_video_channel_users
- me
- member_count
- members
- mfa_level
- name
- nsfw_level
- owner
- owner_id
- preferred_locale
- premium_progress_bar_enabled
- premium_subscriber_role
- premium_subscribers
- premium_subscription_count
- premium_tier
- public_updates_channel
- roles
- rules_channel
- safety_alerts_channel
- scheduled_events
- self_role
- shard_id
- splash
- stage_channels
- stage_instances
- sticker_limit
- stickers
- system_channel
- system_channel_flags
- text_channels
- threads
- unavailable
- vanity_url
- vanity_url_code
- verification_level
- voice_channels
- voice_client
- widget_channel
- widget_enabled
- asyncactive_threads
- async foraudit_logs
- asyncban
- async forbans
- asyncbulk_ban
- defby_category
- asyncchange_voice_state
- asyncchunk
- asynccreate_automod_rule
- asynccreate_category
- asynccreate_category_channel
- asynccreate_custom_emoji
- asynccreate_forum
- asynccreate_integration
- asynccreate_role
- asynccreate_scheduled_event
- asynccreate_stage_channel
- asynccreate_sticker
- asynccreate_template
- asynccreate_text_channel
- asynccreate_voice_channel
- asyncdelete
- asyncdelete_emoji
- asyncdelete_sticker
- defdms_paused
- asyncedit
- asyncedit_role_positions
- asyncedit_welcome_screen
- asyncedit_widget
- asyncestimate_pruned_members
- asyncfetch_automod_rule
- asyncfetch_automod_rules
- asyncfetch_ban
- asyncfetch_channel
- asyncfetch_channels
- asyncfetch_emoji
- asyncfetch_emojis
- asyncfetch_member
- async forfetch_members
- asyncfetch_roles
- asyncfetch_scheduled_event
- asyncfetch_scheduled_events
- asyncfetch_sticker
- asyncfetch_stickers
- defget_channel
- defget_channel_or_thread
- defget_emoji
- defget_member
- defget_member_named
- defget_role
- defget_scheduled_event
- defget_stage_instance
- defget_thread
- asyncintegrations
- asyncinvites
- definvites_paused
- asynckick
- asyncleave
- asyncprune_members
- asyncquery_members
- asynctemplates
- asyncunban
- asyncvanity_invite
- asyncwebhooks
- asyncwelcome_screen
- asyncwidget
- class discord.Guild¶
Discordのギルド。
これはDiscordの公式UIでは「サーバー」と呼ばれています。
- x == y
二つのギルドが等しいかを比較します。
- x != y
二つのギルドが等しくないか比較します。
- hash(x)
ギルドのハッシュ値を返します。
- str(x)
ギルドの名前を返します。
- stickers¶
ギルドに追加されている全てのスタンプ。
バージョン 2.0 で追加.
- 型
Tuple[
GuildSticker
, ...]
- owner_id¶
ギルドのオーナーのID。代わりに
Guild.owner
を使用してください。- 型
ギルドが利用できないかどうか。これが
True
の場合Guild.id
以外の属性の信頼度は低くNone
の場合もあります。利用不可能なギルドに対しては何も行わないことをおすすめします。on_guild_unavailable()
とon_guild_available()
イベントも確認してください。- 型
- max_members¶
ギルドのメンバーの最大数。
注釈
この情報は
Client.fetch_guild()
経由でのみ入手できます。- 型
Optional[
int
]
- verification_level¶
ギルドの認証レベル。
- explicit_content_filter¶
メディアコンテンツフィルターのレベル。
- default_notifications¶
ギルドの標準の通知設定。
- features¶
ギルドの機能のリスト。ギルドの機能の種類はDiscordによって変更されることがあります。 ギルドの機能の一覧は the Discord documentation にあります。
- 型
List[
str
]
ギルドのプレミアム階級。これは公式UIの「ニトロサーバー」に対応します。これは0以上3以下です。
- 型
ギルドの現在の「ブースト」数。
- 型
- preferred_locale¶
ギルドの優先ローケル。これはサーバー発見画面の結果を特定の言語で絞り込むときに利用されます。
バージョン 2.0 で変更: このフィールドが
str
から列挙型に変更されました。- 型
- approximate_member_count¶
ギルドのおおよそのメンバーの数を示します。
Client.fetch_guild()
やClient.fetch_guilds()
にてwith_counts=True
を指定してギルドを取得しない限り、None
を返します。バージョン 2.0 で追加.
- 型
Optional[
int
]
- approximate_presence_count¶
ギルドで現在アクティブなメンバーのおおよその数を示します。オフラインのメンバーは除外された値となります。
Client.fetch_guild()
やClient.fetch_guilds()
にてwith_counts=True
を指定してギルドを取得しない限り、None
を返します。バージョン 2.0 で変更.
- 型
Optional[
int
]
ギルドがプレミアム、すなわちサーバーブーストレベルの進捗バーを有効化しているか。
バージョン 2.0 で追加.
- 型
- property channels¶
このギルド内に存在するチャンネルのリスト。
- 型
Sequence[
abc.GuildChannel
]
- property large¶
ギルドが「ラージ」かどうかを示します。
ギルドが「ラージ」かはメンバー数が
large_threshold
を超えているかによって判断されます。このライブラリでは、これは最大の250に設定されています。- 型
- property voice_channels¶
このギルド内に存在するボイスチャンネルのリスト。
これはUIにおける順位と同様に、上から下へとソートされています。
- 型
List[
VoiceChannel
]
- property stage_channels¶
このギルド内に存在するステージチャンネルのリスト。
バージョン 1.7 で追加.
これはUIにおける順位と同様に、上から下へとソートされています。
- 型
List[
StageChannel
]
- property me¶
これは
Member
のインスタンスであることを除いて、Client.user
と似ています。これはギルドにおけるボット自身のメンバーインスタンスを取得するために使用されます。- 型
- property voice_client¶
ギルドに紐づいた
VoiceProtocol
が存在していれば、それを返します。- 型
Optional[
VoiceProtocol
]
- property text_channels¶
このギルド内に存在するテキストチャンネルのリスト。
これはUIにおける順位と同様に、上から下へとソートされています。
- 型
List[
TextChannel
]
- property categories¶
このギルド内に存在するカテゴリのリスト。
これはUIにおける順位と同様に、上から下へとソートされています。
- 型
List[
CategoryChannel
]
- property forums¶
このギルド内に存在するフォーラムチャンネルのリスト。
これはUIにおける順位と同様に、上から下へとソートされています。
- 型
List[
ForumChannel
]
- by_category()¶
すべての
CategoryChannel
とそれに属するチャンネルを返します。チャンネルとカテゴリは、公式のDiscord UIと同様の順序によってソートされています。
もしチャンネルがカテゴリに属さないなら、そのタプルの最初の要素は
None
になります。- 戻り値
ギルドに存在するカテゴリと、それに属するチャンネル。
- 戻り値の型
List[Tuple[Optional[
CategoryChannel
], List[abc.GuildChannel
]]]
- get_channel_or_thread(channel_id, /)¶
与えられたIDに合致するチャンネルまたはスレッドを返します。
バージョン 2.0 で追加.
- パラメータ
channel_id (
int
) -- 検索するID。- 戻り値
チャンネルかスレッド、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[Union[
Thread
,abc.GuildChannel
]]
- get_channel(channel_id, /)¶
与えられたIDのチャンネルを返します。
注釈
これはスレッドは確認 しません 。
バージョン 2.0 で変更:
channel_id
引数は位置限定引数になりました。- パラメータ
channel_id (
int
) -- 検索するID。- 戻り値
チャンネル、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[
abc.GuildChannel
]
- get_thread(thread_id, /)¶
与えられたIDに合致するスレッドを返します。
注釈
内部キャッシュに保持されていないため、アーカイブされたスレッドを取得できないことがあります。代わりに
fetch_channel()
を使用してください。バージョン 2.0 で追加.
- get_emoji(emoji_id, /)¶
与えられたIDの絵文字を返します。
バージョン 2.3 で追加.
- property afk_channel¶
AFKチャンネルを示すチャンネル。
チャンネルが設定されていない場合はこれは
None
になります。- 型
Optional[Union[
VoiceChannel
,StageChannel
]]
- property system_channel¶
ギルドの「システムのメッセージチャンネル」として設定されているチャンネルを返します。
チャンネルが設定されていない場合はこれは
None
になります。- 型
Optional[
TextChannel
]
- property system_channel_flags¶
ギルドのシステムチャンネルの設定を返します。
- property rules_channel¶
ルールに使用されるギルドのチャンネルを返します。ギルドはコミュニティギルドでなければなりません。
チャンネルが設定されていない場合はこれは
None
になります。バージョン 1.3 で追加.
- 型
Optional[
TextChannel
]
- property public_updates_channel¶
ギルドの管理者とモデレータがDiscordからの通知を受け取るギルドのチャンネルを返します。ギルドはコミュニティギルドでなければなりません。
チャンネルが設定されていない場合はこれは
None
になります。バージョン 1.4 で追加.
- 型
Optional[
TextChannel
]
- property safety_alerts_channel¶
存在する場合、ギルドの「セーフティ通知チャンネル」として設定されているチャンネルを返します。
例えば、これはレイドプロテクションの設定に使用されます。ギルドには
COMMUNITY
機能が必要です。バージョン 2.3 で追加.
- 型
Optional[
TextChannel
]
- property widget_channel¶
ギルドのウィジェットチャンネルを返します。
チャンネルが設定されていない場合はこれは
None
になります。バージョン 2.3 で追加.
- 型
Optional[Union[
TextChannel
,ForumChannel
,VoiceChannel
,StageChannel
]]
- get_member(user_id, /)¶
与えられたIDのメンバーを返します。
バージョン 2.0 で変更:
user_id
引数は位置限定引数になりました。
このギルドに対してサーバーブーストを行ったメンバーのリスト。
- 型
List[
Member
]
- property roles¶
設定された順序で並んだギルドのロールのシーケンスを返します。
最初の要素は、ギルド内の全てのロールにおいて、最も順位の低いものになります。
- 型
Sequence[
Role
]
- get_role(role_id, /)¶
与えられたIDのロールを返します。
バージョン 2.0 で変更: 引数
role_id
は位置専用引数となりました。
ギルドのプレミアムサブスクライバーロール、つまり「ブースト」ロールを取得します。
バージョン 1.6 で追加.
- 型
Optional[
Role
]
- property stage_instances¶
現在開催中のギルドのステージインスタンスのシーケンスを返します。
バージョン 2.0 で追加.
- 型
Sequence[
StageInstance
]
- get_stage_instance(stage_instance_id, /)¶
与えられたIDを持つステージインスタンスを返します。
バージョン 2.0 で追加.
- パラメータ
stage_instance_id (
int
) -- 検索するID。- 戻り値
ステージインスタンス、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[
StageInstance
]
- property scheduled_events¶
ギルドのスケジュールイベントのシーケンスを返します。
バージョン 2.0 で追加.
- 型
Sequence[
ScheduledEvent
]
- get_scheduled_event(scheduled_event_id, /)¶
与えられたIDのスケジュールイベントを返します。
バージョン 2.0 で追加.
- パラメータ
scheduled_event_id (
int
) -- 検索するID。- 戻り値
スケジュールイベント、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[
ScheduledEvent
]
- property member_count¶
利用可能な場合、メンバー数を返します。
警告
Discordの制限により、この属性を最新かつ正確に維持するには、
Intents.members
を有効化しないといけません。バージョン 2.0 で変更:
Optional[int]
を返すように変更されました。- 型
Optional[
int
]
- property chunked¶
ギルドが「チャンクされたか」を返すブール値を返します。
member_count
が内部のmembers
に存在するメンバーの数と同じ場合にギルドはチャンクされています。これが
False
の場合、オフラインのメンバーをリクエストすべきです。- 型
- property created_at¶
ギルドの作成時刻をUTCで返します。
- get_member_named(name, /)¶
指定された名前に一致する最初のメンバーを返します。
名前は以下の順番で検索されます:
ユーザー名#タグ (非推奨)
ユーザー名#0 (非推奨、タグから移行したユーザーのみ取得)
ニックネーム
グローバルの表示名
ユーザー名
メンバーが見つからない場合は
None
が返されます。バージョン 2.0 で変更:
name
引数は位置限定引数になりました。バージョン 2.3 で非推奨: Discord APIの変更のため、ユーザーのタグによる検索。
- await create_text_channel(name, *, reason=None, category=None, news=False, position=..., topic=..., slowmode_delay=..., nsfw=..., overwrites=..., default_auto_archive_duration=..., default_thread_slowmode_delay=...)¶
This function is a coroutine.
ギルドに
TextChannel
を作成します。チャンネルを作成するには、
manage_channels
が必要です。overwrites
パラメータを使用すると秘密のチャンネルを作成できます。このパラメータは対象(Member
かRole
)をキーとしPermissionOverwrite
を値とするdict
を取ります。注釈
指定された位置のチャンネルを作成しても、それに続く他のチャンネルの位置は更新されません。 チャンネルリスト内のチャンネルの位置を更新するには、呼び出し後に
edit()
を呼び出さないといけません。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。サンプル
基本的なチャンネルの作成例:
channel = await guild.create_text_channel('cool-channel')
秘密のチャンネルの作成例:
overwrites = { guild.default_role: discord.PermissionOverwrite(read_messages=False), guild.me: discord.PermissionOverwrite(read_messages=True) } channel = await guild.create_text_channel('secret', overwrites=overwrites)
- パラメータ
name (
str
) -- チャンネルの名前。overwrites (Dict[Union[
Role
,Member
],PermissionOverwrite
]) -- チャンネル作成時に適用すべき、対象(ロールまたはメンバー)をキーとしPermissionOverwrite
を値とするdict
。秘密のチャンネルの作成に便利です。category (Optional[
CategoryChannel
]) -- 新しく作成されたチャンネルを配置するカテゴリ。上書きがない場合、権限は自動的にカテゴリと同期されます。position (
int
) -- チャンネルリストにおける位置。これは0から始まる番号で、最も上のチャンネルの位置は0です。topic (
str
) -- 新しいチャンネルのトピック。slowmode_delay (
int
) -- チャンネル内の低速モードの時間を秒単位で指定します。最大値は21600
です。nsfw (
bool
) -- チャンネルに年齢制限をかけるかどうか。news (
bool
) --ニュースチャンネルとしてテキストチャンネルを作成するかどうか。
バージョン 2.0 で追加.
default_auto_archive_duration (
int
) --このテキストチャンネルで作成されたスレッドの分単位のデフォルトの自動アーカイブ期間。これは
60
、1440
、4320
、または10080
でないといけません。バージョン 2.0 で追加.
default_thread_slowmode_delay (
int
) --このテキストチャンネルで作成されたスレッドの、デフォルトの秒単位の低速モードレート制限。
バージョン 2.3 で追加.
reason (Optional[
str
]) -- チャンネルを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_voice_channel(name, *, reason=None, category=None, position=..., bitrate=..., user_limit=..., rtc_region=..., video_quality_mode=..., overwrites=...)¶
This function is a coroutine.
これは
VoiceChannel
を作る点以外ではcreate_text_channel()
と似ています。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
name (
str
) -- チャンネルの名前。overwrites (Dict[Union[
Role
,Member
],PermissionOverwrite
]) -- チャンネル作成時に適用すべき、対象(ロールまたはメンバー)をキーとしPermissionOverwrite
を値とするdict
。秘密のチャンネルの作成に便利です。category (Optional[
CategoryChannel
]) -- 新しく作成されたチャンネルを配置するカテゴリ。上書きがない場合、権限は自動的にカテゴリと同期されます。position (
int
) -- チャンネルリストにおける位置。これは0から始まる番号で、最も上のチャンネルの位置は0です。bitrate (
int
) -- チャンネルのビット毎秒単位の推奨オーディオビットレート設定。user_limit (
int
) -- ボイスチャンネルに参加できるメンバー数の制限。rtc_region (Optional[
str
]) --ボイスチャンネルの音声通信のためのリージョン。値が
None
の場合は自動で検出されます。バージョン 1.7 で追加.
video_quality_mode (
VideoQualityMode
) --ボイスチャンネル参加者のカメラビデオの画質。
バージョン 2.0 で追加.
reason (Optional[
str
]) -- チャンネルを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_stage_channel(name, *, reason=None, category=None, position=..., bitrate=..., user_limit=..., rtc_region=..., video_quality_mode=..., overwrites=...)¶
This function is a coroutine.
これは
StageChannel
を作る点以外ではcreate_text_channel()
と似ています。バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
name (
str
) -- チャンネルの名前。overwrites (Dict[Union[
Role
,Member
],PermissionOverwrite
]) -- チャンネル作成時に適用すべき、対象(ロールまたはメンバー)をキーとしPermissionOverwrite
を値とするdict
。秘密のチャンネルの作成に便利です。category (Optional[
CategoryChannel
]) -- 新しく作成されたチャンネルを配置するカテゴリ。上書きがない場合、権限は自動的にカテゴリと同期されます。position (
int
) -- チャンネルリストにおける位置。これは0から始まる番号で、最も上のチャンネルの位置は0です。bitrate (
int
) --チャンネルのビット毎秒単位の推奨オーディオビットレート設定。
バージョン 2.2 で追加.
user_limit (
int
) --ボイスチャンネルに参加できるメンバー数の制限。
バージョン 2.2 で追加.
rtc_region (Optional[
str
]) --ボイスチャンネルの音声通信のためのリージョン。値が
None
の場合は自動で検出されます。バージョン 2.2 で追加.
video_quality_mode (
VideoQualityMode
) --ボイスチャンネル参加者のカメラビデオの画質。
バージョン 2.2 で追加.
reason (Optional[
str
]) -- チャンネルを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_category(name, *, overwrites=..., reason=None, position=...)¶
This function is a coroutine.
これは
CategoryChannel
を作る点以外ではcreate_text_channel()
と似ています。注釈
カテゴリを重ねることはできないため、この関数は
category
パラメータをサポートしません。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_category_channel(name, *, overwrites=..., reason=None, position=...)¶
This function is a coroutine.
これは
CategoryChannel
を作る点以外ではcreate_text_channel()
と似ています。注釈
カテゴリを重ねることはできないため、この関数は
category
パラメータをサポートしません。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_forum(name, *, topic=..., position=..., category=None, slowmode_delay=..., nsfw=..., overwrites=..., reason=None, default_auto_archive_duration=..., default_thread_slowmode_delay=..., default_sort_order=..., default_reaction_emoji=..., default_layout=..., available_tags=...)¶
This function is a coroutine.
これは
ForumChannel
を作る点以外ではcreate_text_channel()
と似ています。overwrites
パラメータを使用すると秘密のチャンネルを作成できます。このパラメータは対象(Member
かRole
)をキーとしPermissionOverwrite
を値とするdict
を取ります。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- チャンネルの名前。overwrites (Dict[Union[
Role
,Member
],PermissionOverwrite
]) -- チャンネル作成時に適用すべき、対象(ロールまたはメンバー)をキーとしPermissionOverwrite
を値とするdict
。秘密のチャンネルの作成に便利です。topic (
str
) -- チャンネルのトピック。category (Optional[
CategoryChannel
]) -- 新しく作成されたチャンネルを配置するカテゴリ。上書きがない場合、権限は自動的にカテゴリと同期されます。position (
int
) -- チャンネルリストにおける位置。これは0から始まる番号で、最も上のチャンネルの位置は0です。nsfw (
bool
) -- チャンネルに年齢制限をかけるかどうか。slowmode_delay (
int
) -- チャンネル内の低速モードの時間を秒単位で指定します。最大値は21600
です。reason (Optional[
str
]) -- チャンネルを作成する理由。監査ログに表示されます。default_auto_archive_duration (
int
) -- このフォーラムチャンネルで作成されたスレッドの分単位のデフォルトの自動アーカイブ期間。これは60
、1440
、4320
、または10080
でないといけません。default_thread_slowmode_delay (
int
) --このフォーラムで作成されたスレッドの、デフォルトの秒単位の低速モードレート制限。
バージョン 2.1 で追加.
default_sort_order (
ForumOrderType
) --このフォーラムチャネルの投稿の並び替え順。
バージョン 2.3 で追加.
default_reaction_emoji (Union[
Emoji
,PartialEmoji
,str
]) --このフォーラムで作成されたスレッドで、デフォルトでリアクション追加ボタンに表示するリアクション絵文字。
バージョン 2.3 で追加.
default_layout (
ForumLayoutType
) --このフォーラムの投稿のデフォルトの表示レイアウト。
バージョン 2.3 で追加.
available_tags (Sequence[
ForumTag
]) --このフォーラムチャンネルで利用可能なタグ。
バージョン 2.1 で追加.
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
TypeError -- 権限の上書きの情報が適切なものでない場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await leave()¶
This function is a coroutine.
ギルドから脱退します。
注釈
自分のギルドから脱退することはできません。代わりに
delete()
で削除する必要があります。- 例外
HTTPException -- ギルドの脱退に失敗した場合。
- await delete()¶
This function is a coroutine.
ギルドを削除します。ただし、あなたが削除するギルドの所有者である必要があります。
- 例外
HTTPException -- ギルドの削除に失敗した場合。
Forbidden -- ギルドを削除する権限がない場合。
- await edit(*, reason=..., name=..., description=..., icon=..., banner=..., splash=..., discovery_splash=..., community=..., afk_channel=..., owner=..., afk_timeout=..., default_notifications=..., verification_level=..., explicit_content_filter=..., vanity_code=..., system_channel=..., system_channel_flags=..., preferred_locale=..., rules_channel=..., public_updates_channel=..., premium_progress_bar_enabled=..., discoverable=..., invites_disabled=..., widget_enabled=..., widget_channel=..., mfa_level=..., raid_alerts_disabled=..., safety_alerts_channel=..., invites_disabled_until=..., dms_disabled_until=...)¶
This function is a coroutine.
ギルドを編集します。
ルールを編集するには、
manage_guild
が必要です。バージョン 2.0 で変更: 新しく更新されたギルドが返されるようになりました。
バージョン 2.0 で変更:
region
キーワード引数が削除されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
name (
str
) -- ギルドの新しい名前。description (Optional[
str
]) -- ギルドの新しい説明。説明がない場合None
を指定することができます。ただし、これはGuild.features
にCOMMUNITY
があるギルドでのみ使用できます。icon (
bytes
) -- アイコンを示す bytes-like object 。PNGとJPEGのみ使用できます。Guild.features
にANIMATED_ICON
を含むギルドではGIFも使用できます。アイコンを削除する場合にはNone
を指定できます。banner (
bytes
) -- バナーを示す bytes-like object 。バナーを削除する場合にはNone
を指定できます。Guild.features
にBANNER
を含むギルドでのみ利用可能です。splash (
bytes
) -- 招待スプラッシュを示す bytes-like object 。PNGとJPEGのみ使用できます。スプラッシュを削除する場合にはNone
を指定できます。Guild.features
にINVITE_SPLASH
を含むギルドでのみ利用可能です。discovery_splash (
bytes
) --発見画面のスプラッシュを示す bytes-like object 。PNGとJPEGのみ使用できます。スプラッシュを削除する場合には
None
を指定できます。Guild.features
にDISCOVERABLE
を含むギルドでのみ利用可能です。バージョン 2.0 で追加.
community (
bool
) --ギルドをコミュニティギルドにするかどうか。
True
に設定した場合、rules_channel
とpublic_updates_channel
の両方のパラメータが必要です。バージョン 2.0 で追加.
afk_channel (Optional[
VoiceChannel
]) -- AFKチャンネルに設定する新しいチャンネル。AFKチャンネルを設定しない場合にはNone
を指定することができます。afk_timeout (
int
) -- メンバーをAFKチャンネルに移動させるまでの秒数。owner (
Member
) -- ギルドの新しい所有者。ただし、これを設定する場合には、ギルドの所有者である必要があります。verification_level (
VerificationLevel
) -- ギルドの新しい認証レベル。default_notifications (
NotificationLevel
) -- ギルドの新しい標準の通知レベル。explicit_content_filter (
ContentFilter
) -- ギルドの新しい、不適切な表現のフィルター設定。vanity_code (
str
) -- ギルドの新しいバニティコード。system_channel (Optional[
TextChannel
]) -- システムチャンネルに設定する新しいチャンネル。システムチャンネルを設定しない場合にはNone
を指定することができます。system_channel_flags (
SystemChannelFlags
) -- 新しいシステムチャンネルの使用設定。preferred_locale (
Locale
) --ギルドの新しい優先ロケール。ギルドの主要言語として使用されます。
バージョン 2.0 で変更:
str
の代わりに列挙型を受け付けます。rules_channel (Optional[
TextChannel
]) --ルールに使用される新しいチャンネル。これは
Guild.features
にCOMMUNITY
を含むギルドでのみ利用できます。ルールチャネルがない場合はNone
を指定できます。バージョン 1.4 で追加.
public_updates_channel (Optional[
TextChannel
]) --Discordからのコミュニティーアップデートに使用される新しいチャンネル。これは
Guild.features
にCOMMUNITY
を含むギルドでのみ利用できます。コミュニティーアップデートチャネルがない場合はNone
を指定できます。バージョン 1.4 で追加.
premium_progress_bar_enabled (
bool
) --ギルドのプレミアム、すなわちサーバーブーストレベルの進捗バーを有効化すべきか。
バージョン 2.0 で追加.
discoverable (
bool
) --このギルドでサーバー発見を有効にするかどうか。
バージョン 2.1 で追加.
invites_disabled (
bool
) --招待でのギルドへの参加を無効にするかどうか。
バージョン 2.1 で追加.
widget_enabled (
bool
) --ギルドのウィジェットを有効にするかどうか。
バージョン 2.3 で追加.
widget_channel (Optional[
abc.Snowflake
]) --新しいウィジェットチャンネル。
None
を指定するとウィジェットチャンネルを除去できます。バージョン 2.3 で追加.
mfa_level (
MFALevel
) --新しいギルドの二要素認証要件レベル。これを行うにはギルドの所有者でないといけません。
バージョン 2.3 で追加.
reason (Optional[
str
]) -- ギルドを編集する理由。監査ログに表示されます。raid_alerts_disabled (
bool
) --レイドプロテクションのアラートをギルドで無効にするかどうか。
バージョン 2.3 で追加.
safety_alerts_channel (Optional[
TextChannel
]) --安全アラートに使用される新しいチャンネル。これは
Guild.features
にCOMMUNITY
を含むギルドでのみ利用できます。安全アラートチャネルがない場合はNone
を指定できます。バージョン 2.3 で追加.
invites_disabled_until (Optional[
datetime.datetime
]) --The time when invites should be enabled again, or
None
to disable the action. This must be a timezone-aware datetime object. Consider usingutils.utcnow()
.バージョン 2.4 で追加.
dms_disabled_until (Optional[
datetime.datetime
]) --The time when direct messages should be allowed again, or
None
to disable the action. This must be a timezone-aware datetime object. Consider usingutils.utcnow()
.バージョン 2.4 で追加.
- 例外
Forbidden -- ギルドを編集する権限がない場合。
HTTPException -- ギルドの編集に失敗した場合。
ValueError --
icon
に渡された画像形式が無効な場合。これはPNGかJPGでなくてはいけません。また、あなたがギルドの所有者でないのに、ギルドの所有権の移動を行おうとした場合にも発生します。TypeError --
default_notifications
、rules_channel
、public_updates_channel
、safety_alerts_channel
、verification_level
、explicit_content_filter
、system_channel_flags
、mfa_level
に間違った型の値が渡されたとき。
- 戻り値
新しく更新されたギルド。これは
Client.fetch_guild()
に記載されているものと同じ制限があり、完全なデータを持っていない可能性があることに注意してください。- 戻り値の型
- await fetch_channels()¶
This function is a coroutine.
ギルドの
abc.GuildChannel
をすべて取得します。注釈
このメソッドはAPIを呼び出します。通常は
channels
を代わりとして使用してください。バージョン 1.2 で追加.
- 例外
InvalidData -- まだ定義されていないチャンネルタイプがDiscord Apiから受信された場合。
HTTPException -- チャンネルの取得に失敗した場合。
- 戻り値
ギルド内のすべてのチャンネル。
- 戻り値の型
Sequence[
abc.GuildChannel
]
- await active_threads()¶
This function is a coroutine.
クライアントがアクセスできるアクティブな
Thread
のリストを返します。これにはプライベートスレッドとパブリックスレッドの両方が含まれます。
バージョン 2.0 で追加.
- 例外
HTTPException -- アクティブなスレッドの取得に失敗した場合。
- 戻り値
アクティブなスレッド
- 戻り値の型
List[
Thread
]
- async for ... in fetch_members(*, limit=1000, after=...)¶
ギルドのメンバーを取得できる asynchronous iterator を取得します。これを使用するには
Intents.members()
が必要です。注釈
このメソッドはAPIを呼び出します。通常は
members
を代わりとして使用してください。バージョン 1.3 で追加.
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメンバーの数。デフォルトは1000です。すべてのメンバーを取得するにはNone
を渡します。これは取得に時間がかかる可能性があります。after (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) -- 渡された日付、またはオブジェクトより後のメンバーを取得します。日付を指定する場合、UTC対応の「aware」を利用することを推奨します。日付が「naive」である場合、これは地域時間であるとみなされます。
- 例外
ClientException -- メンバーインテントが有効でない場合。
HTTPException -- メンバーの取得に失敗した場合。
- 列挙
Member
-- メンバーデータが解析されたメンバー。
サンプル
使い方
async for member in guild.fetch_members(limit=150): print(member.name)
- await fetch_member(member_id, /)¶
This function is a coroutine.
ギルドIDとメンバーIDから
Member
を取得します。注釈
このメソッドはAPIを呼び出します。
Intents.members
とメンバーキャッシュを有効にしている場合は、代わりにget_member()
を検討してください。バージョン 2.0 で変更:
member_id
引数は位置専用引数となりました。- パラメータ
member_id (
int
) -- 取得したいメンバーのID。- 例外
Forbidden -- ギルドにアクセスする権限がない場合。
HTTPException -- メンバーの取得に失敗した場合。
NotFound -- メンバーが見つからなかった場合。
- 戻り値
メンバーIDで指定されたメンバー。
- 戻り値の型
- await fetch_ban(user)¶
This function is a coroutine.
ユーザーの
BanEntry
を返します。この情報を取得するためには、
ban_members
が必要です。- パラメータ
user (
abc.Snowflake
) -- BAN情報を取得するユーザー。- 例外
Forbidden -- 適切な権限を有していない場合。
NotFound -- 指定されたユーザーがBANされていない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
指定されたユーザーの
BanEntry
オブジェクト。- 戻り値の型
- await fetch_channel(channel_id, /)¶
This function is a coroutine.
指定されたIDを持つ
abc.GuildChannel
またはThread
を取得します。注釈
このメソッドはAPIを呼び出します。通常は
get_channel_or_thread()
を代わりとして使用してください。バージョン 2.0 で追加.
- 例外
InvalidData -- 不明なチャンネルタイプをDiscordから受け取ったか、チャンネルが属するギルドがこのオブジェクトが示すものと異なる場合。
HTTPException -- チャンネルの取得に失敗した場合。
NotFound -- 引数が無効なチャンネル IDである場合。
Forbidden -- このチャンネルからメッセージを取得する権限がない場合。
- 戻り値
IDから取得したチャンネル。
- 戻り値の型
Union[
abc.GuildChannel
,Thread
]
- async for ... in bans(*, limit=1000, before=..., after=...)¶
ギルドからBANされたユーザの asynchronous iterator を
BanEntry
として取得します。この情報を取得するためには、
ban_members
が必要です。バージョン 2.0 で変更: DiscordのAPIの変更により、リストの代わりにページ化されたイテレータが返されるようになりました。
サンプル
使い方
async for entry in guild.bans(limit=150): print(entry.user, entry.reason)
リストへフラット化
bans = [entry async for entry in guild.bans(limit=2000)] # bans is now a list of BanEntry...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するBANの数。None
の場合、BotがアクセスできるBANすべてを取得します。ただし、これには時間が掛かることに注意してください。デフォルトは1000
です。before (
abc.Snowflake
) -- このユーザ以前のBANを取得します。after (
abc.Snowflake
) -- このユーザ以降のBANを取得します。
- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
TypeError --
after
とbefore
の両方が渡された場合。Discordはこのタイプのページネーションをサポートしていません。
- 列挙
BanEntry
-- BANされたユーザーのBANエントリー。
- await prune_members(*, days, compute_prune_count=True, roles=..., reason=None)¶
This function is a coroutine.
ギルドからアクティブでないメンバーをキックします。
days
日間ログインせずロールを持たないメンバーが非アクティブとされます。You must have both
kick_members
andmanage_guild
to do this.実際にキックせずにキックされるメンバー数を確認するには
estimate_pruned_members()
関数を確認してください。特定のロールを持つメンバーもキックするには、
roles
パラメータを参照してください。バージョン 1.4 で変更:
roles
キーワード引数が追加されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
days (
int
) -- 非アクティブとしてカウントするまでの日数。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。compute_prune_count (
bool
) -- キックされるユーザー数を計算するか。これはデフォルトがTrue
なので、非常に大きいギルドではタイムアウトが発生する場合があります。これを防ぐには、False
に設定してください。これがFalse
の場合この関数は常にNone
を返します。roles (List[
abc.Snowflake
]) -- キックすべきロールであるabc.Snowflake
のリスト。このリストに含まれないロールに属するメンバーは除外されます。
- 例外
Forbidden -- メンバーをキックする権限がない場合。
HTTPException -- メンバーのキック中にエラーが発生した場合。
TypeError --
days
が整数でない場合。
- 戻り値
キックされたメンバー数。もし
compute_prune_count
がFalse
の場合これはNone
を返します。- 戻り値の型
Optional[
int
]
- await templates()¶
This function is a coroutine.
ギルド内のテンプレートのリストを取得します。
これを行うには、
manage_guild
が必要です。バージョン 1.7 で追加.
- await webhooks()¶
This function is a coroutine.
ギルド内のWebhookのリストを取得します。
これを行うには、
manage_webhooks
が必要です。
- await estimate_pruned_members(*, days, roles=...)¶
This function is a coroutine.
prune_members()
と似ていますが、実際にキックせず、何人キックされるであろうかを返します。バージョン 2.0 で変更: 返される値は
None
になることがあります。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
days (
int
) -- 非アクティブとしてカウントするまでの日数。roles (List[
abc.Snowflake
]) --算入すべきロールである
abc.Snowflake
のリスト。このリストに含まれないロールに属するメンバーは除外されます。バージョン 1.7 で追加.
- 例外
Forbidden -- メンバーをキックする権限がない場合。
HTTPException -- メンバー数の概算を取得中にエラーが発生した場合。
TypeError --
days
が整数でない場合。
- 戻り値
キックされると推定されるメンバーの数。
- 戻り値の型
Optional[
int
]
- await invites()¶
This function is a coroutine.
このギルドの全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_guild
が必要です。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- await create_template(*, name, description=...)¶
This function is a coroutine.
サーバーのテンプレートを作成します。
これを行うには、
manage_guild
が必要です。バージョン 1.7 で追加.
- await create_integration(*, type, id)¶
This function is a coroutine.
ギルドに連携サービスを付属させます。
これを行うには、
manage_guild
が必要です。バージョン 1.4 で追加.
- パラメータ
- 例外
Forbidden -- 連携サービスを作成する権限がない場合。
HTTPException -- アカウントが見つからなかった場合。
- await integrations()¶
This function is a coroutine.
サーバーに追加されたすべての連携サービスのリストを返します。
これを行うには、
manage_guild
が必要です。バージョン 1.4 で追加.
- 例外
Forbidden -- 連携サービスを作成する権限がない場合。
HTTPException -- 連携サービスの取得に失敗した場合。
- 戻り値
サーバーの連携サービスのリスト。
- 戻り値の型
List[
Integration
]
- await fetch_stickers()¶
This function is a coroutine.
ギルドの
Sticker
のリストを取得します。バージョン 2.0 で追加.
注釈
このメソッドはAPIを呼び出します。通常は
stickers
を代わりとして使用してください。- 例外
HTTPException -- スタンプの取得中にエラーが発生した場合。
- 戻り値
取得したスタンプ。
- 戻り値の型
List[
GuildSticker
]
- await fetch_sticker(sticker_id, /)¶
This function is a coroutine.
ギルドのカスタム
Sticker
を取得します。バージョン 2.0 で追加.
注釈
このメソッドはAPIを呼び出します。通常は
stickers
をイテレートして使用してください。- パラメータ
sticker_id (
int
) -- スタンプのID。- 例外
NotFound -- 要求されたスタンプが見つからなかった場合。
HTTPException -- スタンプの取得中にエラーが発生した場合。
- 戻り値
取得したスタンプ。
- 戻り値の型
- await create_sticker(*, name, description, emoji, file, reason=None)¶
This function is a coroutine.
ギルドに
Sticker
を作成します。これを行うには、
manage_emojis_and_stickers
が必要です。バージョン 2.0 で追加.
- パラメータ
- 例外
Forbidden -- スタンプを作成する権限がない場合。
HTTPException -- スタンプ作成中にエラーが発生した場合。
- 戻り値
作成したスタンプ。
- 戻り値の型
- await delete_sticker(sticker, /, *, reason=None)¶
This function is a coroutine.
ギルドのカスタム
Sticker
を削除します。これを行うには、
manage_emojis_and_stickers
が必要です。バージョン 2.0 で追加.
- パラメータ
sticker (
abc.Snowflake
) -- 削除するスタンプ。reason (Optional[
str
]) -- スタンプを削除する理由。監査ログに表示されます。
- 例外
Forbidden -- スタンプを削除する権限がない場合。
HTTPException -- スタンプの削除中にエラーが発生した場合。
- await fetch_scheduled_events(*, with_counts=True)¶
This function is a coroutine.
ギルドのスケジュールイベントのリストを取得します。
バージョン 2.0 で追加.
- パラメータ
with_counts (
bool
) -- イベントに購読しているユーザー数を含めるかどうか。デフォルトはTrue
です。- 例外
HTTPException -- スケジュールイベントの取得に失敗した場合。
- 戻り値
スケジュールイベント。
- 戻り値の型
List[
ScheduledEvent
]
- await fetch_scheduled_event(scheduled_event_id, /, *, with_counts=True)¶
This function is a coroutine.
ギルドのスケジュールイベントを取得します。
バージョン 2.0 で追加.
- パラメータ
- 例外
NotFound -- スケジュールイベントが見つからなかった場合。
HTTPException -- スケジュールイベントの取得に失敗した場合。
- 戻り値
スケジュールイベント。
- 戻り値の型
- await create_scheduled_event(*, name, start_time, entity_type=..., privacy_level=..., channel=..., location=..., end_time=..., description=..., image=..., reason=None)¶
This function is a coroutine.
ギルドのスケジュールイベントを作成します。
これを行うには、
manage_events
が必要です。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- スケジュールイベントの名前。description (
str
) -- スケジュールイベントの説明。channel (Optional[
abc.Snowflake
]) -- スケジュールイベントの送信先チャンネル。もしチャンネルがStageInstance
またはVoiceChannel
ならば、開催場所の種類が自動で設定されます。entity_type
がEntityType.voice
またはEntityType.stage_instance
の場合必須です。start_time (
datetime.datetime
) -- スケジュールイベントの開始予定時刻。これはtimezone awareなdatetimeオブジェクトでないといけません。utils.utcnow()
を使用してみてください。end_time (
datetime.datetime
) -- スケジュールイベントの終了予定時刻。これはtimezone awareなdatetimeオブジェクトでないといけません。utils.utcnow()
を使用してみてください。EntityType.external
の場合必須です。privacy_level (
PrivacyLevel
) -- スケジュールイベントのプライバシーレベル。entity_type (
EntityType
) -- スケジュールイベントの開催場所の種類。もしチャンネルがStageInstance
またはVoiceChannel
の場合これは適切な種類に自動で設定されます。もしチャンネルが渡されなかった場合はEntityType.external
とみなされます。image (
bytes
) -- スケジュールイベントの画像。location (
str
) -- スケジュールイベントの場所。entity_type
がEntityType.external
の場合必須です。reason (Optional[
str
]) -- スケジュールイベントを作成する理由。監査ログに表示されます。
- 例外
TypeError --
image
が bytes-like object でない場合、privacy_level
がPrivacyLevel
でない場合、entity_type
がEntityType
でない場合、status
がEventStatus
でない場合、または引数が渡されたentity_type
と互換性のない場合。ValueError --
start_time
やend_time
がtimezone awareなdatetimeオブジェクトでない場合。Forbidden -- スケジュールイベントを作成する権限がない場合。
HTTPException -- スケジュールイベントの作成に失敗した場合。
- 戻り値
作成されたスケジュールイベント。
- 戻り値の型
- await fetch_emojis()¶
This function is a coroutine.
ギルドのカスタム
Emoji
をすべて取得します。注釈
これはAPIを呼び出します。通常は
emojis
を代わりに使用してください。- 例外
HTTPException -- 絵文字の取得中にエラーが発生した場合。
- 戻り値
取得した絵文字。
- 戻り値の型
List[
Emoji
]
- await fetch_emoji(emoji_id, /)¶
This function is a coroutine.
ギルドのカスタム
Emoji
を取得します。注釈
このメソッドはAPIを呼び出します。通常は
emojis
をイテレートして使用してください。バージョン 2.0 で変更:
emoji_id
引数は位置限定引数になりました。- パラメータ
emoji_id (
int
) -- 絵文字のID。- 例外
NotFound -- 絵文字が見つからなかった場合。
HTTPException -- 絵文字の取得中にエラーが発生した場合。
- 戻り値
取得した絵文字。
- 戻り値の型
- await create_custom_emoji(*, name, image, roles=..., reason=None)¶
This function is a coroutine.
カスタム
Emoji
をギルド内に作成します。現在ギルドには静的絵文字・アニメーション付き絵文字それぞれ50個ごとの制限があります。ただし、
MORE_EMOJI
機能が有効化されたギルドでは、これは200個になります。これを行うには、
manage_emojis
が必要です。- パラメータ
- 例外
Forbidden -- 絵文字を作成する権限がない場合。
HTTPException -- 絵文字の作成中にエラーが発生した場合。
- 戻り値
作成された絵文字。
- 戻り値の型
- await delete_emoji(emoji, /, *, reason=None)¶
This function is a coroutine.
ギルドのカスタム
Emoji
を削除します。これを行うには、
manage_emojis
が必要です。バージョン 2.0 で変更:
emoji
引数は位置限定引数になりました。- パラメータ
emoji (
abc.Snowflake
) -- 削除する絵文字。reason (Optional[
str
]) -- 絵文字を削除する理由。監査ログに表示されます。
- 例外
Forbidden -- 絵文字を削除する権限がない場合。
HTTPException -- 絵文字の削除中にエラーが発生した場合。
- await fetch_roles()¶
This function is a coroutine.
ギルドの
Role
をすべて取得します。注釈
これはAPIを呼び出します。通常は
roles
を代わりに使用してください。バージョン 1.3 で追加.
- 例外
HTTPException -- ロールの取得に失敗した場合。
- 戻り値
サーバー内の全てのロール。
- 戻り値の型
List[
Role
]
- await create_role(*, name=..., permissions=..., color=..., colour=..., hoist=..., display_icon=..., mentionable=..., reason=None)¶
This function is a coroutine.
サーバーに
Role
を作成します。すべてのフィールドはオプションです。
これを行うには、
manage_roles
が必要です。バージョン 1.6 で変更:
int
をcolour
キーワード引数に渡せるようになりました。バージョン 2.0 で追加:
display_icon
キーワード引数が追加されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
name (
str
) -- ロール名。デフォルトは 'new role' です。permissions (
Permissions
) -- 持っている権限。デフォルトは権限がありません。colour (Union[
Colour
,int
]) -- ロールの色。デフォルトはColour.default()
です。color
というエイリアスが存在します。hoist (
bool
) -- メンバーリストにロールを他と分けて表示するかどうかを示します。デフォルトはFalse
です。display_icon (Union[
bytes
,str
]) -- ロールのアイコンを表す bytes-like object か、ロールのアイコンとして使用すべきユニコード絵文字であるstr
。PNGとJPEGのみサポートされています。これはfeatures
にROLE_ICONS
を含むギルドでのみ利用できます。mentionable (
bool
) -- ロールをメンションできるかどうか。デフォルトはFalse
です。reason (Optional[
str
]) -- ロールを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- ロールを作成する権限がない場合。
HTTPException -- ロールの作成に失敗した場合。
TypeError -- 不正なキーワード引数を受け取った場合。
- 戻り値
新しく作成されたロール。
- 戻り値の型
- await edit_role_positions(positions, *, reason=None)¶
This function is a coroutine.
サーバーの
Role
のリストを一括編集します。これを行うには、
manage_roles
が必要です。バージョン 1.4 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。サンプル
positions = { bots_role: 1, # penultimate role tester_role: 2, admin_role: 6 } await guild.edit_role_positions(positions=positions)
- await welcome_screen()¶
This function is a coroutine.
ギルドのようこそ画面を返します。
features
にCOMMUNITY
が含まれている必要があります。これを行うには、
manage_guild
も必要です。バージョン 2.0 で追加.
- 例外
Forbidden -- 取得するのに適切な権限がない場合。
HTTPException -- ようこそ画面の取得に失敗した場合。
- 戻り値
ようこそ画面。
- 戻り値の型
- await edit_welcome_screen(*, description=..., welcome_channels=..., enabled=..., reason=None)¶
This function is a coroutine.
ようこそ画面を事前に取得せずに
WelcomeScreen.edit
を呼び出すことのできるメソッド。features
にCOMMUNITY
が含まれている必要があります。You must have
manage_guild
to do this as well.バージョン 2.0 で追加.
- 戻り値
編集した後のようこそ画面。
- 戻り値の型
- await kick(user, *, reason=None)¶
This function is a coroutine.
サーバーからユーザーをキックします。
ユーザーは
abc.Snowflake
抽象基底クラスのサブクラスである必要があります。これを行うには、
kick_members
が必要です。- パラメータ
user (
abc.Snowflake
) -- The user to kick from the guild.reason (Optional[
str
]) -- ユーザーをキックする理由。
- 例外
Forbidden -- キックするのに適切な権限がない場合。
HTTPException -- キックに失敗した場合。
- await ban(user, *, reason=None, delete_message_days=..., delete_message_seconds=...)¶
This function is a coroutine.
ギルドからユーザーをBANします。
ユーザーは
abc.Snowflake
抽象基底クラスのサブクラスである必要があります。これを行うには、
ban_members
が必要です。- パラメータ
user (
abc.Snowflake
) -- The user to ban from the guild.delete_message_days (
int
) --このユーザーの何日分のメッセージをギルドから削除するか。最小は 0日 で、最大は 7日 です。
delete_message_days
とdelete_message_seconds
のどちらも渡されない場合、デフォルトは 1 日に指定されます。バージョン 2.1 で非推奨.
delete_message_seconds (
int
) --このユーザーの何秒分のメッセージをギルドから削除するか。最小は 0秒 で、最大は 604800秒 (7日) です。
delete_message_days
とdelete_message_seconds
のどちらも渡されない場合、デフォルトは 1 日に指定されます。バージョン 2.1 で追加.
reason (Optional[
str
]) -- ユーザーをBANする理由。
- 例外
NotFound -- ユーザーが見つからなかった場合。
Forbidden -- BANするのに適切な権限がない場合。
HTTPException -- BANに失敗した場合。
TypeError --
delete_message_days
とdelete_message_seconds
の両方を指定した場合。
- await unban(user, *, reason=None)¶
This function is a coroutine.
ギルドにおける、ユーザーのBANを解除します。
ユーザーは
abc.Snowflake
抽象基底クラスのサブクラスである必要があります。これを行うには、
ban_members
が必要です。- パラメータ
user (
abc.Snowflake
) -- BANを解除したいユーザー。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
NotFound -- BAN解除対象が見つからなかった場合。
Forbidden -- BANを解除するのに適切な権限がない場合。
HTTPException -- BAN解除に失敗した場合。
- await bulk_ban(users, *, reason=None, delete_message_seconds=86400)¶
This function is a coroutine.
Bans multiple users from the guild.
The users must meet the
abc.Snowflake
abc.You must have
ban_members
andmanage_guild
to do this.バージョン 2.4 で追加.
- パラメータ
users (Iterable[
abc.Snowflake
]) -- The users to ban from the guild, up to 200 users.delete_message_seconds (
int
) -- The number of seconds worth of messages to delete from the user in the guild. The minimum is 0 and the maximum is 604800 (7 days). Defaults to 1 day.reason (Optional[
str
]) -- The reason the users got banned.
- 例外
Forbidden -- BANするのに適切な権限がない場合。
HTTPException -- BANに失敗した場合。
- 戻り値
The result of the bulk ban operation.
- 戻り値の型
- await vanity_invite()¶
This function is a coroutine.
ギルドの特別なバニティ招待を返します。
features
に VANITY_URL が含まれている必要があります。これを行うには、
manage_guild
も必要です。- 例外
Forbidden -- 取得するのに適切な権限がない場合。
HTTPException -- バニティ招待の取得に失敗した場合。
- 戻り値
特別なバニティ招待。これが
None
の場合ギルドにはバニティ招待がありません。- 戻り値の型
Optional[
Invite
]
- async for ... in audit_logs(*, limit=100, before=..., after=..., oldest_first=..., user=..., action=...)¶
ギルドの監査ログを取得する asynchronous iterator を返します。
これを行うには、
view_audit_log
が必要です。サンプル
最初の100項目を取得する:
async for entry in guild.audit_logs(limit=100): print(f'{entry.user} did {entry.action} to {entry.target}')
特定のアクションのエントリを取得する:
async for entry in guild.audit_logs(action=discord.AuditLogAction.ban): print(f'{entry.user} banned {entry.target}')
特定のユーザーによる項目の取得:
entries = [entry async for entry in guild.audit_logs(limit=None, user=guild.me)] await channel.send(f'I made {len(entries)} moderation actions.')
- パラメータ
limit (Optional[
int
]) -- 取得する項目数。None
の場合すべての項目を取得します。before (Union[
abc.Snowflake
,datetime.datetime
]) -- 渡された日付、または項目より前の項目を取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Union[
abc.Snowflake
,datetime.datetime
]) -- 渡された日付、または項目より後の項目を取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。oldest_first (
bool
) --True
の場合、古いものから新しいものの順で項目を返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。user (
abc.Snowflake
) -- 項目をフィルターするためのモデレーター。action (
AuditLogAction
) -- フィルターするアクション。
- 例外
Forbidden -- 監査ログを取得する権限がない場合。
HTTPException -- 監査ログ取得中にエラーが発生した場合。
- 列挙
AuditLogEntry
-- 監査ログの項目。
- await widget()¶
This function is a coroutine.
ギルドのウィジェットを返します。
注釈
この情報を取得するためには、ギルドのウィジェットを有効化しておく必要があります。
- 例外
Forbidden -- Guildのウィジェットが無効になっている場合。
HTTPException -- ウィジェットの取得に失敗した場合。
- 戻り値
ギルドのウィジェット。
- 戻り値の型
- await edit_widget(*, enabled=..., channel=..., reason=None)¶
This function is a coroutine.
ギルドのウィジェットを編集します。これは
edit
でも行えます。これを行うには、
manage_guild
が必要です。バージョン 2.0 で追加.
- パラメータ
- 例外
Forbidden -- ウィジェットを編集する権限がない場合。
HTTPException -- ウィジェットの編集に失敗した場合。
- await chunk(*, cache=True)¶
This function is a coroutine.
このギルドに所属するすべてのメンバーをリクエストします。これを使用するには、
Intents.members()
を有効にする必要があります。これはウェブソケットを使用していて、遅くなる可能性があります。
バージョン 1.5 で追加.
- パラメータ
cache (
bool
) -- メンバーをキャッシュするかどうか。- 例外
ClientException -- メンバーインテントが有効でない場合。
- 戻り値
ギルドのメンバーのリスト。
- 戻り値の型
List[
Member
]
- await query_members(query=None, *, limit=5, user_ids=None, presences=False, cache=True)¶
This function is a coroutine.
ユーザー名またはニックネームが指定されたクエリで始まるギルドのメンバーをリクエストします。これはWebSocket操作です。
バージョン 1.3 で追加.
- パラメータ
query (Optional[
str
]) -- ユーザー名またはニックネームの先頭の文字列。limit (
int
) -- 取得するメンバーの最大数。5から100までの数にする必要があります。presences (
bool
) --プレゼンスを取得するかどうか。デフォルトは
False
です。バージョン 1.6 で追加.
cache (
bool
) -- メンバーを内部でキャッシュするか。これを行うとマッチされたユーザーがget_member()
などで取得できるようになります。user_ids (Optional[List[
int
]]) --検索するユーザーIDの一覧。ユーザーIDがギルドに属さない場合は返されません。
バージョン 1.4 で追加.
- 例外
asyncio.TimeoutError -- メンバーを待っている間にクエリがタイムアウトした場合。
ValueError -- 無効なパラメータが関数に渡された場合。
ClientException -- プレゼンスインテントが有効でない場合。
- 戻り値
クエリに一致するメンバーのリスト。
- 戻り値の型
List[
Member
]
- await change_voice_state(*, channel, self_mute=False, self_deaf=False)¶
This function is a coroutine.
ギルド内のクライアントのボイス状態を変更します。
バージョン 1.4 で追加.
- パラメータ
channel (Optional[
abc.Snowflake
]) -- クライアントが接続するチャンネル。切断するにはNone
を渡してください。self_mute (
bool
) -- クライアントをセルフミュートすべきか。self_deaf (
bool
) -- クライアントをセルフスピーカーミュートすべきか。
- await fetch_automod_rule(automod_rule_id, /)¶
This function is a coroutine.
ギルドの有効な自動管理ルールを取得します。
これを行うには、
Permissions.manage_guild
が必要です。バージョン 2.0 で追加.
- await fetch_automod_rules()¶
This function is a coroutine.
ギルドの自動管理ルールをすべて取得します。
これを行うには、
Permissions.manage_guild
が必要です。バージョン 2.0 で追加.
- 例外
- 戻り値
取得した自動管理ルール。
- 戻り値の型
List[
AutoModRule
]
- await create_automod_rule(*, name, event_type, trigger, actions, enabled=False, exempt_roles=..., exempt_channels=..., reason=...)¶
This function is a coroutine.
自動管理ルールを作成します。
これを行うには、
Permissions.manage_guild
が必要です。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- 自動管理ルールの名前。event_type (
AutoModRuleEventType
) -- 自動管理ルールが発動するイベントの種類。trigger (
AutoModTrigger
) -- 自動管理ルールの発動条件。actions (List[
AutoModRuleAction
]) -- 自動管理ルールが発動したときの対応。enabled (
bool
) -- 自動管理ルールを有効にするか。デフォルトはFalse
です。exempt_roles (Sequence[
abc.Snowflake
]) -- 自動管理ルールの除外対象のロールのリスト。exempt_channels (Sequence[
abc.Snowflake
]) -- 自動管理ルールの除外対象のチャンネルのリスト。reason (
str
) -- 自動管理ルールを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- 自動管理ルールを作成する権限がない場合。
HTTPException -- 自動管理ルールの作成に失敗した場合。
- 戻り値
作成された自動管理ルール。
- 戻り値の型
- property invites_paused_until¶
If invites are paused, returns when invites will get enabled in UTC, otherwise returns None.
バージョン 2.4 で追加.
- 型
Optional[
datetime.datetime
]
- property dms_paused_until¶
If DMs are paused, returns when DMs will get enabled in UTC, otherwise returns None.
バージョン 2.4 で追加.
- 型
Optional[
datetime.datetime
]
- class discord.BulkBanResult¶
A namedtuple which represents the result returned from
bulk_ban()
.バージョン 2.4 で追加.
- banned¶
The list of users that were banned. The inner
Object
of the list has theObject.type
set toUser
.- 型
List[
Object
]
- failed¶
The list of users that could not be banned. The inner
Object
of the list has theObject.type
set toUser
.- 型
List[
Object
]
ScheduledEvent¶
- class discord.ScheduledEvent¶
ギルドのスケジュールイベント。
バージョン 2.0 で追加.
- x == y
二つのスケジュールイベントが等しいかを比較します。
- x != y
二つのスケジュールイベントが等しくないかを比較します。
- hash(x)
スケジュールイベントのハッシュ値を返します。
- entity_type¶
イベントの開催場所の種類。
- start_time¶
スケジュールイベントのUTCの開始予定時間。
- end_time¶
スケジュールイベントのUTCの終了予定時間。
- 型
Optional[
datetime.datetime
]
- privacy_level¶
スケジュールイベントのプライバシーレベル。
- status¶
スケジュールイベントのステータス。
- property channel¶
スケジュールイベントの属するチャンネル。
- 型
Optional[Union[
VoiceChannel
,StageChannel
]]
- await start(*, reason=None)¶
This function is a coroutine.
スケジュールイベントを開始します。
以下の短縮形です:
await event.edit(status=EventStatus.active)
- パラメータ
reason (Optional[
str
]) -- スケジュールイベントの開始理由。- 例外
ValueError -- スケジュールイベントが既に開始し、または終了している場合。
Forbidden -- スケジュールイベントを開始するのに必要な権限がない場合。
HTTPException -- スケジュールイベントを開始できなかった場合。
- 戻り値
開始されたスケジュールイベント。
- 戻り値の型
- await end(*, reason=None)¶
This function is a coroutine.
スケジュールイベントを終了します。
以下の短縮形です:
await event.edit(status=EventStatus.completed)
- パラメータ
reason (Optional[
str
]) -- スケジュールイベントの終了理由。- 例外
ValueError -- スケジュールイベントがアクティブでないか、既に終了している場合。
Forbidden -- スケジュールイベントを終了するのに必要な権限がない場合。
HTTPException -- スケジュールイベントを終了できなかった場合。
- 戻り値
終了されたスケジュールイベント。
- 戻り値の型
- await cancel(*, reason=None)¶
This function is a coroutine.
スケジュールイベントをキャンセルします。
以下の短縮形です:
await event.edit(status=EventStatus.cancelled)
- パラメータ
reason (Optional[
str
]) -- スケジュールイベントのキャンセル理由。- 例外
ValueError -- スケジュールイベントが既に開始している場合。
Forbidden -- スケジュールイベントをキャンセルするのに必要な権限がない場合。
HTTPException -- スケジュールイベントをキャンセルできなかった場合。
- 戻り値
キャンセルされたスケジュールイベント。
- 戻り値の型
- await edit(*, name=..., description=..., channel=..., start_time=..., end_time=..., privacy_level=..., entity_type=..., status=..., image=..., location=..., reason=None)¶
This function is a coroutine.
スケジュールイベントを編集します。
これを行うには、
manage_events
が必要です。- パラメータ
name (
str
) -- スケジュールイベントの名前。description (
str
) -- スケジュールイベントの説明。channel (Optional[
Snowflake
]) -- スケジュールイベントを開催するチャンネル。もしチャンネルがStageInstance
またはVoiceChannel
ならば、開催場所の種類が自動で設定されます。 開催場所の種類がEntityType.voice
またはEntityType.stage_instance
の場合必須です。start_time (
datetime.datetime
) -- スケジュールイベントの開始予定時刻。これはtimezone awareなdatetimeオブジェクトでないといけません。utils.utcnow()
を使用してみてください。end_time (Optional[
datetime.datetime
]) -- スケジュールイベントの終了予定時刻。これはtimezone awareなdatetimeオブジェクトでないといけません。utils.utcnow()
を使用してみてください。もし開催場所がEntityType.voice
やEntityType.stage_instance
の場合はこれはNone
を渡して除去することができます。entity_type
がEntityType.external
の場合必須です。privacy_level (
PrivacyLevel
) -- スケジュールイベントのプライバシーレベル。entity_type (
EntityType
) -- 新しいスケジュールイベントの開催場所の種類。もしチャンネルがStageInstance
またはVoiceChannel
の場合これは適切な種類に自動で設定されます。status (
EventStatus
) -- スケジュールイベントの新しいステータス。image (Optional[
bytes
]) -- スケジュールイベントの新しい画像。None
を渡すと画像を削除できます。location (
str
) -- 新しいスケジュールイベントの場所。開催場所の種類がEntityType.external
の場合必須です。reason (Optional[
str
]) -- スケジュールイベントを編集する理由。監査ログに表示されます。
- 例外
TypeError --
image
が bytes-like object でない場合、privacy_level
がPrivacyLevel
でない場合、entity_type
がEntityType
でない場合、status
がEventStatus
でない場合、または引数がスケジュールイベントの開催場所の種類と互換性のない場合。ValueError --
start_time
やend_time
がtimezone awareなdatetimeオブジェクトでない場合。Forbidden -- スケジュールイベントを編集するのに必要な権限がない場合。
HTTPException -- スケジュールイベントの編集に失敗した場合。
- 戻り値
編集されたスケジュールイベント。
- 戻り値の型
- await delete(*, reason=None)¶
This function is a coroutine.
スケジュールイベントを削除します。
これを行うには、
manage_events
が必要です。- パラメータ
reason (Optional[
str
]) -- スケジュールイベントを削除する理由。監査ログに表示されます。- 例外
Forbidden -- スケジュールイベントを削除する権限がない場合。
HTTPException -- スケジュールイベントの削除に失敗した場合。
- async for ... in users(*, limit=None, before=None, after=None, oldest_first=...)¶
This function is a coroutine.
このイベントを購読しているすべての
User
を取得します。あなた自身以外のメンバーに関する情報を取得するには、
Intents.members
が必要です。- 例外
HTTPException -- メンバーの取得に失敗した場合。
- 戻り値
このイベントに購読済みのユーザー。
- 戻り値の型
List[
User
]
Integration¶
- class discord.Integration¶
ギルドの連携サービス。
バージョン 1.4 で追加.
- account¶
この連携サービスにリンクされたアカウント。
- await delete(*, reason=None)¶
This function is a coroutine.
この連携サービスを削除します。
これを行うには、
manage_guild
が必要です。- パラメータ
reason (
str
) --連携サービスを削除する理由。監査ログに表示されます。
バージョン 2.0 で追加.
- 例外
Forbidden -- 連携サービスを削除する権限がない場合。
HTTPException -- 連携サービスの削除に失敗した場合。
- class discord.IntegrationAccount¶
連携サービスのアカウント。
バージョン 1.4 で追加.
- class discord.BotIntegration¶
Discordのボット連携サービス。
バージョン 2.0 で追加.
- account¶
連携サービスのアカウント情報。
- application¶
この連携サービスにリンクされたアプリケーション。
- class discord.IntegrationApplication¶
ボット連携サービスのアプリケーション。
バージョン 2.0 で追加.
- class discord.StreamIntegration¶
TwitchやYouTubeのストリーム連携サービス。
バージョン 2.0 で追加.
- expire_behaviour¶
期限切れのサブスクライバーの動作。
expire_behavior
というエイリアスが存在します。
- account¶
連携サービスのアカウント情報。
- synced_at¶
連携サービスが最後に同期された日時を示すaware UTC datetime。
- property expire_behavior¶
expire_behaviour
のエイリアス
- await edit(*, expire_behaviour=..., expire_grace_period=..., enable_emoticons=...)¶
This function is a coroutine.
連携サービスを編集します。
これを行うには、
manage_guild
が必要です。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
expire_behaviour (
ExpireBehaviour
) -- 期限切れのサブスクライバーの動作。expire_behavior
というエイリアスが存在します。expire_grace_period (
int
) -- 連携サービスがサブスクリプションが終了したユーザーに与える猶予期間(日数)。enable_emoticons (
bool
) -- この連携サービスで絵文字を同期するか(現在Twitch専用)。
- 例外
Forbidden -- 連携サービスを編集する権限がない場合。
HTTPException -- ギルドの編集に失敗した場合。
TypeError --
expire_behaviour
がExpireBehaviour
でない場合。
- await sync()¶
This function is a coroutine.
連携サービスを同期します。
これを行うには、
manage_guild
が必要です。- 例外
Forbidden -- 連携サービスを同期する権限がない場合。
HTTPException -- 連携サービスの同期に失敗した場合。
Member¶
- accent_color
- accent_colour
- activities
- activity
- avatar
- avatar_decoration
- avatar_decoration_sku_id
- banner
- bot
- color
- colour
- created_at
- default_avatar
- desktop_status
- discriminator
- display_avatar
- display_icon
- display_name
- dm_channel
- flags
- global_name
- guild
- guild_avatar
- guild_permissions
- id
- joined_at
- mention
- mobile_status
- mutual_guilds
- name
- nick
- pending
- premium_since
- public_flags
- raw_status
- resolved_permissions
- roles
- status
- system
- timed_out_until
- top_role
- voice
- web_status
- asyncadd_roles
- asyncban
- asynccreate_dm
- asyncedit
- asyncfetch_message
- defget_role
- async forhistory
- defis_on_mobile
- defis_timed_out
- asynckick
- defmentioned_in
- asyncmove_to
- asyncpins
- asyncremove_roles
- asyncrequest_to_speak
- asyncsend
- asynctimeout
- deftyping
- asyncunban
- class discord.Member¶
Guild
内のDiscordのメンバー。User
にある多くの機能が、これにも実装されています。- x == y
2人のメンバーが等しいかを比較します。これは
User
インスタンスにおいても同様に動作することに注意してください。
- x != y
2人のメンバーが等しくないかを比較します。これは
User
インスタンスにおいても同様に動作することに注意してください。
- hash(x)
メンバーのハッシュ値を返します。
- str(x)
メンバーのハンドル(例えば
name
やname#discriminator
など)を返します。
- joined_at¶
メンバーがギルドに参加した日時をUTCで示すaware datetimeオブジェクト。もしメンバーが脱退し再参加した場合、これは直近のものを反映します。場合によってこれは
None
になりえます。- 型
Optional[
datetime.datetime
]
- activities¶
ユーザーが現在行っているアクティビティ。
注釈
Discord APIの制限により、題名が128文字を超える音楽を聴いているユーザーのSpotifyアクティビティは現れない場合があります。詳細は GH-1738 を確認してください。
- 型
Tuple[Union[
BaseActivity
,Spotify
]]
利用可能な場合、メンバーがギルドで「Nitroブースト」を使用したUTCでの日時を示すaware datetimeオブジェクト。これは
None
の場合があります。- 型
Optional[
datetime.datetime
]
- timed_out_until¶
利用可能な場合、メンバーのギルド内のタイムアウトが満了するUTCでの日時を示すaware datetimeオブジェクト。これは
None
の場合があります。バージョン 2.0 で追加.
- 型
Optional[
datetime.datetime
]
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property discriminator¶
User.discriminator
と同じです。
- property global_name¶
User.global_name
と同じです。
- property system¶
User.system
と同じです。
- property created_at¶
User.created_at
と同じです。
- property default_avatar¶
User.default_avatar
と同じです。
- property avatar¶
User.avatar
と同じです。
- property dm_channel¶
User.dm_channel
と同じです。
- await create_dm()¶
This function is a coroutine.
このユーザーと
DMChannel
を作ります。これは、ほとんどの人にとっては自動で行われるため、呼び出す必要はめったにありません。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- property mutual_guilds¶
User.mutual_guilds
と同じです。
- property public_flags¶
User.public_flags
と同じです。
- property banner¶
User.banner
と同じです。
- property accent_color¶
User.accent_color
と同じです。
- property accent_colour¶
User.accent_colour
と同じです。
- property avatar_decoration¶
Equivalent to
User.avatar_decoration
- property avatar_decoration_sku_id¶
Equivalent to
User.avatar_decoration_sku_id
- property colour¶
メンバーのレンダリングされた色を返すプロパティ。 デフォルトの色がレンダリングされている場合、
Colour.default()
が返されます。color
という名前のエイリアスが存在します。- 型
- property color¶
メンバーのレンダリングされた色を返すプロパティ。 デフォルトの色がレンダリングされている場合、
Colour.default()
が返されます。colour
という名前のエイリアスが存在します。- 型
- property roles¶
メンバーが属する
Role
のlist
。このリストの最初の要素は必ずデフォルトの @everyone ロールです。ロールはロールの階層順によってソートされています。
- 型
List[
Role
]
- property display_icon¶
このメンバーに対してレンダリングされるロールアイコンを返すプロパティ。アイコンが表示されない場合は
None
が返されます。バージョン 2.0 で追加.
- property display_name¶
ユーザーの表示名を返します。
通常であれば、これはグローバル表示名またはユーザー名がそのまま返りますが、ギルドにてニックネームを設定している場合は、代替としてニックネームが返ります。
- 型
- property display_avatar¶
メンバーの表示されるアバターを返します。
通常であれば、これはアバターがそのまま返りますが、ギルド固有アバターを設定している場合は、代替としてそれが返ります。
バージョン 2.0 で追加.
- 型
- property guild_avatar¶
メンバーが持つギルドアバターの
Asset
を返します。利用できない場合はNone
を返します。バージョン 2.0 で追加.
- 型
Optional[
Asset
]
- property activity¶
ユーザーが現在行っている主なアクティビティを返します。何も行われていない場合は
None
の場合があります。注釈
Discord APIの制限により、ユーザーが題名が128文字を超える音楽をSpotifyで聴いている場合はこれが
None
になるかもしれません。詳細は GH-1738 を確認してください。注釈
ユーザーは複数のアクティビティを行っていることがあります。これらは
activities
でアクセスできます。- 型
Optional[Union[
BaseActivity
,Spotify
]]
- mentioned_in(message)¶
指定のメッセージにメンバーに対するメンションが含まれているかを確認します。
- property guild_permissions¶
メンバーのギルド権限を返します。
これは、ギルドの権限のみ考慮し、暗示された権限やチャンネルの権限上書きは考慮しません。100%正確な権限計算を行う場合は
abc.GuildChannel.permissions_for()
を使用してください。これはギルドの所有権、管理者権限、メンバーがタイムアウトされているかどうかを考慮します。
バージョン 2.0 で変更: メンバータイムアウトを考慮するようになりました。
- property resolved_permissions¶
インタラクションにより与えられたメンバーの解決済み権限を返します。
これはインタラクション内でのみ利用できインタラクションが実行されたチャンネルでのメンバーの権限を示します。これは
abc.GuildChannel.permissions_for()
と同様ですが、算出されたものではなく、Discord APIによって保管され、渡されたものです。バージョン 2.0 で追加.
- 型
Optional[
Permissions
]
- property voice¶
メンバーの現在のボイス状態を返します。
- 型
Optional[
VoiceState
]
- property flags¶
メンバーのフラグを返します。
バージョン 2.2 で追加.
- await ban(*, delete_message_days=..., delete_message_seconds=..., reason=None)¶
This function is a coroutine.
このメンバーをBANします。
Guild.ban()
と同等です。
- await unban(*, reason=None)¶
This function is a coroutine.
このメンバーのBANを解除します。
Guild.unban()
と同等です。
- await kick(*, reason=None)¶
This function is a coroutine.
このメンバーを追放します。
Guild.kick()
と同等です。
- await edit(*, nick=..., mute=..., deafen=..., suppress=..., roles=..., voice_channel=..., timed_out_until=..., bypass_verification=..., reason=None)¶
This function is a coroutine.
メンバーデータを編集します。
渡されたパラメータに応じて、以下のような権限が必要です:
パラメータ
権限
nick
mute
deafen
roles
voice_channel
timed_out_until
bypass_verification
すべてのパラメータがオプションです。
バージョン 1.1 で変更:
None
をvoice_channel
に渡してボイスからメンバーを追放できるようになりました。バージョン 2.0 で変更: 可能な場合、新しく更新されたメンバーが返されるようになりました。
- パラメータ
nick (Optional[
str
]) -- メンバーの新しいニックネーム。ニックネームを除去する場合はNone
を渡してください。mute (
bool
) -- メンバーがギルドミュートまたはミュート解除されるべきかどうかを示します。deafen (
bool
) -- メンバーがギルドスピーカーミュートまたはスピーカーミュート解除されるべきかどうかを示します。suppress (
bool
) --ステージチャンネルでメンバーを抑制するかどうかを示します。
バージョン 1.7 で追加.
roles (List[
Role
]) -- メンバーの新しいロールのリスト。これは以前のものを 置き換えます 。voice_channel (Optional[Union[
VoiceChannel
,StageChannel
]]) -- メンバーの移動先のボイスチャンネル。None
を渡すとボイスから退出させることができます。timed_out_until (Optional[
datetime.datetime
]) --メンバーのタイムアウトの満了日時。
None
を渡すとタイムアウトを除去できます。これはtimezone awareなdatetimeオブジェクトでないといけません。utils.utcnow()
の使用を検討してください。バージョン 2.0 で追加.
bypass_verification (
bool
) --メンバーがギルドの認証要件をバイパスできるかどうかを示します。
バージョン 2.2 で追加.
reason (Optional[
str
]) -- メンバーを編集する理由。監査ログに表示されます。
- 例外
Forbidden -- You do not have the proper permissions to do the action requested.
HTTPException -- 操作に失敗した場合。
TypeError --
timed_out_until
に渡されたdatetimeオブジェクトがtimezone awareでない場合。
- 戻り値
該当する場合、新しく更新されたメンバー。
suppress
などの一部の項目が更新された場合は返されません。- 戻り値の型
Optional[
Member
]
- await request_to_speak()¶
This function is a coroutine.
接続されたチャンネルで話すことを要求します。
ステージチャンネルにのみ適用されます。
注釈
クライアントでないメンバーをリクエストした場合は、
edit
を、suppress
パラメータをFalse
にして呼び出すのと同等です。バージョン 1.7 で追加.
- 例外
ClientException -- ボイスチャンネルに接続していない場合。
Forbidden -- You do not have the proper permissions to do the action requested.
HTTPException -- 操作に失敗した場合。
- await move_to(channel, *, reason=None)¶
This function is a coroutine.
メンバーを別のボイスチャンネルに移動します。(メンバーは既に接続されていないといけません。)
これを行うには、
move_members
が必要です。edit()
と同じ例外を送出します。バージョン 1.1 で変更:
None
を渡してボイスからメンバーを追放できるようになりました。- パラメータ
channel (Optional[Union[
VoiceChannel
,StageChannel
]]) -- メンバーの移動先のボイスチャンネル。None
を渡すとボイスから退出させることができます。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- await timeout(until, /, *, reason=None)¶
This function is a coroutine.
指定された日時まで、または与えられた
datetime.timedelta
の間、メンバーをタイムアウトさせます。これを行うには、
moderate_members
が必要です。edit()
と同じ例外を送出します。- パラメータ
until (Optional[Union[
datetime.timedelta
,datetime.datetime
]]) -- もしこれがdatetime.timedelta
の場合はこれはメンバーがタイムアウトされるべき期間を表します。もしこれがdatetime.datetime
の場合はこれはメンバーのタイムアウトが満了すべき日時です。None
を渡すとタイムアウトが除去されます。なお、APIがタイムアウトの最大日数を28日に制限していることに注意してください。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
TypeError --
until
パラメータの型が間違っていたか、timezone-awareでない場合。
- await add_roles(*roles, reason=None, atomic=True)¶
This function is a coroutine.
メンバーに
Role
を付与します。これを行うには
manage_roles
が必要で、また付与されたRole
はメンバーの最高のロールより下の階層にないといけません。- パラメータ
*roles (
abc.Snowflake
) -- メンバーに付与するRole
であるabc.Snowflake
の引数リスト。reason (Optional[
str
]) -- ロールを付与する理由。監査ログに表示されます。atomic (
bool
) -- ロールをアトミックに付与するか。これは現在のキャッシュの状態にかかわらず複数の操作が適用されることを保証します。
- 例外
Forbidden -- ロールを付与する権限がない場合。
HTTPException -- ロールの付与に失敗した場合。
- await remove_roles(*roles, reason=None, atomic=True)¶
This function is a coroutine.
このメンバーから
Role
を除去します。これを行うには
manage_roles
が必要で、また除去されたRole
はメンバーの最高のロールより下の階層にないといけません。- パラメータ
*roles (
abc.Snowflake
) -- メンバーから除去するRole
であるabc.Snowflake
の引数リスト。reason (Optional[
str
]) -- ロールを除去する理由。監査ログに表示されます。atomic (
bool
) -- ロールをアトミックに除去するか。これは現在のキャッシュの状態にかかわらず複数の操作が適用されることを保証します。
- 例外
Forbidden -- ロールを除去する権限がない場合。
HTTPException -- ロールの除去に失敗した場合。
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- get_role(role_id, /)¶
メンバーの持つロールのうち、与えられたIDを持つものを返します。
バージョン 2.0 で追加.
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
Spotify¶
- class discord.Spotify¶
DiscordのSpotifyリスニングアクティビティ。これはSpotify連携サービスの取り扱いを簡単にするようにした
Activity
の特殊なケースです。- x == y
2つのアクティビティーが同一か比較します。
- x != y
2つのアクティビティーが同一でないか比較します。
- hash(x)
アクティビティのハッシュ値を返します。
- str(x)
文字列 'Spotify' を返します。
- property type¶
アクティビティのタイプを返します。これは
Activity
との互換性のためです。これは常に
ActivityType.listening
を返します。
- property created_at¶
ユーザーがリスニングを開始したときのUTC時刻。
バージョン 1.3 で追加.
- 型
Optional[
datetime.datetime
]
- property start¶
ユーザーが再生を開始したときのUTC時刻。
- property end¶
ユーザーが再生を終了する予定のUTC時刻。
- property duration¶
再生中の音楽の長さ。
VoiceState¶
- class discord.VoiceState¶
Discordユーザーのボイス状態を表します。
- requested_to_speak_at¶
メンバーが話すことを要求したUTCでの日時を示すaware datetimeオブジェクト。話すことを要求していない場合や要求が承認された場合は
None
になります。ステージチャンネルにのみ適用されます。
バージョン 1.7 で追加.
- 型
Optional[
datetime.datetime
]
- channel¶
ユーザーが現在接続しているボイスチャンネル。ユーザーがボイスチャンネルに接続していない場合は
None
。- 型
Optional[Union[
VoiceChannel
,StageChannel
]]
Emoji¶
- class discord.Emoji¶
カスタム絵文字を表します。
このオブジェクトの作成方法によって、属性の一部が
None
の値になることがあります。- x == y
2つの絵文字が等しいものか比較します。
- x != y
2つの絵文字が等しいものではないか比較します。
- hash(x)
絵文字のハッシュ値を返します。
- iter(x)
(field, value)
ペアのイテレータを返します。これにより、このクラスを list/dictなどの作成時にイテラブルとして使用できます。
- str(x)
Discordでレンダリングされる絵文字を返します。
- user¶
絵文字を作成したユーザー。これは
Guild.fetch_emoji()
経由で、かつmanage_emojis
を持つユーザーによってのみ取得できます。- 型
Optional[
User
]
- property created_at¶
絵文字の作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
カスタム絵文字を削除します。
これを行うには、
manage_emojis
が必要です。- パラメータ
reason (Optional[
str
]) -- 絵文字を削除する理由。監査ログに表示されます。- 例外
Forbidden -- 絵文字を削除する権限がない場合。
HTTPException -- 絵文字の削除中にエラーが発生した場合。
- await edit(*, name=..., roles=..., reason=None)¶
This function is a coroutine.
カスタム絵文字を編集します。
これを行うには、
manage_emojis
が必要です。バージョン 2.0 で変更: 新しく更新された絵文字が返されるようになりました。
- await read()¶
This function is a coroutine.
このアセットの内容を
bytes
オブジェクトとして取得します。- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
アセットの内容。
- 戻り値の型
- await save(fp, *, seek_begin=True)¶
This function is a coroutine.
このアセットをファイルライクオブジェクトに保存します。
- パラメータ
fp (Union[
io.BufferedIOBase
,os.PathLike
]) -- このアセットの保存先となるファイルのようなオブジェクト、または使用するファイル名。ファイル名を指定すると、そのファイル名でファイルが作成され、代わりに使用されます。seek_begin (
bool
) -- 正常に保存した後にファイルの先頭にシークすべきか。
- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
書き込まれたバイト数。
- 戻り値の型
- await to_file(*, filename=..., description=None, spoiler=False)¶
This function is a coroutine.
アセットを
abc.Messageable.send()
を介して送信するのに適したFile
に変換します。バージョン 2.0 で追加.
- パラメータ
- 例外
DiscordException -- アセットにステートが付属していない場合。
ValueError -- アセットがユニコード絵文字である場合。
TypeError -- アセットがロッティータイプのスタンプであった場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
送信に適したファイルとしてのアセット。
- 戻り値の型
PartialEmoji¶
- clsPartialEmoji.from_str
- defis_custom_emoji
- defis_unicode_emoji
- asyncread
- asyncsave
- asyncto_file
- class discord.PartialEmoji¶
「部分的な」絵文字を表します。
これは以下の2つの場合に提供されます:
on_raw_reaction_add()
といった「生の」データイベントMessage.reactions
などから取得した、ボットが見ることのできないカスタム絵文字
- x == y
2つの絵文字が等しいものか比較します。
- x != y
2つの絵文字が等しいものではないか比較します。
- hash(x)
絵文字のハッシュ値を返します。
- str(x)
Discordでレンダリングされる絵文字を返します。
- name¶
カスタム絵文字の名前か、カスタム絵文字でない絵文字のユニコードコードポイント。これは絵文字が削除されていた場合(例:削除された絵文字のリアクションを除去する場合)
None
になります。- 型
Optional[
str
]
- classmethod from_str(value)¶
Discordの文字列形式で表現された絵文字を
PartialEmoji
に変換します。以下の形式が利用できます:
a:name:id
<a:name:id>
name:id
<:name:id>
これらの形式に当てはまらない場合はユニコード絵文字とみなされます。
バージョン 2.0 で追加.
- パラメータ
value (
str
) -- 絵文字の文字列表現。- 戻り値
この文字列に含まれる部分的な絵文字。
- 戻り値の型
- property created_at¶
UTCで絵文字の作成時刻を返します。ユニコード絵文字の場合は None を返します。
バージョン 1.6 で追加.
- 型
Optional[
datetime.datetime
]
- await read()¶
This function is a coroutine.
このアセットの内容を
bytes
オブジェクトとして取得します。- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
ValueError -- PartialEmojiがカスタム絵文字でない場合。
- 戻り値
アセットの内容。
- 戻り値の型
- await save(fp, *, seek_begin=True)¶
This function is a coroutine.
このアセットをファイルライクオブジェクトに保存します。
- パラメータ
fp (Union[
io.BufferedIOBase
,os.PathLike
]) -- このアセットの保存先となるファイルのようなオブジェクト、または使用するファイル名。ファイル名を指定すると、そのファイル名でファイルが作成され、代わりに使用されます。seek_begin (
bool
) -- 正常に保存した後にファイルの先頭にシークすべきか。
- 例外
DiscordException -- 内部の接続ステートが存在しない場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
書き込まれたバイト数。
- 戻り値の型
- await to_file(*, filename=..., description=None, spoiler=False)¶
This function is a coroutine.
アセットを
abc.Messageable.send()
を介して送信するのに適したFile
に変換します。バージョン 2.0 で追加.
- パラメータ
- 例外
DiscordException -- アセットにステートが付属していない場合。
ValueError -- アセットがユニコード絵文字である場合。
TypeError -- アセットがロッティータイプのスタンプであった場合。
HTTPException -- アセットのダウンロードに失敗した場合。
NotFound -- アセットが削除された場合。
- 戻り値
送信に適したファイルとしてのアセット。
- 戻り値の型
Role¶
- asyncdelete
- asyncedit
- defis_assignable
- defis_bot_managed
- defis_default
- defis_integration
- defis_premium_subscriber
- class discord.Role¶
Guild
のDiscordのロール。- x == y
二つのロールが等しいかを比較します。
- x != y
二つのロールが等しいものではないか比較します。
- x > y
そのロールがもう1つのロールと比べて、階層において順位が上かを比較します。
- x < y
そのロールがもう1つのロールと比べて、階層において順位が下かを比較します。
- x >= y
そのロールがもう1つのロールと比べて、階層において順位が同じ、または上かを比較します。
- x <= y
そのロールがもう1つのロールと比べて、階層において順位が同じ、または下かを比較します。
- hash(x)
ロールのハッシュを返します。
- str(x)
ロールの名前を返します。
- position¶
ロールの位置。この数値は通常正です。一番下のロールの位置は 0 です。
警告
複数のロールが同じ位置番号を持つことがあります。このため、ロールの位置の比較はロール階層の確認時にバグの原因となります。ロール階層を比較するときの推奨され、正しい方法はロールオブジェクトそのものへの比較演算子の使用です。
- 型
- unicode_emoji¶
存在する場合、ロールのユニコード絵文字。
注釈
もし
icon
がNone
でない場合、このユニコード絵文字ではなくそのアイコンがロールアイコンとして表示されます。ロールに表示されるアイコンを取得したい場合は、
display_icon
を使用してみてください。バージョン 2.0 で追加.
- 型
Optional[
str
]
bool
: ロールがギルドのプレミアムサブスクライバー、すなわち「ブースト」のロールかどうか。バージョン 1.6 で追加.
- property permissions¶
ロールの権限を返します。
- property icon¶
利用できる場合、ロールのアイコンのアセットを返します。
注釈
これが
None
のときで、unicode_emoji
がNone
でない場合、ロールは ユニコード絵文字をアイコンとして使用しているかもしれません。ロールに表示されるアイコンを取得したい場合は、
display_icon
を使用してみてください。バージョン 2.0 で追加.
- 型
Optional[
Asset
]
- property created_at¶
ロールの作成時刻をUTCで返します。
- await edit(*, name=..., permissions=..., colour=..., color=..., hoist=..., display_icon=..., mentionable=..., position=..., reason=...)¶
This function is a coroutine.
ロールを編集します。
これを行うには、
manage_roles
が必要です。すべてのフィールドはオプションです。
バージョン 1.4 で変更:
int
をcolour
キーワード引数に渡せるようになりました。バージョン 2.0 で変更: 編集はロールを置き換えず、編集された新しいロールが返されるようになりました。
バージョン 2.0 で追加:
display_icon
キーワード引数が追加されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
name (
str
) -- 変更する新しいロール名。permissions (
Permissions
) -- 変更する新しい権限。hoist (
bool
) -- メンバーリストにロールを他と分けて表示するかどうかを示します。display_icon (Optional[Union[
bytes
,str
]]) -- ロールのアイコンとして使用すべきアイコンを表す bytes-like object またはユニコード絵文字を表すstr
。アイコンを除去する場合None
を渡せます。PNGとJPEGのみサポートしています。これはGuild.features
にROLE_ICONS
を含むギルドでのみ利用可能です。mentionable (
bool
) -- ロールがユーザーによってメンションできるかどうかを示します。position (
int
) -- 新しいロールの位置。これはあなたの最高位のロールより下位でないといけません。reason (Optional[
str
]) -- ロールを編集する理由。監査ログに表示されます。
- 例外
Forbidden -- ロールを変更する権限がない場合。
HTTPException -- ロールの編集に失敗した場合。
ValueError -- 無効なポジションが与えられたか、デフォルトのロールを移動するように求めた場合。
- 戻り値
新しく編集されたロール。
- 戻り値の型
- await delete(*, reason=None)¶
This function is a coroutine.
ロールを削除します。
これを行うには、
manage_roles
が必要です。- パラメータ
reason (Optional[
str
]) -- ロールを削除する理由。監査ログに表示されます。- 例外
Forbidden -- ロールを削除する権限がない場合。
HTTPException -- ロールの削除に失敗した場合。
PartialMessageable¶
- asyncfetch_message
- defget_partial_message
- async forhistory
- defpermissions_for
- asyncpins
- asyncsend
- deftyping
- class discord.PartialMessageable¶
チャンネルIDのみ存在する場合にメッセージ可能なチャンネルとの作業を簡単にする部分的なメッセージ可能チャンネル。
これは
Client.get_partial_messageable()
によってのみ作成できます。これは機能が削られていてリッチな属性を持ちません。
バージョン 2.0 で追加.
- x == y
二つの部分的なメッセージ可能チャンネルが等しいかを比較します。
- x != y
二つの部分的なメッセージ可能チャンネルが等しくないかを比較します。
- hash(x)
部分的なメッセージ可能チャンネルのハッシュ値を返します。
- type¶
与えられた場合、この部分的なメッセージ可能チャンネルのチャンネルタイプ。
- 型
Optional[
ChannelType
]
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- permissions_for(obj=None, /)¶
User
の権限を解決します。この機能は他のチャンネルタイプとの互換性のためにあります。
部分的なメッセージ可能チャンネルには権限の概念がないため、これは常に
Permissions.none()
を返します。- パラメータ
obj (
User
) -- 権限を確認するユーザー。このパラメータは他のpermissions_for
メソッドとの互換性のためにあり、無視されます。- 戻り値
解決された権限。
- 戻り値の型
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
TextChannel¶
- async forarchived_threads
- asyncclone
- asynccreate_invite
- asynccreate_thread
- asynccreate_webhook
- asyncdelete
- asyncdelete_messages
- asyncedit
- asyncfetch_message
- asyncfollow
- defget_partial_message
- defget_thread
- async forhistory
- asyncinvites
- defis_news
- defis_nsfw
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncpins
- asyncpurge
- asyncsend
- asyncset_permissions
- deftyping
- asyncwebhooks
- class discord.TextChannel¶
Discordギルドのテキストチャンネル。
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
チャンネルのハッシュ値を返します。
- str(x)
チャンネルの名前を返します。
- slowmode_delay¶
このチャンネルにメッセージを送信する間にメンバーが待たなければいけない時間。値が
0
の場合これは無効です。ボットやユーザーがmanage_channels
かmanage_messages
権限を有する場合低速モードを回避できます。- 型
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property type¶
チャンネルのDiscordタイプ。
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- property last_message¶
キャッシュからこのチャンネルに最後に送信されたメッセージを取得します。
このメッセージは有効でなかったり、存在するものでない場合があります。
信頼性の高い取得方法
より信頼性のある最後のメッセージの取得方法として、
history()
やlast_message_id
とfetch_message()
の組み合わせがあります。- 戻り値
このチャンネルの最後のメッセージ。見つからない場合は
None
です。- 戻り値の型
Optional[
Message
]
- await edit(*, reason=None, **options)¶
This function is a coroutine.
チャンネルを編集します。
これを行うには、
manage_channels
が必要です。バージョン 1.3 で変更:
overwrites
キーワード引数が追加されました。バージョン 1.4 で変更:
type
キーワード引数が追加されました。バージョン 2.0 で変更: 編集はチャンネルを置き換えず、編集された新しいチャンネルが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
name (
str
) -- チャンネルの名前。topic (
str
) -- 新しいチャンネルのトピック。position (
int
) -- チャンネルの位置。nsfw (
bool
) -- チャンネルに年齢制限をかけるかどうか。sync_permissions (
bool
) -- チャンネルの新しい、又は既存のカテゴリと権限を同期するか。デフォルトはFalse
です。category (Optional[
CategoryChannel
]) -- チャンネルの新しいカテゴリ。カテゴリを削除するにはNone
を指定できます。slowmode_delay (
int
) -- 秒単位でこのチャンネルのユーザーの低速モードの値を指定します。0
を渡すと低速モードを無効にできます。可能な最大の値は21600
です。type (
ChannelType
) -- このテキストチャンネルのタイプを変更します。現時点ではChannelType.text
とChannelType.news
間での変更のみできます。これはGuild.features
にNEWS
を含むギルドでのみ利用できます。reason (Optional[
str
]) -- チャンネルを編集する理由。監査ログに表示されます。overwrites (
Mapping
) -- ターゲット(ロール又はメンバー)をキーとし適用されるPermissionOverwrite
を値とするMapping
。default_auto_archive_duration (
int
) --このチャンネルで作成されたスレッドの分単位のデフォルトの自動アーカイブ期間。これは
60
、1440
、4320
、または10080
でないといけません。バージョン 2.0 で追加.
default_thread_slowmode_delay (
int
) --このチャンネルで作成されたスレッドの、新しいデフォルトの秒単位の低速モードレート制限。
バージョン 2.3 で追加.
- 例外
ValueError -- 新しい
position
が0より小さいか、カテゴリの数より大きい場合。TypeError -- 権限の上書きの情報が適切なものでない場合。
Forbidden -- チャンネルを編集する権限がない場合。
HTTPException -- チャンネルの編集に失敗した場合。
- 戻り値
新しく編集されたテキストチャンネル。編集が位置のみだった場合は代わりに
None
が返されます。- 戻り値の型
Optional[
TextChannel
]
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await delete_messages(messages, *, reason=None)¶
This function is a coroutine.
メッセージのリストを削除します。複数のメッセージを一括削除する点を除き、これは
Message.delete()
に似ています。スペシャルケースとして、もしメッセージ数が0の場合は何もせず、メッセージ数が1の場合は単独のメッセージ削除が行われます。これが2以上の場合一括削除が行われます。
14日以上前のメッセージや100件以上のメッセージを一括削除することはできません。
これを行うには、
manage_messages
が必要です。バージョン 2.0 で変更: 引数
messages
は位置専用引数となりました。reason
キーワード引数が追加されました。- パラメータ
messages (Iterable[
abc.Snowflake
]) -- 一括削除するものを示すメッセージのiterableオブジェクト。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
ClientException -- 削除するメッセージの数が100以上の場合。
Forbidden -- メッセージを一括削除するための適切な権限がない場合。
NotFound -- 1メッセージのみ削除する時、メッセージが既に削除されていた場合。
HTTPException -- メッセージの削除に失敗した場合。
- await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=None, bulk=True, reason=None)¶
This function is a coroutine.
check
関数の要件を満たすメッセージを一括削除します。check
が渡されない場合はすべてのメッセージが削除されます。メッセージを削除するときに、それが自分のものであったとしても、削除するには
manage_messages
が必要です。メッセージの履歴を取得するためにread_message_history
も必要になります。バージョン 2.0 で変更:
reason
キーワード引数が追加されました。サンプル
Botによるメッセージを削除する
def is_me(m): return m.author == client.user deleted = await channel.purge(limit=100, check=is_me) await channel.send(f'Deleted {len(deleted)} message(s)')
- パラメータ
limit (Optional[
int
]) -- 検索するメッセージ数。これは削除するメッセージ数になるとは必ずしも限りません。check (Callable[[
Message
],bool
]) -- メッセージが削除されるかどうかを確認するために使用される関数。Message
を唯一のパラメータとして受け取る必要があります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのbefore
と同じです。after (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのafter
と同じです。around (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのaround
と同じです。oldest_first (Optional[
bool
]) --history()
でのoldest_first
と同じです。bulk (
bool
) --True
の場合、一括削除を使用します。これをFalse
に設定すると、Permissions.manage_messages
なしでボット自身のメッセージを一括削除することができます。True
の場合でも、2週間以上前のメッセージは個別に削除されます。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
Forbidden -- 必要なアクションをするための適切な権限がない場合。
HTTPException -- メッセージの一括削除に失敗した場合。
- 戻り値
削除されたメッセージのlist。
- 戻り値の型
List[
Message
]
- await webhooks()¶
This function is a coroutine.
チャンネル内のWebhookのリストを取得します。
これを行うには、
manage_webhooks
が必要です。
- await create_webhook(*, name, avatar=None, reason=None)¶
This function is a coroutine.
チャンネルに新しいWebhookを作ります。
これを行うには、
manage_webhooks
が必要です。バージョン 1.1 で変更:
reason
キーワード引数が追加されました。- パラメータ
name (
str
) -- Webhookの名前。avatar (Optional[
bytes
]) -- Webhookのデフォルトアバターを表す bytes-like object 。edit()
と同様に動作します。reason (Optional[
str
]) -- Webhookを作成する理由。監査ログに表示されます。
- 例外
HTTPException -- Webhookの作成に失敗した場合。
Forbidden -- Webhookを作成する権限を持っていない場合。
- 戻り値
作成されたwebhook。
- 戻り値の型
- await follow(*, destination, reason=None)¶
This function is a coroutine.
Webhookを使用してチャンネルをフォローします。
フォローできるのはニュースチャンネルのみです。
注釈
返されたWebhookは、Discordが提供していないため、Webhook アクションを実行するためのトークンを提供しません。
バージョン 1.3 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
destination (
TextChannel
) -- フォローしたいチャンネル。reason (Optional[
str
]) --チャンネルをフォローする理由。宛先のギルドの監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
HTTPException -- チャンネルのフォローに失敗した場合。
Forbidden -- Webhookを作成する権限を持っていない場合。
ClientException -- チャンネルがニュースチャンネルでない場合。
TypeError -- 宛先チャンネルがテキストチャンネルでない場合。
- 戻り値
作成されたwebhook。
- 戻り値の型
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
バージョン 1.6 で追加.
バージョン 2.0 で変更: 引数
message_id
は位置専用引数となりました。- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
- get_thread(thread_id, /)¶
与えられたIDに合致するスレッドを返します。
注釈
内部キャッシュに保持されていないため、アーカイブされたスレッドを取得できないことがあります。代わりに
Guild.fetch_channel()
を使用してください。バージョン 2.0 で追加.
- await create_thread(*, name, message=None, auto_archive_duration=..., type=None, reason=None, invitable=True, slowmode_delay=None)¶
This function is a coroutine.
このテキストチャンネルでスレッドを作成します。
パブリックスレッドを作成するには、
create_public_threads
が必要です。プライベートスレッドの場合は、代わりにcreate_private_threads
が必要です。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- スレッドの名前。message (Optional[
abc.Snowflake
]) -- スレッドを開始するメッセージを表すスノーフレーク。None
が渡された場合、プライベートスレッドが作成されます。デフォルトはNone
です。auto_archive_duration (
int
) -- スレッドがチャンネルリストから自動的に非表示になるまでの分単位の時間。 指定されていない場合、チャンネルのデフォルトの自動アーカイブ期間が使用されます。指定された場合は、60
、1440
、4320
、または10080
のいずれかでないといけません。type (Optional[
ChannelType
]) -- 作成するスレッドの種類。message
が渡された場合、メッセージで作成されたスレッドは常に公開スレッドであるためこのパラメータは無視されます。 デフォルトでは、これがNone
の場合、プライベートスレッドが作成されます。reason (
str
) -- スレッドを作成する理由。監査ログに表示されます。invitable (
bool
) -- モデレータ以外がスレッドにユーザーを追加できるかどうか。プライベートスレッドにのみ適用されます。デフォルトはTrue
です。slowmode_delay (Optional[
int
]) -- このチャンネルの秒単位での低速モードレート制限。 最大値は21600
です。デフォルトはNone
でこの場合は低速モードレート制限が無しとなります。
- 例外
Forbidden -- スレッドを作成する権限を持っていない場合。
HTTPException -- スレッドの作成に失敗した場合。
- 戻り値
作成されたスレッド。
- 戻り値の型
- async for ... in archived_threads(*, private=False, joined=False, limit=100, before=None)¶
このテキストチャンネルのアーカイブされたスレッドをイテレートする asynchronous iterator を返します。これは参加したスレッドではIDの降順、それ以外では
Thread.archive_timestamp
の降順です。これを行うには、
read_message_history
が必要です。プライベートスレッドをイテレートする場合は、manage_threads
も必要です。バージョン 2.0 で追加.
- パラメータ
limit (Optional[
bool
]) -- 取得するスレッドの数。None
の場合、チャンネル内のアーカイブされたスレッドすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) -- 指定された日付またはIDより前のアーカイブされたチャンネルを取得します。private (
bool
) -- プライベートのアーカイブされたスレッドを取得するかどうか。joined (
bool
) -- 参加したプライベートアーカイブスレッドを取得するかどうか。joined
にTrue
を設定した場合はprivate
にFalse
を設定することはできません。
- 例外
Forbidden -- アーカイブしたスレッドを取得する権限を持っていない場合。
HTTPException -- アーカイブなスレッドの取得に失敗した場合。
ValueError --
joined
がTrue
に設定され、private
がFalse
に設定された場合。参加したパブリックのアーカイブされたスレッドは取得できません。
- 列挙
Thread
-- アーカイブされたスレッド。
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
ForumChannel¶
- available_tags
- category
- category_id
- changed_roles
- created_at
- default_auto_archive_duration
- default_layout
- default_reaction_emoji
- default_sort_order
- default_thread_slowmode_delay
- flags
- guild
- id
- jump_url
- last_message_id
- mention
- name
- nsfw
- overwrites
- permissions_synced
- position
- slowmode_delay
- threads
- topic
- type
- async forarchived_threads
- asyncclone
- asynccreate_invite
- asynccreate_tag
- asynccreate_thread
- asynccreate_webhook
- asyncdelete
- asyncedit
- defget_tag
- defget_thread
- asyncinvites
- defis_media
- defis_nsfw
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncset_permissions
- asyncwebhooks
- class discord.ForumChannel¶
Discordサーバーのフォーラムチャンネルを表します。
バージョン 2.0 で追加.
- x == y
二つのフォーラムが等しいかを比較します。
- x != y
二つのフォーラムが等しいものではないか比較します。
- hash(x)
フォーラムのハッシュ値を返します。
- str(x)
フォーラムの名前を返します。
- last_message_id¶
このフォーラムで最後に作成されたスレッドのID。これは作成されたスレッドを開始するメッセージのIDと技術的には一致します。存または有効なスレッドやメッセージを指して いない 場合があります。
- 型
Optional[
int
]
- slowmode_delay¶
このフォーラムでスレッドを作成する間にメンバーが待たなければいけない時間。値が
0
の場合これは無効です。ボットやユーザーがmanage_channels
かmanage_messages
権限を有する場合低速モードを回避できます。- 型
- default_reaction_emoji¶
このフォーラムで作成されたスレッドで、デフォルトでリアクション追加ボタンに表示するリアクション絵文字。
バージョン 2.1 で追加.
- 型
Optional[
PartialEmoji
]
- default_layout¶
このフォーラムチャネルの投稿のデフォルトの表示レイアウト。デフォルトは
ForumLayoutType.not_set
です。バージョン 2.2 で追加.
- default_sort_order¶
このフォーラムチャネルの投稿の並び替え順。
バージョン 2.3 で追加.
- 型
Optional[
ForumOrderType
]
- property type¶
チャンネルのDiscordタイプ。
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- get_thread(thread_id, /)¶
与えられたIDに合致するスレッドを返します。
注釈
内部キャッシュに保持されていないため、アーカイブされたスレッドを取得できないことがあります。代わりに
Guild.fetch_channel()
を使用してください。バージョン 2.2 で追加.
- property flags¶
このスレッドに関連付けられたフラグ。
バージョン 2.1 で追加.
- get_tag(tag_id, /)¶
与えられたIDのタグを返します。
バージョン 2.1 で追加.
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await edit(*, reason=None, **options)¶
This function is a coroutine.
フォーラムを編集します。
これを行うには、
manage_channels
が必要です。- パラメータ
name (
str
) -- 新しいフォーラムの名前。topic (
str
) -- 新しいフォーラムのトピック。position (
int
) -- 新しいフォーラムの位置。nsfw (
bool
) -- フォーラムに年齢制限をかけるかどうか。sync_permissions (
bool
) -- フォーラムの新しい、又は既存のカテゴリと権限を同期するか。デフォルトはFalse
です。category (Optional[
CategoryChannel
]) -- フォーラムの新しいカテゴリ。カテゴリを削除するにはNone
を指定できます。slowmode_delay (
int
) -- 秒単位でこのフォーラムのユーザーの低速モードの値を指定します。0
を渡すと低速モードを無効にできます。可能な最大の値は21600
です。type (
ChannelType
) -- このフォーラムチャンネルのタイプを変更します。現時点ではChannelType.text
とChannelType.news
間での変更のみできます。これはGuild.features
にNEWS
を含むギルドでのみ利用できます。reason (Optional[
str
]) -- フォーラムを編集する理由。監査ログに表示されます。overwrites (
Mapping
) -- ターゲット(ロール又はメンバー)をキーとし適用されるPermissionOverwrite
を値とするMapping
。default_auto_archive_duration (
int
) -- このチャンネルで作成されたスレッドの分単位のデフォルトの自動アーカイブ期間。これは60
、1440
、4320
、または10080
でないといけません。available_tags (Sequence[
ForumTag
]) --新しいフォーラムで利用できるタグ。
バージョン 2.1 で追加.
default_thread_slowmode_delay (
int
) --新しいチャンネル内のスレッドのデフォルトの低速モードレート制限。
バージョン 2.1 で追加.
default_reaction_emoji (Optional[Union[
Emoji
,PartialEmoji
,str
]]) --新しいチャンネル内のスレッドのデフォルトのリアクション絵文字。
バージョン 2.1 で追加.
default_layout (
ForumLayoutType
) --このフォーラムの新しい投稿のデフォルトの表示レイアウト。
バージョン 2.2 で追加.
default_sort_order (Optional[
ForumOrderType
]) --このフォーラムの新しい投稿のデフォルトの並び替え順。
バージョン 2.3 で追加.
require_tag (
bool
) --チャンネル内のスレッドにタグが必要であるかどうか。
バージョン 2.1 で追加.
- 例外
ValueError -- 新しい
position
が0より小さいか、カテゴリの数より大きい場合。TypeError -- 権限上書きが適切でないか、または期待された型でない場合。
Forbidden -- フォーラムを編集する権限がない場合。
HTTPException -- フォーラムの編集に失敗した場合。
- 戻り値
新しく編集されたフォーラムチャンネル。編集が位置のみだった場合は代わりに
None
が返されます。- 戻り値の型
Optional[
ForumChannel
]
- await create_tag(*, name, emoji=None, moderated=False, reason=None)¶
This function is a coroutine.
このフォーラムに新しいタグを作成します。
これを行うには、
manage_channels
が必要です。- パラメータ
name (
str
) -- タグ名。最大20文字までです。emoji (Optional[Union[
str
,PartialEmoji
]]) -- タグに使用する絵文字。moderated (
bool
) -- モデレータによってのみタグを追加できるようにするかどうか。reason (Optional[
str
]) -- タグを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- このフォーラムでタグを作成する権限がない場合。
HTTPException -- タグの作成に失敗した場合。
- 戻り値
新しく作成されたタグ。
- 戻り値の型
- await create_thread(*, name, auto_archive_duration=..., slowmode_delay=None, content=None, tts=False, embed=..., embeds=..., file=..., files=..., stickers=..., allowed_mentions=..., mention_author=..., applied_tags=..., view=..., suppress_embeds=False, reason=None)¶
This function is a coroutine.
このフォーラムにスレッドを作成します。
このスレッドは、最初のメッセージが与えられたパブリックスレッドになります。現在、フォーラムでスレッドを作成するには、
send_messages
権限が必要です。フォーラムチャンネルには最初ののメッセージが必要であるため、
content
、embed
、embed
、file
、files
、files
、view
のうち少なくとも1つを送信する必要があります。- パラメータ
name (
str
) -- スレッドの名前。auto_archive_duration (
int
) -- スレッドがチャンネルリストから自動的に非表示になるまでの分単位の時間。 指定されていない場合、チャンネルのデフォルトの自動アーカイブ期間が使用されます。指定された場合は、60
、1440
、4320
、または10080
のいずれかでないといけません。slowmode_delay (Optional[
int
]) -- このチャンネルの秒単位での低速モードレート制限。 最大値は21600
です。デフォルトはNone
でこの場合は低速モードレート制限が無しとなります。content (Optional[
str
]) -- スレッドで送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) -- 送信する埋め込みのリスト。最大10個まで送信できます。file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。allowed_mentions (
AllowedMentions
) -- 処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトはallowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。mention_author (
bool
) -- 設定された場合、allowed_mentions
のreplied_user
属性を上書きします。applied_tags (List[
discord.ForumTag
]) -- スレッドに適用するタグのリスト。view (
discord.ui.View
) -- メッセージに追加するDiscord UI ビュー。stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) -- 送信するスタンプのリスト。最大3個まで送信できます。suppress_embeds (
bool
) -- メッセージの埋め込みを抑制するかどうか。これがTrue
に設定されている場合、埋め込みなしでメッセージを送信します。reason (
str
) -- スレッドを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- スレッドを作成する権限を持っていない場合。
HTTPException -- スレッドの作成に失敗した場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、またはembed
とembeds
の両方が指定された場合。
- 戻り値
作成されたスレッドとメッセージ。これは、
thread
とmessage
フィールドを持つ名前付きタプルとしてもアクセスできます。- 戻り値の型
- await webhooks()¶
This function is a coroutine.
チャンネル内のWebhookのリストを取得します。
これを行うには、
manage_webhooks
が必要です。
- await create_webhook(*, name, avatar=None, reason=None)¶
This function is a coroutine.
チャンネルに新しいWebhookを作ります。
これを行うには、
manage_webhooks
が必要です。- パラメータ
name (
str
) -- Webhookの名前。avatar (Optional[
bytes
]) -- Webhookのデフォルトアバターを表す bytes-like object 。edit()
と同様に動作します。reason (Optional[
str
]) -- Webhookを作成する理由。監査ログに表示されます。
- 例外
HTTPException -- Webhookの作成に失敗した場合。
Forbidden -- Webhookを作成する権限を持っていない場合。
- 戻り値
作成されたwebhook。
- 戻り値の型
- async for ... in archived_threads(*, limit=100, before=None)¶
このフォーラムののアーカイブされたスレッドを
Thread.archive_timestamp
の降順でイテレートする asynchronous iterator を返します。これを行うためには、
read_message_history
が必要です。バージョン 2.0 で追加.
- パラメータ
limit (Optional[
bool
]) -- 取得するスレッドの数。None
の場合、チャンネル内のアーカイブされたスレッドすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) -- 指定された日付またはIDより前のアーカイブされたチャンネルを取得します。
- 例外
Forbidden -- アーカイブしたスレッドを取得する権限を持っていない場合。
HTTPException -- アーカイブなスレッドの取得に失敗した場合。
- 列挙
Thread
-- アーカイブされたスレッド。
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
Thread¶
- asyncadd_tags
- asyncadd_user
- asyncdelete
- asyncdelete_messages
- asyncedit
- asyncfetch_member
- asyncfetch_members
- asyncfetch_message
- defget_partial_message
- async forhistory
- defis_news
- defis_nsfw
- defis_private
- asyncjoin
- asyncleave
- defpermissions_for
- asyncpins
- asyncpurge
- asyncremove_tags
- asyncremove_user
- asyncsend
- deftyping
- class discord.Thread¶
Discordのスレッドを表します。
- x == y
二つのスレッドが等しいかを比較します。
- x != y
二つのスレッドが等しいものではないか比較します。
- hash(x)
スレッドのハッシュ値を返します。
- str(x)
スレッドの名前を返します。
バージョン 2.0 で追加.
- parent_id¶
スレッドが属する親
TextChannel
またはForumChannel
のID。- 型
- slowmode_delay¶
このスレッドにメッセージを送信する間にメンバーが待たなければいけない時間。値が
0
の場合これは無効です。ボットやユーザーがmanage_channels
かmanage_messages
権限を有する場合低速モードを回避できます。- 型
- me¶
スレッドに参加している場合、自分自身を示すスレッドメンバーです。これは利用できない場合があります。
- 型
Optional[
ThreadMember
]
- archive_timestamp¶
スレッドのアーカイブ状態が最後に更新されたときのUTCでのawareなタイムスタンプ。
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property type¶
チャンネルのDiscordタイプ。
- property parent¶
このスレッドが属する親チャンネル。
- 型
Optional[Union[
ForumChannel
,TextChannel
]]
- property flags¶
このスレッドに関連付けられたフラグ。
- property members¶
スレッドのメンバーのリスト。
これを適切に使用するには
Intents.members
が必要です。しかし、ほとんどの場合では、このデータはゲートウェイにより提供されていないためfetch_members()
を呼び出さないといけません。- 型
List[
ThreadMember
]
- property starter_message¶
キャッシュからスレッドの最初のメッセージを返します。
このメッセージはキャッシュされていなかったり、有効でなかったり、存在するものでない場合があります。
スレッドの最初のメッセージのIDはスレッドIDと同じです。
- 戻り値
スレッドの最初のメッセージ、または該当するものが見つからない場合
None
が返ります。- 戻り値の型
Optional[
Message
]
- property last_message¶
キャッシュからこのスレッドに最後に送信されたメッセージを返します。
このメッセージは有効でなかったり、存在するものでない場合があります。
信頼性の高い取得方法
より信頼性のある最後のメッセージの取得方法として、
history()
やlast_message_id
とfetch_message()
の組み合わせがあります。- 戻り値
このチャンネルの最後のメッセージ。見つからない場合は
None
です。- 戻り値の型
Optional[
Message
]
- property category¶
該当する場合、親チャンネルが属するカテゴリチャンネル。
- 例外
ClientException -- 親チャンネルがキャッシュされておらず、
None
を返した場合。- 戻り値
親チャンネルのカテゴリ。
- 戻り値の型
Optional[
CategoryChannel
]
- property category_id¶
該当する場合、親チャンネルが属するカテゴリチャンネルのID。
- 例外
ClientException -- 親チャンネルがキャッシュされておらず、
None
を返した場合。- 戻り値
親チャンネルのカテゴリID。
- 戻り値の型
Optional[
int
]
- property created_at¶
スレッドが作成されたときのUTCでのaware タイムスタンプ。
注釈
このタイムスタンプは、2022 年1 月 9 日以降に作成されたスレッドにのみ存在します。それ以外の場合は
None
を返します。
- is_private()¶
bool
: スレッドがプライベートスレッドかどうか。プライベートスレッドは、明示的に招待された者と
manage_threads
権限を有する者のみが閲覧できます。
- is_news()¶
bool
: スレッドがニューススレッドかどうか。ニューススレッドは親がニュースチャンネルであるスレッドです。つまり、
TextChannel.is_news()
がTrue
であるものです。
- is_nsfw()¶
bool
: スレッドに年齢制限があるか。年齢制限のあるスレッドとは親チャンネルに年齢制限があるスレッドです。つまり、
TextChannel.is_nsfw()
がTrue
であるものです。
- permissions_for(obj, /)¶
-
スレッドは独自の権限を有さないため、親チャンネルから一部の変更を加えたうえでほとんどの権限を継承します。
- パラメータ
obj (Union[
Member
,Role
]) -- 権限を解決すべきオブジェクト。これはメンバーかロールです。ロールの場合メンバーの上書きは判断しません。- 例外
ClientException -- 親チャンネルがキャッシュされておらず、
None
を返した場合。- 戻り値
メンバーまたはロールの解決された権限。
- 戻り値の型
- await delete_messages(messages, /, *, reason=None)¶
This function is a coroutine.
メッセージのリストを削除します。複数のメッセージを一括削除する点を除き、これは
Message.delete()
に似ています。スペシャルケースとして、もしメッセージ数が0の場合は何もせず、メッセージ数が1の場合は単独のメッセージ削除が行われます。これが2以上の場合一括削除が行われます。
14日以上前のメッセージや100件以上のメッセージを一括削除することはできません。
これを行うには、
manage_messages
が必要です。- パラメータ
messages (Iterable[
abc.Snowflake
]) -- 一括削除するものを示すメッセージのiterableオブジェクト。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
ClientException -- 削除するメッセージの数が100以上の場合。
Forbidden -- メッセージを削除するための適切な権限がないか、ボットアカウントを使用していない場合。
NotFound -- 1メッセージのみ削除する時、メッセージが既に削除されていた場合。
HTTPException -- メッセージの削除に失敗した場合。
- await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=None, bulk=True, reason=None)¶
This function is a coroutine.
check
関数の要件を満たすメッセージを一括削除します。check
が渡されない場合はすべてのメッセージが削除されます。メッセージを削除するときに、それが自分のものであったとしても、削除するには
manage_messages
が必要です。メッセージの履歴を取得するためにread_message_history
も必要になります。サンプル
Botによるメッセージを削除する
def is_me(m): return m.author == client.user deleted = await thread.purge(limit=100, check=is_me) await thread.send(f'Deleted {len(deleted)} message(s)')
- パラメータ
limit (Optional[
int
]) -- 検索するメッセージ数。これは削除するメッセージ数になるとは必ずしも限りません。check (Callable[[
Message
],bool
]) -- メッセージが削除されるかどうかを確認するために使用される関数。Message
を唯一のパラメータとして受け取る必要があります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのbefore
と同じです。after (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのafter
と同じです。around (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのaround
と同じです。oldest_first (Optional[
bool
]) --history()
でのoldest_first
と同じです。bulk (
bool
) --True
の場合、一括削除を使用します。これをFalse
に設定すると、Permissions.manage_messages
なしでボット自身のメッセージを一括削除することができます。True
の場合でも、2週間以上前のメッセージは個別に削除されます。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
Forbidden -- 必要なアクションをするための適切な権限がない場合。
HTTPException -- メッセージの一括削除に失敗した場合。
- 戻り値
削除されたメッセージのlist。
- 戻り値の型
List[
Message
]
- await edit(*, name=..., archived=..., locked=..., invitable=..., pinned=..., slowmode_delay=..., auto_archive_duration=..., applied_tags=..., reason=None)¶
This function is a coroutine.
スレッドを編集します。
スレッドの編集には
Permissions.manage_threads
権限が必要です。スレッドの作成者はname
、archived
、auto_archive_duration
も編集できます。もしスレッドがロックされている場合はPermissions.manage_threads
権限を有する者のみスレッドのアーカイブを解除できます。スレッドを編集するにはアーカイブを解除する必要があります。
- パラメータ
name (
str
) -- スレッドの新しい名前。archived (
bool
) -- スレッドをアーカイブするかどうか。locked (
bool
) -- スレッドをロックするかどうか。pinned (
bool
) -- スレッドをピン留めするかどうか。スレッドがフォーラムに属する場合にのみ動作します。invitable (
bool
) -- モデレータでないユーザーがこのスレッドに他のモデレータでないユーザーを追加できるかどうか。プライベートスレッドでのみ利用できます。auto_archive_duration (
int
) -- スレッドが自動的にチャンネルリストから非表示となるまでの分単位の新しい期間。60
、1440
、4320
、または10080
のいずれかでなければなりません。slowmode_delay (
int
) -- 秒単位でこのスレッドのユーザーの低速モードの値を指定します。0
を渡すと低速モードを無効にできます。可能な最大の値は21600
です。applied_tags (Sequence[
ForumTag
]) --スレッドに適用する新しいタグ。スレッドに適用できるタグは最大5つまでです。
バージョン 2.1 で追加.
reason (Optional[
str
]) -- スレッドを編集する理由。監査ログに表示されます。
- 例外
Forbidden -- スレッドを編集する権限がない場合。
HTTPException -- スレッドの編集に失敗した場合。
- 戻り値
新しく編集されたスレッド。
- 戻り値の型
- await add_tags(*tags, reason=None)¶
This function is a coroutine.
渡されたフォーラムタグをスレッドに追加します。
自身で作成したスレッド以外でこれを使用するには、
manage_threads
が必要です。ForumTag.moderated
がTrue
に設定されているタグを追加するには、manage_threads
が必要になります。スレッドに追加できるタグの最大数は 5 です。
親チャンネルは
ForumChannel
でなければなりません。バージョン 2.1 で追加.
- パラメータ
*tags (
abc.Snowflake
) -- スレッドに追加するForumTag
であるabc.Snowflake
の引数リスト。reason (Optional[
str
]) -- タグを追加する理由。
- 例外
Forbidden -- タグを追加する権限がない場合。
HTTPException -- タグの追加に失敗した場合。
- await remove_tags(*tags, reason=None)¶
This function is a coroutine.
渡されたフォーラムタグをスレッドから除去します。
自身で作成したスレッド以外でこれを使用するには、
manage_threads
が必要です。親チャンネルは
ForumChannel
でなければなりません。バージョン 2.1 で追加.
- パラメータ
*tags (
abc.Snowflake
) -- スレッドから除去するForumTag
であるabc.Snowflake
の引数リスト。reason (Optional[
str
]) -- タグを除去する理由。
- 例外
Forbidden -- タグを除去する権限がない場合。
HTTPException -- タグの除去に失敗した場合。
- await join()¶
This function is a coroutine.
スレッドに参加します。
スレッドに参加するには
send_messages_in_threads
権限が必要です。スレッドがプライベートの場合は、manage_threads
も必要です。- 例外
Forbidden -- スレッドに参加する権限を持っていない場合。
HTTPException -- スレッドへの参加に失敗した場合。
- await leave()¶
This function is a coroutine.
このスレッドから退出します。
- 例外
HTTPException -- スレッドの退出に失敗した場合。
- await add_user(user, /)¶
This function is a coroutine.
このスレッドにユーザーを追加します。
スレッドにユーザーを追加するには
send_messages_in_threads
権限が必要です。このスレッドがプライベートでinvitable
がFalse
ならばmanage_messages
権限も必要です。- パラメータ
user (
abc.Snowflake
) -- スレッドに追加するユーザー。- 例外
Forbidden -- スレッドにユーザーを追加する権限がない場合。
HTTPException -- スレッドへのユーザーの追加に失敗した場合。
- await remove_user(user, /)¶
This function is a coroutine.
このスレッドからユーザーを除去します。
ユーザーの除去には、
manage_threads
権限を持ち、またはスレッドの作成者である必要があります。- パラメータ
user (
abc.Snowflake
) -- スレッドから除去するユーザー。- 例外
Forbidden -- スレッドからユーザーを除去する権限がない場合。
HTTPException -- スレッドからユーザーを除去するのに失敗した場合。
- await fetch_member(user_id, /)¶
This function is a coroutine.
指定されたユーザー ID の
ThreadMember
を取得します。- 例外
NotFound -- 指定されたユーザーがこのスレッドのメンバーでない場合。
HTTPException -- メンバーの取得に失敗した場合。
- 戻り値
指定されたユーザー IDのスレッドメンバー。
- 戻り値の型
- await fetch_members()¶
This function is a coroutine.
このスレッドにいるすべての
ThreadMember
を取得します。あなた自身以外のメンバーに関する情報を取得するには、
Intents.members
が必要です。- 例外
HTTPException -- メンバーの取得に失敗した場合。
- 戻り値
スレッドのすべてのメンバー。
- 戻り値の型
List[
ThreadMember
]
- await delete()¶
This function is a coroutine.
スレッドを削除します。
スレッドを削除するには、
manage_threads
権限が必要です。- 例外
Forbidden -- スレッドを削除する権限がない場合。
HTTPException -- スレッドの削除に失敗した場合。
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
バージョン 2.0 で追加.
- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
ThreadMember¶
VoiceChannel¶
- asyncclone
- asyncconnect
- asynccreate_invite
- asynccreate_webhook
- asyncdelete
- asyncdelete_messages
- asyncedit
- asyncfetch_message
- defget_partial_message
- async forhistory
- asyncinvites
- defis_nsfw
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncpins
- asyncpurge
- asyncsend
- asyncset_permissions
- deftyping
- asyncwebhooks
- class discord.VoiceChannel¶
Discordサーバーのボイスチャンネル。
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
チャンネルのハッシュ値を返します。
- str(x)
チャンネルの名前を返します。
- rtc_region¶
ボイスチャンネルの音声通信のためのリージョン。値が
None
の場合は自動で検出されます。バージョン 1.7 で追加.
バージョン 2.0 で変更: この属性の型は
str
に変更されました。- 型
Optional[
str
]
- video_quality_mode¶
ボイスチャンネル参加者のカメラビデオの画質。
バージョン 2.0 で追加.
- last_message_id¶
このチャンネルに送信された最後のメッセージのID。既存または有効なメッセージを指して いない 場合があります。
バージョン 2.0 で追加.
- 型
Optional[
int
]
- slowmode_delay¶
このチャンネルにメッセージを送信する間にメンバーが待たなければいけない時間。値が
0
の場合これは無効です。ボットやユーザーがmanage_channels
かmanage_messages
権限を有する場合低速モードを回避できます。バージョン 2.2 で追加.
- 型
- property type¶
チャンネルのDiscordタイプ。
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await edit(*, reason=None, **options)¶
This function is a coroutine.
チャンネルを編集します。
これを行うには、
manage_channels
が必要です。バージョン 1.3 で変更:
overwrites
キーワード引数が追加されました。バージョン 2.0 で変更: 編集はチャンネルを置き換えず、編集された新しいチャンネルが返されるようになりました。
バージョン 2.0 で変更:
region
パラメータは列挙型の代わりにstr
を受け付けるようになりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
name (
str
) -- チャンネルの新しい名前。bitrate (
int
) -- チャンネルの新しいビットレート。nsfw (
bool
) -- チャンネルに年齢制限をかけるかどうか。user_limit (
int
) -- チャンネルの新しいユーザー人数制限。position (
int
) -- チャンネルの位置。sync_permissions (
bool
) -- チャンネルの新しい、又は既存のカテゴリと権限を同期するか。デフォルトはFalse
です。category (Optional[
CategoryChannel
]) -- チャンネルの新しいカテゴリ。カテゴリを削除するにはNone
を指定できます。slowmode_delay (
int
) -- 秒単位でこのチャンネルのユーザーの低速モードの値を指定します。0
を渡すと低速モードを無効にできます。可能な最大の値は21600
です。reason (Optional[
str
]) -- チャンネルを編集する理由。監査ログに表示されます。overwrites (
Mapping
) -- ターゲット(ロール又はメンバー)をキーとし適用されるPermissionOverwrite
を値とするMapping
。rtc_region (Optional[
str
]) --ボイスチャンネルの新しい音声通信のためのリージョン。値が
None
の場合は自動で検出されます。バージョン 1.7 で追加.
video_quality_mode (
VideoQualityMode
) --ボイスチャンネル参加者のカメラビデオの画質。
バージョン 2.0 で追加.
status (Optional[
str
]) --The new voice channel status. It can be up to 500 characters. Can be
None
to remove the status.バージョン 2.4 で追加.
- 例外
TypeError -- 権限の上書きの情報が適切なものでない場合。
Forbidden -- チャンネルを編集する権限がない場合。
HTTPException -- チャンネルの編集に失敗した場合。
- 戻り値
新しく編集されたボイスチャンネル。編集が位置のみだった場合は代わりに
None
が返されます。- 戻り値の型
Optional[
VoiceChannel
]
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- await connect(*, timeout=30.0, reconnect=True, cls=<class 'discord.voice_client.VoiceClient'>, self_deaf=False, self_mute=False)¶
This function is a coroutine.
ボイスに接続し
VoiceClient
を作成してボイスサーバーへの接続を確立します。voice_states
が必要です。- パラメータ
timeout (
float
) -- The timeout in seconds to wait the connection to complete.reconnect (
bool
) -- ハンドシェイクの一部が失敗し、またはゲートウェイが使用できない場合に、ボットが自動で再接続を試みるべきか。cls (Type[
VoiceProtocol
]) --VoiceProtocol
をサブクラスする型。既定値はVoiceClient
。self_mute (
bool
) --クライアントをセルフミュートすべきか。
バージョン 2.0 で追加.
self_deaf (
bool
) --クライアントをセルフスピーカーミュートすべきか。
バージョン 2.0 で追加.
- 例外
asyncio.TimeoutError -- 時間内にボイスチャンネルに接続できなかった場合。
ClientException -- すでにボイスチャンネルに接続している場合。
OpusNotLoaded -- opusライブラリが読み込まれていない場合。
- 戻り値
ボイスサーバーに完全に接続されたボイスクライアント。
- 戻り値の型
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- await create_webhook(*, name, avatar=None, reason=None)¶
This function is a coroutine.
チャンネルに新しいWebhookを作ります。
これを行うには、
manage_webhooks
が必要です。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- Webhookの名前。avatar (Optional[
bytes
]) -- Webhookのデフォルトアバターを表す bytes-like object 。edit()
と同様に動作します。reason (Optional[
str
]) -- Webhookを作成する理由。監査ログに表示されます。
- 例外
HTTPException -- Webhookの作成に失敗した場合。
Forbidden -- Webhookを作成する権限を持っていない場合。
- 戻り値
作成されたwebhook。
- 戻り値の型
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await delete_messages(messages, *, reason=None)¶
This function is a coroutine.
メッセージのリストを削除します。複数のメッセージを一括削除する点を除き、これは
Message.delete()
に似ています。スペシャルケースとして、もしメッセージ数が0の場合は何もせず、メッセージ数が1の場合は単独のメッセージ削除が行われます。これが2以上の場合一括削除が行われます。
14日以上前のメッセージや100件以上のメッセージを一括削除することはできません。
これを行うには、
manage_messages
が必要です。バージョン 2.0 で追加.
- パラメータ
messages (Iterable[
abc.Snowflake
]) -- 一括削除するものを示すメッセージのiterableオブジェクト。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
ClientException -- 削除するメッセージの数が100以上の場合。
Forbidden -- メッセージを一括削除するための適切な権限がない場合。
NotFound -- 1メッセージのみ削除する時、メッセージが既に削除されていた場合。
HTTPException -- メッセージの削除に失敗した場合。
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
バージョン 2.0 で追加.
- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- property last_message¶
キャッシュからこのチャンネルに最後に送信されたメッセージを取得します。
このメッセージは有効でなかったり、存在するものでない場合があります。
バージョン 2.0 で追加.
信頼性の高い取得方法
より信頼性のある最後のメッセージの取得方法として、
history()
やlast_message_id
とfetch_message()
の組み合わせがあります。- 戻り値
このチャンネルの最後のメッセージ。見つからない場合は
None
です。- 戻り値の型
Optional[
Message
]
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=None, bulk=True, reason=None)¶
This function is a coroutine.
check
関数の要件を満たすメッセージを一括削除します。check
が渡されない場合はすべてのメッセージが削除されます。メッセージを削除するときに、それが自分のものであったとしても、削除するには
manage_messages
が必要です。メッセージの履歴を取得するためにread_message_history
も必要になります。バージョン 2.0 で追加.
サンプル
Botによるメッセージを削除する
def is_me(m): return m.author == client.user deleted = await channel.purge(limit=100, check=is_me) await channel.send(f'Deleted {len(deleted)} message(s)')
- パラメータ
limit (Optional[
int
]) -- 検索するメッセージ数。これは削除するメッセージ数になるとは必ずしも限りません。check (Callable[[
Message
],bool
]) -- メッセージが削除されるかどうかを確認するために使用される関数。Message
を唯一のパラメータとして受け取る必要があります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのbefore
と同じです。after (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのafter
と同じです。around (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのaround
と同じです。oldest_first (Optional[
bool
]) --history()
でのoldest_first
と同じです。bulk (
bool
) --True
の場合、一括削除を使用します。これをFalse
に設定すると、Permissions.manage_messages
なしでボット自身のメッセージを一括削除することができます。True
の場合でも、2週間以上前のメッセージは個別に削除されます。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
Forbidden -- 必要なアクションをするための適切な権限がない場合。
HTTPException -- メッセージの一括削除に失敗した場合。
- 戻り値
削除されたメッセージのlist。
- 戻り値の型
List[
Message
]
- property scheduled_events¶
このチャンネルのすべてのスケジュールイベントを返します。
バージョン 2.0 で追加.
- 型
List[
ScheduledEvent
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
- typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property voice_states¶
このチャンネル内にボイス状態のあるメンバーIDのマッピングを返します。
バージョン 1.3 で追加.
注釈
これは、メンバーキャッシュが存在しない場合に
members
を置き換えるため意図的に低レベルとなっています。- 戻り値
メンバーIDをキーとしボイス状態を値とするマッピング。
- 戻り値の型
Mapping[
int
,VoiceState
]
- await webhooks()¶
This function is a coroutine.
チャンネル内のWebhookのリストを取得します。
これを行うには、
manage_webhooks
が必要です。バージョン 2.0 で追加.
StageChannel¶
- bitrate
- category
- category_id
- changed_roles
- created_at
- guild
- id
- instance
- jump_url
- last_message
- last_message_id
- listeners
- members
- mention
- moderators
- name
- nsfw
- overwrites
- permissions_synced
- position
- requesting_to_speak
- rtc_region
- scheduled_events
- slowmode_delay
- speakers
- topic
- type
- user_limit
- video_quality_mode
- voice_states
- asyncclone
- asyncconnect
- asynccreate_instance
- asynccreate_invite
- asynccreate_webhook
- asyncdelete
- asyncdelete_messages
- asyncedit
- asyncfetch_instance
- asyncfetch_message
- defget_partial_message
- async forhistory
- asyncinvites
- defis_nsfw
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncpins
- asyncpurge
- asyncsend
- asyncset_permissions
- deftyping
- asyncwebhooks
- class discord.StageChannel¶
Discordサーバーのステージチャンネルを表します。
バージョン 1.7 で追加.
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
チャンネルのハッシュ値を返します。
- str(x)
チャンネルの名前を返します。
- video_quality_mode¶
ステージチャンネル参加者のカメラビデオの画質。
バージョン 2.0 で追加.
- last_message_id¶
このチャンネルに送信された最後のメッセージのID。既存または有効なメッセージを指して いない 場合があります。
バージョン 2.2 で追加.
- 型
Optional[
int
]
- slowmode_delay¶
このチャンネルにメッセージを送信する間にメンバーが待たなければいけない時間。値が
0
の場合これは無効です。ボットやユーザーがmanage_channels
かmanage_messages
権限を有する場合低速モードを回避できます。バージョン 2.2 で追加.
- 型
- property type¶
チャンネルのDiscordタイプ。
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- property instance¶
ステージチャンネルの開催中のステージインスタンス。
バージョン 2.0 で追加.
- 型
Optional[
StageInstance
]
- await create_instance(*, topic, privacy_level=..., send_start_notification=False, scheduled_event=..., reason=None)¶
This function is a coroutine.
ステージインスタンスを作成します。
これを行うには、
manage_channels
が必要です。バージョン 2.0 で追加.
- パラメータ
topic (
str
) -- ステージインスタンスのトピック。privacy_level (
PrivacyLevel
) -- ステージインスタンスのプライバシーレベル。デフォルトはPrivacyLevel.guild_only
です。send_start_notification (
bool
) --開始通知を送信するかどうか。
True
の場合、プッシュ通知を@everyoneに送信します。 デフォルトはFalse
です。これを行うには、mention_everyone
が必要です。バージョン 2.3 で追加.
scheduled_event (
Snowflake
) --The guild scheduled event associated with the stage instance.
バージョン 2.4 で追加.
reason (
str
) -- ステージインスタンスを作成する理由。監査ログに表示されます。
- 例外
TypeError -- 引数
privacy_level
が適切な型でない場合。Forbidden -- ステージインスタンスを作成する権限がない場合。
HTTPException -- ステージインスタンスの作成に失敗した場合。
- 戻り値
新しく作成されたステージインスタンス。
- 戻り値の型
- await fetch_instance()¶
This function is a coroutine.
開催中の
StageInstance
を取得します。バージョン 2.0 で追加.
- 例外
NotFound -- ステージインスタンスまたはチャンネルが見つからなかった場合
HTTPException -- ステージインスタンスの取得に失敗した場合
- 戻り値
ステージインスタンス。
- 戻り値の型
- await edit(*, reason=None, **options)¶
This function is a coroutine.
チャンネルを編集します。
これを行うには、
manage_channels
が必要です。バージョン 2.0 で変更:
topic
パラメーターはcreate_instance
で設定する必要があります。バージョン 2.0 で変更: 編集はチャンネルを置き換えず、編集された新しいチャンネルが返されるようになりました。
バージョン 2.0 で変更:
region
パラメータは列挙型の代わりにstr
を受け付けるようになりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
name (
str
) -- チャンネルの新しい名前。position (
int
) -- チャンネルの位置。nsfw (
bool
) -- チャンネルに年齢制限をかけるかどうか。user_limit (
int
) -- チャンネルの新しいユーザー人数制限。sync_permissions (
bool
) -- チャンネルの新しい、又は既存のカテゴリと権限を同期するか。デフォルトはFalse
です。category (Optional[
CategoryChannel
]) -- チャンネルの新しいカテゴリ。カテゴリを削除するにはNone
を指定できます。slowmode_delay (
int
) -- 秒単位でこのチャンネルのユーザーの低速モードの値を指定します。0
を渡すと低速モードを無効にできます。可能な最大の値は21600
です。reason (Optional[
str
]) -- チャンネルを編集する理由。監査ログに表示されます。overwrites (
Mapping
) -- ターゲット(ロール又はメンバー)をキーとし適用されるPermissionOverwrite
を値とするMapping
。rtc_region (Optional[
str
]) -- 新しいステージチャンネルの音声通信のためのリージョン。値がNone
の場合は自動で検出されます。video_quality_mode (
VideoQualityMode
) --ステージチャンネル参加者のカメラビデオの画質。
バージョン 2.0 で追加.
- 例外
ValueError -- 権限の上書きの情報が適切なものでない場合。
Forbidden -- チャンネルを編集する権限がない場合。
HTTPException -- チャンネルの編集に失敗した場合。
- 戻り値
新しく編集されたステージチャンネル。編集が位置のみだった場合は代わりに
None
が返されます。- 戻り値の型
Optional[
StageChannel
]
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- await connect(*, timeout=30.0, reconnect=True, cls=<class 'discord.voice_client.VoiceClient'>, self_deaf=False, self_mute=False)¶
This function is a coroutine.
ボイスに接続し
VoiceClient
を作成してボイスサーバーへの接続を確立します。voice_states
が必要です。- パラメータ
timeout (
float
) -- The timeout in seconds to wait the connection to complete.reconnect (
bool
) -- ハンドシェイクの一部が失敗し、またはゲートウェイが使用できない場合に、ボットが自動で再接続を試みるべきか。cls (Type[
VoiceProtocol
]) --VoiceProtocol
をサブクラスする型。既定値はVoiceClient
。self_mute (
bool
) --クライアントをセルフミュートすべきか。
バージョン 2.0 で追加.
self_deaf (
bool
) --クライアントをセルフスピーカーミュートすべきか。
バージョン 2.0 で追加.
- 例外
asyncio.TimeoutError -- 時間内にボイスチャンネルに接続できなかった場合。
ClientException -- すでにボイスチャンネルに接続している場合。
OpusNotLoaded -- opusライブラリが読み込まれていない場合。
- 戻り値
ボイスサーバーに完全に接続されたボイスクライアント。
- 戻り値の型
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- await create_webhook(*, name, avatar=None, reason=None)¶
This function is a coroutine.
チャンネルに新しいWebhookを作ります。
これを行うには、
manage_webhooks
が必要です。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- Webhookの名前。avatar (Optional[
bytes
]) -- Webhookのデフォルトアバターを表す bytes-like object 。edit()
と同様に動作します。reason (Optional[
str
]) -- Webhookを作成する理由。監査ログに表示されます。
- 例外
HTTPException -- Webhookの作成に失敗した場合。
Forbidden -- Webhookを作成する権限を持っていない場合。
- 戻り値
作成されたwebhook。
- 戻り値の型
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await delete_messages(messages, *, reason=None)¶
This function is a coroutine.
メッセージのリストを削除します。複数のメッセージを一括削除する点を除き、これは
Message.delete()
に似ています。スペシャルケースとして、もしメッセージ数が0の場合は何もせず、メッセージ数が1の場合は単独のメッセージ削除が行われます。これが2以上の場合一括削除が行われます。
14日以上前のメッセージや100件以上のメッセージを一括削除することはできません。
これを行うには、
manage_messages
が必要です。バージョン 2.0 で追加.
- パラメータ
messages (Iterable[
abc.Snowflake
]) -- 一括削除するものを示すメッセージのiterableオブジェクト。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
ClientException -- 削除するメッセージの数が100以上の場合。
Forbidden -- メッセージを一括削除するための適切な権限がない場合。
NotFound -- 1メッセージのみ削除する時、メッセージが既に削除されていた場合。
HTTPException -- メッセージの削除に失敗した場合。
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
バージョン 2.0 で追加.
- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- property last_message¶
キャッシュからこのチャンネルに最後に送信されたメッセージを取得します。
このメッセージは有効でなかったり、存在するものでない場合があります。
バージョン 2.0 で追加.
信頼性の高い取得方法
より信頼性のある最後のメッセージの取得方法として、
history()
やlast_message_id
とfetch_message()
の組み合わせがあります。- 戻り値
このチャンネルの最後のメッセージ。見つからない場合は
None
です。- 戻り値の型
Optional[
Message
]
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await purge(*, limit=100, check=..., before=None, after=None, around=None, oldest_first=None, bulk=True, reason=None)¶
This function is a coroutine.
check
関数の要件を満たすメッセージを一括削除します。check
が渡されない場合はすべてのメッセージが削除されます。メッセージを削除するときに、それが自分のものであったとしても、削除するには
manage_messages
が必要です。メッセージの履歴を取得するためにread_message_history
も必要になります。バージョン 2.0 で追加.
サンプル
Botによるメッセージを削除する
def is_me(m): return m.author == client.user deleted = await channel.purge(limit=100, check=is_me) await channel.send(f'Deleted {len(deleted)} message(s)')
- パラメータ
limit (Optional[
int
]) -- 検索するメッセージ数。これは削除するメッセージ数になるとは必ずしも限りません。check (Callable[[
Message
],bool
]) -- メッセージが削除されるかどうかを確認するために使用される関数。Message
を唯一のパラメータとして受け取る必要があります。before (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのbefore
と同じです。after (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのafter
と同じです。around (Optional[Union[
abc.Snowflake
,datetime.datetime
]]) --history()
でのaround
と同じです。oldest_first (Optional[
bool
]) --history()
でのoldest_first
と同じです。bulk (
bool
) --True
の場合、一括削除を使用します。これをFalse
に設定すると、Permissions.manage_messages
なしでボット自身のメッセージを一括削除することができます。True
の場合でも、2週間以上前のメッセージは個別に削除されます。reason (Optional[
str
]) -- メッセージを一括削除する理由。監査ログに表示されます。
- 例外
Forbidden -- 必要なアクションをするための適切な権限がない場合。
HTTPException -- メッセージの一括削除に失敗した場合。
- 戻り値
削除されたメッセージのlist。
- 戻り値の型
List[
Message
]
- property scheduled_events¶
このチャンネルのすべてのスケジュールイベントを返します。
バージョン 2.0 で追加.
- 型
List[
ScheduledEvent
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
- typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property voice_states¶
このチャンネル内にボイス状態のあるメンバーIDのマッピングを返します。
バージョン 1.3 で追加.
注釈
これは、メンバーキャッシュが存在しない場合に
members
を置き換えるため意図的に低レベルとなっています。- 戻り値
メンバーIDをキーとしボイス状態を値とするマッピング。
- 戻り値の型
Mapping[
int
,VoiceState
]
- await webhooks()¶
This function is a coroutine.
チャンネル内のWebhookのリストを取得します。
これを行うには、
manage_webhooks
が必要です。バージョン 2.0 で追加.
StageInstance¶
- class discord.StageInstance¶
ギルド内のステージチャンネルのステージインスタンスを表します。
バージョン 2.0 で追加.
- x == y
二つのステージインスタンスが等しいかを比較します。
- x != y
二つのステージインスタンスが等しくないかを比較します。
- hash(x)
ステージインスタンスのハッシュ値を返します。
- privacy_level¶
ステージインスタンスのプライバシーレベル。
- channel¶
ステージインスタンスを開催しているチャンネル。
- 型
Optional[
StageChannel
]
- scheduled_event¶
ステージインスタンスに属するスケジュールイベント。
- 型
Optional[
ScheduledEvent
]
- await edit(*, topic=..., privacy_level=..., reason=None)¶
This function is a coroutine.
ステージインスタンスを編集します。
これを行うには、
manage_channels
が必要です。- パラメータ
topic (
str
) -- ステージインスタンスの新しいトピック。privacy_level (
PrivacyLevel
) -- ステージインスタンスの新しいプライバシーレベル。reason (
str
) -- ステージインスタンスを編集する理由。監査ログに表示されます。
- 例外
TypeError -- 引数
privacy_level
が適切な型でない場合。Forbidden -- ステージインスタンスを編集する権限がない場合。
HTTPException -- ステージインスタンスの編集に失敗した場合。
- await delete(*, reason=None)¶
This function is a coroutine.
ステージインスタンスを削除します。
これを行うには、
manage_channels
が必要です。- パラメータ
reason (
str
) -- ステージインスタンスを削除する理由。監査ログに表示されます。- 例外
Forbidden -- ステージインスタンスを削除する権限がない場合。
HTTPException -- ステージインスタンスの削除に失敗した場合。
CategoryChannel¶
- asyncclone
- asynccreate_forum
- asynccreate_invite
- asynccreate_stage_channel
- asynccreate_text_channel
- asynccreate_voice_channel
- asyncdelete
- asyncedit
- asyncinvites
- defis_nsfw
- asyncmove
- defoverwrites_for
- defpermissions_for
- asyncset_permissions
- class discord.CategoryChannel¶
Discordのチャンネルカテゴリを表します。
チャンネルを論理的な区画にグループ化するのに便利な機能です。
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
カテゴリのハッシュを返します。
- str(x)
カテゴリの名前を返します。
- property type¶
チャンネルのDiscordタイプ。
- await clone(*, name=None, reason=None)¶
This function is a coroutine.
チャンネルをクローンします。これはそのチャンネルと同じ属性を持つチャンネルを作成します。
これを行うには
manage_channels
が必要です。バージョン 1.1 で追加.
- パラメータ
- 例外
Forbidden -- チャンネルを作成するのに必要な権限がない場合。
HTTPException -- チャンネルの作成に失敗した場合。
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await edit(*, reason=None, **options)¶
This function is a coroutine.
チャンネルを編集します。
これを行うには、
manage_channels
が必要です。バージョン 1.3 で変更:
overwrites
キーワード引数が追加されました。バージョン 2.0 で変更: 編集はチャンネルを置き換えず、編集された新しいチャンネルが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
name (
str
) -- 新しいカテゴリの名前。position (
int
) -- 新しいカテゴリの位置。nsfw (
bool
) -- カテゴリに年齢制限をかけるかどうか。reason (Optional[
str
]) -- カテゴリを編集する理由。監査ログに表示されます。overwrites (
Mapping
) -- ターゲット(ロール又はメンバー)をキーとし適用されるPermissionOverwrite
を値とするMapping
。
- 例外
ValueError -- 位置が0より小さいか、カテゴリの数値より大きい場合。
TypeError -- 上書き情報が適切なものでない場合。
Forbidden -- カテゴリを編集するのに必要な権限がない場合。
HTTPException -- カテゴリの編集に失敗した場合。
- 戻り値
新しく編集されたカテゴリチャンネル。編集が位置のみだった場合は代わりに
None
が返されます。- 戻り値の型
Optional[
CategoryChannel
]
- await move(**kwargs)¶
This function is a coroutine.
チャンネルを他のチャンネルと相対的に移動させるのに役立つインターフェイスです。
正確に位置を移動させる場合は、代わりに
edit
を使用する必要があります。これを行うには
manage_channels
が必要です。注釈
ボイスチャンネルは常にテキストチャンネルの下にソートされます。これはDiscordの制限です。
バージョン 1.7 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
beginning (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の先頭に移動させるかどうかを指定します。これは、end
,before
,after
とは互いに排他的です。end (
bool
) -- チャンネルをチャンネルリスト (または指定された場合はカテゴリ) の末尾に移動するかどうかを指定します。これはbeginning
,before
,after
とは互いに排他的です。before (
Snowflake
) -- このチャンネルの前にあるべきチャンネル。これとbeginning
、end
、after
は同時に使用できません。after (
Snowflake
) -- このチャンネルの後にあるべきチャンネル。これとbeginning
、end
、before
は同時に使用できません。offset (
int
) -- 移動のオフセット。たとえば、beginning=True
の場合にてオフセットが2
ならば、チャンネルは始めから2つ分の場所に動きます。正の整数を渡すと下に、負の整数を渡すと上に動きます。この数は相対的でbeginning
、end
、before
、after
パラメータの後に計算されます。category (Optional[
Snowflake
]) -- チャンネルの移動先のカテゴリ。None
を渡した場合はチャンネルはカテゴリに属さなくなります。このパラメータはカテゴリチャンネルの場合は無視されます。sync_permissions (
bool
) -- (カテゴリが指定されている場合に)権限を同期すべきか。reason (
str
) -- 移動の理由。
- 例外
ValueError -- 位置が無効な場合。
TypeError -- 同時に指定できない引数らが同時に指定された場合。
Forbidden -- チャンネルを移動する権限がない場合。
HTTPException -- チャンネルの移動に失敗した場合。
- property channels¶
このカテゴリに属するチャンネルを返します。
これらは公式のDiscord UIによってソートされており、ボイスチャンネルはテキストチャンネルの下に配置されます。
- 型
List[
abc.GuildChannel
]
- property text_channels¶
このカテゴリに属するテキストチャンネルを返します。
- 型
List[
TextChannel
]
- property voice_channels¶
このカテゴリに属するボイスチャンネルを返します。
- 型
List[
VoiceChannel
]
- property stage_channels¶
このカテゴリに属するステージチャンネルを返します。
バージョン 1.7 で追加.
- 型
List[
StageChannel
]
- property forums¶
Returns the forum channels that are under this category.
バージョン 2.4 で追加.
- 型
List[
ForumChannel
]
- await create_text_channel(name, **options)¶
This function is a coroutine.
カテゴリ内に
TextChannel
を作成するためのGuild.create_text_channel()
のショートカット。- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_voice_channel(name, **options)¶
This function is a coroutine.
カテゴリ内に
VoiceChannel
を作成するためのGuild.create_voice_channel()
のショートカット。- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_stage_channel(name, **options)¶
This function is a coroutine.
カテゴリ内に
StageChannel
を作成するためのGuild.create_stage_channel()
のショートカット。バージョン 1.7 で追加.
- 戻り値
作成されたチャンネル。
- 戻り値の型
- await create_forum(name, **options)¶
This function is a coroutine.
カテゴリ内に
ForumChannel
を作成するためのGuild.create_forum()
のショートカット。バージョン 2.0 で追加.
- 戻り値
作成されたチャンネル。
- 戻り値の型
- property category¶
チャンネルが属するカテゴリ。
カテゴリがない場合は
None
になります。- 型
Optional[
CategoryChannel
]
- await create_invite(*, reason=None, max_age=0, max_uses=0, temporary=False, unique=True, target_type=None, target_user=None, target_application_id=None)¶
This function is a coroutine.
テキストやボイスチャンネルから招待を作成します。
これを行うには、
create_instant_invite
が必要です。- パラメータ
max_age (
int
) -- 招待の有効期限の秒単位の長さ。0の場合、招待は期限切れにはなりません。これはデフォルトでは0
になります。max_uses (
int
) -- 招待の使用回数の制限。もしこれが0なら、招待を無制限に使用することができます。デフォルトではこれは0
になります。temporary (
bool
) -- 一時的なメンバーとして招待するかを示しています。(つまり、招待されたメンバーは、特定のロールを付与されない限り、Discordを切断するときキックされます。)デフォルトはFalse
です。unique (
bool
) -- 新しい招待URLを作成すべきか示します。既定ではTrueです。これがFalse
に指定された場合は、前に作成された招待を返します。reason (Optional[
str
]) -- 招待を作成する理由。監査ログに表示されます。target_type (Optional[
InviteTarget
]) --ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
target_user (Optional[
User
]) --この招待に表示すべきストリームのユーザー。
target_type
がInviteTarget.stream
の場合必須です。このユーザーはチャンネル内でストリームしていないといけません。バージョン 2.0 で追加.
target_application_id: --
Optional[
int
]: 招待に紐づいた埋め込みアプリケーションのID。target_type
がInviteTarget.embedded_application
の場合必須です。バージョン 2.0 で追加.
- 例外
HTTPException -- 招待の作成に失敗した場合。
NotFound -- カテゴリや不正なチャンネルが渡された場合。
- 戻り値
作成された招待。
- 戻り値の型
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- await delete(*, reason=None)¶
This function is a coroutine.
チャンネルを削除します。
これを行うには
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- チャンネルを削除する理由。監査ログに表示されます。- 例外
Forbidden -- チャンネルを削除するのに必要な権限がない場合。
NotFound -- チャンネルが見つからないか、すでに削除されていた場合。
HTTPException -- チャンネルの削除に失敗した場合。
- await invites()¶
This function is a coroutine.
このチャンネルから作成された全てのアクティブなインスタント招待のリストを返します。
この情報を取得するためには、
manage_channels
権限を持っている必要があります。- 例外
Forbidden -- 適切な権限を有していない場合。
HTTPException -- 情報取得中にエラーが発生した場合。
- 戻り値
現時点でアクティブな招待のリスト。
- 戻り値の型
List[
Invite
]
- property overwrites¶
チャンネルの上書きをすべて返します。
これは、
Role
かMember
のターゲットをキーとし、PermissionOverwrite
を値とする辞書型として返されます。バージョン 2.0 で変更: キャッシュ取得に失敗した場合、上書きが型付きの
Object
になるようになりました。- 戻り値
チャンネルの権限の上書き。
- 戻り値の型
Dict[Union[
Role
,Member
,Object
],PermissionOverwrite
]
- overwrites_for(obj)¶
メンバーまたはロール固有の上書きされたリストを返します
- パラメータ
- 戻り値
そのオブジェクトの権限の上書き。
- 戻り値の型
- permissions_for(obj, /)¶
-
これは以下を考慮します:
サーバーの所有者
サーバーにあるロール
チャンネルの上書き
メンバーの上書き
自動で処理される権限
メンバーのタイムアウト
Role
が渡された場合、そのロールを持つ人が持つべき権限を確認します。つまり:デフォルトのロールの権限
パラメータとして使用されるロールの権限
デフォルトのロールの権限の上書き
パラメータとして使用されるロールの権限の上書き
バージョン 2.0 で変更: ロールを渡すことができるようになりました。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。
- property permissions_synced¶
チャンネルの権限が属するカテゴリと同期されているかどうか。
カテゴリがない場合は
False
になります。バージョン 1.3 で追加.
- 型
- await set_permissions(target, *, overwrite=see - below, reason=None, **permissions)¶
This function is a coroutine.
ある対象に対して特定のチャンネルでの権限の上書きを設定します。
target
パラメータは当該ギルドに属するMember
かRole
であるべきです。overwrite
パラメータを渡す場合は、それはNone
か、PermissionOverwrite
でないといけません。利便性のため、Permissions
の属性を示すキーワード引数を渡すこともできます。これとoverwrite
パラメータは同時に使用できません。overwrite
パラメータがNone
の場合は権限の上書きは削除されます。これを行うには
manage_roles
が必要です。注釈
これは、以前の上書きを与えられたもので 置き換えます 。
サンプル
許可と拒否の設定:
await message.channel.set_permissions(message.author, read_messages=True, send_messages=False)
上書きの削除
await channel.set_permissions(member, overwrite=None)
PermissionOverwrite
を使用しますoverwrite = discord.PermissionOverwrite() overwrite.send_messages = False overwrite.read_messages = True await channel.set_permissions(member, overwrite=overwrite)
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
overwrite (Optional[
PermissionOverwrite
]) -- 対象に対して許可し、または拒否する権限。None
を渡すと上書きを削除できます。**permissions -- 設定すべき権限のキーワード引数リスト。これは
overwrite
と同時に使用できません。reason (Optional[
str
]) -- アクションを実行する理由。監査ログに表示されます。
- 例外
Forbidden -- チャンネルの権限を編集するための権限がない場合。
HTTPException -- チャンネルの権限を編集するのに失敗した場合。
NotFound -- 編集中のロールやメンバーがギルドに属さない場合。
ValueError --
overwrite
パラメータとpositions
パラメータの両方とも指定されていなかった場合。
DMChannel¶
- asyncfetch_message
- defget_partial_message
- async forhistory
- defpermissions_for
- asyncpins
- asyncsend
- deftyping
- class discord.DMChannel¶
Discordのダイレクトメッセージチャンネルを表します。
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
チャンネルのハッシュ値を返します。
- str(x)
このチャンネルの文字列表現を返します。
- recipient¶
ダイレクトメッセージチャンネルに参加しているユーザー。 このチャンネルがゲートウェイ経由で受信された場合は、この情報が利用可能ではない場合があります。
- 型
Optional[
User
]
- me¶
あなた自身を示すユーザー。
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property type¶
チャンネルのDiscordタイプ。
- property guild¶
DMチャンネルが属するギルド。常に
None
。これは主にダックタイピング時の互換性の目的で提供されます。
バージョン 2.0 で追加.
- 型
Optional[
Guild
]
- property created_at¶
ダイレクトメッセージチャンネルの作成された時間をUTCで返します。
- permissions_for(obj=None, /)¶
User
の権限を解決します。この機能は他のチャンネルタイプとの互換性のためにあります。
実際のダイレクトメッセージには権限の概念は存在しません。
これは以下を除いてテキスト関連の権限を
True
にしたものです:send_tts_messages
:DMにTTSメッセージは送ることはできません。manage_messages
:DM内の他のメッセージは削除できません。create_private_threads
: DMにはスレッドが存在しません。create_public_threads
: DMにはスレッドが存在しません。manage_threads
: DMにはスレッドが存在しません。send_messages_in_threads
: DMにはスレッドが存在しません。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。バージョン 2.1 で変更: スレッド関連の権限が
False
に設定されるようになりました。- パラメータ
obj (
User
) -- 権限を確認するユーザー。このパラメータは他のpermissions_for
メソッドとの互換性のためにあり、無視されます。- 戻り値
解決された権限。
- 戻り値の型
- get_partial_message(message_id, /)¶
メッセージIDから
PartialMessage
を作成します。これは、IDしかない場合に不必要なAPI呼び出しなくメッセージに関する作業をする時に便利です。
バージョン 1.6 で追加.
バージョン 2.0 で変更: 引数
message_id
は位置専用引数となりました。- パラメータ
message_id (
int
) -- 部分的なメッセージのID。- 戻り値
部分的なメッセージ。
- 戻り値の型
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
GroupChannel¶
- asyncfetch_message
- async forhistory
- asyncleave
- defpermissions_for
- asyncpins
- asyncsend
- deftyping
- class discord.GroupChannel¶
Discordのグループチャンネルを表します。
- x == y
二つのチャンネルが等しいかを比較します。
- x != y
二つのチャンネルが等しいものではないか比較します。
- hash(x)
チャンネルのハッシュ値を返します。
- str(x)
このチャンネルの文字列表現を返します。
- me¶
あなた自身を示すユーザー。
- async with typing()¶
入力インジケーターを宛先に無期限で、または
await
で呼び出された場合10秒間表示できるようにする非同期コンテキストマネージャーを返します。使用例:
async with channel.typing(): # simulate something heavy await asyncio.sleep(20) await channel.send('Done!')
使用例:
await channel.typing() # Do some computational magic for about 10 seconds await channel.send('Done!')
バージョン 2.0 で変更: これは
with
構文で動作せず、代わりにasync with
を使用しないといけないように変更されました。バージョン 2.0 で変更: コンテキストマネージャーを
await
して入力インジケーターを10秒間送信する機能を追加しました。
- property type¶
チャンネルのDiscordタイプ。
- property guild¶
グループチャンネルが属するギルド。常に
None
。これは主にダックタイピング時の互換性の目的で提供されます。
バージョン 2.0 で追加.
- 型
Optional[
Guild
]
- property created_at¶
チャンネルの作成された時間をUTCで返します。
- permissions_for(obj, /)¶
User
の権限を解決します。この機能は他のチャンネルタイプとの互換性のためにあります。
実際のダイレクトメッセージには権限の概念は存在しません。
これは以下を除いてテキスト関連の権限を
True
にしたものです:send_tts_messages
:DMにTTSメッセージは送ることはできません。manage_messages
:DM内の他のメッセージは削除できません。create_private_threads
: DMにはスレッドが存在しません。create_public_threads
: DMにはスレッドが存在しません。manage_threads
: DMにはスレッドが存在しません。send_messages_in_threads
: DMにはスレッドが存在しません。
ユーザーが所有者の場合、kick_members 権限もチェックします。
バージョン 2.0 で変更:
obj
引数は位置限定引数になりました。バージョン 2.1 で変更: スレッド関連の権限が
False
に設定されるようになりました。- パラメータ
obj (
Snowflake
) -- 権限を確認したいユーザー。- 戻り値
ユーザーの解決された権限。
- 戻り値の型
- await fetch_message(id, /)¶
This function is a coroutine.
宛先から、単一の
Message
を取得します。- パラメータ
id (
int
) -- 探すメッセージのID。- 例外
NotFound -- 指定されたメッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
要求されたメッセージ。
- 戻り値の型
- async for ... in history(*, limit=100, before=None, after=None, around=None, oldest_first=None)¶
チャンネルのメッセージ履歴を取得する asynchronous iterator を返します。
これを行うためには、
read_message_history
が必要です。サンプル
使い方
counter = 0 async for message in channel.history(limit=200): if message.author == client.user: counter += 1
リストにフラット化:
messages = [message async for message in channel.history(limit=123)] # messages is now a list of Message...
すべてのパラメータがオプションです。
- パラメータ
limit (Optional[
int
]) -- 取得するメッセージの数。None
の場合、チャンネル内のメッセージすべてを取得します。ただし、これには時間がかかります。before (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより前のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。after (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージより後のメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。around (Optional[Union[
Snowflake
,datetime.datetime
]]) -- 渡された日付、またはメッセージあたりのメッセージを取得します。日付を指定する場合、UTC aware datetimeを利用することを推奨します。naive datetimeである場合、これはローカル時間であるとみなされます。この引数を使用するときは、取得できる最大のメッセージ数は101個です。もし制限が偶数の場合は最大でそれに1を加えた分だけ返します。oldest_first (Optional[
bool
]) --True
の場合、古いものから新しいものの順でメッセージを返します。既定値はafter
が指定された場合にはTrue
で、それ以外の場合はFalse
です。
- 例外
Forbidden -- メッセージ履歴を読む権限が無い場合。
HTTPException -- メッセージ履歴の取得に失敗した場合。
- 列挙
Message
-- メッセージデータをパースしたメッセージ。
- await leave()¶
This function is a coroutine.
グループから脱退します。
あなたがグループにいる唯一の者である場合、グループが削除されます。
- 例外
HTTPException -- グループの脱退に失敗した場合。
- await pins()¶
This function is a coroutine.
現時点でチャンネルにピン留めされている全てのメッセージを取得します。
注釈
Discord APIの制限により、このメソッドの返した
Message
オブジェクトには、完全なMessage.reactions
のデータが含まれていません。- 例外
Forbidden -- ピン留めされたメッセージの取得に必要な権限がない場合。
HTTPException -- ピン留めされたメッセージの取得に失敗した場合。
- 戻り値
現時点でピン留めされているメッセージ。
- 戻り値の型
List[
Message
]
- await send(content=None, *, tts=False, embed=None, embeds=None, file=None, files=None, stickers=None, delete_after=None, nonce=None, allowed_mentions=None, reference=None, mention_author=None, view=None, suppress_embeds=False, silent=False)¶
This function is a coroutine.
指定された内容のメッセージを宛先に送信します。
contentは、
str(content)
によって文字列に変換が可能である必要があります。もしcontentにNone
(デフォルト) を指定するなら、embed
パラメータを設定する必要があります。単一のファイルをアップロードするには、
file
パラメータにFile
オブジェクトを指定する必要があります。複数のファイルをアップロードするには、files
パラメータにFile
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。単一の埋め込みを送信するには、
embed
パラメータにEmbed
オブジェクトを指定する必要があります。複数の埋め込みを送信するには、embeds
パラメータにEmbed
オブジェクトのlist
を指定する必要があります。なお、 両方のパラメータを指定した場合には例外が発生します 。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- パラメータ
content (Optional[
str
]) -- 送信するメッセージの内容。tts (
bool
) -- メッセージが音声合成で送信されるべきかどうかを示します。embed (
Embed
) -- 内容に埋め込む、typeがrich
な埋め込み。embeds (List[
Embed
]) --送信する埋め込みのリスト。最大10個まで送信できます。
バージョン 2.0 で追加.
file (
File
) -- アップロードするファイル。files (List[
File
]) -- アップロードするファイルのリスト。ファイル数は最大で10個まででなくてはいけません。nonce (
int
) -- メッセージの送信時に使用するナンス値。メッセージが正常に送信された場合、このメッセージには指定されたナンス値が含まれます。delete_after (
float
) -- 指定したなら、これはメッセージを送信したあと待機し、すぐ削除する秒数となります。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (
AllowedMentions
) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
reference (Union[
Message
,MessageReference
,PartialMessage
]) --返信する
Message
への参照。これは、to_reference()
を使用して作成することができ、またMessage
を直接渡すこともできます。これが返信元のメッセージの投稿者をメンションすべきかは、allowed_mentions
のreplied_user
属性や、mention_author
パラメータで制御できます。バージョン 1.6 で追加.
mention_author (Optional[
bool
]) --設定された場合、
allowed_mentions
のreplied_user
属性を上書きします。バージョン 1.6 で追加.
view (
discord.ui.View
) --メッセージに追加するDiscord UI ビュー。
バージョン 2.0 で追加.
stickers (Sequence[Union[
GuildSticker
,StickerItem
]]) --送信するスタンプのリスト。最大3個まで送信できます。
バージョン 2.0 で追加.
suppress_embeds (
bool
) --メッセージの埋め込みを抑制するかどうか。これが
True
に設定されている場合、埋め込みなしでメッセージを送信します。バージョン 2.0 で追加.
silent (
bool
) --メッセージのプッシュ通知とデスクトップ通知を抑制するかどうか。 抑制した場合、UIのメンションカウンターを増やしますが、実際に通知を送信することはありません。
バージョン 2.2 で追加.
- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
またはembeds
リストの大きさが適切でない場合。TypeError --
file
とfiles
の両方が指定された場合、embed
とembeds
の両方が指定された場合、またはreference
がMessage
、MessageReference
、PartialMessage
でない場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
PartialInviteGuild¶
- class discord.PartialInviteGuild¶
「部分的な」招待ギルドを表します。
このモデルは、ユーザーが
Invite
にて解決されたギルドに属さない場合に与えられます。- x == y
2つの部分的なギルドが等しいものか比較します。
- x != y
2つの部分的なギルドが等しいものではないか比較します。
- hash(x)
部分的なギルドのハッシュ値を返します。
- str(x)
部分的なギルドの名前を返します。
- verification_level¶
部分的なギルドの認証レベル。
- features¶
ギルドが持っている機能のリスト。詳細は
Guild.features
を参照してください。- 型
List[
str
]
部分的なギルドの現在の「ブースト」数。
バージョン 2.0 で追加.
- 型
- property created_at¶
ギルドの作成時刻をUTCで返します。
PartialInviteChannel¶
Invite¶
- asyncdelete
- defset_scheduled_event
- class discord.Invite¶
Discord の
Guild
またはabc.GuildChannel
への招待を表します。このオブジェクトの作成方法によって、属性の一部が
None
の値になることがあります。- x == y
二つの招待が等しいかを比較します。
- x != y
二つの招待が等しくないかを比較します。
- hash(x)
招待のハッシュ値を返します。
- str(x)
招待URLを返します。
次の表は、属性を取得できるメソッドを示しています。
Attribute
Method
Client.fetch_invite()
でwith_counts
を有効にする。Client.fetch_invite()
でwith_counts
を有効にする。Client.fetch_invite()
でwith_expiration
を有効にする。上の表にない場合は、すべての方法で利用可能です。
- guild¶
招待先のギルド。グループのダイレクトメッセージからの場合は
None
にできます。- 型
Optional[Union[
Guild
,Object
,PartialInviteGuild
]]
- created_at¶
招待が作成された時刻を示す UTC datetimeオブジェクトです。
- 型
Optional[
datetime.datetime
]
- approximate_presence_count¶
ギルドで現在アクティブなメンバーのおおよその数です。これには退席中、取り込み中、オンライン、非表示のメンバーが含まれます。オフラインのメンバーは除外されます。
- 型
Optional[
int
]
- expires_at¶
招待の有効期限。
with_expiration
が有効になっているClient.fetch_invite()
経由で受け取ったときにこれがNone
の場合は、招待は期限切れになりません。バージョン 2.0 で追加.
- 型
Optional[
datetime.datetime
]
- channel¶
招待先のチャンネル。
- 型
Optional[Union[
abc.GuildChannel
,Object
,PartialInviteChannel
]]
- target_type¶
ボイスチャンネル招待の対象の種類。
バージョン 2.0 で追加.
- target_application¶
存在する場合、この招待の対象の埋め込みアプリケーション。
バージョン 2.0 で追加.
- 型
Optional[
PartialAppInfo
]
- scheduled_event¶
存在する場合、この招待に関連付けられたスケジュールイベント。
バージョン 2.0 で追加.
- 型
Optional[
ScheduledEvent
]
- set_scheduled_event(scheduled_event, /)¶
この招待のスケジュールイベントを設定します。
バージョン 2.0 で追加.
- await delete(*, reason=None)¶
This function is a coroutine.
インスタント招待を取り消します。
これを行うには、
manage_channels
が必要です。- パラメータ
reason (Optional[
str
]) -- 招待を削除する理由。監査ログに表示されます。- 例外
Forbidden -- 削除する権限がない場合。
NotFound -- 招待が無効または期限切れの場合。
HTTPException -- 招待の取り消しに失敗した場合。
Template¶
- asynccreate_guild
- asyncdelete
- asyncedit
- asyncsync
- class discord.Template¶
Discordのテンプレートを表します。
バージョン 1.4 で追加.
- created_at¶
テンプレートが作成された日時を表す UTC aware datetime。
- updated_at¶
テンプレートが最後に更新された日時を表す UTC aware datetime。これは公式のDiscordクライアントでは「最終同期日時」と呼ばれています。
- await create_guild(name, icon=...)¶
This function is a coroutine.
テンプレートを使用して
Guild
を作成します。10以上のギルドに参加しているBotアカウントはギルドの作成ができません。
バージョン 2.0 で変更:
region
キーワード引数が削除されました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにValueError
を送出します。- パラメータ
name (
str
) -- ギルドの名前。icon (
bytes
) -- アイコンを表す bytes-like object です。ClientUser.edit()
で、予期されるデータの詳細を確認してください。
- 例外
HTTPException -- ギルドの作成に失敗した場合。
ValueError -- Guildのアイコンの画像形式が無効だった時。画像は、PNGまたはJPGである必要があります。
- 戻り値
作成されたギルド。キャッシュに追加されるギルドとは別物です。
- 戻り値の型
- await sync()¶
This function is a coroutine.
テンプレートをギルドの現在の状態に同期します。
これを行うためには、元のギルドにて
manage_guild
が必要です。バージョン 1.7 で追加.
バージョン 2.0 で変更: 編集はテンプレートを置き換えず、編集された新しいテンプレートが返されるようになりました。
- 例外
HTTPException -- テンプレートの編集に失敗した場合。
Forbidden -- テンプレートを編集するのに必要な権限がない場合。
NotFound -- テンプレートが存在しない場合。
- 戻り値
編集された新しいテンプレート。
- 戻り値の型
- await edit(*, name=..., description=...)¶
This function is a coroutine.
テンプレートのメタデータを編集します。
これを行うためには、元のギルドにて
manage_guild
が必要です。バージョン 1.7 で追加.
バージョン 2.0 で変更: 編集はテンプレートを置き換えず、編集された新しいテンプレートが返されるようになりました。
- await delete()¶
This function is a coroutine.
テンプレートを削除します。
これを行うためには、元のギルドにて
manage_guild
が必要です。バージョン 1.7 で追加.
- 例外
HTTPException -- テンプレートの編集に失敗した場合。
Forbidden -- テンプレートを編集するのに必要な権限がない場合。
NotFound -- テンプレートが存在しない場合。
WelcomeScreen¶
- asyncedit
- class discord.WelcomeScreen¶
Guild
ようこそ画面を表します。バージョン 2.0 で追加.
- welcome_channels¶
ようこそ画面に表示されるチャンネル。
- 型
List[
WelcomeChannel
]
- property enabled¶
ようこそ画面を表示すべきか。
これは
Guild.features
にWELCOME_SCREEN_ENABLED
があるかどうかを確認するのと同じです。- 型
- await edit(*, description=..., welcome_channels=..., enabled=..., reason=None)¶
This function is a coroutine.
ようこそ画面を編集します。
ようこそ画面のチャンネルは、
Guild.premium_tier
がレベル 2 以上の場合のみカスタム絵文字を使用できます。これを行うためには、ギルドにて
manage_guild
が必要です。使い方:
rules_channel = guild.get_channel(12345678) announcements_channel = guild.get_channel(87654321) custom_emoji = utils.get(guild.emojis, name='loudspeaker') await welcome_screen.edit( description='This is a very cool community server!', welcome_channels=[ WelcomeChannel(channel=rules_channel, description='Read the rules!', emoji='👨🏫'), WelcomeChannel(channel=announcements_channel, description='Watch out for announcements!', emoji=custom_emoji), ] )
- パラメータ
description (Optional[
str
]) -- ようこそ画面の説明。welcome_channels (Optional[List[
WelcomeChannel
]]) -- ようこそ画面のチャンネルを、順番に並べたもの。enabled (Optional[
bool
]) -- ようこそ画面を表示すべきか。reason (Optional[
str
]) -- ようこそ画面を編集する理由。監査ログに表示されます。
- 例外
HTTPException -- ようこそ画面の編集に失敗した場合。
Forbidden -- ようこそ画面を編集するのに必要な権限がない場合。
NotFound -- ようこそ画面が存在しない場合。
WelcomeChannel¶
- class discord.WelcomeChannel¶
WelcomeScreen
のチャンネルを表します。バージョン 2.0 で追加.
- channel¶
参照されているギルドチャンネル。
- emoji¶
チャンネルの説明の横に使用される絵文字。
- 型
Optional[
PartialEmoji
,Emoji
,str
]
WidgetChannel¶
WidgetMember¶
- defmentioned_in
- class discord.WidgetMember¶
ウィジェットのギルドの "部分的な" メンバーを表します。
- x == y
2つのウィジェットメンバーが等しいものか比較します。
- x != y
2つのウィジェットメンバーが等しいものではないか比較します。
- hash(x)
ウィジェットメンバーのハッシュ値を返します。
- str(x)
ウィジェットメンバーのハンドル(例えば
name
やname#discriminator
など)を返します。
- activity¶
メンバーのアクティビティ。
- 型
Optional[Union[
BaseActivity
,Spotify
]]
- connected_channel¶
メンバーが接続しているチャンネル。
- 型
Optional[
WidgetChannel
]
- property accent_color¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_colour
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property accent_colour¶
該当する場合、ユーザーのアクセントカラーを返します。
ユーザーのアクセントカラーはバナーがない場合にのみ表示されます。 これは、ユーザーが明示的に色を設定した場合にのみ利用可能です。
accent_color
という名前のエイリアスが存在します。バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Colour
]
- property avatar_decoration¶
Returns an
Asset
for the avatar decoration the user has.If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
Asset
]
- property avatar_decoration_sku_id¶
Returns the SKU ID of the avatar decoration the user has.
If the user has not set an avatar decoration,
None
is returned.バージョン 2.4 で追加.
- 型
Optional[
int
]
- property banner¶
利用できる場合、ユーザーのバナーのアセットを返します。
バージョン 2.0 で追加.
注釈
この情報は
Client.fetch_user()
経由でのみ入手できます。- 型
Optional[
Asset
]
- property color¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。colour
という名前のエイリアスが存在します。- 型
- property colour¶
レンダリングされる色を返すプロパティ。これは常に
Colour.default()
を返します。color
という名前のエイリアスが存在します。- 型
- property created_at¶
ユーザーの作成された時間をUTCで返します。
これはユーザーのDiscordアカウントが作成された時間です。
- property display_avatar¶
ユーザーの表示されるアバターを返します。
通常のユーザーの場合は、これはデフォルトのアバターか、アップロードされたアバターです。
バージョン 2.0 で追加.
- 型
- mentioned_in(message)¶
指定のメッセージにユーザーに対するメンションが含まれているかを確認します。
- property public_flags¶
ユーザーが持っている公開のフラグ。
Widget¶
- asyncfetch_invite
- class discord.Widget¶
Guild
ウィジェットを表します。- x == y
2つのウィジェットが等しいものか比較します。
- x != y
2つのウィジェットが等しいものではないか比較します。
- str(x)
ウィジェットの JSON URL を返します。
- channels¶
ギルド内のアクセスできるボイスチャンネル。
- 型
List[
WidgetChannel
]
- members¶
ギルド内のオンラインのメンバー。オフラインのメンバーはウィジェットには表示されません。
注釈
Discordの制限により、このデータが利用可能な場合、ユーザーのIDとタグは「仮名化」され、誤った情報になります。同様に、取得できるメンバー数にも制限があります。
- 型
List[
WidgetMember
]
- property created_at¶
メンバーの作成された時間をUTCで返します。
- await fetch_invite(*, with_counts=True)¶
This function is a coroutine.
ウィジェットの招待URLから
Invite
を取得します。これはClient.fetch_invite()
と同じです。招待コードは抽象化されます。- パラメータ
with_counts (
bool
) -- 招待にカウント情報を含めるかどうか。これによりInvite.approximate_member_count
とInvite.approximate_presence_count
に取得した値が代入されます。- 戻り値
利用可能な場合は、ウィジェットの招待URLからの招待。
- 戻り値の型
Optional[
Invite
]
StickerPack¶
- class discord.StickerPack¶
スタンプパックを表します。
バージョン 2.0 で追加.
- str(x)
スタンプパックの名前を返します。
- x == y
スタンプパックが他のスタンプパックと等しいか確認します。
- x != y
スタンプパックが他のスタンプパックと等しくないか確認します。
- stickers¶
このスタンプパックのスタンプ。
- 型
List[
StandardSticker
]
- cover_sticker¶
スタンプパックのカバーに使用されるスタンプ。
- 型
Optional[
StandardSticker
]
StickerItem¶
- class discord.StickerItem¶
スタンプアイテムを表します。
バージョン 2.0 で追加.
- str(x)
スタンプアイテムの名前を返します。
- x == y
スタンプアイテムが他のスタンプアイテムと等しいか確認します。
- x != y
スタンプアイテムが他のスタンプアイテムと等しくないことを確認します。
- format¶
スタンプの画像のフォーマット。
- await fetch()¶
This function is a coroutine.
スタンプアイテムの完全なスタンプデータを取得するのを試みます。
- 例外
HTTPException -- スタンプの取得に失敗した場合。
- 戻り値
取得したスタンプ。
- 戻り値の型
Union[
StandardSticker
,GuildSticker
]
Sticker¶
StandardSticker¶
- asyncpack
- class discord.StandardSticker¶
標準のスタンプパックに含まれるスタンプを表します。
バージョン 2.0 で追加.
- str(x)
スタンプの名前を返します。
- x == y
スタンプが他のスタンプと等しいか確認します。
- x != y
スタンプが他のスタンプと等しくないか確認します。
- format¶
スタンプの画像のフォーマット。
- await pack()¶
This function is a coroutine.
このスタンプが属するスタンプパックを取得します。
- 例外
InvalidData -- 対応するスタンプパックが見つからない場合。
HTTPException -- スタンプパックの取得に失敗した場合。
- 戻り値
取得したスタンプパック。
- 戻り値の型
GuildSticker¶
- class discord.GuildSticker¶
ギルドに属するスタンプを表します。
バージョン 2.0 で追加.
- str(x)
スタンプの名前を返します。
- x == y
スタンプが他のスタンプと等しいか確認します。
- x != y
スタンプが他のスタンプと等しくないか確認します。
- format¶
スタンプの画像のフォーマット。
- user¶
スタンプを作成したユーザー。これは
Guild.fetch_sticker()
経由で、かつmanage_emojis_and_stickers
を持つユーザーによってのみ取得できます。- 型
Optional[
User
]
- await edit(*, name=..., description=..., emoji=..., reason=None)¶
This function is a coroutine.
ギルドの
GuildSticker
を編集します。- パラメータ
- 例外
Forbidden -- スタンプを編集する権限がない場合。
HTTPException -- スタンプの編集中にエラーが発生した場合。
- 戻り値
新しく変更されたスタンプ。
- 戻り値の型
- await delete(*, reason=None)¶
This function is a coroutine.
ギルドのカスタム
Sticker
を削除します。これを行うには、
manage_emojis_and_stickers
が必要です。- パラメータ
reason (Optional[
str
]) -- スタンプを削除する理由。監査ログに表示されます。- 例外
Forbidden -- スタンプを削除する権限がない場合。
HTTPException -- スタンプの削除中にエラーが発生した場合。
SKU¶
Entitlement¶
- asyncdelete
- defis_expired
- class discord.Entitlement¶
Represents an entitlement from user or guild which has been granted access to a premium offering.
バージョン 2.4 で追加.
- type¶
The type of the entitlement.
- starts_at¶
A UTC start date which the entitlement is valid. Not present when using test entitlements.
- 型
Optional[
datetime.datetime
]
- ends_at¶
A UTC date which entitlement is no longer valid. Not present when using test entitlements.
- 型
Optional[
datetime.datetime
]
- property created_at¶
Returns the entitlement's creation time in UTC.
- is_expired()¶
bool
: ReturnsTrue
if the entitlement is expired. Will be always False for test entitlements.
- await delete()¶
This function is a coroutine.
Deletes the entitlement.
- 例外
MissingApplicationID -- The application ID could not be found.
NotFound -- The entitlement could not be found.
HTTPException -- Deleting the entitlement failed.
RawMessageDeleteEvent¶
RawBulkMessageDeleteEvent¶
RawMessageUpdateEvent¶
- class discord.RawMessageUpdateEvent¶
on_raw_message_edit()
イベントのペイロードを表します。- cached_message¶
内部メッセージキャッシュで見つかった場合、そのキャッシュされたメッセージ。
RawMessageUpdateEvent.data
のデータによって変更される前のメッセージを表します。- 型
Optional[
Message
]
RawReactionActionEvent¶
- class discord.RawReactionActionEvent¶
on_raw_reaction_add()
またはon_raw_reaction_remove()
イベントのペイロードを表します。- emoji¶
使用されたカスタムまたはユニコード絵文字。
- member¶
リアクションを追加したメンバー。
event_type
がREACTION_ADD
でリアクションがギルド内にある場合にのみ利用できます。バージョン 1.3 で追加.
- 型
Optional[
Member
]
- message_author_id¶
The author ID of the message being reacted to. Only available if
event_type
isREACTION_ADD
.バージョン 2.4 で追加.
- 型
Optional[
int
]
- event_type¶
このアクションの原因であるイベントタイプ。リアクションの追加は
REACTION_ADD
、リアクションの除去はREACTION_REMOVE
です。バージョン 1.3 で追加.
- 型
- burst¶
Whether the reaction was a burst reaction, also known as a "super reaction".
バージョン 2.4 で追加.
- 型
- burst_colours¶
A list of colours used for burst reaction animation. Only available if
burst
isTrue
and ifevent_type
isREACTION_ADD
.バージョン 2.0 で追加.
- 型
List[
Colour
]
- property burst_colors¶
An alias of
burst_colours
.バージョン 2.4 で追加.
RawReactionClearEvent¶
RawReactionClearEmojiEvent¶
- class discord.RawReactionClearEmojiEvent¶
on_raw_reaction_clear_emoji()
イベントのペイロードを表します。バージョン 1.3 で追加.
- emoji¶
除去されたカスタムまたはユニコード絵文字。
RawIntegrationDeleteEvent¶
RawThreadUpdateEvent¶
- class discord.RawThreadUpdateEvent¶
on_raw_thread_update()
イベントのペイロードを表します。バージョン 2.0 で追加.
- thread_type¶
更新されたスレッドのチャンネルタイプ。
- thread¶
スレッドが内部キャッシュで見つかった場合、そのスレッド。
- 型
Optional[
discord.Thread
]
RawThreadMembersUpdate¶
RawThreadDeleteEvent¶
- class discord.RawThreadDeleteEvent¶
on_raw_thread_delete()
イベントのペイロードを表します。バージョン 2.0 で追加.
- thread_type¶
削除されたスレッドのチャンネルタイプ。
- thread¶
スレッドが内部キャッシュで見つかった場合、そのスレッド。
- 型
Optional[
discord.Thread
]
RawTypingEvent¶
- class discord.RawTypingEvent¶
on_raw_typing()
イベントのペイロードを表します。バージョン 2.0 で追加.
- user¶
内部キャッシュで見つかった場合、入力し始めたユーザー。
- 型
Optional[Union[
discord.User
,discord.Member
]]
- timestamp¶
UTCのaware datetimeでの、タイピングの開始時刻。
RawMemberRemoveEvent¶
- class discord.RawMemberRemoveEvent¶
on_raw_member_remove()
イベントのペイロードを表します。バージョン 2.0 で追加.
- user¶
ギルドを脱退したユーザー。
- 型
Union[
discord.User
,discord.Member
]
RawAppCommandPermissionsUpdateEvent¶
- class discord.RawAppCommandPermissionsUpdateEvent¶
on_raw_app_command_permissions_update()
イベントのペイロードを表します。バージョン 2.0 で追加.
- target_id¶
権限が更新されたコマンドIDまたはアプリケーションID。これがコマンドIDではなくアプリケーションIDの場合、権限は明示的に上書きされていないすべてのコマンドに適用されます。
- 型
- permissions¶
アプリケーションコマンドの新しい権限のリスト。
- 型
List[
AppCommandPermissions
]
PartialWebhookGuild¶
PartialWebhookChannel¶
データクラス¶
一部のクラスはデータコンテナとして用いられます。ここではそのクラスを一覧表にしています。
models とは異なり、属性を持つものであっても、自分で作成することが許されています。
ほぼすべてのクラスに __slots__ が定義されています。つまり、データクラスに動的に変数を追加することは不可能です。
このルールの唯一の例外は Object
で、動的な属性を念頭に置いて作成されます。
Object¶
- class discord.Object(id, *, type=...)¶
一般的なDiscordオブジェクトを表します。
このクラスの目的は、IDだけを渡したい場合に、ミニチュアバージョンのデータクラスを作成できるようにすることです。 IDを持つ特定のデータクラスを受け取るほとんどの関数も、このクラスを代わりに受け取ることができます。 この場合であっても、(もしあるとすれば) すべてのオブジェクトがこのクラスから継承されるわけではないことに注意してください。
また、WebSocketイベントを 奇妙な順序 で受け取る場合があり、この場合には実際のデータクラスではなくこのクラスを受け取ります。これは非常にまれです。
- x == y
二つのオブジェクトが等しいか比較します。
- x != y
二つのオブジェクトが等しいものでないか比較します。
- hash(x)
オブジェクトのハッシュを返します。
- type¶
オブジェクトのdiscord.pyモデルタイプ。指定されていない場合は、デフォルトでこのクラスになります。
バージョン 2.0 で追加.
- 型
Type[
abc.Snowflake
]
- property created_at¶
スノーフレークの作成時刻をUTCで返します。
Embed¶
- clsEmbed.from_dict
- defadd_field
- defclear_fields
- defcopy
- definsert_field_at
- defremove_author
- defremove_field
- defremove_footer
- defset_author
- defset_field_at
- defset_footer
- defset_image
- defset_thumbnail
- defto_dict
- class discord.Embed(*, colour=None, color=None, title=None, type='rich', url=None, description=None, timestamp=None)¶
Discordの埋め込み。
- len(x)
埋め込みの合計サイズを返します。6000文字の上限内かどうかを確認するのに便利です。
- bool(b)
埋め込みにデータがあるかどうかを返します。
バージョン 2.0 で追加.
- x == y
二つの埋め込みが等しいかを比較します。
バージョン 2.0 で追加.
使いやすさを考慮して、
str
が渡されることを想定されたすべてのパラメータは、暗黙的にstr
にキャストされます。バージョン 2.0 で変更:
Embed.Empty
は、None
に置き換えられ削除されました。- timestamp¶
埋め込みコンテンツのタイムスタンプ。これはaware datetimeです。 naive datetimeが渡されると、ローカルタイムゾーンを用いたaware datetimeに変換されます。
- 型
Optional[
datetime.datetime
]
- classmethod from_dict(data)¶
Discordの期待するフォーマットの
dict
をEmbed
に変換します。このフォーマットについては、 Discord公式のドキュメント を参照してください。
- パラメータ
data (
dict
) -- 埋め込みに変換する辞書。
- copy()¶
埋め込みのシャローコピーを返します。
フッターの内容を表す
EmbedProxy
を返します。アクセス可能な値は
set_footer()
を参照してください。属性に値がない場合は
None
が返されます。
埋め込みコンテンツのフッターを設定します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
- パラメータ
text (
str
) -- フッターテキスト。最大2048文字までです。icon_url (
str
) -- フッターアイコンのURL。HTTP(S) のみサポートされています。インラインの添付ファイル URL もサポートされています。 Embedの画像にローカルの画像を使用するにはどうすればいいですか。 を参照してください。
埋め込みフッター情報を消去します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
バージョン 2.0 で追加.
- property image¶
画像の内容を表す
EmbedProxy
を返します。アクセス可能な属性は次のとおりです:
url
proxy_url
width
height
属性に値がない場合は
None
が返されます。
- set_image(*, url)¶
埋め込みコンテンツの画像を設定します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
- パラメータ
url (
str
) -- 画像のソースURL。HTTP(S) のみサポートされています。インラインの添付ファイル URL もサポートされています。 Embedの画像にローカルの画像を使用するにはどうすればいいですか。 を参照してください。
- property thumbnail¶
サムネイルの内容を表す
EmbedProxy
を返します。アクセス可能な属性は次のとおりです:
url
proxy_url
width
height
属性に値がない場合は
None
が返されます。
- set_thumbnail(*, url)¶
埋め込みコンテンツのサムネイルを設定します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
バージョン 1.4 で変更:
None
を渡すとサムネイルが除去されます。- パラメータ
url (
str
) -- サムネイルのソースURL。HTTP(S) のみサポートされています。インラインの添付ファイル URL もサポートされています。 Embedの画像にローカルの画像を使用するにはどうすればいいですか。 を参照してください。
- property video¶
ビデオの内容を表す
EmbedProxy
を返します。可能な属性は次のとおりです:
url
:ビデオのURLheight
:ビデオの高さwidth
:ビデオの幅
属性に値がない場合は
None
が返されます。
- property provider¶
プロバイダの内容を表す
EmbedProxy
を返します。アクセス可能な属性は
name
とurl
だけです。属性に値がない場合は
None
が返されます。
- property author¶
作成者の内容を表す
EmbedProxy
を返します。アクセス可能な値は
set_author()
を参照してください。属性に値がない場合は
None
が返されます。
- set_author(*, name, url=None, icon_url=None)¶
埋め込みコンテンツの作成者を設定します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
- パラメータ
name (
str
) -- 作成者名。最大256文字までです。url (
str
) -- 作成者のURL。icon_url (
str
) -- 作成者のアイコンのURL。HTTP(S) のみサポートされています。インラインの添付ファイル URL もサポートされています。 Embedの画像にローカルの画像を使用するにはどうすればいいですか。 を参照してください。
- remove_author()¶
埋め込みの作成者情報を消去します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
バージョン 1.4 で追加.
- property fields¶
項目の内容を表す
EmbedProxy
のlist
を返します。アクセス可能な値は
add_field()
を参照してください。属性に値がない場合は
None
が返されます。- 型
List[
EmbedProxy
]
- add_field(*, name, value, inline=True)¶
埋め込みオブジェクトに項目を追加します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。項目は最大25個まで追加できます。
- insert_field_at(index, *, name, value, inline=True)¶
指定したインデックスの前に項目を挿入します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。項目は最大25個まで追加できます。
バージョン 1.2 で追加.
- clear_fields()¶
埋め込みからすべての項目を削除します。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
バージョン 2.0 で変更: この関数はクラスインスタンスを返すようになりました。
- remove_field(index)¶
特定のインデックスの項目を削除します。
インデックスが無効または範囲外の場合、エラーは無視されます。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
注釈
インデックスで項目を削除する場合、他の項目のインデックスは、通常のリストのようにギャップを埋めるために繰り上げられます。
バージョン 2.0 で変更: この関数はクラスインスタンスを返すようになりました。
- パラメータ
index (
int
) -- 削除する項目のインデックス。
- set_field_at(index, *, name, value, inline=True)¶
埋め込みオブジェクトの項目を変更します。
インデックスは、有効な既存の項目を指す必要があります。項目は最大で25個までです。
この関数は、流暢なスタイルのチェーンを可能にするため、クラスインスタンスを返します。
- パラメータ
- 例外
IndexError -- 無効なインデックスが指定された場合。
- to_dict()¶
埋め込みオブジェクトを辞書型に変換します。
AllowedMentions¶
- class discord.AllowedMentions(*, everyone=True, users=True, roles=True, replied_user=True)¶
メッセージ内で許可されたメンションを表すクラス。
これは
Client
の初期化時に設定して、すべての送信されるメッセージに適用できます。より細かなコントロールを行いたい場合に、abc.Messageable.send()
を用いてメッセージ単位でも適用できます。- users¶
メンションできるユーザーをコントロールします。
True
(デフォルト)の場合ユーザーはメッセージ内容によってメンションされます。False
の場合ユーザーは一切メンションされません。abc.Snowflake
のリストが与えられた場合、与えられたユーザーがメッセージ内容に存在する場合に、そのユーザーのみメンションされます。- 型
Union[
bool
, Sequence[abc.Snowflake
]]
- roles¶
メンションできるロールをコントロールします。
True
(デフォルト)の場合ロールはメッセージ内容によってメンションされます。False
の場合ロールは一切メンションされません。abc.Snowflake
のリストが与えられた場合、与えられたロールがメッセージ内容に存在する場合に、そのロールのみメンションされます。- 型
Union[
bool
, Sequence[abc.Snowflake
]]
- classmethod all()¶
すべてのフィールドが
True
に明示的に設定されたAllowedMentions
を返すファクトリメソッド。バージョン 1.5 で追加.
- classmethod none()¶
すべてのフィールドが
False
に設定されたAllowedMentions
を返すファクトリメソッド。バージョン 1.5 で追加.
MessageReference¶
- class discord.MessageReference(*, message_id, channel_id, guild_id=None, fail_if_not_exists=True)¶
Message
への参照を表します。バージョン 1.5 で追加.
バージョン 1.6 で変更: このクラスはユーザーによって作成できるようになりました。
- fail_if_not_exists¶
参照されたメッセージに返信するとき、メッセージが存在しなくなった場合、またはDiscordがメッセージを取得できなかった場合、
HTTPException
を送出させるかどうか。バージョン 1.7 で追加.
- 型
- resolved¶
この参照が解決したメッセージ。
None
の場合、Discord APIが解決しようとしていないか、作成時に利用できないため、元のメッセージは取得されませんでした。 メッセージが以前の時点で解決されていて削除されている場合は、DeletedReferencedMessage
になります。現在、これは主にユーザーがメッセージに返信したときの返信元メッセージです。
バージョン 1.6 で追加.
- 型
Optional[Union[
Message
,DeletedReferencedMessage
]]
- classmethod from_message(message, *, fail_if_not_exists=True)¶
既存の
Message
からMessageReference
を作成します。バージョン 1.6 で追加.
- パラメータ
message (
Message
) -- 参照に変換されるメッセージ。fail_if_not_exists (
bool
) --参照されたメッセージに返信するとき、メッセージが存在しなくなった場合、またはDiscordがメッセージを取得できなかった場合、
HTTPException
を送出させるかどうか。バージョン 1.7 で追加.
- 戻り値
メッセージへの参照。
- 戻り値の型
PartialMessage¶
- asyncadd_reaction
- asyncclear_reaction
- asyncclear_reactions
- asynccreate_thread
- asyncdelete
- asyncedit
- asyncfetch
- asyncfetch_thread
- asyncpin
- asyncpublish
- asyncremove_reaction
- asyncreply
- defto_reference
- asyncunpin
- class discord.PartialMessage(*, channel, id)¶
チャンネルIDとメッセージIDのみ存在する場合にメッセージとの作業を簡単にする部分的なメッセージを表します。
このクラスを構築するには2つの方法があります。最初の方法はコンストラクタ自体で、もう一つの方法は以下によるものです:
これは機能が削られていてリッチな属性を持ちません。
バージョン 1.6 で追加.
- x == y
二つの部分的なメッセージが等しいかを比較します。
- x != y
二つの部分的なメッセージが等しくないかを比較します。
- hash(x)
部分的なメッセージのハッシュ値を返します。
- channel¶
この部分的なメッセージに関連付けられたチャンネル。
- 型
Union[
PartialMessageable
,TextChannel
,StageChannel
,VoiceChannel
,Thread
,DMChannel
]
- property created_at¶
UTCの、部分的なメッセージが作成された時刻。
- property thread¶
The public thread created from this message, if it exists.
注釈
This does not retrieve archived threads, as they are not retained in the internal cache. Use
fetch_thread()
instead.バージョン 2.4 で追加.
- 型
Optional[
Thread
]
- await fetch()¶
This function is a coroutine.
部分的なメッセージを完全な
Message
に変換します。- 例外
NotFound -- メッセージが見つからなかった場合。
Forbidden -- メッセージの取得に必要な権限がない場合。
HTTPException -- メッセージの取得に失敗した場合。
- 戻り値
完全なメッセージ。
- 戻り値の型
- await delete(*, delay=None)¶
This function is a coroutine.
メッセージを削除します。
自身が送信したメッセージは適切な権限が無くとも削除できます。しかし、他人の送信したメッセージを削除する場合には、
manage_messages
が必要です。バージョン 1.1 で変更:
delay
キーワード引数が追加されました。- パラメータ
delay (Optional[
float
]) -- 指定したなら、これはメッセージを削除前に待機する秒数となります。もし削除が失敗しても、それは静かに無視されます。- 例外
Forbidden -- メッセージを削除するための適切な権限がない場合。
NotFound -- メッセージがすでに削除されている場合。
HTTPException -- メッセージの削除に失敗した場合。
- await edit(*, content=..., embed=..., embeds=..., attachments=..., delete_after=None, allowed_mentions=..., view=...)¶
This function is a coroutine.
メッセージを編集します。
内容は
str(content)
によって文字列に変換できる必要があります。バージョン 2.0 で変更: 編集はメッセージを置き換えず、編集された新しいメッセージが返されるようになりました。
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
content (Optional[
str
]) -- 現在のメッセージと置き換える新しい内容。内容を削除するためにNone
を指定することもできます。embed (Optional[
Embed
]) -- オリジナルのメッセージと置き換える新しい埋め込み。埋め込みを削除するためにNone
を指定することもできます。embeds (List[
Embed
]) --オリジナルのメッセージと置き換える新しい埋め込み。最大で10個まで指定できます。埋め込みをすべて削除するためには
[]
を指定してください。バージョン 2.0 で追加.
attachments (List[Union[
Attachment
,File
]]) --メッセージ内で残す添付ファイルと、新規にアップロードする添付ファイルのリスト。
[]
が渡された場合すべての添付ファイルが除去されます。注釈
新しいファイルは常に現在の添付ファイルのあとに表示されます。
バージョン 2.0 で追加.
delete_after (Optional[
float
]) -- もし指定したなら、これはメッセージを編集したあと待機し削除するまでの秒数です。もし削除が失敗しても、それは静かに無視されます。allowed_mentions (Optional[
AllowedMentions
]) --処理すべきメッセージ内のメンションを制御します。これが渡された場合、オブジェクトは
allowed_mentions
とマージされます。これは、オブジェクトに明示的に渡された属性のみを上書きするもので、それ以外はallowed_mentions
で設定された属性が使用されます。もしオブジェクトが渡されていない場合はallowed_mentions
が既定値として利用されます。バージョン 1.4 で追加.
view (Optional[
View
]) -- このメッセージを更新するために更新されたビュー。None
が渡された場合、ビューは削除されます。
- 例外
HTTPException -- メッセージの編集に失敗した場合。
Forbidden -- 権限なしに埋め込みを除去しようとした場合や、他人のメッセージの内容や埋め込みを編集しようとした場合。
TypeError --
embed
とembeds
の両方を指定した場合。
- 戻り値
編集された新しいメッセージ。
- 戻り値の型
- await publish()¶
This function is a coroutine.
このメッセージをチャンネルのフォロワーに公開します。
メッセージはニュースチャンネルで送信されている必要があります。これを行うには、
send_messages
が必要です。自身のメッセージ以外の場合は
manage_messages
も必要です。- 例外
Forbidden -- このメッセージを公開するための適切な権限がないか、チャンネルがニュースチャンネルでない場合。
HTTPException -- メッセージの公開に失敗した場合。
- await pin(*, reason=None)¶
This function is a coroutine.
メッセージをピン留めします。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージをピン留めする理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージをピン留めする権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- チャンネルにすでに50個ピン留めされたメッセージがあるなどの理由で、メッセージのピン留めに失敗した場合。
- await unpin(*, reason=None)¶
This function is a coroutine.
メッセージのピン留めを外します。
プライベートチャンネルでない通常のチャンネルで行うには、
manage_messages
が必要です。- パラメータ
reason (Optional[
str
]) --メッセージのピン留めを解除した理由。監査ログに表示されます。
バージョン 1.4 で追加.
- 例外
Forbidden -- このメッセージのピン留めを外す権限を持っていない場合。
NotFound -- ピン留めするメッセージやチャンネルが見つからなかったか、既に削除されている場合。
HTTPException -- メッセージのピン留め解除に失敗した場合。
- await add_reaction(emoji, /)¶
This function is a coroutine.
メッセージにリアクションを追加します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うためには、そのチャンネルにて
read_message_history
が必要です。 もし、他の人がその絵文字でリアクションしていない場合、さらにadd_reactions
が必要です。バージョン 2.0 で変更:
emoji
引数は位置限定引数になりました。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- リアクションとして追加する絵文字。- 例外
HTTPException -- リアクションの追加に失敗した場合。
Forbidden -- メッセージにリアクションを付けるのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await remove_reaction(emoji, member)¶
This function is a coroutine.
メッセージからあるメンバーによるリアクションをすべて除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。もしリアクションがあなたのものではなければ(つまり、
member
パラメーターがあなたでないなら)、manage_messages
も必要になります。member
パラメータはメンバーを示しabc.Snowflake
抽象基底クラスを満たす必要があります。バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。member (
abc.Snowflake
) -- リアクションを除去すべきメンバー。
- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
NotFound -- 指定されたメンバーや絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await clear_reaction(emoji)¶
This function is a coroutine.
メッセージから特定のリアクションを除去します。
絵文字はユニコード絵文字かカスタムギルド絵文字の
Emoji
でないといけません。これを行うには、
manage_messages
が必要です。バージョン 1.3 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
を送出します。- パラメータ
emoji (Union[
Emoji
,Reaction
,PartialEmoji
,str
]) -- 除去する絵文字。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションを除去するのに必要な権限がない場合。
NotFound -- 指定された絵文字が見つからなかった場合。
TypeError -- emojiパラメータが無効の場合。
- await clear_reactions()¶
This function is a coroutine.
メッセージからリアクションをすべて除去します。
これを行うには、
manage_messages
が必要です。- 例外
HTTPException -- リアクションの除去に失敗した場合。
Forbidden -- リアクションの除去に必要な権限を持っていない場合。
- await create_thread(*, name, auto_archive_duration=..., slowmode_delay=None, reason=None)¶
This function is a coroutine.
メッセージからパブリックスレッドを作成します。
メッセージからパブリックスレッドを作成するには、
create_public_threads
権限が必要です。このメッセージが属するチャンネルは、
TextChannel
でなければなりません。バージョン 2.0 で追加.
- パラメータ
name (
str
) -- スレッドの名前。auto_archive_duration (
int
) -- スレッドがチャンネルリストから自動的に非表示になるまでの分単位の時間。 指定されていない場合、チャンネルのデフォルトの自動アーカイブ期間が使用されます。指定された場合は、60
、1440
、4320
、または10080
のいずれかでないといけません。slowmode_delay (Optional[
int
]) -- このチャンネルの秒単位での低速モードレート制限。 最大値は21600
です。デフォルトはNone
でこの場合は低速モードレート制限が無しとなります。reason (Optional[
str
]) -- スレッドを作成する理由。監査ログに表示されます。
- 例外
Forbidden -- スレッドを作成する権限を持っていない場合。
HTTPException -- スレッドの作成に失敗した場合。
ValueError -- メッセージがギルド情報を持っていない場合。
- 戻り値
作成されたスレッド。
- 戻り値の型
- await fetch_thread()¶
This function is a coroutine.
Retrieves the public thread attached to this message.
注釈
This method is an API call. For general usage, consider
thread
instead.バージョン 2.4 で追加.
- 例外
InvalidData -- An unknown channel type was received from Discord or the guild the thread belongs to is not the same as the one in this object points to.
HTTPException -- Retrieving the thread failed.
NotFound -- There is no thread attached to this message.
Forbidden -- このチャンネルからメッセージを取得する権限がない場合。
- 戻り値
The public thread attached to this message.
- 戻り値の型
- await reply(content=None, **kwargs)¶
This function is a coroutine.
Message
に返信するためのabc.Messageable.send()
のショートカットメソッド。バージョン 1.6 で追加.
バージョン 2.0 で変更: この関数は
InvalidArgument
の代わりにTypeError
やValueError
を送出します。- 例外
HTTPException -- メッセージの送信に失敗した場合。
Forbidden -- メッセージを送信する適切な権限がない場合。
ValueError --
files
リストの大きさが適切でない場合。TypeError --
file
とfiless
の両方を指定した場合。
- 戻り値
送信されたメッセージ。
- 戻り値の型
- to_reference(*, fail_if_not_exists=True)¶
現在のメッセージから
MessageReference
を作成します。バージョン 1.6 で追加.
- パラメータ
fail_if_not_exists (
bool
) --メッセージ参照を使用して返信するとき、メッセージが存在しなくなった場合、またはDiscordがメッセージを取得できなかった場合、
HTTPException
を送出させるかどうか。バージョン 1.7 で追加.
- 戻り値
メッセージへの参照。
- 戻り値の型
MessageApplication¶
RoleSubscriptionInfo¶
- class discord.RoleSubscriptionInfo(data)¶
メッセージのロールサブスクリプション情報を表します。
現在、
MessageType.role_subscription_purchase
のメッセージでのみ利用されています。バージョン 2.0 で追加.
Intents¶
- auto_moderation
- auto_moderation_configuration
- auto_moderation_execution
- bans
- dm_messages
- dm_reactions
- dm_typing
- emojis
- emojis_and_stickers
- guild_messages
- guild_reactions
- guild_scheduled_events
- guild_typing
- guilds
- integrations
- invites
- members
- message_content
- messages
- moderation
- presences
- reactions
- typing
- value
- voice_states
- webhooks
- clsIntents.all
- clsIntents.default
- clsIntents.none
- class discord.Intents(value=0, **kwargs)¶
Discordゲートウェイのインテントフラグをまとめます。
Permissions
と同様に、提供されるプロパティは双方向で利用できます。通常の真偽値であるかのように、 プロパティを使用し個々のビットを設定したり取得したりできます。オブジェクトを構築するときに、フラグを表すキーワード引数を渡して有効または無効にすることができます。
これは、ボットを実行するのに不要な特定のゲートウェイ機能を無効にするために使用されます。 これを利用するには、
Client
のintents
キーワード引数に渡してください。バージョン 1.5 で追加.
- x == y
二つのフラグが等しいかを比較します。
- x != y
二つのフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つIntentsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つIntentsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つIntentsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したIntentsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。
- bool(b)
何らかのインテントが有効かどうかを返します。
バージョン 2.0 で追加.
- classmethod default()¶
presences
、members
、message_content
以外の全てのインテントを有効にしたIntents
を作成するファクトリメソッド。
- guilds¶
ギルド関連イベントが有効かどうか。
以下のイベントに対応します:
これはキャッシュの点で次の属性とクラスにも対応します:
ボットの動作のためにこのインテントを有効化しておくことを強く推奨します。
- 型
- members¶
ギルドメンバー関連イベントが有効になっているかどうか。
以下のイベントに対応します:
これはキャッシュの点で次の属性とクラスにも対応します:
詳細については、 メンバーインテントの説明 を参照してください。
注釈
現在、開発者ポータルからも明示的にオプトインする必要があります。100を超えるギルドに属するボットは、認証のためにDiscordに申請する必要があります。
- 型
- moderation¶
ギルドモデレーション関連イベントが有効になっているかどうか。
以下のイベントに対応します:
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- bans¶
moderation
のエイリアス。バージョン 2.2 で変更: エイリアスに変更されました。
- 型
- emojis¶
emojis_and_stickers
のエイリアス。バージョン 2.0 で変更: エイリアスに変更されました。
- 型
- emojis_and_stickers¶
ギルドの絵文字とスタンプ関連イベントが有効になっているかどうか。
バージョン 2.0 で追加.
以下のイベントに対応します:
これはキャッシュの点で次の属性とクラスにも対応します:
- 型
- integrations¶
ギルド連携サービス関連イベントが有効になっているかどうか。
以下のイベントに対応します:
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- webhooks¶
ギルドのWebhook関連イベントが有効かどうか。
以下のイベントに対応します:
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- invites¶
ギルド招待関連イベントが有効かどうか。
以下のイベントに対応します:
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- voice_states¶
ギルドのボイス状態関連イベントが有効かどうか。
以下のイベントに対応します:
これはキャッシュの点で次の属性とクラスにも対応します:
注釈
ボイスに接続するには、このインテントが必要です。
- 型
- presences¶
ギルドプレゼンス関連イベントが有効になっているかどうか。
以下のイベントに対応します:
これはキャッシュの点で次の属性とクラスにも対応します:
詳細については、 プレゼンスインテントの説明 を参照してください。
注釈
現在、開発者ポータルからも明示的にオプトインする必要があります。100を超えるギルドに属するボットは、認証のためにDiscordに申請する必要があります。
- 型
- messages¶
ギルドとダイレクトメッセージ関連イベントが有効になっているかどうか。
guild_messages
とdm_messages
の両方を設定または取得するためのショートカットです。以下のイベントに対応します:
on_message()
(ギルドとDMの両方)on_message_edit()
(ギルドとDMの両方)on_message_delete()
(ギルドとDMの両方)on_raw_message_delete()
(ギルドとDMの両方)on_raw_message_edit()
(ギルドとDMの両方)
これはキャッシュの点で次の属性とクラスにも対応します:
暗黙の関係により、これは次のイベントにも対応することに注意してください:
on_reaction_add()
(ギルドとDMの両方)on_reaction_remove()
(ギルドとDMの両方)on_reaction_clear()
(ギルドとDMの両方)
- 型
- guild_messages¶
ギルドメッセージ関連イベントが有効になっているかどうか。
DMの場合は
dm_messages
、両方に対応するmessages
も参照してください。以下のイベントに対応します:
on_message()
(ギルドのみ)on_message_edit()
(ギルドのみ)on_message_delete()
(ギルドのみ)on_raw_message_delete()
(ギルドのみ)on_raw_message_edit()
(ギルドのみ)
これはキャッシュの点で次の属性とクラスにも対応します:
Client.cached_messages
(ギルドのみ)
暗黙の関係により、これは次のイベントにも対応することに注意してください:
on_reaction_add()
(ギルドのみ)on_reaction_remove()
(ギルドのみ)on_reaction_clear()
(ギルドのみ)
- 型
- dm_messages¶
ダイレクトメッセージ関連イベントが有効になっているかどうか。
ギルドの場合は
guild_messages
、両方に対応するmessages
も参照してください。以下のイベントに対応します:
on_message()
(DMのみ)on_message_edit()
(DMのみ)on_message_delete()
(DMのみ)on_raw_message_delete()
(DMのみ)on_raw_message_edit()
(DMのみ)
これはキャッシュの点で次の属性とクラスにも対応します:
Client.cached_messages
(DMのみ)
暗黙の関係により、これは次のイベントにも対応することに注意してください:
on_reaction_add()
(DMのみ)on_reaction_remove()
(DMのみ)on_reaction_clear()
(DMのみ)
- 型
- reactions¶
ギルドとダイレクトメッセージのリアクション関連イベントが有効になっているかどうか。
guild_reactions
とdm_reactions
の両方を設定または取得するためのショートカットです。以下のイベントに対応します:
on_reaction_add()
(ギルドとDMの両方)on_reaction_remove()
(ギルドとDMの両方)on_reaction_clear()
(ギルドとDMの両方)on_raw_reaction_add()
(ギルドとDMの両方)on_raw_reaction_remove()
(ギルドとDMの両方)on_raw_reaction_clear()
(ギルドとDMの両方)
これはキャッシュの点で次の属性とクラスにも対応します:
Message.reactions
(ギルドとDMの両方のメッセージ)
- 型
- guild_reactions¶
ギルドメッセージのリアクション関連イベントが有効かどうか。
DMの場合は
dm_reactions
、両方に対応するreactions
も参照してください。以下のイベントに対応します:
on_reaction_add()
(ギルドのみ)on_reaction_remove()
(ギルドのみ)on_reaction_clear()
(ギルドのみ)on_raw_reaction_add()
(ギルドのみ)on_raw_reaction_remove()
(ギルドのみ)on_raw_reaction_clear()
(ギルドのみ)
これはキャッシュの点で次の属性とクラスにも対応します:
Message.reactions
(ギルドメッセージのみ)
- 型
- dm_reactions¶
ダイレクトメッセージのリアクション関連イベントが有効かどうか。
ギルドの場合は
guild_reactions
、両方に対応するreactions
も参照してください。以下のイベントに対応します:
on_reaction_add()
(DMのみ)on_reaction_remove()
(DMのみ)on_reaction_clear()
(DMのみ)on_raw_reaction_add()
(DMのみ)on_raw_reaction_remove()
(DMのみ)on_raw_reaction_clear()
(DMのみ)
これはキャッシュの点で次の属性とクラスにも対応します:
Message.reactions
(DMのメッセージのみ)
- 型
- typing¶
ギルドとダイレクトメッセージの入力関連イベントが有効になっているかどうか。
guild_typing
とdm_typing
の両方を設定または取得するためのショートカットです。以下のイベントに対応します:
on_typing()
(ギルドとDMの両方)
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- guild_typing¶
ギルドとダイレクトメッセージの入力関連イベントが有効になっているかどうか。
DMの場合は
dm_typing
、両方に対応するtyping
も参照してください。以下のイベントに対応します:
on_typing()
(ギルドのみ)
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- dm_typing¶
ギルドとダイレクトメッセージの入力関連イベントが有効になっているかどうか。
ギルドの場合は
guild_typing
、両方に対応するtyping
も参照してください。以下のイベントに対応します:
on_typing()
(DMのみ)
これは、キャッシュに関しては、ライブラリ内の属性やクラスには対応しません。
- 型
- message_content¶
メッセージの内容、添付ファイル、埋め込みおよびコンポーネントが次の基準をすべて満たしていないメッセージで利用できるかどうか:
このクライアントにより送信されていないこと。
メッセージがダイレクトメッセージで送信されていないこと。
メッセージがクライアントをメンションしないこと。
以下のイベントに適用されます。
詳細は メッセージコンテンツインテントの説明 を参照してください。
注釈
現在、開発者ポータルからも明示的にオプトインする必要があります。100を超えるギルドに属するボットは、認証のためにDiscordに申請する必要があります。
バージョン 2.0 で追加.
- 型
- guild_scheduled_events¶
ギルドスケジュールイベント関連イベントが有効になっているかどうか。
以下のイベントに対応します:
バージョン 2.0 で追加.
- 型
- auto_moderation¶
自動管理ルール関係のイベントが有効になっているかどうか。
これは、
auto_moderation_configuration
とauto_moderation_execution
の両方を設定または取得するためのショートカットです。以下のイベントに対応します:
バージョン 2.0 で追加.
- 型
- auto_moderation_configuration¶
自動管理ルール設定関係のイベントが有効になっているかどうか。
以下のイベントに対応します:
バージョン 2.0 で追加.
- 型
- auto_moderation_execution¶
自動管理ルール対応関係のイベントが有効になっているかどうか。
これは以下のイベントに対応します: -
on_automod_action()
バージョン 2.0 で追加.
- 型
MemberCacheFlags¶
- class discord.MemberCacheFlags(**kwargs)¶
メンバーに関するライブラリのキャッシュポリシーを制御します。
これはキャッシュされたメンバーをより細かく制御することを可能にします。ボット自身のメンバーは常にキャッシュされることに注意してください。 このクラスは
Client
のmember_cache_flags
パラメータに渡されます。Discordがどのように動作するかの影響で、キャッシュリソースを適切にクリーンアップするために、
Intents.members
を有効化することをお勧めします。そうでなければ、ライブラリはメンバーがいつギルドから脱退したのかを知ることができず、その後のクリーンアップができません。オブジェクトを構築するときに、フラグを表すキーワード引数を渡して有効または無効にすることができます。
デフォルト値はすべて有効になっているフラグです。
バージョン 1.5 で追加.
- x == y
二つのフラグが等しいかを比較します。
- x != y
二つのフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つMemberCacheFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つMemberCacheFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つMemberCacheFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したMemberCacheFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。バージョン 2.0 で追加.
- classmethod all()¶
すべて有効化された
MemberCacheFlags
を作成するファクトリメソッド。
- classmethod none()¶
すべて無効化された
MemberCacheFlags
を作成するファクトリメソッド。
- voice¶
ボイス内のメンバーをキャッシュするか。
Intents.voice_states
が必要です。ボイスを退出したメンバーはキャッシュされません。
- 型
- joined¶
ギルドに参加したメンバーや、最初のログインフローの一環としてチャンクされたメンバーをキャッシュするか。
Intents.members
を有効にする必要があります。ギルドから脱退したメンバーはキャッシュされません。
- 型
- classmethod from_intents(intents)¶
現在選択されている
Intents
に基づいてMemberCacheFlags
を作成するファクトリメソッド。- パラメータ
intents (
Intents
) -- 選択するインテント。- 戻り値
結果として生成されるメンバーキャッシュフラグ。
- 戻り値の型
ApplicationFlags¶
- class discord.ApplicationFlags(**kwargs)¶
Discordアプリケーションのフラグをまとめます。
- x == y
アプリケーションフラグが等しいか確認します。
- x != y
アプリケーションフラグが等しくないか確認します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つApplicationFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つApplicationFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つApplicationFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したApplicationFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
バージョン 2.0 で追加.
- auto_mod_badge¶
アプリケーションがすべてのギルドを合算して少なくとも100の自動管理ルールを使用している場合
True
を返します。これは公式クライアントにバッジとして表示されます。バージョン 2.3 で追加.
- 型
- app_commands_badge¶
アプリケーションがグローバルアプリケーションコマンドを登録している場合に
True
を返します。これは公式クライアントにバッジとして表示されます。- 型
ChannelFlags¶
- class discord.ChannelFlags(**kwargs)¶
Discordの
GuildChannel
やThread
のフラグをまとめます。- x == y
二つのチャンネルフラグが等しいかを比較します。
- x != y
二つのチャンネルフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
バージョン 2.0 で追加.
- require_tag¶
ForumChannel
でスレッドを作成する際にタグを指定する必要がある場合にTrue
を返します。バージョン 2.1 で追加.
- 型
- hide_media_download_options¶
Returns
True
if the client hides embedded media download options in aForumChannel
. Only available in media channels.バージョン 2.4 で追加.
- 型
AutoModPresets¶
- class discord.AutoModPresets(**kwargs)¶
Discordの
AutoModRule
プリセットをまとめます。バージョン 2.0 で追加.
- x == y
二つの自動管理プリセットフラグが等しいかを比較します。
- x != y
二つの自動管理プリセットフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つAutoModPresetsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つAutoModPresetsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つAutoModPresetsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したAutoModPresetsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
- classmethod all()¶
すべて有効化された
AutoModPresets
を作成するファクトリメソッド。
- classmethod none()¶
すべて無効化された
AutoModPresets
を作成するファクトリメソッド。
AutoModRuleAction¶
- class discord.AutoModRuleAction(*, type=None, channel_id=None, duration=None, custom_message=None)¶
自動管理ルールの対応を表します。
注釈
channel_id
、duration
、custom_message
のいずれか一つのみが使用できます。バージョン 2.0 で追加.
- type¶
行う対応の種類。デフォルトは
block_message
です。
- channel_id¶
該当する場合、アラートメッセージを送信するチャンネルまたはスレッドのID。これを渡すと、
type
がsend_alert_message
に設定されます。- 型
Optional[
int
]
- duration¶
該当する場合、適用するタイムアウトの長さ。最大28日間です。これを渡すと、
type
がtimeout
に設定されます。- 型
Optional[
datetime.timedelta
]
- custom_message¶
メッセージがブロックされたときに送信者に表示されるカスタムメッセージ。
type
をblock_message
に設定します。バージョン 2.2 で追加.
- 型
Optional[
str
]
AutoModTrigger¶
- class discord.AutoModTrigger(*, type=None, keyword_filter=None, presets=None, allow_list=None, mention_limit=None, regex_patterns=None, mention_raid_protection=None)¶
自動管理ルールの発動条件を表します。
以下は、各
AutoModRuleTriggerType
に関連する属性を示す表です。種類
属性
バージョン 2.0 で追加.
- type¶
発動条件の種類。
- keyword_filter¶
The list of strings that will trigger the filter. Maximum of 1000. Keywords can only be up to 60 characters in length.
regex_patterns
と組み合わせることができます。- 型
List[
str
]
- regex_patterns¶
フィルタを発動させる正規表現パターン。構文は Rust の正規表現構文 に基づいています。 最大 10 個まで。正規表現文字列は 260 文字までしか使用できません。
keyword_filter
やallow_list
と組み合わせることができます。バージョン 2.1 で追加.
- 型
List[
str
]
- presets¶
プリセットキーワードフィルタで使用されるプリセット。
File¶
- class discord.File(fp, filename=None, *, spoiler=..., description=None)¶
abc.Messageable.send()
にてファイルを送信するときに使用されるパラメータオブジェクト。注釈
ファイルオブジェクトは使い切りであり、複数の
abc.Messageable.send()
呼び出しで再利用することは意図していません。- fp¶
バイナリモードで開かれたファイルライクオブジェクト、または開くハードドライブ内のファイルを表すファイル名。
注釈
もしファイルライクオブジェクトが
open
で開かれた場合モード rb が使用されるべきです。バイナリデータを渡すには、
io.BytesIO
を使用してみてください。- 型
Union[
os.PathLike
,io.BufferedIOBase
]
Colour¶
- clsColour.blue
- clsColour.blurple
- clsColour.brand_green
- clsColour.brand_red
- clsColour.dark_blue
- clsColour.dark_embed
- clsColour.dark_gold
- clsColour.dark_gray
- clsColour.dark_green
- clsColour.dark_grey
- clsColour.dark_magenta
- clsColour.dark_orange
- clsColour.dark_purple
- clsColour.dark_red
- clsColour.dark_teal
- clsColour.dark_theme
- clsColour.darker_gray
- clsColour.darker_grey
- clsColour.default
- clsColour.from_hsv
- clsColour.from_rgb
- clsColour.from_str
- clsColour.fuchsia
- clsColour.gold
- clsColour.green
- clsColour.greyple
- clsColour.light_embed
- clsColour.light_gray
- clsColour.light_grey
- clsColour.lighter_gray
- clsColour.lighter_grey
- clsColour.magenta
- clsColour.og_blurple
- clsColour.orange
- clsColour.pink
- clsColour.purple
- clsColour.random
- clsColour.red
- clsColour.teal
- clsColour.yellow
- defto_rgb
- class discord.Colour(value)¶
Discordのロールの色を表します。このクラスは (赤、緑、青) の
tuple
に似ています。Colorという名前のエイリアスが存在します。
- x == y
二つの色が等しいかを比較します。
- x != y
二つの色が等しいものではないか比較します。
- hash(x)
色のハッシュ値を返します。
- str(x)
色の16進数表記を返します。
- int(x)
生の色の値を返します。
注釈
クラスメソッドの色はDiscordクライアントの色をほぼそのまま提供しているため、クライアントで使用する色が変更された場合、値がバージョン間で変更されることがあります。
- classmethod from_str(value)¶
文字列から
Colour
を作成します。以下のフォーマットが利用可能です:
0x<hex>
#<hex>
0x#<hex>
rgb(<数値>, <数値>, <数値>)
CSSのように、
<number>
は0-255か0-100%で指定でき、<hex>
は6桁の16進数表記か3桁のショートカット (例: #FFF)で指定できます。バージョン 2.0 で追加.
- 例外
ValueError -- 文字列を色に変換できなかった場合。
- classmethod random(*, seed=None)¶
ランダムな色相を持つ
Colour
を返すクラスメソッドです。注釈
これは、色相をランダムに選び、彩度と明度を最大にした色を選びます。
バージョン 1.6 で追加.
BaseActivity¶
- class discord.BaseActivity(**kwargs)¶
ユーザーが設定可能なアクティビティがすべて継承する基礎のアクティビティ。ユーザーが設定可能なアクティビティは、
Client.change_presence()
で使用できるものです。現在以下がユーザーによって設定できます:
なお、ライブラリはこれらをユーザー設定可能としますが、Discordは現在設定されているものによって特定のアクティビティの組み合わせを無視することがよくあります。この動作は将来変更される可能性があるため、こうしたタイプを実際に設定できるかの保証はありません。
バージョン 1.3 で追加.
- property created_at¶
ユーザーがアクティビティを開始したときのUTC時刻。
バージョン 1.3 で追加.
- 型
Optional[
datetime.datetime
]
Activity¶
- class discord.Activity(**kwargs)¶
Discordでのアクティビティを表します。
これは、ストリーミング、再生、リスニング、視聴などのアクティビティであるかもしれません。
メモリの最適化のために、いくつかのアクティビティは軽量化されたバージョンで提供されます:
- type¶
現在行われているアクティビティのタイプ。
- timestamps¶
タイムスタンプの辞書。次のオプションキーが含まれています:
start
: ユーザーがアクティビティを開始したときのUnixエポック起算ミリ秒数に対応します。end
: ユーザーがアクティビティを終了する予定時刻のUnixエポック起算ミリ秒数に対応します。
- 型
- assets¶
アクティビティの画像とそれらのホバーテキストを表す辞書。次のオプションキーが含まれています:
large_image
: 大きな画像アセットのIDを表す文字列。large_text
: 大きな画像アセットをホバーしたときに表示するテキストを表す文字列。small_image
: 小さな画像アセットのIDを表す文字列。small_text
: 小さな画像アセットをホバーしたときに表示するテキストを表す文字列。
- 型
- party¶
アクティビティのパーティーを表す辞書。次のオプションキーが含まれています:
id
: パーティー ID を表す文字列。size
: 現在の大きさと最大の大きさをである二個以内の整数のリスト。
- 型
- emoji¶
このアクティビティに属する絵文字。
- 型
Optional[
PartialEmoji
]
- property start¶
該当する場合、ユーザーがアクティビティを開始したときのUTC時刻。
- 型
Optional[
datetime.datetime
]
- property end¶
該当する場合、ユーザーがアクティビティを終了する予定のUTC時刻。
- 型
Optional[
datetime.datetime
]
Game¶
- class discord.Game(name, **extra)¶
Discordのゲームを表す
Activity
の軽量化されたバージョン。これは通常、公式のDiscordクライアントにて プレイ中 として表示されます。
- x == y
二つのゲームが等しいかを比較します。
- x != y
二つのゲームが等しいものではないか比較します。
- hash(x)
ゲームのハッシュ値を返します。
- str(x)
ゲームの名前を返します。
- パラメータ
name (
str
) -- ゲームの名前。
- assets¶
A dictionary representing the images and their hover text of a game. It contains the following optional keys:
large_image
: 大きな画像アセットのIDを表す文字列。large_text
: 大きな画像アセットをホバーしたときに表示するテキストを表す文字列。small_image
: 小さな画像アセットのIDを表す文字列。small_text
: 小さな画像アセットをホバーしたときに表示するテキストを表す文字列。
バージョン 2.4 で追加.
- 型
- property type¶
ゲームのタイプを返します。これは
Activity
との互換性のためです。これは常に
ActivityType.playing
を返します。
- property start¶
該当する場合、ユーザーがゲームを開始したときのUTC時刻。
- 型
Optional[
datetime.datetime
]
- property end¶
該当する場合、ユーザーがゲームを終了する予定のUTC時刻。
- 型
Optional[
datetime.datetime
]
Streaming¶
- class discord.Streaming(*, name, url, **extra)¶
Discordのストリーム状態を表す
Activity
の軽量化されたバージョン。これは通常、公式のDiscordクライアントにて ストリーム中 として表示されます。
- x == y
二つのストリームが等しいかを比較します。
- x != y
二つのストリームが等しいものではないか比較します。
- hash(x)
ストリームのハッシュ値を返します。
- str(x)
ストリームの名前を返します。
- assets¶
Activity.assets
のキーと同様のキーで構成される辞書。- 型
- property type¶
ゲームのタイプを返します。これは
Activity
との互換性のためです。これは常に
ActivityType.streaming
を返します。
- property twitch_name¶
提供された場合、ストリーム中のユーザーのTwitchの名前。
これが
twitch:
で始まる場合、Streaming.assets
辞書のlarge_image
キーに対応します。典型的にはDiscordクライアントによって設定されます。- 型
Optional[
str
]
CustomActivity¶
- class discord.CustomActivity(name, *, emoji=None, **extra)¶
Discordでのカスタムアクティビティを表します。
- x == y
2つのアクティビティーが同一か比較します。
- x != y
2つのアクティビティーが同一でないか比較します。
- hash(x)
アクティビティのハッシュ値を返します。
- str(x)
カスタムステータスのテキストを返します。
バージョン 1.3 で追加.
- emoji¶
存在する場合、アクティビティに渡す絵文字。
- 型
Optional[
PartialEmoji
]
- property type¶
アクティビティのタイプを返します。これは
Activity
との互換性のためです。これは常に
ActivityType.custom
を返します。
Permissions¶
- add_reactions
- administrator
- attach_files
- ban_members
- change_nickname
- connect
- create_events
- create_expressions
- create_instant_invite
- create_private_threads
- create_public_threads
- deafen_members
- embed_links
- external_emojis
- external_stickers
- kick_members
- manage_channels
- manage_emojis
- manage_emojis_and_stickers
- manage_events
- manage_expressions
- manage_guild
- manage_messages
- manage_nicknames
- manage_permissions
- manage_roles
- manage_threads
- manage_webhooks
- mention_everyone
- moderate_members
- move_members
- mute_members
- priority_speaker
- read_message_history
- read_messages
- request_to_speak
- send_messages
- send_messages_in_threads
- send_tts_messages
- send_voice_messages
- speak
- stream
- use_application_commands
- use_embedded_activities
- use_external_emojis
- use_external_sounds
- use_external_stickers
- use_soundboard
- use_voice_activation
- value
- view_audit_log
- view_channel
- view_creator_monetization_analytics
- view_guild_insights
- clsPermissions.advanced
- clsPermissions.all
- clsPermissions.all_channel
- clsPermissions.elevated
- clsPermissions.events
- clsPermissions.general
- clsPermissions.membership
- clsPermissions.none
- clsPermissions.stage
- clsPermissions.stage_moderator
- clsPermissions.text
- clsPermissions.voice
- defis_strict_subset
- defis_strict_superset
- defis_subset
- defis_superset
- defupdate
- class discord.Permissions(permissions=0, **kwargs)¶
Discordの権限値をまとめます。
供されるプロパティは双方向で利用できます。通常の真偽値であるかのように、 プロパティを使用し個々のビットを設定したり取得したりできます。これを用いると権限を編集できます。
バージョン 1.3 で変更: キーワード引数を使用して、
Permissions
をupdate()
と同様に初期化できるようになりました。- x == y
二つの権限が等しいかを比較します。
- x != y
二つの権限が等しくないかを比較します。
- x <= y
権限が他の権限の部分集合であるかどうかを確認します。
- x >= y
権限が他の権限の上位集合であるかどうかを確認します。
- x < y
権限が他の権限の真部分集合であるかどうかを確認します。
- x > y
権限が他の権限の真上位集合であるかどうかを確認します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つPermissionsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つPermissionsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つPermissionsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したPermissionsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
権限のハッシュ値を返します。
- iter(x)
(perm, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
権限オブジェクトの権限のいずれかが
True
に設定されているかどうかを返します。バージョン 2.0 で追加.
- is_subset(other)¶
これが他の権限より同じか少ない権限を有する場合
True
を返します。
- is_superset(other)¶
これが他の権限より同じか多い権限を有する場合
True
を返します。
- is_strict_subset(other)¶
この権限が他の権限の真部分集合である場合に
True
を返します。
- is_strict_superset(other)¶
この権限が他の権限の真上位集合である場合に
True
を返します。
- classmethod none()¶
すべての権限が
False
に設定されたPermissions
を作成するファクトリメソッド。
- classmethod all()¶
すべての権限が
True
に設定されたPermissions
を作成するファクトリメソッド。
- classmethod all_channel()¶
チャンネル特有の権限が
True
に、ギルド特有の権限がFalse
に設定されたPermissions
。ギルド特有の権限は現在以下の通りです:バージョン 1.7 で変更:
stream
、priority_speaker
、use_application_commands
権限を追加しました。バージョン 2.0 で変更:
create_public_threads
、create_private_threads
、manage_threads
、use_external_stickers
、send_messages_in_threads
、request_to_speak
権限を追加しました。バージョン 2.3 で変更:
use_soundboard
とcreate_expressions
権限を追加しました。
- classmethod general()¶
Discord公式UIの「サーバー全般の権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。バージョン 1.7 で変更:
read_messages
が全般の権限に含まれるようになり、administrator
、create_instant_invite
、kick_members
、ban_members
、change_nickname
、manage_nicknames
は全般の権限に含まれなくなりました。バージョン 2.3 で変更:
create_expressions
権限を追加しました。
- classmethod membership()¶
Discord公式UIの「メンバーシップ権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。バージョン 1.7 で追加.
- classmethod text()¶
Discord公式UIの「テキストチャンネル権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。バージョン 1.7 で変更:
read_messages
がテキストチャンネル権限に含まれなくなりました。use_application_commands
権限を追加しました。バージョン 2.0 で変更:
create_public_threads
、create_private_threads
、manage_threads
、send_messages_in_threads
、use_external_stickers
権限が追加されました。バージョン 2.3 で変更:
send_voice_messages
権限を追加しました。
- classmethod voice()¶
Discord公式UIの「ボイスチャンネル権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。
- classmethod stage()¶
Discord公式UIの「ステージチャンネル権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。バージョン 1.7 で追加.
- classmethod stage_moderator()¶
ステージモデレーターの権限をすべて
True
に設定したPermissions
を作成するファクトリメソッド。これは現在以下の通りです:バージョン 1.7 で追加.
バージョン 2.0 で変更:
manage_channels
権限を追加し、request_to_speak
権限を削除しました。
- classmethod elevated()¶
二段階認証を必要とする権限をすべて
True
に設定したPermissions
を作成するファクトリメソッド。これは現在以下の通りです:バージョン 2.0 で追加.
- classmethod events()¶
A factory method that creates a
Permissions
with all "Events" permissions from the official Discord UI set toTrue
.バージョン 2.4 で追加.
- classmethod advanced()¶
Discord公式UIの「高度な権限」をすべて
True
に設定したPermissions
を作成するファクトリメソッド。バージョン 1.7 で追加.
- update(**kwargs)¶
権限オブジェクトを一括更新します。
キーワード引数を使用して複数の属性を設定できます。 名前は記載されているプロパティと同等でなければなりません。それ以外のキーと値のペアは無視されます。
- パラメータ
**kwargs -- 権限を一括更新するためのキーと値のペアのリスト。
- view_channel¶
read_messages
のエイリアス。バージョン 1.3 で追加.
- 型
- manage_messages¶
テキストチャンネル内のメッセージを削除またはピン留めできる場合は
True
を返します。注釈
なお、現在、他の人のメッセージを編集する方法はありません。
- 型
- use_external_emojis¶
external_emojis
のエイリアス。バージョン 1.3 で追加.
- 型
- manage_roles¶
ユーザーに付与されている最高レベルのロールより低いレベルのロールを、作成または編集できる場合は
True
を返します。「権限の管理」のチャンネル固有の上書きにも対応します。
- 型
- manage_permissions¶
manage_roles
のエイリアス。バージョン 1.3 で追加.
- 型
- manage_emojis¶
manage_expressions
のエイリアス。- 型
- manage_emojis_and_stickers¶
manage_expressions
のエイリアス。バージョン 2.0 で追加.
- 型
- use_external_stickers¶
external_stickers
のエイリアス。バージョン 2.0 で追加.
- 型
- view_creator_monetization_analytics¶
Returns
True
if a user can view role subscription insights.バージョン 2.4 で追加.
- 型
PermissionOverwrite¶
- clsPermissionOverwrite.from_pair
- defis_empty
- defpair
- defupdate
- class discord.PermissionOverwrite(**kwargs)¶
チャンネル固有の権限を表すために使用されるタイプ。
通常の
Permissions
とは異なり、権限の既定値はFalse
でなくNone
です。値をFalse
にすると 明示的に 権限が拒否され、値をTrue
にすると 明示的に 権限が許可されます。サポートされる値はこれが
None
になる可能性を除きPermissions
と同じです。- x == y
二つの上書きが等しいかを比較します。
- x != y
二つの上書きが等しくないかを比較します。
- iter(x)
(perm, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- パラメータ
**kwargs -- 権限の値を名前を指定して設定します。
- pair()¶
Tuple[
Permissions
,Permissions
]: この上書きの (許可, 拒否) ペアを返します。
- classmethod from_pair(allow, deny)¶
Permissions
の許可と拒否のペアから上書きを作成します。
- is_empty()¶
権限の上書きが現在空であるかどうかを確認します。
空の権限上書きは、
True
またはFalse
に設定された上書きが存在しないものです。- 戻り値
上書きが空かどうかを示します。
- 戻り値の型
- update(**kwargs)¶
権限上書きオブジェクトを一括更新します。
キーワード引数を使用して複数の属性を設定できます。 名前は記載されているプロパティと同等でなければなりません。それ以外のキーと値のペアは無視されます。
- パラメータ
**kwargs -- 一括更新するためのキーと値のペアのリスト。
SystemChannelFlags¶
- class discord.SystemChannelFlags(**kwargs)¶
Discordシステムチャンネルのフラグ値をまとめます。
Permissions
と同様に、提供されるプロパティは双方向で利用できます。通常の真偽値であるかのように、 プロパティを使用し個々のビットを設定したり取得したりできます。これを用いるとシステムフラグを容易に変更できます。オブジェクトを構築するときに、フラグを表すキーワード引数を渡して有効または無効にすることができます。
- x == y
二つのフラグが等しいかを比較します。
- x != y
二つのフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つSystemChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つSystemChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つSystemChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したSystemChannelFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。バージョン 2.0 で追加.
システムチャンネルが「Nitroブースト」通知に使用される場合に
True
を返します。- 型
- join_notification_replies¶
メンバーの参加通知にスタンプ返信ボタン(「手を振って挨拶しましょう!」)が表示される場合に
True
を返します。バージョン 2.0 で追加.
- 型
- role_subscription_purchase_notifications¶
ロールサブスクリプションの購入と更新通知が有効になっている場合に
True
を返します。バージョン 2.2 で追加.
- 型
MessageFlags¶
- class discord.MessageFlags(**kwargs)¶
Discordメッセージのフラグ値をまとめます。
SystemChannelFlags
を参照してください。- x == y
二つのフラグが等しいかを比較します。
- x != y
二つのフラグが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つMessageFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つMessageFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つMessageFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したMessageFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。バージョン 2.0 で追加.
バージョン 1.3 で追加.
- failed_to_mention_some_roles_in_thread¶
メッセージがロールをメンションし、そのメンバーをスレッドに追加するのに失敗した場合に
True
を返します。バージョン 2.0 で追加.
- 型
- silent¶
suppress_notifications
のエイリアス。バージョン 2.2 で追加.
- 型
PublicUserFlags¶
- defall
- class discord.PublicUserFlags(**kwargs)¶
Discordユーザーの公開フラグをまとめます。
- x == y
公開ユーザーフラグが等しいか確認します。
- x != y
公開ユーザーフラグが等しくないか確認します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つPublicUserFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つPublicUserFlagsインスタンスを返します。
バージョン 2.0 で追加.
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つPublicUserFlagsインスタンスを返します。
バージョン 2.0 で追加.
- ~x
x のすべてのフラグが反転したPublicUserFlagsインスタンスを返します。
バージョン 2.0 で追加.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。バージョン 2.0 で追加.
バージョン 1.4 で追加.
- early_verified_bot_developer¶
verified_bot_developer
のエイリアス。バージョン 1.5 で追加.
- 型
- bot_http_interactions¶
ユーザーがHTTPインタラクションのみを使用するボットでオンラインメンバーリストに表示されている場合
True
を返します。バージョン 2.0 で追加.
- 型
MemberFlags¶
- class discord.MemberFlags(**kwargs)¶
Discord ギルドメンバーのフラグをまとめます。
バージョン 2.2 で追加.
- x == y
二つのMemberFlagsが等しいかを比較します。
- x != y
二つのMemberFlagsが等しいものではないか比較します。
- x | y, x |= y
x と y のどちらかにて有効化されたフラグを持つMemberFlagsインスタンスを返します。
- x & y, x &= y
x と y の両方にて有効化されたフラグのみを持つMemberFlagsインスタンスを返します。
- x ^ y, x ^= y
x と y のいずれか一方のみにて有効化されたフラグのみを持つMemberFlagsインスタンスを返します。
- ~x
x のすべてのフラグが反転したMemberFlagsインスタンスを返します。
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
AttachmentFlags¶
- class discord.AttachmentFlags(**kwargs)¶
Wraps up the Discord Attachment flags
バージョン 2.4 で追加.
- x == y
Checks if two AttachmentFlags are equal.
- x != y
Checks if two AttachmentFlags are not equal.
- x | y, x |= y
Returns a AttachmentFlags instance with all enabled flags from both x and y.
- x & y, x &= y
Returns a AttachmentFlags instance with only flags enabled on both x and y.
- x ^ y, x ^= y
Returns a AttachmentFlags instance with only flags enabled on only one of x or y, not on both.
- ~x
Returns a AttachmentFlags instance with all flags inverted from x.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
RoleFlags¶
- class discord.RoleFlags(**kwargs)¶
Wraps up the Discord Role flags
バージョン 2.4 で追加.
- x == y
Checks if two RoleFlags are equal.
- x != y
Checks if two RoleFlags are not equal.
- x | y, x |= y
Returns a RoleFlags instance with all enabled flags from both x and y.
- x & y, x &= y
Returns a RoleFlags instance with only flags enabled on both x and y.
- x ^ y, x ^= y
Returns a RoleFlags instance with only flags enabled on only one of x or y, not on both.
- ~x
Returns a RoleFlags instance with all flags inverted from x.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
SKUFlags¶
- class discord.SKUFlags¶
Wraps up the Discord SKU flags
バージョン 2.4 で追加.
- x == y
Checks if two SKUFlags are equal.
- x != y
Checks if two SKUFlags are not equal.
- x | y, x |= y
Returns a SKUFlags instance with all enabled flags from both x and y.
- x & y, x &= y
Returns a SKUFlags instance with only flags enabled on both x and y.
- x ^ y, x ^= y
Returns a SKUFlags instance with only flags enabled on only one of x or y, not on both.
- ~x
Returns a SKUFlags instance with all flags inverted from x.
- hash(x)
フラグのハッシュ値を返します。
- iter(x)
(name, value)
ペアのイテレータを返します。これにより、例えば、辞書型やペアのリストに変換できます。エイリアスは含まれません。
- bool(b)
何らかのフラグが
True
に設定されているかどうかを返します。
ForumTag¶
- class discord.ForumTag(*, name, emoji=None, moderated=False)¶
ForumChannel
内のスレッドに適用できるフォーラムタグを表します。バージョン 2.1 で追加.
- x == y
二つのフォーラムタグが等しいかを比較します。
- x != y
二つのフォーラムタグが等しいものではないか比較します。
- hash(x)
フォーラムタグのハッシュ値を返します。
- str(x)
フォーラムタグの名前を返します。
- moderated¶
manage_threads
権限を有するモデレータのみ、タグを追加除去できるか。- 型
- emoji¶
このタグを表すために使用される絵文字。絵文字がカスタム絵文字の場合、名前情報は 提供されません 。
- 型
Optional[
PartialEmoji
]
例外¶
以下の例外がライブラリにより送出されます。
- exception discord.DiscordException¶
discord.py の基本例外クラス
理想的には、このライブラリから発生した例外をすべて処理するために、これを捕捉することができます。
- exception discord.LoginFailure¶
Client.login()
関数が不適切な認証情報またはその他の問題によりログインに失敗した場合に送出する例外。
- exception discord.HTTPException(response, message)¶
HTTPリクエスト操作に失敗したときに発生する例外です。
- response¶
失敗したHTTPリクエストのレスポンス。これは
aiohttp.ClientResponse
のインスタンスです。場合によっては、requests.Response
になるかもしれません。
- exception discord.RateLimited(retry_after)¶
ステータスコード429が発生し、タイムアウトが
Client
のmax_ratelimit_timeout
パラメータで指定された最大値を超えた場合に送出される例外。これは、グローバルのレート制限では発生しません。
リクエストが実際に行われる前に送出されることがあるため、これは
HTTPException
をサブクラス しません 。バージョン 2.0 で追加.
- exception discord.Forbidden(response, message)¶
ステータスコード403が発生したときに発生する例外です。
HTTPException
のサブクラス
- exception discord.NotFound(response, message)¶
ステータスコード404が発生したときに発生する例外です。
HTTPException
のサブクラス
- exception discord.DiscordServerError(response, message)¶
500番台のステータスコードが発生したときに発生する例外です。
HTTPException
のサブクラス。バージョン 1.5 で追加.
- exception discord.InvalidData¶
ライブラリがDiscordから不明または無効なデータに遭遇した場合に発生する例外です。
- exception discord.GatewayNotFound¶
Discordのゲートウェイが見つからなかったときに発生する例外です。
- exception discord.ConnectionClosed(socket, *, shard_id, code=None)¶
内部で処理できなかった理由でゲートウェイ接続が閉じられたときに送出される例外。
- exception discord.PrivilegedIntentsRequired(shard_id)¶
ゲートウェイが特権インテントを要求しているが、開発者ページではまだ有効にされていない場合に発生する例外です。
https://discord.com/developers/applications/ にアクセスし、必要なインテントを有効にします。現在、これらは以下の通りです。
- exception discord.InteractionResponded(interaction)¶
InteractionResponse
を用いてインタラクションに応答しようとしたときに、すでに応答があった場合に送出される例外。インタラクションは一度だけ応答します。
バージョン 2.0 で追加.
- interaction¶
すでに応答されたインタラクション。
- exception discord.opus.OpusNotLoaded¶
libopus がロードされていないときに送出される例外。