Skip to content

client

Read-only access to the client state PhoenixCord tracks.

current-user() → option<user>

get-user(id: snowflake) → option<user>

get-member(guild-id: snowflake, user-id: snowflake) → option<member>

get-guild(id: snowflake) → option<guild>

list-guilds() → list<guild>

list-roles(guild-id: snowflake) → list<role>

Roles of a guild, lowest position first.

get-channel(id: snowflake) → option<channel>

list-guild-channels(guild-id: snowflake) → list<channel>

Channels and threads of a guild, ordered by position.

list-private-channels() → list<channel>

DMs and group DMs, most recently active first.

get-message(channel-id: snowflake, message-id: snowflake) → option<message>

list-messages(channel-id: snowflake) → list<message>

Cached messages of a channel, oldest first. Only recent messages are cached.

get-presence(user-id: snowflake) → option<presence>

list-relationships() → list<relationship>

list-voice-states(channel-id: snowflake) → list<voice-state>

Users connected to a voice channel.

get-permissions(channel-id: snowflake) → u64

The current user’s permission bitfield in a channel, after roles, overwrites and timeouts. All bits are set in DMs.

get-selection() → channel-selection