Class Client

Hierarchy

EventEmitter<ClientEvents>
- Client

Constructors

constructor

new Client(options?: Partial<ClientOptions>): Client
Parameters
- Optional options: Partial<ClientOptions>
Returns Client
Overrides EventEmitter<ClientEvents>.constructor
- Defined in core/src/Client.ts:122

Properties

api

api: API

channels

channels: ChannelManager

config

config: {
    app: string;
    build: {
        commit_sha: string;
        commit_timestamp: string;
        origin_url: string;
        semver: string;
        timestamp: string;
    };
    features: {
        autumn: {
            enabled: boolean;
            url: string;
        };
        captcha: {
            enabled: boolean;
            key: string;
        };
        email: boolean;
        invite_only: boolean;
        january: {
            enabled: boolean;
            url: string;
        };
        voso: {
            enabled: boolean;
            url: string;
            ws: string;
        };
    };
    revolt: string;
    vapid: string;
    ws: string;
}

Type declaration

app: string

Description
URL pointing to the client serving this node
build: {
    commit_sha: string;
    commit_timestamp: string;
    origin_url: string;
    semver: string;
    timestamp: string;
}

Description
Build information
- commit_sha: string
  
  Description
  Commit Hash
- commit_timestamp: string
  
  Description
  Commit Timestamp
- origin_url: string
  
  Description
  Git Origin URL
- semver: string
  
  Description
  Git Semver
- timestamp: string
  
  Description
  Build Timestamp
features: {
    autumn: {
        enabled: boolean;
        url: string;
    };
    captcha: {
        enabled: boolean;
        key: string;
    };
    email: boolean;
    invite_only: boolean;
    january: {
        enabled: boolean;
        url: string;
    };
    voso: {
        enabled: boolean;
        url: string;
        ws: string;
    };
}

Description
Features enabled on this Revolt node
- autumn: {
  enabled: boolean;
  url: string;
  }
  
  Description
  File server service configuration
  - enabled: boolean
    
    Description
    Whether the service is enabled
  - url: string
    
    Description
    URL pointing to the service
- captcha: {
  enabled: boolean;
  key: string;
  }
  
  Description
  hCaptcha configuration
  - enabled: boolean
    
    Description
    Whether captcha is enabled
  - key: string
    
    Description
    Client key used for solving captcha
- email: boolean
  
  Description
  Whether email verification is enabled
- invite_only: boolean
  
  Description
  Whether this server is invite only
- january: {
  enabled: boolean;
  url: string;
  }
  
  Description
  Proxy service configuration
  - enabled: boolean
    
    Description
    Whether the service is enabled
  - url: string
    
    Description
    URL pointing to the service
- voso: {
      enabled: boolean;
      url: string;
      ws: string;
  }
  
  Description
  Voice server configuration
  - enabled: boolean
    
    Description
    Whether voice is enabled
  - url: string
    
    Description
    URL pointing to the voice API
  - ws: string
    
    Description
    URL pointing to the voice WebSocket server
revolt: string

Description
Revolt API Version
vapid: string

Description
Web Push VAPID public key
ws: string

Description
WebSocket URL

`Static` prefixed

prefixed: string | boolean

Accessors

mfa

get mfa(): {
    allowedMethods(): Promise<("Password" | "Recovery" | "Totp")[]>;
    disableTOTP(ticketToken: string): Promise<void>;
    enableTOTP(ticketToken: string, totp_code: string): Promise<undefined>;
    fetchRecoveryCodes(ticketToken: string): Promise<string[]>;
    generateRecoveryCodes(ticketToken: string): Promise<string[]>;
    generateTOTPSecret(ticketToken: string): Promise<string>;
    generateTicket(code: {
        password: string;
    } | {
        recovery_code: string;
    } | {
        totp_code: string;
    }): Promise<{
        accountID: string;
        authorized: boolean;
        id: string;
        lastTOTPCode: string;
        token: string;
        validated: boolean;
    }>;
    status(): Promise<{
        hasRecovery: boolean;
    }>;
}
Returns {
    allowedMethods(): Promise<("Password" | "Recovery" | "Totp")[]>;
    disableTOTP(ticketToken: string): Promise<void>;
    enableTOTP(ticketToken: string, totp_code: string): Promise<undefined>;
    fetchRecoveryCodes(ticketToken: string): Promise<string[]>;
    generateRecoveryCodes(ticketToken: string): Promise<string[]>;
    generateTOTPSecret(ticketToken: string): Promise<string>;
    generateTicket(code: {
        password: string;
    } | {
        recovery_code: string;
    } | {
        totp_code: string;
    }): Promise<{
        accountID: string;
        authorized: boolean;
        id: string;
        lastTOTPCode: string;
        token: string;
        validated: boolean;
    }>;
    status(): Promise<{
        hasRecovery: boolean;
    }>;
}
- allowedMethods:function
  - allowedMethods(): Promise<("Password" | "Recovery" | "Totp")[]>
  - Allowed ticket methods for account.
    
    Returns Promise<("Password" | "Recovery" | "Totp")[]>
    - Defined in core/src/Client.ts:292
- disableTOTP:function
  - disableTOTP(ticketToken: string): Promise<void>
  - Disable TOTP.
    Parameters
    - ticketToken: string
    Returns Promise<void>
    - Defined in core/src/Client.ts:317
- enableTOTP:function
  - enableTOTP(ticketToken: string, totp_code: string): Promise<undefined>
  - Enable TOTP with the code from MFA app.
    Parameters
    - ticketToken: string
    - totp_code: string
    Returns Promise<undefined>
    - Defined in core/src/Client.ts:313
- fetchRecoveryCodes:function
  - fetchRecoveryCodes(ticketToken: string): Promise<string[]>
  - Fetch recovery codes. (or generate/enable them if not enabled)
    Parameters
    - ticketToken: string
    Returns Promise<string[]>
    - Defined in core/src/Client.ts:321
- generateRecoveryCodes:function
  - generateRecoveryCodes(ticketToken: string): Promise<string[]>
  - Generate new recovery codes.
    Parameters
    - ticketToken: string
    Returns Promise<string[]>
    - Defined in core/src/Client.ts:328
- generateTOTPSecret:function
  - generateTOTPSecret(ticketToken: string): Promise<string>
  - Generate the TOTP secret for MFA app.
    Parameters
    - ticketToken: string
    Returns Promise<string>
    - Defined in core/src/Client.ts:308
- generateTicket:function
  - generateTicket(code: {
        password: string;
    } | {
        recovery_code: string;
    } | {
        totp_code: string;
    }): Promise<{
        accountID: string;
        authorized: boolean;
        id: string;
        lastTOTPCode: string;
        token: string;
        validated: boolean;
    }>
  - Generate an MFA ticket for later use.
    Parameters
    - code: {
          password: string;
      } | {
          recovery_code: string;
      } | {
          totp_code: string;
      }
    Returns Promise<{
        accountID: string;
        authorized: boolean;
        id: string;
        lastTOTPCode: string;
        token: string;
        validated: boolean;
    }>
    - Defined in core/src/Client.ts:296
- status:function
  - status(): Promise<{
    hasRecovery: boolean;
    }>
  - MFA status.
    
    Returns Promise<{
    hasRecovery: boolean;
    }>
    - Defined in core/src/Client.ts:285
- Defined in core/src/Client.ts:274

user

get user(): User
Returns User
- Defined in core/src/Client.ts:118

Methods

acceptInvite

acceptInvite(invite: string | ServerInvite | GlobalInvite): Promise<GroupDMChannel | Server>
Accept an invite. (Group DMs not supported yet)
Parameters
- invite: string | ServerInvite | GlobalInvite
Returns Promise<GroupDMChannel | Server>
- Defined in core/src/Client.ts:179

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void), context?: any): Client
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)
  - - (...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.addListener
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

authenticate

authenticate(details: {
    email: string;
    friendly_name?: string;
    password: string;
} | {
    friendly_name?: string;
    mfa_response?: {
        password: string;
    } | {
        recovery_code: string;
    } | {
        totp_code: string;
    };
    mfa_ticket: string;
}): Promise<{
    type: "none";
} | {
    type: "onboard";
    respond(username: string, loginAfterSuccess: boolean): Promise<void>;
} | {
    methods: ("Password" | "Recovery" | "Totp")[];
    ticket: string;
    type: "mfa";
    respond(totp_code: string): Promise<{
        type: "none";
    } | {
        type: "onboard";
        respond(username: string, loginAfterSuccess: boolean): Promise<void>;
    } | ({ type: "mfa"; ticket: string; methods: ("Password" | "Recovery" | "Totp")[]; respond(totp_code: string): Promise<{ type: "none"; } | { type: "onboard"; respond(username: string, loginAfterSuccess: boolean): Promise<...>; } | ...>; })>;
}>
Log in with a username and password.

Returns
Returns a response being one of none, onboard, or mfa. Onboarding and MFA both require a response.
Parameters
- details: {
      email: string;
      friendly_name?: string;
      password: string;
  } | {
      friendly_name?: string;
      mfa_response?: {
          password: string;
      } | {
          recovery_code: string;
      } | {
          totp_code: string;
      };
      mfa_ticket: string;
  }
Returns Promise<{
    type: "none";
} | {
    type: "onboard";
    respond(username: string, loginAfterSuccess: boolean): Promise<void>;
} | {
    methods: ("Password" | "Recovery" | "Totp")[];
    ticket: string;
    type: "mfa";
    respond(totp_code: string): Promise<{
        type: "none";
    } | {
        type: "onboard";
        respond(username: string, loginAfterSuccess: boolean): Promise<void>;
    } | ({ type: "mfa"; ticket: string; methods: ("Password" | "Recovery" | "Totp")[]; respond(totp_code: string): Promise<{ type: "none"; } | { type: "onboard"; respond(username: string, loginAfterSuccess: boolean): Promise<...>; } | ...>; })>;
}>
- Defined in core/src/Client.ts:227

changeUsername

changeUsername(details: {
password: string;
username: string;
}): Promise<User>
Change the client User's username.
Parameters
- details: {
  password: string;
  username: string;
  }
  - password: string
    
    Description
    Current account password
  - username: string
    
    Description
    New username
Returns Promise<User>
- Defined in core/src/Client.ts:169

createGroup

createGroup(data: {
    description?: string;
    name: string;
    nsfw?: boolean;
    users: string[];
}): Promise<Channel>
Create a new group.
Parameters
- data: {
      description?: string;
      name: string;
      nsfw?: boolean;
      users: string[];
  }
  - Optional description?: string
    
    Description
    Group description
  - name: string
    
    Description
    Group name
  - Optional nsfw?: boolean
    
    Description
    Whether this group is age-restricted
  - users: string[]
    
    Description
    Array of user IDs to add to the group
    
    Must be friends with these users.
Returns Promise<Channel>
- Defined in core/src/Client.ts:160

createServer

createServer(data: {
    description?: string;
    name: string;
    nsfw?: boolean;
}): Promise<Server>
Create a new server.
Parameters
- data: {
      description?: string;
      name: string;
      nsfw?: boolean;
  }
  - Optional description?: string
    
    Description
    Server description
  - name: string
    
    Description
    Server name
  - Optional nsfw?: boolean
    
    Description
    Whether this server is age-restricted
Returns Promise<Server>
- Defined in core/src/Client.ts:155

destroy

destroy(destroySession?: boolean): Promise<void>
Parameters
- destroySession: boolean = false
Returns Promise<void>
- Defined in core/src/Client.ts:377

editUser

editUser(details: {
    avatar?: string;
    badges?: number;
    display_name?: string;
    flags?: number;
    profile?: {
        background?: string;
        content?: string;
    };
    remove?: ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[];
    status?: {
        presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: string;
    };
}): Promise<User>
Edit the client User's profile information.
Parameters
- details: {
      avatar?: string;
      badges?: number;
      display_name?: string;
      flags?: number;
      profile?: {
          background?: string;
          content?: string;
      };
      remove?: ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[];
      status?: {
          presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
          text?: string;
      };
  }
  - Optional avatar?: string
    
    Description
    Attachment Id for avatar
  - Optional badges?: number
    
    Format: int32
    
    Description
    Bitfield of user badges
  - Optional display_name?: string
    
    Description
    New display name
  - Optional flags?: number
    
    Format: int32
    
    Description
    Enum of user flags
  - Optional profile?: {
    background?: string;
    content?: string;
    }
    
    Description
    New user profile data
    
    This is applied as a partial.
    - Optional background?: string
      
      Description
      Attachment Id for background
    - Optional content?: string
      
      Description
      Text to set as user profile description
  - Optional remove?: ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[]
    
    Description
    Fields to remove from user object
  - Optional status?: {
    presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
    text?: string;
    }
    
    Description
    New user status
    - Optional presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
      
      Description
      Current presence option
    - Optional text?: string
      
      Description
      Custom status text
Returns Promise<User>
- Defined in core/src/Client.ts:165

emit

emit<T>(event: T, ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof ClientEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ClientEvents)[]
Inherited from EventEmitter.eventNames
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

fetchAutumnConfiguration

fetchAutumnConfiguration(): Promise<AutumnConfig>
Returns Promise<AutumnConfig>
- Defined in core/src/Client.ts:355

fetchConfiguration

fetchConfiguration(force?: boolean): Promise<void>
Parameters
- force: boolean = false
Returns Promise<void>
- Defined in core/src/Client.ts:352

fetchInvite

fetchInvite(code: string): Promise<GlobalInvite>
Fetch an existing invite.
Parameters
- code: string
Returns Promise<GlobalInvite>
- Defined in core/src/Client.ts:174

fetchJanuaryConfiguration

fetchJanuaryConfiguration(): Promise<JanuaryConfig>
Returns Promise<JanuaryConfig>
- Defined in core/src/Client.ts:360

fetchVortexConfiguration

fetchVortexConfiguration(): Promise<VortexConfig>
Returns Promise<VortexConfig>
- Defined in core/src/Client.ts:365

listenerCount

listenerCount(event: keyof ClientEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ClientEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:20

login

login(token: string, type: "user" | "bot", connect?: boolean, details?: Partial<Omit<Omit<ClientSession, "token">, "type">>): Promise<void>
Log in using an existing session or bot token.
Parameters
- token: string
- type: "user" | "bot"
- connect: boolean = true
- Optional details: Partial<Omit<Omit<ClientSession, "token">, "type">>
Returns Promise<void>
- Defined in core/src/Client.ts:207

off

off<T>(event: T, fn?: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void), context?: any, once?: boolean): Client
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)
  - - (...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Client
Inherited from EventEmitter.off
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void), context?: any): Client
Add a listener for a given event.
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)
  - - (...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.on
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void), context?: any): Client
Add a one-time listener for a given event.
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)
  - - (...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
      
      Returns void
- Optional context: any
Returns Client
Inherited from EventEmitter.once
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:54

proxyFile

proxyFile(url: string): string
Proxies a file URL through january. (if enabled)
Parameters
- url: string
Returns string
- Defined in core/src/Client.ts:148

removeAllListeners

removeAllListeners(event?: keyof ClientEvents): Client
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof ClientEvents
Returns Client
Inherited from EventEmitter.removeAllListeners
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void), context?: any, once?: boolean): Client
Remove the listeners of a given event.
Type Parameters
- T extends keyof ClientEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]) => void)
  - - (...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Client
Inherited from EventEmitter.removeListener
- Defined in core/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

setup

setup(): void
Returns void
- Defined in core/src/Client.ts:370

syncFetchSettings

syncFetchSettings(keys: string[]): Promise<{
[key: string]: [number, string];
}>
Compatibility layer. Do not use in prod.
Parameters
- keys: string[]
Returns Promise<{
[key: string]: [number, string];
}>
- Defined in core/src/Client.ts:336

syncSetSettings

syncSetSettings(data: {
[key: string]: object | string;
}, timestamp?: number): Promise<void>
Compatibility layer. Do not use in prod.
Parameters
- data: {
  [key: string]: object | string;
  }
  - [key: string]: object | string
- Optional timestamp: number
Returns Promise<void>
- Defined in core/src/Client.ts:340

uploadAttachment

uploadAttachment(filename: string, data: Buffer | Blob, type?: AttachmentBucket): Promise<string>
Upload an attachment to Autumn.
Parameters
- filename: string
- data: Buffer | Blob
- type: AttachmentBucket = "attachments"
Returns Promise<string>
- Defined in core/src/Client.ts:132

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: Partial<ClientOptions>

Returns Client

Properties

api

channels

config

Type declaration

app: string

Description

build: { commit_sha: string; commit_timestamp: string; origin_url: string; semver: string; timestamp: string; }

Description

commit_sha: string

Description

commit_timestamp: string

Description

origin_url: string

Description

semver: string

Description

timestamp: string

Description

features: { autumn: { enabled: boolean; url: string; }; captcha: { enabled: boolean; key: string; }; email: boolean; invite_only: boolean; january: { enabled: boolean; url: string; }; voso: { enabled: boolean; url: string; ws: string; }; }

Description

autumn: { enabled: boolean; url: string; }

Description

enabled: boolean

Description

url: string

Description

captcha: { enabled: boolean; key: string; }

Description

enabled: boolean

Description

key: string

Description

email: boolean

Description

invite_only: boolean

Description

january: { enabled: boolean; url: string; }

Description

enabled: boolean

Description

url: string

Description

voso: { enabled: boolean; url: string; ws: string; }

Description

enabled: boolean

Description

url: string

Description

ws: string

Description

revolt: string

Description

vapid: string

Description

ws: string

Description

emojis

options

servers

session

unreads

users

ws

Static prefixed

Accessors

mfa

allowedMethods:function

`Optional` options: Partial<ClientOptions>

build: {
commit_sha: string;
commit_timestamp: string;
origin_url: string;
semver: string;
timestamp: string;
}

features: {
autumn: {
enabled: boolean;
url: string;
};
captcha: {
enabled: boolean;
key: string;
};
email: boolean;
invite_only: boolean;
january: {
enabled: boolean;
url: string;
};
voso: {
enabled: boolean;
url: string;
ws: string;
};
}

autumn: {
enabled: boolean;
url: string;
}

captcha: {
enabled: boolean;
key: string;
}

january: {
enabled: boolean;
url: string;
}

voso: {
enabled: boolean;
url: string;
ws: string;
}

`Static` prefixed

code: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
}

Returns Promise<{
accountID: string;
authorized: boolean;
id: string;
lastTOTPCode: string;
token: string;
validated: boolean;
}>

Returns Promise<{
hasRecovery: boolean;
}>

`Rest` ...args: ArgumentMap<ClientEvents>[Extract<T, keyof ClientEvents>]

`Optional` context: any

details: {
email: string;
friendly_name?: string;
password: string;
} | {
friendly_name?: string;
mfa_response?: {
password: string;
} | {
recovery_code: string;
} | {
totp_code: string;
};
mfa_ticket: string;
}

details: {
password: string;
username: string;
}

data: {
description?: string;
name: string;
nsfw?: boolean;
users: string[];
}

`Optional` description?: string