Class KuracordRole

Inheritance
Object
SnowflakeObject
KuracordRole
Implements
IEquatable<KuracordRole>
Inherited Members
Namespace: KSharpPlus.Entities.Guild
Assembly: KSharpPlus.dll
Syntax
public class KuracordRole : SnowflakeObject

Properties

| Improve this Doc View Source

Color

Gets the color of this role.

Declaration
public KuracordColor Color { get; }
Property Value
Type Description
KuracordColor
| Improve this Doc View Source

IsHoisted

Gets whether this role is hoisted.

Declaration
public bool IsHoisted { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Mention

Gets a mention string for this role. If the role is mentionable, this string will mention all the users that belong to this role.

Declaration
public string Mention { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Name

Gets the name of this role.

Declaration
public string Name { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Permissions

Gets the permissions set for this role.

Declaration
public Permissions Permissions { get; }
Property Value
Type Description
Permissions

Methods

| Improve this Doc View Source

Equals(KuracordRole)

Checks whether this KuracordRole is equal to another KuracordRole.

Declaration
public bool Equals(KuracordRole e)
Parameters
Type Name Description
KuracordRole e

KuracordRole to compare to.
Returns
Type Description
Boolean

Whether the KuracordRole is equal to this KuracordRole.
| Improve this Doc View Source

Equals(Object)

Checks whether this KuracordRole is equal to another object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

Object to compare to.
Returns
Type Description
Boolean

Whether the object is equal to this KuracordRole.
Overrides
| Improve this Doc View Source

GetHashCode()

Gets the hash code for this KuracordRole.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

The hash code for this KuracordRole.
Overrides
| Improve this Doc View Source

ToString()

Returns a string representation of this role.

Declaration
public override string ToString()
Returns
Type Description
String

String representation of this role.
Overrides

Operators

| Improve this Doc View Source

Equality(KuracordRole, KuracordRole)

Gets whether the two KuracordRole objects are equal.

Declaration
public static bool operator ==(KuracordRole e1, KuracordRole e2)
Parameters
Type Name Description
KuracordRole e1

First role to compare.
KuracordRole e2

Second role to compare.
Returns
Type Description
Boolean

Whether the two roles are equal.
| Improve this Doc View Source

Inequality(KuracordRole, KuracordRole)

Gets whether the two KuracordRole objects are not equal.

Declaration
public static bool operator !=(KuracordRole e1, KuracordRole e2)
Parameters
Type Name Description
KuracordRole e1

First role to compare.
KuracordRole e2

Second role to compare.
Returns
Type Description
Boolean

Whether the two roles are not equal.

Implements

IEquatable<>