Guild Scheduled Event

Guild Scheduled Event's public API supported by Concord. More...

Collaboration diagram for Guild Scheduled Event:

Data Structures
struct	discord_ret_guild_scheduled_event
	Request's return context. More...
struct	discord_ret_guild_scheduled_events
	Request's return context. More...
struct	discord_ret_guild_scheduled_event_users
	Request's return context. More...

Functions
CCORDcode	discord_list_guild_scheduled_events (struct discord *client, u64snowflake guild_id, struct discord_list_guild_scheduled_events *params, struct discord_ret_guild_scheduled_events *ret)
	Get a list of scheduled events for the guild. More...
CCORDcode	discord_create_guild_scheduled_event (struct discord *client, u64snowflake guild_id, struct discord_create_guild_scheduled_event *params, struct discord_ret_guild_scheduled_event *ret)
	Create a guild scheduled event. More...
CCORDcode	discord_get_guild_scheduled_event (struct discord *client, u64snowflake guild_id, u64snowflake guild_scheduled_event_id, struct discord_get_guild_scheduled_event *params, struct discord_ret_guild_scheduled_event *ret)
	Get a guild scheduled event. More...
CCORDcode	discord_modify_guild_scheduled_event (struct discord *client, u64snowflake guild_id, u64snowflake guild_scheduled_event_id, struct discord_modify_guild_scheduled_event *params, struct discord_ret_guild_scheduled_event *ret)
	Modify a guild scheduled event. More...
CCORDcode	discord_delete_guild_scheduled_event (struct discord *client, u64snowflake guild_id, u64snowflake guild_scheduled_event_id, struct discord_ret *ret)
	Delete a guild scheduled event. More...
CCORDcode	discord_get_guild_scheduled_event_users (struct discord *client, u64snowflake guild_id, u64snowflake guild_scheduled_event_id, struct discord_get_guild_scheduled_event_users *params, struct discord_ret_guild_scheduled_event_users *ret)
	Get a list of members subscribed to a guild scheduled event. More...

Detailed Description

Guild Scheduled Event's public API supported by Concord.

Function Documentation

discord_list_guild_scheduled_events()

CCORDcode discord_list_guild_scheduled_events	(	struct discord *	client,
		u64snowflake	guild_id,
		struct discord_list_guild_scheduled_events *	params,
		struct discord_ret_guild_scheduled_events *	ret
	)

Get a list of scheduled events for the guild.

Parameters

client	the client created with discord_init()
guild_id	the guild to fetch the scheduled events from
params	request parameters
ret	return context of the request. if successful a discord_guild_scheduled_events will be sent over to its assigned done callback

See also

discord_ret_guild_scheduled_events for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_create_guild_scheduled_event()

CCORDcode discord_create_guild_scheduled_event	(	struct discord *	client,
		u64snowflake	guild_id,
		struct discord_create_guild_scheduled_event *	params,
		struct discord_ret_guild_scheduled_event *	ret
	)

Create a guild scheduled event.

Note

A guild can have a maximum of 100 events with SCHEDULED or ACTIVE status at any time

Parameters

client	the client created with discord_init()
guild_id	the guild to create the scheduled event at
params	request parameters
ret	return context of the request. if successful a discord_guild_scheduled_event will be sent over to its assigned done callback

See also

discord_ret_guild_scheduled_event for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_get_guild_scheduled_event()

CCORDcode discord_get_guild_scheduled_event	(	struct discord *	client,
		u64snowflake	guild_id,
		u64snowflake	guild_scheduled_event_id,
		struct discord_get_guild_scheduled_event *	params,
		struct discord_ret_guild_scheduled_event *	ret
	)

Get a guild scheduled event.

Parameters

client	the client created with discord_init()
guild_id	the guild to fetch the scheduled event from
guild_scheduled_event_id	the scheduled event to be fetched
params	request parameters
ret	return context of the request. if successful a discord_guild_scheduled_event will be sent over to its assigned done callback

See also

discord_ret_guild_scheduled_event for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_modify_guild_scheduled_event()

CCORDcode discord_modify_guild_scheduled_event	(	struct discord *	client,
		u64snowflake	guild_id,
		u64snowflake	guild_scheduled_event_id,
		struct discord_modify_guild_scheduled_event *	params,
		struct discord_ret_guild_scheduled_event *	ret
	)

Modify a guild scheduled event.

Note

Silently discards entity_metadata for non-EXTERNAL events

Parameters

client	the client created with discord_init()
guild_id	the guild where the scheduled event to be modified is at
guild_scheduled_event_id	the scheduled event to be modified
params	request parameters
ret	return context of the request. if successful a discord_guild_scheduled_event will be sent over to its assigned done callback

See also

discord_ret_guild_scheduled_event for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_delete_guild_scheduled_event()

CCORDcode discord_delete_guild_scheduled_event	(	struct discord *	client,
		u64snowflake	guild_id,
		u64snowflake	guild_scheduled_event_id,
		struct discord_ret *	ret
	)

Delete a guild scheduled event.

Parameters

client	the client created with discord_init()
guild_id	the guild where the scheduled event to be deleted is at
guild_scheduled_event_id	the scheduled event to be deleted
ret	return context of the request. if successful the assigned done will be triggered

See also

discord_ret for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary

discord_get_guild_scheduled_event_users()

CCORDcode discord_get_guild_scheduled_event_users	(	struct discord *	client,
		u64snowflake	guild_id,
		u64snowflake	guild_scheduled_event_id,
		struct discord_get_guild_scheduled_event_users *	params,
		struct discord_ret_guild_scheduled_event_users *	ret
	)

Get a list of members subscribed to a guild scheduled event.

Note

Guild member data, if it exists, is included if the params.with_member value is set

Parameters

client	the client created with discord_init()
guild_id	the guild with the scheduled event belongs to
guild_scheduled_event_id	the scheduled event
params	request parameters
ret	return context of the request. if successful a discord_guild_scheduled_event_users will be sent over to its assigned done callback

See also

discord_ret_guild_scheduled_event_users for more options

Returns

CCORDcode value for how the operation went, CCORD_OK means nothing out of the ordinary