Class DiscordPermissionExtensions

Contains all the extensions methods for DiscordPermission.

Inheritance

Object

DiscordPermissionExtensions

Inherited Members

System.Object.Equals(System.Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Object.ToString()

Namespace: Color_Chan.Discord.Core.Extensions

Assembly: Color-Chan.Discord.Core.dll

Syntax

public static class DiscordPermissionExtensions

Methods

ConvertToGuildPermission(ReadOnlySpan<Char>)

Convert a permission ReadOnlySpan<T> of Char into a DiscordPermission.

Declaration

public static DiscordPermission ConvertToGuildPermission(this ReadOnlySpan<char> permissions)

Parameters

Type	Name	Description
ReadOnlySpan<Char>	permissions	The ReadOnlySpan<T> of Char that will be converter into a DiscordPermission.

Returns

Type	Description
DiscordPermission	The converted DiscordPermission.

ConvertToGuildPermission(String)

Convert a permission String into a DiscordPermission.

Declaration

public static DiscordPermission ConvertToGuildPermission(this string permissions)

Parameters

Type	Name	Description
String	permissions	The String that will be converter into a DiscordPermission.

Returns

Type	Description
DiscordPermission	The converted DiscordPermission.

ConvertToString(DiscordPermission)

Convert a permission DiscordPermission into a String.

Declaration

public static string ConvertToString(this DiscordPermission permissions)

Parameters

Type	Name	Description
DiscordPermission	permissions	The DiscordPermission that will be converter into a String .

Returns

Type	Description
String	The converted String.

HasChannelPermissions(DiscordPermission)

Checks if the provided permissions contains any channel permissions.

Declaration

public static bool HasChannelPermissions(this DiscordPermission permissions)

Parameters

Type	Name	Description
DiscordPermission	permissions	The DiscordPermission that will be checked for channel permissions.

Returns

Type	Description
Boolean	Whether or not the permissions contained any channel permissions.

ToList(DiscordPermission)

Get all the flags of DiscordPermission separately in a list.

Declaration

public static List<DiscordPermission> ToList(this DiscordPermission permission)

Parameters

Type	Name	Description
DiscordPermission	permission	The permission flags.

Returns

Type	Description
List<DiscordPermission>	A list of DiscordPermission flags.

ToList(Nullable<DiscordPermission>)

Get all the flags of DiscordPermission separately in a list.

Declaration

public static List<DiscordPermission> ToList(this DiscordPermission? permission)

Parameters

Type	Name	Description
System.Nullable<DiscordPermission>	permission	The permission flags.

Returns

Type	Description
List<DiscordPermission>	A list of DiscordPermission flags.

ToReadableString(DiscordPermission)

Get a readable string for a single permission.

Declaration

public static string ToReadableString(this DiscordPermission permission)

Parameters

Type	Name	Description
DiscordPermission	permission	The permission that will be turned into a string.

Returns

Type	Description
String	A readable string for a single permission.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when there was no string for the provided permission.

TryParseDiscordGuildPermission(ReadOnlySpan<Char>, out Nullable<DiscordPermission>)

Try to parse a ReadOnlySpan<T> of Char into a DiscordPermission.

Declaration

public static bool TryParseDiscordGuildPermission(this ReadOnlySpan<char> permissionSpan, out DiscordPermission? permission)

Parameters

Type	Name	Description
ReadOnlySpan<Char>	permissionSpan	The ReadOnlySpan<T> of Char that will be converter into a DiscordPermission.
System.Nullable<DiscordPermission>	permission	The converted DiscordPermission.

Returns

Type	Description
Boolean	Whether or not the permissionSpan has been converted to a DiscordPermission.

TryParseDiscordGuildPermission(String, out Nullable<DiscordPermission>)

Try to parse a String into a DiscordPermission.

Declaration

public static bool TryParseDiscordGuildPermission(this string permissionString, out DiscordPermission? permission)

Parameters

Type	Name	Description
String	permissionString	The String that will be converter into a DiscordPermission.
System.Nullable<DiscordPermission>	permission	The converted DiscordPermission.

Returns

Type	Description
Boolean	Whether or not the permissionString has been converted to a DiscordPermission.