Interface ServerPayloadHello

Hierarchy

  • ServerPayloadHello

Properties

d op

Properties

d

d: {
    heartbeat_interval: number;
    instance_info: InstanceInfo;
    rate_limit: RateLimitConf;
}

Type declaration

  • heartbeat_interval: number

    The amount of milliseconds your ping interval is supposed to be.

  • instance_info: InstanceInfo

    The instance's info.

    This is the same payload you get from the [get_instance_info] payload without ratelimits

  • rate_limit: RateLimitConf

    The pandemonium ratelimit info.

op

op: "HELLO"

The payload sent by the server when you initiate a new gateway connection.

Example

{
  "op": "HELLO",
  "d": {
    "heartbeat_interval": 45000,
    "instance_info": {
      "instance_name": "EmreLand",
      "description": "More based than Oliver's instance (trust)",
      "version": "0.3.3",
      "message_limit": 2048,
      "oprish_url": "https://example.com",
      "pandemonium_url": "https://example.com",
      "effis_url": "https://example.com",
      "file_size": 20000000,
      "attachment_file_size": 100000000
    },
    "rate_limit": {
      "reset_after": 10,
      "limit": 5
    }
  }
}

On This Page