RelationshipType
Represents a Relationship 's type.
Attributes
strThe relationship type's name.
intThe Discord side identifier value of the relationship type.
Class Attributes
str = 'Undefined'The default name of the relation types.
The predefined relation types stored in a list, so they can be accessed with their respective value as key. This behaviour is used to translate their Discord side value to their representation.
type = intThe relationship types' values' type.
Each predefined relationship type can also be accessed as class attribute:
| Class attribute name | name | value |
|---|---|---|
| stranger | stranger | 0 |
| friend | friend | 1 |
| blocked | blocked | 2 |
| pending_incoming | pending incoming | 3 |
| pending_outgoing | pending outgoing | 4 |
| implicit | implicit | 5 |
| suggestion | suggestion | 6 |
Methods
__init__(value, name)
Creates a new preinstanced instance.
| Parameter | Type | Description |
|---|---|---|
| value |
| The value of the preinstanced object. |
| name |
| The object's name. |
get(value)
Returns the value's representation. If the value is already preinstanced, returns that, else creates a new object.
| Parameter | Type | Description |
|---|---|---|
| value |
| The value to get it's representation. |
Returns
obj_ : PreinstancedBase
_from_value(value)
Creates a new preinstanced object from the given value.
| Parameter | Type | Description |
|---|---|---|
| value |
| The value what has no representation yet. |
Returns
self : PreinstancedBase
The created object.
__eq__()
Returns whether self's value equals to the other object's.
__ge__()
Returns whether self's value is greater or equal to the other object's.
__getattr__()
Drops a rich attribute error.
__gt__()
Returns whether self's value is greater than the other object's.
__hash__()
Returns the hash of the preinstanced object.
__le__()
Returns whether self's value is less or equal to the other object's.
__lt__()
Returns whether self's value is less than the other object's.
__ne__()
Returns whether self's not equals to the other object's.
__repr__()
Returns the representation of the preinstanced object.