Class AddGuildUserProperties

Properties that are used to add a new IGuildUser to the guild with the following parameters.

Inheritance

System.Object

AddGuildUserProperties

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Discord

Assembly: Discord.Net.Core.dll

Syntax

public class AddGuildUserProperties

Properties

Deaf

Gets or sets whether the user should be deafened in a voice channel.

Declaration

public Optional<bool> Deaf { get; set; }

Property Value

Type	Description
Optional<System.Boolean>

Remarks

If this value is set to true, this user will not be able to hear anyone speak in the guild.

Mute

Gets or sets whether the user should be muted in a voice channel.

Declaration

public Optional<bool> Mute { get; set; }

Property Value

Type	Description
Optional<System.Boolean>

Remarks

If this value is set to true, no user will be able to hear this user speak in the guild.

Nickname

Gets or sets the user's nickname.

Declaration

public Optional<string> Nickname { get; set; }

Property Value

Type	Description
Optional<System.String>

Remarks

To clear the user's nickname, this value can be set to null or System.String.Empty.

RoleIds

Gets or sets the roles the user should have.

Declaration

public Optional<IEnumerable<ulong>> RoleIds { get; set; }

Property Value

Type	Description
Optional<System.Collections.Generic.IEnumerable<System.UInt64>>

Remarks

To add a role to a user: AddRolesAsync(IEnumerable<IRole>, RequestOptions)

To remove a role from a user: RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

Roles

Gets or sets the roles the user should have.

Declaration

public Optional<IEnumerable<IRole>> Roles { get; set; }

Property Value

Type	Description
Optional<System.Collections.Generic.IEnumerable<IRole>>

Remarks

To add a role to a user: AddRolesAsync(IEnumerable<IRole>, RequestOptions)

To remove a role from a user: RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

See Also

AddGuildUserAsync(System.UInt64, System.String, System.Action<AddGuildUserProperties>, RequestOptions)