Docs(unreal): Add blueprint images to unreal documentation

sdk/unreal/advanced-configuration.mdx

@@ -0,0 +1,249 @@
+---
+title: "Advanced Configuration"
+description: "Fine-tune SDK settings, manage connections manually, and query authentication state."
+---
+
+Beyond the basic `Configure` call, the CometChat Unreal SDK offers advanced configuration for custom hosts, manual connection management, and runtime state queries.
+
+---
+
+## ConfigureWithSettings
+
+Use `ConfigureWithSettings` instead of `Configure` when you need control over connection behavior, custom hosts, or presence subscription settings.
+
+<Tabs>
+<Tab title="Blueprint">
+1. Create an `FCometChatAppSettings` struct
+2. Set the desired properties (region, custom hosts, auto-connect behavior)
+3. Call **Configure With Settings** on the CometChat Subsystem with your App ID and the settings struct
+</Tab>
+<Tab title="C++">
+```cpp
+void AMyActor::InitCometChat()
+{
+    UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();
+
+    FCometChatAppSettings Settings;
+    Settings.Region = TEXT("us");
+    Settings.bAutoEstablishSocketConnection = false; // Manual connection mode
+    Settings.SubscriptionType = TEXT("allUsers");
+
+    Chat->ConfigureWithSettings(TEXT("YOUR_APP_ID"), Settings);
+}
+```
+</Tab>
+</Tabs>
+
+### FCometChatAppSettings
+
+| Property | Type | Default | Description |
+| -------- | ---- | ------- | ----------- |
+| `Region` | `FString` | — | App region (`us` or `eu`) |
+| `SubscriptionType` | `FString` | — | Presence subscription type (`allUsers`, `roles`, `friends`) |
+| `Roles` | `TArray<FString>` | — | Roles to subscribe to (when `SubscriptionType` is `roles`) |
+| `AdminHost` | `FString` | — | Custom admin API host URL |
+| `ClientHost` | `FString` | — | Custom client/WebSocket host URL |
+| `bAutoEstablishSocketConnection` | `bool` | `true` | Automatically connect WebSocket on login |
+
+<Info>
+When `bAutoEstablishSocketConnection` is `true` (default), the SDK connects the WebSocket immediately after a successful login. Set to `false` if you want to control when the connection is established — useful for splash screens or loading flows.
+</Info>
+
+---
+
+## Manual Connection Management
+
+When `bAutoEstablishSocketConnection` is `false`, use the async connection nodes to control the WebSocket lifecycle.
+
+### Connect
+
+Manually establish the WebSocket connection after login.
+
+<Tabs>
+<Tab title="Blueprint">
+Call the **Connect Async** node after login succeeds. Handle **On Success** to know the connection is ready.
+</Tab>
+<Tab title="C++">
+```cpp
+void AMyActor::ManualConnect()
+{
+    auto* Action = UCometChatConnectAction::Connect(this);
+    Action->OnSuccess.AddDynamic(this, &AMyActor::HandleConnected);
+    Action->OnFailure.AddDynamic(this, &AMyActor::HandleError);
+    Action->Activate();
+}
+
+void AMyActor::HandleConnected()
+{
+    UE_LOG(LogTemp, Log, TEXT("WebSocket connected — ready to receive events"));
+}
+```
+</Tab>
+</Tabs>
+
+### Disconnect
+
+Manually close the WebSocket connection without logging out.
+
+<Tabs>
+<Tab title="Blueprint">
+Call the **Disconnect Async** node. The user remains authenticated but won't receive real-time events.
+</Tab>
+<Tab title="C++">
+```cpp
+void AMyActor::ManualDisconnect()
+{
+    auto* Action = UCometChatDisconnectAction::Disconnect(this);
+    Action->OnSuccess.AddDynamic(this, &AMyActor::HandleDisconnected);
+    Action->OnFailure.AddDynamic(this, &AMyActor::HandleError);
+    Action->Activate();
+}
+```
+</Tab>
+</Tabs>
+
+### Ping
+
+Verify the connection is alive by sending a ping to the server.
+
+<Tabs>
+<Tab title="Blueprint">
+Call the **Ping Async** node. **On Success** means the server responded — connection is healthy.
+</Tab>
+<Tab title="C++">
+```cpp
+void AMyActor::PingServer()
+{
+    auto* Action = UCometChatPingAction::Ping(this);
+    Action->OnSuccess.AddDynamic(this, &AMyActor::HandlePingSuccess);
+    Action->OnFailure.AddDynamic(this, &AMyActor::HandlePingFailed);
+    Action->Activate();
+}
+```
+</Tab>
+</Tabs>
+
+---
+
+## Connection Status
+
+Query the current WebSocket connection state at any time.
+
+<Tabs>
+<Tab title="Blueprint">
+Call **Get Connection Status** on the CometChat Subsystem. Returns an `ECometChatConnectionState` enum.
+</Tab>
+<Tab title="C++">
+```cpp
+void AMyActor::CheckConnection()
+{
+    UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();
+    ECometChatConnectionState State = Chat->GetConnectionStatus();
+
+    switch (State)
+    {
+    case ECometChatConnectionState::Connected:
+        UE_LOG(LogTemp, Log, TEXT("Connected"));
+        break;
+    case ECometChatConnectionState::Connecting:
+        UE_LOG(LogTemp, Log, TEXT("Connecting..."));
+        break;
+    case ECometChatConnectionState::Disconnected:
+        UE_LOG(LogTemp, Warning, TEXT("Disconnected"));
+        break;
+    case ECometChatConnectionState::FeatureThrottled:
+        UE_LOG(LogTemp, Warning, TEXT("Feature throttled"));
+        break;
+    }
+}
+```
+</Tab>
+</Tabs>
+
+### ECometChatConnectionState
+
+| Value | Description |
+| ----- | ----------- |
+| `Connected` | WebSocket is active and receiving events |
+| `Connecting` | SDK is attempting to establish the connection |
+| `Disconnected` | WebSocket is closed |
+| `FeatureThrottled` | A feature is being rate-limited by the server |
+
+---
+
+## Authentication State
+
+### IsLoggedIn
+
+Check whether a user is currently authenticated.
+
+<Tabs>
+<Tab title="Blueprint">
+Call **Is Logged In** on the CometChat Subsystem. Returns a `bool`.
+</Tab>
+<Tab title="C++">
+```cpp
+bool bLoggedIn = Chat->IsLoggedIn();
+```
+</Tab>
+</Tabs>
+
+### GetLoggedInUser
+
+Retrieve the currently authenticated user's profile.
+
+<Tabs>
+<Tab title="Blueprint">
+<Frame>
+  <img src="/images/unreal-blueprints/GetLoggedInUser.png" />
+</Frame>
+
+Call **Get Logged In User** on the CometChat Subsystem. Returns an `FCometChatUser`.
+</Tab>
+<Tab title="C++">
+```cpp
+FCometChatUser CurrentUser = Chat->GetLoggedInUser();
+UE_LOG(LogTemp, Log, TEXT("Logged in as: %s (%s)"), *CurrentUser.Name, *CurrentUser.Uid);
+```
+</Tab>
+</Tabs>
+
+---
+
+## Connection Flow (Manual Mode)
+
+```mermaid
+flowchart TD
+    A["ConfigureWithSettings<br/>(bAutoEstablishSocketConnection = false)"] --> B["Login Async"]
+    B -->|"On Success"| C["User authenticated<br/>(no WebSocket yet)"]
+    C --> D["Connect Async"]
+    D -->|"On Success"| E["WebSocket active<br/>Real-time events flowing"]
+    E --> F["Disconnect Async"]
+    F -->|"On Success"| G["WebSocket closed<br/>(still authenticated)"]
+    G --> D
+
+    style A fill:#333,stroke:#666,color:#fff
+    style B fill:#444,stroke:#888,color:#fff
+    style C fill:#333,stroke:#666,color:#fff
+    style D fill:#444,stroke:#888,color:#fff
+    style E fill:#333,stroke:#666,color:#fff
+    style F fill:#444,stroke:#888,color:#fff
+    style G fill:#333,stroke:#666,color:#fff
+```
+
+<Tip>
+**When to use manual mode**: If your game has a loading screen or lobby where you don't need real-time events yet, configure with `bAutoEstablishSocketConnection = false`, then call `Connect` when the player enters the chat-enabled area. This saves bandwidth and server resources.
+</Tip>
+
+---
+
+## Next Steps
+
+<CardGroup cols={2}>
+  <Card title="Authentication" icon="lock" href="/sdk/unreal/authentication">
+    Log users in with Auth Key or Auth Token.
+  </Card>
+  <Card title="Real-Time Events" icon="bolt" href="/sdk/unreal/real-time-events">
+    Listen for connection state changes and other events.
+  </Card>
+</CardGroup>

sdk/unreal/authentication.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Authentication"
+title: "Overview"
 description: "Log users in and out of CometChat in your Unreal Engine project."
 ---
 
@@ -41,13 +41,12 @@ flowchart LR
     style F fill:#333,stroke:#666,color:#fff
 ```
 
-The Login node authenticates a user with CometChat. You should call it:
-
-1. When the user is logging in for the first time
-2. When `IsLoggedIn` returns `false`
-
 <Tabs>
 <Tab title="Blueprint">
+<Frame>
+  <img src="/images/unreal-blueprints/ConfigureAndLoginAsync.png" />
+</Frame>
+
 1. Get a reference to the **CometChat Subsystem**
 2. Call the **Login Async** node
 3. Wire the **On Success** and **On Failure** pins
@@ -138,6 +137,10 @@ flowchart LR
 
 <Tabs>
 <Tab title="Blueprint">
+<Frame>
+  <img src="/images/unreal-blueprints/ConfigureAndLoginAuthToken.png" />
+</Frame>
+
 1. Get a reference to the **CometChat Subsystem**
 2. Call the **Login With Auth Token Async** node
 3. Wire the **On Success** and **On Failure** pins
@@ -192,7 +195,11 @@ Before performing operations, you can check whether a user is currently logged i
 
 <Tabs>
 <Tab title="Blueprint">
-Call the **Is Logged In** node on the CometChat Subsystem. It returns a `bool`.
+<Frame>
+  <img src="/images/unreal-blueprints/GetLoggedInUser.png" />
+</Frame>
+
+Call the **Get Logged In User** node on the CometChat Subsystem. It returns an `FCometChatUser` — if the `Uid` is empty, no user is logged in.
 </Tab>
 <Tab title="C++">
 ```cpp
@@ -214,6 +221,10 @@ Logs the current user out and disconnects the real-time WebSocket.
 
 <Tabs>
 <Tab title="Blueprint">
+<Frame>
+  <img src="/images/unreal-blueprints/LogoutAsync.png" />
+</Frame>
+
 Call the **Logout Async** node on the CometChat Subsystem. Wire the **On Success** and **On Failure** pins.
 </Tab>
 <Tab title="C++">
@@ -258,6 +269,9 @@ You typically don't need to call Shutdown manually — the Subsystem's `Deinitia
 ## Next Steps
 
 <CardGroup cols={2}>
+  <Card title="Overview" icon="house" href="/sdk/unreal/overview">
+    Return to the SDK overview and architecture.
+  </Card>
   <Card title="Send a Message" icon="paper-plane" href="/sdk/unreal/send-message">
     Send your first text message after logging in.
   </Card>