@ -422,20 +422,20 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
format : str format : : class : ` str `
The format to attempt to convert the icon to . The format to attempt to convert the icon to .
size : int size : : class : ` int `
The size of the image to display . The size of the image to display .
Returns
- - - - - - - -
str
The resulting CDN URL .
Raises Raises
- - - - - - - - - - - -
InvalidArgument InvalidArgument
Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` . Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` .
Returns
- - - - - - - -
: class : ` str `
The resulting CDN URL .
""" """
if not valid_icon_size ( size ) : if not valid_icon_size ( size ) :
raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " ) raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " )
@ -460,20 +460,20 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
format : str format : : class : ` str `
The format to attempt to convert the banner to . The format to attempt to convert the banner to .
size : int size : : class : ` int `
The size of the image to display . The size of the image to display .
Returns
- - - - - - - -
str
The resulting CDN URL .
Raises Raises
- - - - - - - - - - - -
InvalidArgument InvalidArgument
Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` . Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` .
Returns
- - - - - - - -
: class : ` str `
The resulting CDN URL .
""" """
if not valid_icon_size ( size ) : if not valid_icon_size ( size ) :
raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " ) raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " )
@ -498,20 +498,20 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
format : str format : : class : ` str `
The format to attempt to convert the splash to . The format to attempt to convert the splash to .
size : int size : : class : ` int `
The size of the image to display . The size of the image to display .
Returns
- - - - - - - -
str
The resulting CDN URL .
Raises Raises
- - - - - - - - - - - -
InvalidArgument InvalidArgument
Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` . Bad image format passed to ` ` format ` ` or invalid ` ` size ` ` .
Returns
- - - - - - - -
: class : ` str `
The resulting CDN URL .
""" """
if not valid_icon_size ( size ) : if not valid_icon_size ( size ) :
raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " ) raise InvalidArgument ( " size must be a power of 2 between 16 and 4096 " )
@ -573,7 +573,7 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
name : str name : : class : ` str `
The name of the member to lookup with an optional discriminator . The name of the member to lookup with an optional discriminator .
Returns Returns
@ -649,11 +649,11 @@ class Guild(Hashable):
overwrites with the target ( either a : class : ` Member ` or a : class : ` Role ` ) overwrites with the target ( either a : class : ` Member ` or a : class : ` Role ` )
as the key and a : class : ` PermissionOverwrite ` as the value . as the key and a : class : ` PermissionOverwrite ` as the value .
Note . . note : :
- - - - - - - -
Creating a channel of a specified position will not update the position of Creating a channel of a specified position will not update the position of
other channels to follow suit . A follow - up call to : meth : ` ~ TextChannel . edit ` other channels to follow suit . A follow - up call to : meth : ` ~ TextChannel . edit `
will be required to update the position of the channel in the channel list . will be required to update the position of the channel in the channel list .
Examples Examples
- - - - - - - - - - - - - - - - - - - -
@ -765,10 +765,10 @@ class Guild(Hashable):
Leaves the guild . Leaves the guild .
Note . . note : :
- - - - - - - -
You cannot leave the guild that you own , you must delete it instead You cannot leave the guild that you own , you must delete it instead
via : meth : ` delete ` . via : meth : ` delete ` .
Raises Raises
- - - - - - - - - - - - - - - -
@ -803,18 +803,18 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - -
name : str name : : class : ` str `
The new name of the guild . The new name of the guild .
description : str description : : class : ` str `
The new description of the guild . This is only available to guilds that The new description of the guild . This is only available to guilds that
contain ` VERIFIED ` in : attr : ` Guild . features ` . contain ` VERIFIED ` in : attr : ` Guild . features ` .
icon : bytes icon : : class : ` bytes `
A : term : ` py : bytes - like object ` representing the icon . Only PNG / JPEG supported . A : term : ` py : bytes - like object ` representing the icon . Only PNG / JPEG supported .
Could be ` ` None ` ` to denote removal of the icon . Could be ` ` None ` ` to denote removal of the icon .
banner : bytes banner : : class : ` bytes `
A : term : ` py : bytes - like object ` representing the banner . A : term : ` py : bytes - like object ` representing the banner .
Could be ` ` None ` ` to denote removal of the banner . Could be ` ` None ` ` to denote removal of the banner .
splash : bytes splash : : class : ` bytes `
A : term : ` py : bytes - like object ` representing the invite splash . A : term : ` py : bytes - like object ` representing the invite splash .
Only PNG / JPEG supported . Could be ` ` None ` ` to denote removing the Only PNG / JPEG supported . Could be ` ` None ` ` to denote removing the
splash . Only available for partnered guilds with ` ` INVITE_SPLASH ` ` splash . Only available for partnered guilds with ` ` INVITE_SPLASH ` `
@ -823,7 +823,7 @@ class Guild(Hashable):
The new region for the guild ' s voice communication. The new region for the guild ' s voice communication.
afk_channel : Optional [ : class : ` VoiceChannel ` ] afk_channel : Optional [ : class : ` VoiceChannel ` ]
The new channel that is the AFK channel . Could be ` ` None ` ` for no AFK channel . The new channel that is the AFK channel . Could be ` ` None ` ` for no AFK channel .
afk_timeout : int afk_timeout : : class : ` int `
The number of seconds until someone is moved to the AFK channel . The number of seconds until someone is moved to the AFK channel .
owner : : class : ` Member ` owner : : class : ` Member `
The new owner of the guild to transfer ownership to . Note that you must The new owner of the guild to transfer ownership to . Note that you must
@ -834,11 +834,11 @@ class Guild(Hashable):
The new default notification level for the guild . The new default notification level for the guild .
explicit_content_filter : : class : ` ContentFilter ` explicit_content_filter : : class : ` ContentFilter `
The new explicit content filter for the guild . The new explicit content filter for the guild .
vanity_code : str vanity_code : : class : ` str `
The new vanity code for the guild . The new vanity code for the guild .
system_channel : Optional [ : class : ` TextChannel ` ] system_channel : Optional [ : class : ` TextChannel ` ]
The new channel that is used for the system channel . Could be ` ` None ` ` for no system channel . The new channel that is used for the system channel . Could be ` ` None ` ` for no system channel .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason for editing this guild . Shows up on the audit log . The reason for editing this guild . Shows up on the audit log .
Raises Raises
@ -1026,9 +1026,9 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
days : int days : : class : ` int `
The number of days before counting as inactive . The number of days before counting as inactive .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason for doing this action . Shows up on the audit log . The reason for doing this action . Shows up on the audit log .
Raises Raises
@ -1042,7 +1042,7 @@ class Guild(Hashable):
Returns Returns
- - - - - - - - - - - - - - - - - -
int : class : ` int `
The number of members pruned . The number of members pruned .
""" """
@ -1082,7 +1082,7 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
days : int days : : class : ` int `
The number of days before counting as inactive . The number of days before counting as inactive .
Raises Raises
@ -1096,7 +1096,7 @@ class Guild(Hashable):
Returns Returns
- - - - - - - - - - - - - - - - - -
int : class : ` int `
The number of members estimated to be pruned . The number of members estimated to be pruned .
""" """
@ -1150,27 +1150,27 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
name : str name : : class : ` str `
The emoji name . Must be at least 2 characters . The emoji name . Must be at least 2 characters .
image : bytes image : : class : ` bytes `
The : term : ` py : bytes - like object ` representing the image data to use . The : term : ` py : bytes - like object ` representing the image data to use .
Only JPG , PNG and GIF images are supported . Only JPG , PNG and GIF images are supported .
roles : Optional [ l ist[ : class : ` Role ` ] ] roles : Optional [ L ist[ : class : ` Role ` ] ]
A : class : ` list ` of : class : ` Role ` \s that can use this emoji . Leave empty to make it available to everyone . A : class : ` list ` of : class : ` Role ` \s that can use this emoji . Leave empty to make it available to everyone .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason for creating this emoji . Shows up on the audit log . The reason for creating this emoji . Shows up on the audit log .
Returns
- - - - - - - -
: class : ` Emoji `
The created emoji .
Raises Raises
- - - - - - - - - - - - - -
Forbidden Forbidden
You are not allowed to create emojis . You are not allowed to create emojis .
HTTPException HTTPException
An error occurred creating an emoji . An error occurred creating an emoji .
Returns
- - - - - - - -
: class : ` Emoji `
The created emoji .
""" """
img = utils . _bytes_to_base64_data ( image ) img = utils . _bytes_to_base64_data ( image )
@ -1191,27 +1191,22 @@ class Guild(Hashable):
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
name : str name : : class : ` str `
The role name . Defaults to ' new role ' . The role name . Defaults to ' new role ' .
permissions : : class : ` Permissions ` permissions : : class : ` Permissions `
The permissions to have . Defaults to no permissions . The permissions to have . Defaults to no permissions .
colour : : class : ` Colour ` colour : : class : ` Colour `
The colour for the role . Defaults to : meth : ` Colour . default ` . The colour for the role . Defaults to : meth : ` Colour . default ` .
This is aliased to ` ` color ` ` as well . This is aliased to ` ` color ` ` as well .
hoist : bool hoist : : class : ` bool `
Indicates if the role should be shown separately in the member list . Indicates if the role should be shown separately in the member list .
Defaults to False . Defaults to False .
mentionable : bool mentionable : : class : ` bool `
Indicates if the role should be mentionable by others . Indicates if the role should be mentionable by others .
Defaults to False . Defaults to False .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason for creating this role . Shows up on the audit log . The reason for creating this role . Shows up on the audit log .
Returns
- - - - - - - -
: class : ` Role `
The newly created role .
Raises Raises
- - - - - - - - - - - - - -
Forbidden Forbidden
@ -1220,6 +1215,11 @@ class Guild(Hashable):
Editing the role failed . Editing the role failed .
InvalidArgument InvalidArgument
An invalid keyword argument was given . An invalid keyword argument was given .
Returns
- - - - - - - -
: class : ` Role `
The newly created role .
""" """
try : try :
@ -1261,7 +1261,7 @@ class Guild(Hashable):
- - - - - - - - - - - - - - - - - - - - - -
user : : class : ` abc . Snowflake ` user : : class : ` abc . Snowflake `
The user to kick from their guild . The user to kick from their guild .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason the user got kicked . The reason the user got kicked .
Raises Raises
@ -1287,10 +1287,10 @@ class Guild(Hashable):
- - - - - - - - - - - - - - - - - - - - - -
user : : class : ` abc . Snowflake ` user : : class : ` abc . Snowflake `
The user to ban from their guild . The user to ban from their guild .
delete_message_days : int delete_message_days : : class : ` int `
The number of days worth of messages to delete from the user The number of days worth of messages to delete from the user
in the guild . The minimum is 0 and the maximum is 7. in the guild . The minimum is 0 and the maximum is 7.
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason the user got banned . The reason the user got banned .
Raises Raises
@ -1316,7 +1316,7 @@ class Guild(Hashable):
- - - - - - - - - - - - - - - - - - - - - -
user : : class : ` abc . Snowflake ` user : : class : ` abc . Snowflake `
The user to unban . The user to unban .
reason : Optional [ str ] reason : Optional [ : class : ` str ` ]
The reason for doing this action . Shows up on the audit log . The reason for doing this action . Shows up on the audit log .
Raises Raises
@ -1339,17 +1339,17 @@ class Guild(Hashable):
You must have the : attr : ` ~ Permissions . manage_guild ` permission to use You must have the : attr : ` ~ Permissions . manage_guild ` permission to use
this as well . this as well .
Returns
- - - - - - - -
: class : ` Invite `
The special vanity invite .
Raises Raises
- - - - - - - - - - - - - -
Forbidden Forbidden
You do not have the proper permissions to get this . You do not have the proper permissions to get this .
HTTPException HTTPException
Retrieving the vanity invite failed . Retrieving the vanity invite failed .
Returns
- - - - - - - -
: class : ` Invite `
The special vanity invite .
""" """
# we start with { code: abc } # we start with { code: abc }
@ -1392,9 +1392,27 @@ class Guild(Hashable):
You must have the : attr : ` ~ Permissions . view_audit_log ` permission to use this . You must have the : attr : ` ~ Permissions . view_audit_log ` permission to use this .
Examples
- - - - - - - - - -
Getting the first 100 entries : : :
async for entry in guild . audit_logs ( limit = 100 ) :
print ( ' {0.user} did {0.action} to {0.target} ' . format ( entry ) )
Getting entries for a specific action : : :
async for entry in guild . audit_logs ( action = discord . AuditLogAction . ban ) :
print ( ' {0.user} banned {0.target} ' . format ( entry ) )
Getting entries made by a specific user : : :
entries = await guild . audit_logs ( limit = None , user = guild . me ) . flatten ( )
await channel . send ( ' I made {} moderation actions. ' . format ( len ( entries ) ) )
Parameters Parameters
- - - - - - - - - - - - - - - - - - - - - -
limit : Optional [ int ] limit : Optional [ : class : ` int ` ]
The number of entries to retrieve . If ` ` None ` ` retrieve all entries . The number of entries to retrieve . If ` ` None ` ` retrieve all entries .
before : Union [ : class : ` abc . Snowflake ` , datetime ] before : Union [ : class : ` abc . Snowflake ` , datetime ]
Retrieve entries before this date or entry . Retrieve entries before this date or entry .
@ -1402,7 +1420,7 @@ class Guild(Hashable):
after : Union [ : class : ` abc . Snowflake ` , datetime ] after : Union [ : class : ` abc . Snowflake ` , datetime ]
Retrieve entries after this date or entry . Retrieve entries after this date or entry .
If a date is provided it must be a timezone - naive datetime representing UTC time . If a date is provided it must be a timezone - naive datetime representing UTC time .
reverse : bool reverse : : class : ` bool `
If set to true , return entries in oldest - > newest order . If unspecified , If set to true , return entries in oldest - > newest order . If unspecified ,
this defaults to ` ` False ` ` for most cases . However if passing in a this defaults to ` ` False ` ` for most cases . However if passing in a
` ` after ` ` parameter then this is set to ` ` True ` ` . This avoids getting entries ` ` after ` ` parameter then this is set to ` ` True ` ` . This avoids getting entries
@ -1412,11 +1430,6 @@ class Guild(Hashable):
action : : class : ` AuditLogAction ` action : : class : ` AuditLogAction `
The action to filter with . The action to filter with .
Yields
- - - - - - - -
: class : ` AuditLogEntry `
The audit log entry .
Raises Raises
- - - - - - - - - - - - - -
Forbidden Forbidden
@ -1424,23 +1437,10 @@ class Guild(Hashable):
HTTPException HTTPException
An error occurred while fetching the audit logs . An error occurred while fetching the audit logs .
Examples Yields
- - - - - - - - - - - - - - - - - -
: class : ` AuditLogEntry `
Getting the first 100 entries : : : The audit log entry .
async for entry in guild . audit_logs ( limit = 100 ) :
print ( ' {0.user} did {0.action} to {0.target} ' . format ( entry ) )
Getting entries for a specific action : : :
async for entry in guild . audit_logs ( action = discord . AuditLogAction . ban ) :
print ( ' {0.user} banned {0.target} ' . format ( entry ) )
Getting entries made by a specific user : : :
entries = await guild . audit_logs ( limit = None , user = guild . me ) . flatten ( )
await channel . send ( ' I made {} moderation actions. ' . format ( len ( entries ) ) )
""" """
if user : if user :
user = user . id user = user . id
NCPlayz
6 years ago
Rapptz