FHealthCheckEvent Struct Reference

Sent periodically from the API to indicate a healthy connection. More...

#include <HealthCheckEvent.h>

Inheritance diagram for FHealthCheckEvent:

Static Public Member Functions
static FName	StaticType ()

Public Attributes
FString	ConnectionId
	Identifies this WebSocket connection. Required on every API call made while it is open.
FOwnUserDto	Me
FString	Cid
Public Attributes inherited from FChatEvent
FName	Type
	Event type.
FDateTime	CreatedAt = FDateTime{0}

Additional Inherited Members
Public Member Functions inherited from FChatEvent
	FChatEvent (const FName &Type, const FDateTime &CreatedAt)

Detailed Description

Sent periodically from the API to indicate a healthy connection.

See also

https://getstream.io/chat/docs/events/#health.check

Member Data Documentation

Cid

FString FHealthCheckEvent::Cid

Channel CID (<type>:<id>) for a watched channel's health check, or * for the connection-wide one, which is what the periodic keep-alive reply carries.

Me

FOwnUserDto FHealthCheckEvent::Me

The connected user. Only sent on the first health check of a connection, which is what makes that one the signal that the connection is established.

---

The documentation for this struct was generated from the following file:

• Source/Backend/StreamChatWebSocket/Public/Event/Client/HealthCheckEvent.h