Users and DMs

DirectMessageChannel#

interface DirectMessageChannel

icon#

Group icon hash, or null

string | null

id#

Decimal channel ID, accepted by the existing messages API

string

lastMessageId#

Last message ID supplied by Fluxer, or null

Kept from when the conversation was observed. Sending messages does not update a cached conversation's value, so fetch it for a current value

string | null

lastPinTimestamp optional#

ISO 8601 time of the most recent pin, or null when nothing was ever pinned

Unpinning does not clear it. Absent when Fluxer omits it

string | null

name#

Group name, or null when absent

string | null

nicknames#

Supplied nickname overrides, keyed by decimal user ID

Fluxer names it nicks

Readonly<Record<string, string>>

nsfw optional#

Whether the group is marked as adult content

Fluxer sends it only for groups, so it is absent for a one-to-one DM

boolean

ownerId#

Group owner ID, or null for a one-to-one DM

string | null

recipients#

Public recipient snapshots supplied by Fluxer, not necessarily including the current bot

readonly User[]

type#

Explicitly distinguishes one-to-one and group conversations

"group" | "dm"

DirectMessageGroupEdit#

interface DirectMessageGroupEdit

icon optional#

Image data URI, or null to clear

Fluxer validates the image

string | null

name optional#

Group name, or null to clear it

Raw input may contain at most 10,000 UTF-16 code units. For validation, Fluxer's general-name rules remove U+000C and U+202E, trim surrounding whitespace, strip provider-defined invisible characters, normalize whitespace and collapse its runs, then require 1–100 UTF-16 code units. The SDK sends the original string without lowercasing or hyphenating it

string | null

nicknames optional#

Nicknames keyed by user ID

A nickname must be a nonempty raw string and contain at most 32 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming. A normalized-empty string is allowed. The original string is sent unchanged, and null clears a nickname. Non-owners may change only their own. Fluxer names it nicks

Readonly<Record<string, string | null>> | null| Readonly<
    Record<string, string | null>
  >
| null

ownerId optional#

Transfer ownership to an existing non-bot recipient

Requires current ownership

string

DirectMessageLatestMessages#

interface DirectMessageLatestMessages<
    M extends MessageCore = Message
>interface DirectMessageLatestMessages<
  M extends MessageCore = Message
>

messages#

Returned entries keyed by requested channel ID

Null is ambiguous and does not prove an empty channel or access denial

Readonly<Record<string, M | null>>

omittedChannelIds#

Requested IDs omitted by Fluxer, in input order

Omission is distinct from a returned null

readonly string[]

DirectMessages#

interface DirectMessages<M extends MessageCore = Message>interface DirectMessages<
  M extends MessageCore = Message
>

close(id: string, options?: RequestOptions): ResultAsync<
    void,
    UserOperationFailure | ConfigurationError | CancelledError
>close(
  id: string,
  options?: RequestOptions
): ResultAsync<
  void,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

editGroup(
    id: string,
    input: DirectMessageGroupEdit,
    options?: RequestOptions
): ResultAsync<
    DirectMessageChannel,
    UserOperationFailure | ConfigurationError | CancelledError
>editGroup(
  id: string,
  input: DirectMessageGroupEdit,
  options?: RequestOptions
): ResultAsync<
  DirectMessageChannel,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

fetch(id: string, options?: RequestOptions): ResultAsync<
    DirectMessageChannel,
    UserOperationFailure | ConfigurationError | CancelledError
>fetch(
  id: string,
  options?: RequestOptions
): ResultAsync<
  DirectMessageChannel,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

fetchAll(options?: RequestOptions): ResultAsync<
    readonly DirectMessageChannel[],
    UserOperationFailure | ConfigurationError | CancelledError
>fetchAll(
  options?: RequestOptions
): ResultAsync<
  readonly DirectMessageChannel[],
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

fetchLatestMessages(
    channelIds: readonly string[],
    options?: RequestOptions
): ResultAsync<
    DirectMessageLatestMessages<M>,
    UserOperationFailure | ConfigurationError | CancelledError
>fetchLatestMessages(
  channelIds: readonly string[],
  options?: RequestOptions
): ResultAsync<
  DirectMessageLatestMessages<M>,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

get(id: string): DirectMessageChannel | undefinedget(id: string):
  | DirectMessageChannel
  | undefined

open(userId: string, options?: RequestOptions): ResultAsync<
    DirectMessageChannel,
    UserOperationFailure | ConfigurationError | CancelledError
>open(
  userId: string,
  options?: RequestOptions
): ResultAsync<
  DirectMessageChannel,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

removeRecipient(
    id: string,
    userId: string,
    options?: RequestOptions
): ResultAsync<
    void,
    UserOperationFailure | ConfigurationError | CancelledError
>removeRecipient(
  id: string,
  userId: string,
  options?: RequestOptions
): ResultAsync<
  void,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

send(
    userId: string,
    input: string | ReplyInput,
    options?: RequestOptions
): ResultAsync<M, ConfigurationError | SendError | CancelledError>send(
  userId: string,
  input: string | ReplyInput,
  options?: RequestOptions
): ResultAsync<
  M,
  | ConfigurationError | SendError
  | CancelledError
>

export async function notifyUserExample(client, userId) {
    const user = await client.users.fetch(userId)
    if (user.isErr())
        return user
    return client.directMessages.send(user.value.id, { content: `Hello ${user.value.displayName ?? user.value.username}` })
}

import type { Client } from "@neontechspace/fluxerly"
export async function notifyUserExample(client: Client, userId: string) {
    const user = await client.users.fetch(userId)
    if (user.isErr()) return user
    return client.directMessages.send(user.value.id, { content: `Hello ${user.value.displayName ?? user.value.username}` })
}

ProfileBadge#

interface ProfileBadge

accessibleLabel optional#

Screen reader label with the full count, used instead of label when present

string

aspectRatio#

Image width divided by its height, or null for a square badge

number | null

asset#

Image hash served at the instance's static CDN as badges/{asset}.webp, or null for a text badge or one with assetUrl

string | null

assetUrl#

Absolute image URL for a badge without a static image hash, such as a custom badge, or null

string | null

caption#

Short text such as #42: Alt text for a badge with an image, and the shown text for one without

Null when label covers it

string | null

count optional#

How many passes the badge stands for, from 2

The badge art already shows it, so do not draw it again

number

details optional#

Richer tooltip content, absent when label is the whole tooltip

lines

Further tooltip lines, in order

readonly string[]

title

First line of the tooltip, shown under the larger badge art

string

href#

Absolute URL to open when the badge is clicked, or null

string | null

key#

Stable identity, unique within the list

It equals kind for a built-in badge and is custom:{id} for a custom badge

string

kind#

Badge type, such as staff, partner, bug_hunter, operator_pass, visionary, visionary_number, plutonium, custom or premium

Other strings are kinds this SDK version does not know, kept as Fluxer sent them

| "custom"
| string & { … }
| "staff"
| "partner"
| "bug_hunter"
| "operator_pass"
| "visionary"
| "visionary_number"
| "plutonium"
| "premium"

label#

Full description localized for the viewer, for a tooltip, and alt text when caption is null

string

smallAsset optional#

Image hash to use instead of asset at 20 pixels and smaller, when Fluxer supplies one

string

User#

interface User

avatar#

Avatar asset hash, not an image URL, or null when no avatar is supplied

string | null

avatarColor#

Dominant avatar color, or null

number | null

discriminator#

Provider discriminator used with username to distinguish accounts with the same username

string

displayName#

Account-wide name shown instead of username where supported, or null when unset

Fluxer names it global_name

string | null

flags#

Public account flags returned by Fluxer

number

id#

Decimal account ID

string

isBot#

Whether Fluxer identifies this account as a bot

Fluxer names it bot

boolean

isSystem#

Whether Fluxer identifies this account as a system user

Fluxer names it system

boolean

mentionFlags optional#

Account-wide reply mention preference: 0 for none, 1 to prefer a mention, or 2 to prefer no mention

Absent when Fluxer omits it, which means no preference, and when Fluxer sends a value this SDK version does not know, so a new preference never fails the read. This is descriptive only, and sending and replying keep using explicit AllowedMentions

0 | 2 | 1

username#

Account username, not unique by itself

string

UserProfile#

interface UserProfile

guildProfile#

Explicit community-context profile fields, or null when Fluxer did not supply them

Null does not establish membership

UserProfileFields | null

isLimited#

Whether Fluxer limited this read by profile privacy

Its omitted unrestricted marker becomes false

boolean

profile#

Account-wide profile fields the SDK includes

UserProfileFields

profileBadges optional#

Public badges in Fluxer's display order, when supplied by the instance

Fluxer applies profile visibility before returning this list, and an empty list means there is nothing to show

readonly ProfileBadge[]

user#

Public account identity returned with this profile, without updating the cache

Fluxer's guild_member field, sent for a read with guildId, is checked against the requested account and community and then left out, because this result does not decode community members. Use members.fetch for the member, or a raw client.rest.request GET of /users/{user_id}/profile with query guild_id for Fluxer's complete body

User

UserProfileFields#

interface UserProfileFields

accentColor#

Packed profile accent color, or null

number | null

banner#

Banner hash, or null when absent or withheld by Fluxer

string | null

bannerColor optional#

Account-profile banner color when Fluxer supplies it

Community-specific profiles do not supply this field

number | null

bio#

Biography, null when absent or hidden by profile privacy

string | null

pronouns#

Pronouns, null when absent or hidden by profile privacy

string | null

UserProfileQuery#

interface UserProfileQuery

guildId optional#

Decimal guild ID whose profile settings to include when Fluxer supplies them

string

Users#

interface Users

fetch(id: string, options?: RequestOptions): ResultAsync<
    User,
    UserOperationFailure | ConfigurationError | CancelledError
>fetch(
  id: string,
  options?: RequestOptions
): ResultAsync<
  User,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

fetchProfile(
    id: string,
    query?: UserProfileQuery,
    options?: RequestOptions
): ResultAsync<
    UserProfile,
    UserOperationFailure | ConfigurationError | CancelledError
>fetchProfile(
  id: string,
  query?: UserProfileQuery,
  options?: RequestOptions
): ResultAsync<
  UserProfile,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

export function profileExample(client, userId, guildId) {
    return client.users.fetchProfile(userId, { guildId })
}

import type { Client } from "@neontechspace/fluxerly"
export function profileExample(client: Client, userId: string, guildId: string) {
    return client.users.fetchProfile(userId, { guildId })
}

fetchSelf(options?: RequestOptions): ResultAsync<
    User,
    UserOperationFailure | ConfigurationError | CancelledError
>fetchSelf(
  options?: RequestOptions
): ResultAsync<
  User,
  | UserOperationFailure
  | ConfigurationError
  | CancelledError
>

get(id: string): User | undefined

getSelf(): User | undefined