Preparing search index...
The search index is not available
eludris-api-types - v
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
eludris-api-types
v0.4.0-alpha1
StatusTypeOffline
Interface StatusTypeOffline
Hierarchy
StatusTypeOffline
eludris-
api-
types
v0.3.3
Conflict
The error when a client's request causes a conflict, usually when they're trying to create
Effis
Rate
Limit
Conf
Represents a single rate limit for Effis.
Effis
Rate
Limits
Rate limits that apply to Effis (The CDN).
File
Data
Represents a file stored on Effis.
File
Upload
The data format for uploading a file.
Forbidden
The error when a client *has* been succesfully authorized but does not have the required
Hello
The payload sent by the server when you initiate a new gateway connection.
Image
Instance
Info
Represents information about the connected Eludris instance.
Instance
Rate
Limits
Represents all rate limits that apply to the connected Eludris instance.
Message
The message payload.
Message
Create
The event sent when the client receives a Message.
Not
Found
The error when a client requests a resource that does not exist.
Oprish
Rate
Limits
Rate limits that apply to Oprish (The REST API).
Other
Ping
The payload the client is supposed to periodically send the server to not get disconnected.
Pong
A ClientPayload `PING` payload response.
Rate
Limit
The event sent when the client gets gateway rate limited.
Rate
Limit
Conf
Represents a single rate limit.
Rate
Limited
The error when a client is rate limited.
Server
The error when the server fails to process a request.
Session
The session payload.
Session
Create
The SessionCreate payload.
Session
Created
The response to a SessionCreate.
Shared
Error
Data
Shared fields between all error response variants.
Text
Unauthorized
The error when the client is missing authorization. This error often occurs when the user
User
The user payload.
User
Create
The UserCreate payload.
Validation
The error when a request a client sends is incorrect and fails validation.
Video
Client
Payload
Error
Response
File
Metadata
Server
Payload
v0.4.0-
alpha1
Client
Payload
Authenticate
The first payload the client is supposed to send. The data of this payload is expected to
Client
Payload
Ping
The payload the client is supposed to periodically send the server to not get disconnected.
Create
Password
Reset
Code
The CreatePasswordResetCode payload. This is used when a user wants to generate a code
Effis
Rate
Limit
Conf
Represents a single rate limit for Effis.
Effis
Rate
Limits
Rate limits that apply to Effis (The CDN).
Error
Response
Conflict
The error when a client's request causes a conflict, usually when they're trying to create
Error
Response
Forbidden
The error when a client *has* been succesfully authorized but does not have the required
Error
Response
Misdirected
The error when a server isn't able to reduce a response even though the client's request
Error
Response
Not
Found
The error when a client requests a resource that does not exist.
Error
Response
Rate
Limited
The error when a client is rate limited.
Error
Response
Server
The error when the server fails to process a request.
Error
Response
Unauthorized
The error when the client is missing authorization. This error often occurs when the user
Error
Response
Validation
The error when a request a client sends is incorrect and fails validation.
File
Data
Represents a file stored on Effis.
File
Metadata
Image
File
Metadata
Other
File
Metadata
Text
File
Metadata
Video
File
Upload
The data format for uploading a file.
Instance
Info
Represents information about the connected Eludris instance.
Instance
Rate
Limits
Represents all rate limits that apply to the connected Eludris instance.
Message
The Message payload. This is returned when you're provided information about a pre-existing
Message
Create
The MessageCreate payload. This is used when you want to create a message using the REST API.
Message
Disguise
A temporary way to mask the message's author's name and avatar. This is mainly used for
Oprish
Rate
Limits
Rate limits that apply to Oprish (The REST API).
Password
Delete
Credentials
The DeleteCredentials payload. This is used in multiple places in the API to provide extra
Rate
Limit
Conf
Represents a single rate limit.
Reset
Password
The ResetPassword payload. This is used when the user wants to reset their password using a
Server
Payload
Authenticated
The payload sent when the client has successfully authenticated. This contains the data the
Server
Payload
Hello
The payload sent by the server when you initiate a new gateway connection.
Server
Payload
Message
Create
The payload sent when the client receives a Message.
Server
Payload
Pong
A ClientPayload `PING` payload response.
Server
Payload
Presence
Update
The payload sent when a user's presence is updated.
Server
Payload
Rate
Limit
The payload sent when the client gets gateway rate limited.
Server
Payload
User
Update
The payload received when a user updates themselves. This includes both user updates from
Session
The session payload.
Session
Create
The SessionCreate payload.
Session
Created
The response to a SessionCreate.
Shared
Error
Data
Shared fields between all error response variants.
Status
A user's status.
Status
Type
Busy
Status
Type
Idle
Status
Type
Offline
Status
Type
Online
Update
User
The UpdateUser payload. Any field set to `null`, `undefined` or is missing will be disregarded
Update
User
Profile
The UpdateUserProfile payload. This payload is used to update a user's profile. The abscence of a
User
The user payload.
User
Create
The UserCreate payload.
Client
Payload
Error
Response
File
Metadata
Server
Payload
Status
Type