discord_component Struct Reference

#include <message_components.h>

Collaboration diagram for discord_component:

Data Fields
enum discord_component_types	type
char *	custom_id
bool	disabled
enum discord_component_styles	style
char *	label
struct discord_emoji *	emoji
char *	url
struct discord_select_options *	options
char *	placeholder
int	min_values
int	max_values
struct discord_components *	components
int	min_length
int	max_length
bool	required
char *	value

Detailed Description

Public methods

• Initializer:
  • discord_component_init(struct discord_component *this)
• Cleanup:
  • discord_component_cleanup(struct discord_component *this)
• JSON Decoder:
  • discord_component_from_json(const char json[], size_t len, struct discord_component *this)
  • discord_component_from_jsmnf(jsmnf *root, const char json[], struct discord_component *this)
• JSON Encoder:
  • discord_component_to_json(char buf[], size_t size, const struct discord_component *this)
  • discord_component_to_jsonb(jsonb *b, char buf[], size_t size, const struct discord_component *this)

Examples

components.c.

Field Documentation

type

enum discord_component_types discord_component::type

component type

Examples

components.c.

custom_id

char* discord_component::custom_id

a developer-defined identifier for the component, max 100 characters

disabled

bool discord_component::disabled

whether the component is disabled, default false

style

enum discord_component_styles discord_component::style

one of button or text styles

label

char* discord_component::label

text that appears on the button, max 80 characters

emoji

struct discord_emoji* discord_component::emoji

name, id, and animated

url

char* discord_component::url

a url for link-style buttons

options

struct discord_select_options* discord_component::options

the choices in the select, max 25

placeholder

char* discord_component::placeholder

custom placeholder text if nothing is selected, max 100 characters

min_values

int discord_component::min_values

the minimum number of items that must be chosen: default 1, min 0, max 25

max_values

int discord_component::max_values

the maximum number of items that must be chosen: default 1, max 25

components

struct discord_components* discord_component::components

a list of child components

min_length

int discord_component::min_length

the minimum input length for a text input

max_length

int discord_component::max_length

the maximum input length for a text input

required

bool discord_component::required

whether this componentis required to be filled

value

char* discord_component::value

a pre-filled value for this component

---

The documentation for this struct was generated from the following file:

• docs/api/message_components.h