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.3.3
Video
Interface Video
Hierarchy
Video
Index
Properties
height?
type
width?
Properties
Optional
height
height
?:
null
|
number
The video's height in pixels.
type
type
:
"Video"
Optional
width
width
?:
null
|
number
The video's width in pixels.
On This Page
height
type
width
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
Client
Payload
Ping
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
Shared fields between all error response variants.
Error
Response
Forbidden
Shared fields between all error response variants.
Error
Response
Misdirected
Shared fields between all error response variants.
Error
Response
Not
Found
Shared fields between all error response variants.
Error
Response
Rate
Limited
Shared fields between all error response variants.
Error
Response
Server
Shared fields between all error response variants.
Error
Response
Unauthorized
Shared fields between all error response variants.
Error
Response
Validation
Shared fields between all error response variants.
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
Server
Payload
Hello
Server
Payload
Message
Create
Server
Payload
Pong
Server
Payload
Presence
Update
Server
Payload
Rate
Limit
Server
Payload
User
Update
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.
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
Pandemonium websocket payloads sent by the client to the server.
Error
Response
All the possible error responses that are returned from Eludris HTTP microservices.
File
Metadata
The enum representing all the possible Effis supported file metadatas.
Server
Payload
Pandemonium websocket payloads sent by the server to the client.
Status
Type
The type of a user's status.
ROUTES
The video's height in pixels.