Class DiscordOverwriteBuilder

Represents a Discord permission overwrite builder.

Inheritance
System.Object
DiscordOverwriteBuilder
Namespace: DisCatSharp.Entities
Assembly: DisCatSharp.dll
Syntax
public sealed class DiscordOverwriteBuilder

Constructors

| Improve this Doc View Source

DiscordOverwriteBuilder()

Creates a new Discord permission overwrite builder. This class can be used to construct permission overwrites for guild channels, used when creating channels.

Declaration
public DiscordOverwriteBuilder()
| Improve this Doc View Source

DiscordOverwriteBuilder(DiscordMember)

Creates a new Discord permission overwrite builder for a member. This class can be used to construct permission overwrites for guild channels, used when creating channels.

Declaration
public DiscordOverwriteBuilder(DiscordMember member)
Parameters
Type Name Description
DiscordMember member
| Improve this Doc View Source

DiscordOverwriteBuilder(DiscordRole)

Creates a new Discord permission overwrite builder for a role. This class can be used to construct permission overwrites for guild channels, used when creating channels.

Declaration
public DiscordOverwriteBuilder(DiscordRole role)
Parameters
Type Name Description
DiscordRole role

Properties

| Improve this Doc View Source

Allowed

Gets or sets the allowed permissions for this overwrite.

Declaration
public Permissions Allowed { get; set; }
Property Value
Type Description
Permissions
| Improve this Doc View Source

Denied

Gets or sets the denied permissions for this overwrite.

Declaration
public Permissions Denied { get; set; }
Property Value
Type Description
Permissions
| Improve this Doc View Source

Target

Gets the target for this overwrite.

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

Type

Gets the type of this overwrite's target.

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

Methods

| Improve this Doc View Source

Allow(Permissions)

Allows a permission for this overwrite.

Declaration
public DiscordOverwriteBuilder Allow(Permissions permission)
Parameters
Type Name Description
Permissions permission

Permission or permission set to allow for this overwrite.
Returns
Type Description
DiscordOverwriteBuilder

This builder.
| Improve this Doc View Source

Deny(Permissions)

Denies a permission for this overwrite.

Declaration
public DiscordOverwriteBuilder Deny(Permissions permission)
Parameters
Type Name Description
Permissions permission

Permission or permission set to deny for this overwrite.
Returns
Type Description
DiscordOverwriteBuilder

This builder.
| Improve this Doc View Source

For(DiscordMember)

Sets the member to which this overwrite applies.

Declaration
public DiscordOverwriteBuilder For(DiscordMember member)
Parameters
Type Name Description
DiscordMember member

Member to which apply this overwrite's permissions.
Returns
Type Description
DiscordOverwriteBuilder

This builder.
| Improve this Doc View Source

For(DiscordRole)

Sets the role to which this overwrite applies.

Declaration
public DiscordOverwriteBuilder For(DiscordRole role)
Parameters
Type Name Description
DiscordRole role

Role to which apply this overwrite's permissions.
Returns
Type Description
DiscordOverwriteBuilder

This builder.
| Improve this Doc View Source

FromAsync(DiscordOverwrite)

Populates this builder with data from another overwrite object.

Declaration
public async Task<DiscordOverwriteBuilder> FromAsync(DiscordOverwrite other)
Parameters
Type Name Description
DiscordOverwrite other

Overwrite from which data will be used.
Returns
Type Description
System.Threading.Tasks.Task<DiscordOverwriteBuilder>

This builder.

Extension Methods