ApplicationRoleConnectionMetadata
Role connection metadata of an application.
If a bot's application has .role_connection_verification_url configured, then the application will show up as a verification method in the guild's settings.
These metadatas will appear in the role verification configuration when the application has been linked to a role.
When a user connects their account using the bot's .role_connection_verification_url, the bot will update the user's role connection with metadata using the oauth2 role_connections.write scope.
Attributes
None, strThe metadata's description.
Localized descriptions of the metadata.
strThe dictionary key for the metadata.
strThe name of the metadata.
Localized names of the metadata.
The dictionary value's type and their respective operation.
Methods
__new__(name, metadata_type, ...)
Creates a new role connection metadata.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| name |
| The name of the metadata. | ||
| metadata_type | The dictionary value's type and their respective operation. | |||
| description |
| The metadata's description. | ||
| description_localizations |
| Localized descriptions of the metadata. | ||
| key |
| The dictionary key for the metadata. | ||
| name_localizations |
| Localized names of the metadata. |
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
copy()
Copies the role connection metadata.
Returns
new : instance<type<cls>>
copy_with(...)
Copies the role connection metadata with the given fields.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| description |
| The metadata's description. | ||
| description_localizations |
| Localized descriptions of the metadata. | ||
| key |
| The dictionary key for the metadata. | ||
| metadata_type | The dictionary value's type and their respective operation. | |||
| name |
| The name of the metadata. | ||
| name_localizations |
| Localized names of the metadata. |
Returns
new : instance<type<cls>>
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
from_data(data)
Creates a role connection metadata from the given data.
| Parameter | Type | Description |
|---|---|---|
| data |
| Role connection data. |
Returns
self : instance<cls>
to_data(...)
Converts the role connection metadata to json serializable object.
| Parameter | Type | Optional | Keyword only | Default | Description |
|---|---|---|---|---|---|
| defaults |
|
| Whether fields with their default value should be included as well. |
Returns
data : dict of (str, object) items
__eq__()
__getattr__()
Drops a rich attribute error.
__hash__()
Returns the role connection metadata's hash value.
__repr__()
Returns the role connection metadata's representation.