Interface IGuildScheduledEvent
Represents a generic guild scheduled event.
Assembly: Discord.Net.Core.dll​
View Source​
public interface IGuildScheduledEvent : IEntity<ulong>
Properties​
Guild​
Gets the guild this event is scheduled in.
View Source​
IGuild Guild { get; }
ChannelId​
Gets the optional channel id where this event will be hosted.
View Source​
ulong? ChannelId { get; }
Creator​
Gets the user who created the event.
View Source​
IUser Creator { get; }
Name​
Gets the name of the event.
View Source​
string Name { get; }
Description​
Gets the description of the event.
View Source​
string Description { get; }
StartTime​
Gets the start time of the event.
View Source​
DateTimeOffset StartTime { get; }
EndTime​
Gets the optional end time of the event.
View Source​
DateTimeOffset? EndTime { get; }
PrivacyLevel​
Gets the privacy level of the event.
View Source​
GuildScheduledEventPrivacyLevel PrivacyLevel { get; }
Status​
Gets the status of the event.
View Source​
GuildScheduledEventStatus Status { get; }
Type​
Gets the type of the event.
View Source​
GuildScheduledEventType Type { get; }
EntityId​
Gets the optional entity id of the event. The "entity" of the event can be a stage instance event as is seperate from Discord.IGuildScheduledEvent.ChannelId.
View Source​
ulong? EntityId { get; }
Location​
Gets the location of the event if the Discord.IGuildScheduledEvent.Type is external.
View Source​
string Location { get; }
UserCount​
Gets the user count of the event.
View Source​
int? UserCount { get; }
Methods​
StartAsync(RequestOptions)​
Starts the event.
View Source​
Task StartAsync(RequestOptions options = null)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous start operation.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.RequestOptions | options | The options to be used when sending the request. |
EndAsync(RequestOptions)​
Ends or canceles the event.
View Source​
Task EndAsync(RequestOptions options = null)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous end operation.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.RequestOptions | options | The options to be used when sending the request. |
ModifyAsync(Action<GuildScheduledEventsProperties>, RequestOptions)​
Modifies the guild event.
View Source​
Task ModifyAsync(Action<GuildScheduledEventsProperties> func, RequestOptions options = null)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous modification operation.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Action<Discord.GuildScheduledEventsProperties> | func | The delegate containing the properties to modify the event with. |
| Discord.RequestOptions | options | The options to be used when sending the request. |
DeleteAsync(RequestOptions)​
Deletes the current event.
View Source​
Task DeleteAsync(RequestOptions options = null)
Returns​
System.Threading.Tasks.Task:
A task that represents the asynchronous delete operation.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.RequestOptions | options | The options to be used when sending the request. |
GetUsersAsync(RequestOptions)​
Gets a collection of N users interested in the event.
View Source​
IAsyncEnumerable<IReadOnlyCollection<IUser>> GetUsersAsync(RequestOptions options = null)
Returns​
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IUser>>:
Paged collection of users.
Parameters​
| Type | Name | Description |
|---|---|---|
| Discord.RequestOptions | options | The options to be used when sending the request. |
GetUsersAsync(UInt64, Direction, Int32, RequestOptions)​
Gets a collection of N users interested in the event.
View Source​
IAsyncEnumerable<IReadOnlyCollection<IUser>> GetUsersAsync(ulong fromUserId, Direction dir, int limit = 100, RequestOptions options = null)
Returns​
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<Discord.IUser>>:
Paged collection of users.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt64 | fromUserId | The ID of the starting user to get the users from. |
| Discord.Direction | dir | The direction of the users to be gotten from. |
System.Int32 | limit | The numbers of users to be gotten from. |
| Discord.RequestOptions | options | The options to be used when sending the request. |