Class Role

Namespace

Fluxer.Net

Assembly

Fluxer.Net.dll

Fluxer entity with client attached.

public class Role : Entity, IRole, ISnowflake, IMentionable

Inheritance

object

Entity

Role

Implements

IRole

ISnowflake

IMentionable

Derived

SocketRole

Extension Methods

RoleHelpers.AddMemberAsync(Role, GuildMember)

RoleHelpers.AddMemberAsync(Role, ulong)

RoleHelpers.DeleteAsync(Role)

RoleHelpers.ModifyAsync(Role, UpdateGuildRoleRequest)

RoleHelpers.RemoveMemberAsync(Role, GuildMember)

RoleHelpers.RemoveMemberAsync(Role, ulong)

Properties

Color

The colour of the role as an integer.

public int Color { get; }

Property Value

int

CreatedAt

Object created at UTC date.

public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

GuildId

public ulong GuildId { get; }

Property Value

ulong

HoistPosition

The hoisted position of the role, otherwise use position.

public int? HoistPosition { get; }

Property Value

int?

Id

Unique identifier (snowflake) for the object.

public ulong Id { get; }

Property Value

ulong

IsHoisted

Whether this role is displayed separately in the member list.

public bool IsHoisted { get; }

Property Value

bool

IsMentionable

Whether this role can be mentioned by anyone.

public bool IsMentionable { get; }

Property Value

bool

Mention

Formatted mention string for this object.

public string Mention { get; }

Property Value

string

Name

The name of the role.

public string Name { get; }

Property Value

string

Permissions

The role's permission bitfield. Sent as a quoted string by the gateway (e.g. "8933636165184").

public GuildPermissions Permissions { get; }

Property Value

GuildPermissions

Position

The position of the role in the role hierarchy.

public int Position { get; }

Property Value

int

UnicodeEmoji

The unicode emoji for this role.

public string? UnicodeEmoji { get; }

Property Value

string

Methods

Create(FluxerBaseClient, RoleJson, ulong)

Create a Role object from json.

public static Role Create(FluxerBaseClient client, RoleJson json, ulong guildId)

Parameters

client FluxerBaseClient

json RoleJson

guildId ulong

Returns

Role