plug.discord¶

exception immp.plug.discord.DiscordAPIError¶

Bases: PlugError

Generic error from the Discord API.

class immp.plug.discord.DiscordUser(id_=None, plug=None, *, username=None, real_name=None, avatar=None, link=None, suggested=False, raw=None)¶

Bases: User

User present in Discord.

classmethod from_user(discord, user)¶

Convert a discord.User into a User.

Parameters:

discord (.DiscordPlug) – Related plug instance that provides the user.
user (discord.User) – Hangups user object retrieved from the user list.

Returns:

Parsed user object.

Return type:

.DiscordUser

class immp.plug.discord.DiscordRichText(segments=None)¶

Bases: RichText

classmethod from_message(discord, message)¶

Convert a string of Markdown from a Discord message into a RichText.

Parameters:

discord (.DiscordPlug) – Related plug instance that provides the text.
message (discord.Message) – Containing message object, in order to resolve mentions.

Returns:

Parsed rich text container.

Return type:

.DiscordRichText

classmethod to_markdown(discord, rich, webhook=False)¶

Convert a RichText instance into a Markdown string.

Parameters:

discord (.DiscordPlug) – Related plug instance to cross-reference users.
rich (.DiscordRichText) – Parsed rich text container.
webhook (bool) – True if being sent via a webhook, which allows use of hyperlinks.

Returns:

Markdown formatted text.

Return type:

str

class immp.plug.discord.DiscordMessage(*, text=None, user=None, edited=False, action=False, reply_to=None, joined=None, left=None, title=None, attachments=None, raw=None)¶

Bases: Message

Message originating from Discord.

async classmethod from_message(discord, message, edited=False, deleted=False)¶

Convert a discord.Message into a Message.

Parameters:

discord (.DiscordPlug) – Related plug instance that provides the event.
message (discord.Message) – Discord message object received from a channel.
edited (bool) – Whether this message comes from an edit event.
deleted (bool) – Whether this message comes from a delete event.

Returns:

Parsed message object.

Return type:

.DiscordMessage

async classmethod to_embed(discord, msg, reply=False)¶

Convert a Message to a message embed structure, suitable for embedding within an outgoing message.

Parameters:

discord (.DiscordPlug) – Target plug instance for this attachment.
msg (.Message) – Original message from another plug or hook.
reply (bool) – Whether to show a reply icon instead of a quote icon.

Returns.

discord.Embed:: Discord API embed object.

class immp.plug.discord.DiscordClient(plug, **kwargs)¶

Bases: Client

Subclass of the underlying client to bind events.

class immp.plug.discord.DiscordPlug(name, config, host)¶

Bases: Plug, HTTPOpenable

Plug for a Discord server.

async start()¶

Perform any underlying operations needed to ready this resource for use, such as opening connections to an external network or API.

If using an event-driven framework that yields and runs in the background, you should use a signal of some form (e.g. asyncio.Condition) to block this method until the framework is ready for use.

async stop()¶

Perform any underlying operations needed to stop using this resource and tidy up, such as terminating open network connections.

Like with start(), this should block as needed to wait for other frameworks – this method should return only when ready to be started again.

async user_from_id(id_)¶

Retrieve a User based on the underlying network’s identifier.

Parameters:: id (str) – Network identifier of the user.
Returns:: Corresponding user instance.
Return type:: .User

async user_from_username(username)¶

Retrieve a User based on the underlying network’s username.

Parameters:: username (str) – Network username of the user.
Returns:: Corresponding user instance.
Return type:: .User

async user_is_system(user)¶

Check if a given user is automated by the plug (for example a bot user from which the plug operates). Hooks may exclude system users from certain operations.

Returns:: True if the user relates to the plug itself.
Return type:: bool

async public_channels()¶

Retrieve all shared channels known to this plug, either public or otherwise accessible. May return None if the network doesn’t support channel discovery.

Returns:: All available non-private channels.
Return type:: .Channel list

async private_channels()¶

Retrieve all private (one-to-one) channels known to this plug. May return None if the network doesn’t support channel discovery.

Returns:: All available private channels.
Return type:: .Channel list

async channel_for_user(user)¶

Retrieve a Channel representing a private (one-to-one) conversation between a given user and the service. Returns None if the user does not have a private channel.

Parameters:: user (.User) – Requested user instance.
Returns:: Private channel for this user.
Return type:: .Channel

async channel_title(channel)¶

Retrieve the friendly name of this channel, as used in the underlying network. May return None if the service doesn’t have a notion of titles.

Returns:: Display name for the channel.
Return type:: str

async channel_link(channel)¶

Return a URL that acts as a direct link to the given channel. This is not a join link, rather one that opens a conversation in the client (it may e.g. use a custom protocol).

Parameters:: channel (.Channel) – Requested channel instance.
Returns:: Internal deep link to this channel.
Return type:: str

async channel_rename(channel, title)¶

Update the friendly name of this conversation.

Parameters:

channel (.Channel) – Requested channel instance.
title (str) – New display name for the channel.

async channel_is_private(channel)¶

Test if a given channel represents a private (one-to-one) conversation between a given user and the service. May return None if the network doesn’t have a notion of public/shared and private channels.

Parameters:: channel (.Channel) – Requested channel instance.
Returns:: True if the channel is private.
Return type:: bool

async channel_members(channel)¶

Retrieve a User list representing all members of the given channel. May return None if the plug doesn’t recognise the channel, or is unable to query members.

Parameters:: channel (.Channel) – Requested channel instance.
Returns:: Members present in the channel.
Return type:: .User list

async channel_admins(channel)¶

Retrieve a User list representing members of the given channel with the ability to manage the channel or its members. May return None if the plug doesn’t recognise the channel, is unable to query members, or has no concept of admins.

Parameters:: channel (.Channel) – Requested channel instance.
Returns:: Members with admin privileges present in the channel.
Return type:: .User list

async channel_link_create(channel, shared=True)¶

Create a URL that can be used by non-members to join the given channel. To link existing participants to the channel without invite authorisation, see channel_link().

Parameters:

channel (.Channel) – Requested channel instance.
shared (bool) –
True (default) for a common, unlimited-use, non-expiring link (subject to any limitations from the underlying network); False for a private, single-use link.

Networks may only support one of these two modes of link creation; if None is returned, but the caller can make do with the other type, they may retry the call and flip this option.

Returns:

Shareable invite link, or None if one couldn’t be created.

Return type:

str

async channel_link_revoke(channel, link=None)¶

Revoke an invite link, or otherwise prevent its use in the future.

Parameters:

channel (.Channel) – Requested channel instance.
link (str) – Existing invite link to revoke. This should be provided when known; if None, the plug will revoke the default invite link, if such a link exists for the channel in the underlying network.

async channel_history(channel, before=None)¶

Retrieve the most recent messages sent or received in the given channel. May return an empty list if the plug is unable to query history.

Parameters:

channel (.Channel) – Requested channel instance.
before (.Receipt) – Starting point message, or None to fetch the most recent.

Returns:

Messages from the channel, oldest first.

Return type:

.Receipt list

async get_message(receipt)¶

Lookup a Receipt and fetch the corresponding SentMessage.

Parameters:: receipt (.Receipt) – Existing message reference to retrieve.
Returns:: Full message.
Return type:: .SentMessage

async put(channel, msg)¶

Take a Message object, and push it to the underlying network.

Because some plugs may not support combinations of message components (such as text and an accompanying image), this method may send more than one physical message.

Parameters:

channel (.Channel) – Target channel for the new message.
msg (.Message) – Original message received from another channel or plug.

Returns:

References to new messages sent to the plug.

Return type:

.Receipt list

async delete(sent)¶

Request deletion of this message, if supported by the network.

Parameters:: sent (.SentMessage) – Existing message to be removed.