[CHA-1558] support ext custom header #230
Merged
+19
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Submit a pull request
CLA
Description of the pull request
Summary
Adds support for configuring the
x-stream-extheader in the Stream Chat Java SDK. This header allows clients to pass additional metadata (such as device information, app version, etc.) that will be included in therequest_info.extfield for webhooks and other backend processing.What Changed
X_STREAM_EXT_PROP_NAMEconstant for the configuration propertyextendProperties()method to readx-stream-extvalue from environment variables or system propertiesgetXStreamExt()helper method to retrieve the configured valuebuildOkHttpClient()to include theX-Stream-Extheader in all requests when configuredWhy
This feature aligns the Java SDK with other Stream Chat SDKs (JavaScript, Flutter, Python) that already support the
x-stream-extheader. The backend expects this header and includes it in therequest_info.extfield, which is useful for:Usage
The
x-stream-extheader can be configured in three ways:**1. Via Properties object:**va
var properties = new Properties();
properties.put(DefaultClient.API_KEY_PROP_NAME, "");
properties.put(DefaultClient.API_SECRET_PROP_NAME, "");
properties.put(DefaultClient.X_STREAM_EXT_PROP_NAME, "device-id=123");
var client = new DefaultClient(properties);
DefaultClient.setInstance(client);