Stage Instance

Stage Instance's public API supported by Concord. More...

Collaboration diagram for Stage Instance:

Data Structures
struct	discord_ret_stage_instance
	Request's return context. More...

Functions
CCORDcode	discord_create_stage_instance (struct discord *client, struct discord_create_stage_instance *params, struct discord_ret_stage_instance *ret)
	Creates a new Stage Instance associated to a Stage channel. More...
CCORDcode	discord_get_stage_instance (struct discord *client, u64snowflake channel_id, struct discord_ret_stage_instance *ret)
	Gets the stage instance associated with the Stage channel, if it exists. More...
CCORDcode	discord_modify_stage_instance (struct discord *client, u64snowflake channel_id, struct discord_modify_stage_instance *params, struct discord_ret_stage_instance *ret)
	Updates fields of an existing Stage instance. More...
CCORDcode	discord_delete_stage_instance (struct discord *client, u64snowflake channel_id, struct discord_ret *ret)
	Deletes the Stage instance. More...

Detailed Description

Stage Instance's public API supported by Concord.

Function Documentation

discord_create_stage_instance()

CCORDcode discord_create_stage_instance	(	struct discord *	client,
		struct discord_create_stage_instance *	params,
		struct discord_ret_stage_instance *	ret
	)

Creates a new Stage Instance associated to a Stage channel.

Note

requires the user to be a moderator of the Stage channel

Parameters

client	the client created with discord_init()
params	the request parameters
ret	return context of the request. if successful a discord_stage_instance will be sent over to its assigned done callback

See also

discord_ret_stage_instance for more options

Returns

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

discord_get_stage_instance()

CCORDcode discord_get_stage_instance	(	struct discord *	client,
		u64snowflake	channel_id,
		struct discord_ret_stage_instance *	ret
	)

Gets the stage instance associated with the Stage channel, if it exists.

Parameters

client	the client created with discord_init()
channel_id	the stage channel id
ret	return context of the request. if successful a discord_stage_instance will be sent over to its assigned done callback

See also

discord_ret_stage_instance for more options

Returns

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

discord_modify_stage_instance()

CCORDcode discord_modify_stage_instance	(	struct discord *	client,
		u64snowflake	channel_id,
		struct discord_modify_stage_instance *	params,
		struct discord_ret_stage_instance *	ret
	)

Updates fields of an existing Stage instance.

Note

requires the user to be a moderator of the Stage channel

Parameters

client	the client created with discord_init()
channel_id	the stage channel id
params	the request parameters
ret	return context of the request. if successful a discord_stage_instance will be sent over to its assigned done callback

See also

discord_ret_stage_instance for more options

Returns

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

discord_delete_stage_instance()

CCORDcode discord_delete_stage_instance	(	struct discord *	client,
		u64snowflake	channel_id,
		struct discord_ret *	ret
	)

Deletes the Stage instance.

Note

requires the user to be a moderator of the Stage channel

Parameters

client	the client created with discord_init()
channel_id	the stage channel 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