Class MentionUtils

Namespace

Discord

Assembly

Discord.Net.Core.dll

Provides a series of helper methods for parsing mentions.

public static class MentionUtils

Inheritance

object

MentionUtils

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

MentionChannel(ulong)

Returns a mention string based on the channel ID.

public static string MentionChannel(ulong id)

Parameters

id ulong

Returns

string

A channel mention string (e.g. <#103735883630395392>).

MentionRole(ulong)

Returns a mention string based on the role ID.

public static string MentionRole(ulong id)

Parameters

id ulong

Returns

string

A role mention string (e.g. <@&165511591545143296>).

MentionUser(ulong)

Returns a mention string based on the user ID.

public static string MentionUser(ulong id)

Parameters

id ulong

Returns

string

A user mention string (e.g. <@80351110224678912>).

ParseChannel(string)

Parses a provided channel mention string.

public static ulong ParseChannel(string text)

Parameters

text string

Returns

ulong

Exceptions

ArgumentException

Invalid mention format.

ParseRole(string)

Parses a provided role mention string.

public static ulong ParseRole(string text)

Parameters

text string

Returns

ulong

Exceptions

ArgumentException

Invalid mention format.

ParseUser(string)

Parses a provided user mention string.

public static ulong ParseUser(string text)

Parameters

text string

The user mention.

Returns

ulong

Exceptions

ArgumentException

Invalid mention format.

TryParseChannel(string, out ulong)

Tries to parse a provided channel mention string.

public static bool TryParseChannel(string text, out ulong channelId)

Parameters

text string

channelId ulong

Returns

bool

TryParseRole(string, out ulong)

Tries to parse a provided role mention string.

public static bool TryParseRole(string text, out ulong roleId)

Parameters

text string

roleId ulong

Returns

bool

TryParseUser(string, out ulong)

Tries to parse a provided user mention string.

public static bool TryParseUser(string text, out ulong userId)

Parameters

text string

The user mention.

userId ulong

The UserId of the user.

Returns

bool