Class GuildScheduledEvent

Namespace

NetCord

Assembly

NetCord.dll

public class GuildScheduledEvent : ClientEntity, IEntity, ISpanFormattable, IFormattable, IEquatable<Entity>, IJsonModel<JsonGuildScheduledEvent>

Inheritance

object

Entity

ClientEntity

GuildScheduledEvent

Implements

IEntity

ISpanFormattable

IFormattable

IEquatable<Entity>

IJsonModel<JsonGuildScheduledEvent>

Inherited Members

Entity.Equals(object)

Entity.Equals(Entity)

Entity.GetHashCode()

Entity.ToString()

Entity.ToString(string, IFormatProvider)

Entity.TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)

Entity.CreatedAt

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

GuildScheduledEvent(JsonGuildScheduledEvent, RestClient)

public GuildScheduledEvent(JsonGuildScheduledEvent jsonModel, RestClient client)

Parameters

jsonModel JsonGuildScheduledEvent

client RestClient

Properties

ChannelId

public ulong? ChannelId { get; }

Property Value

ulong?

CoverImageHash

public string? CoverImageHash { get; }

Property Value

string

Creator

public User? Creator { get; }

Property Value

User

CreatorId

public ulong? CreatorId { get; }

Property Value

ulong?

Description

public string? Description { get; }

Property Value

string

EntityId

public ulong? EntityId { get; }

Property Value

ulong?

EntityType

public GuildScheduledEventEntityType EntityType { get; }

Property Value

GuildScheduledEventEntityType

GuildId

public ulong GuildId { get; }

Property Value

ulong

HasCoverImage

public bool HasCoverImage { get; }

Property Value

bool

Id

The unique identifier for this object.

public override ulong Id { get; }

Property Value

ulong

Location

public string? Location { get; }

Property Value

string

Name

public string Name { get; }

Property Value

string

PrivacyLevel

public GuildScheduledEventPrivacyLevel PrivacyLevel { get; }

Property Value

GuildScheduledEventPrivacyLevel

RecurrenceRule

public GuildScheduledEventRecurrenceRule? RecurrenceRule { get; }

Property Value

GuildScheduledEventRecurrenceRule

ScheduledEndTime

public DateTimeOffset? ScheduledEndTime { get; }

Property Value

DateTimeOffset?

ScheduledStartTime

public DateTimeOffset ScheduledStartTime { get; }

Property Value

DateTimeOffset

Status

public GuildScheduledEventStatus Status { get; }

Property Value

GuildScheduledEventStatus

UserCount

public int? UserCount { get; }

Property Value

int?

Methods

DeleteAsync(RestRequestProperties?, CancellationToken)

public Task DeleteAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task

GetAsync(bool, RestRequestProperties?, CancellationToken)

public Task<GuildScheduledEvent> GetAsync(bool withUserCount = false, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

withUserCount bool

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task<GuildScheduledEvent>

GetCoverImageUrl(ImageFormat)

public ImageUrl? GetCoverImageUrl(ImageFormat format)

Parameters

format ImageFormat

Returns

ImageUrl

GetUsersAsync(OptionalGuildUsersPaginationProperties?, RestRequestProperties?)

public IAsyncEnumerable<GuildScheduledEventUser> GetUsersAsync(OptionalGuildUsersPaginationProperties? paginationProperties = null, RestRequestProperties? properties = null)

Parameters

paginationProperties OptionalGuildUsersPaginationProperties

properties RestRequestProperties

Returns

IAsyncEnumerable<GuildScheduledEventUser>

ModifyAsync(Action<GuildScheduledEventOptions>, RestRequestProperties?, CancellationToken)

public Task<GuildScheduledEvent> ModifyAsync(Action<GuildScheduledEventOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<GuildScheduledEventOptions>

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task<GuildScheduledEvent>