Package io.getstream.services.framework

Class StreamSDKClient

java.lang.Object

io.getstream.services.CommonImpl

io.getstream.services.framework.StreamSDKClient

All Implemented Interfaces:

Common

public class StreamSDKClient
extends CommonImpl
implements Common

Constructor Summary

Constructors

Constructor	Description
StreamSDKClient()
StreamSDKClient(StreamHTTPClient httpClient)
StreamSDKClient(String apiKey, String apiSecret)
StreamSDKClient(String apiKey, String apiSecret, StreamClientOptions options)
StreamSDKClient(String apiKey, String apiSecret, okhttp3.OkHttpClient httpClient)
StreamSDKClient(Properties properties)

Method Summary

Modifier and Type	Method	Description
Chat	chat()
Feeds	feeds()
StreamHTTPClient	getHttpClient()
StreamSDKClient	getSDKClient()
Moderation	moderation()
Object	parseSns(String notificationBody)	Decode + parse a Stream-delivered SNS notification body.
Object	parseSqs(String messageBody)	Decode + parse a Stream-delivered SQS message body.
TokenBuilder	tokenBuilder()
Object	verifyAndParseWebhook(byte[] body, String signature)	Verify and parse a webhook payload in one call, using this client's API secret.
boolean	verifySignature(byte[] body, String signature)	Verify a webhook signature using this client's API secret.
Video	video()
GetTaskResponse	waitForTask(String taskId)	Polls getTask(taskId) until the task reaches a terminal status.
GetTaskResponse	waitForTask(String taskId, Duration pollInterval, Duration timeout)	Polls getTask(taskId) until the task reaches a terminal status.

Methods inherited from class io.getstream.services.CommonImpl

addUserGroupMembers, blockUsers, cancelImportV2Task, cancelImportV2Task, checkExternalStorage, checkExternalStorage, checkPush, checkPush, checkSNS, checkSNS, checkSQS, checkSQS, createBlockList, createDevice, createExternalStorage, createGuest, createImport, createImportURL, createImportURL, createImportV2Task, createPermission, createPoll, createPollOption, createRole, createUserGroup, deactivateUser, deactivateUser, deactivateUsers, deleteBlockList, deleteBlockList, deleteDevice, deleteExternalStorage, deleteExternalStorage, deleteFile, deleteFile, deleteImage, deleteImage, deleteImporterExternalStorage, deleteImporterExternalStorage, deleteImportV2Task, deleteImportV2Task, deletePermission, deletePermission, deletePoll, deletePoll, deletePollOption, deletePollOption, deletePushProvider, deletePushProvider, deleteRole, deleteRole, deleteUserGroup, deleteUserGroup, deleteUsers, exportUser, exportUser, exportUsers, getApp, getApp, getBlockedUsers, getBlockedUsers, getBlockList, getBlockList, getImport, getImport, getImporterExternalStorage, getImporterExternalStorage, getImportV2Task, getImportV2Task, getOG, getPermission, getPermission, getPoll, getPoll, getPollOption, getPollOption, getPushTemplates, getRateLimits, getRateLimits, getTask, getTask, getUserGroup, getUserGroup, getUserLiveLocations, getUserLiveLocations, importBlockList, listBlockLists, listBlockLists, listDevices, listDevices, listExternalStorage, listExternalStorage, listImports, listImports, listImportV2Tasks, listImportV2Tasks, listPermissions, listPermissions, listPushProviders, listPushProviders, listRoles, listRoles, listUserGroups, listUserGroups, queryPolls, queryPolls, queryPollVotes, queryPollVotes, queryUsers, queryUsers, reactivateUser, reactivateUser, reactivateUsers, removeUserGroupMembers, restoreUsers, searchRoles, searchUserGroups, unblockUsers, updateApp, updateApp, updateBlockList, updateBlockList, updateExternalStorage, updateLiveLocation, updatePermission, updatePoll, updatePollOption, updatePollPartial, updatePollPartial, updatePushNotificationPreferences, updateUserGroup, updateUserGroup, updateUsers, updateUsersPartial, uploadFile, uploadFile, uploadImage, uploadImage, upsertImporterExternalStorage, upsertPushProvider, upsertPushProvider, upsertPushTemplate, validateImporterExternalStorage, validateImporterExternalStorage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.getstream.services.Common

addUserGroupMembers, blockUsers, cancelImportV2Task, cancelImportV2Task, checkExternalStorage, checkExternalStorage, checkPush, checkPush, checkSNS, checkSNS, checkSQS, checkSQS, createBlockList, createDevice, createExternalStorage, createGuest, createImport, createImportURL, createImportURL, createImportV2Task, createPermission, createPoll, createPollOption, createRole, createUserGroup, deactivateUser, deactivateUser, deactivateUsers, deleteBlockList, deleteBlockList, deleteDevice, deleteExternalStorage, deleteExternalStorage, deleteFile, deleteFile, deleteImage, deleteImage, deleteImporterExternalStorage, deleteImporterExternalStorage, deleteImportV2Task, deleteImportV2Task, deletePermission, deletePermission, deletePoll, deletePoll, deletePollOption, deletePollOption, deletePushProvider, deletePushProvider, deleteRole, deleteRole, deleteUserGroup, deleteUserGroup, deleteUsers, exportUser, exportUser, exportUsers, getApp, getApp, getBlockedUsers, getBlockedUsers, getBlockList, getBlockList, getImport, getImport, getImporterExternalStorage, getImporterExternalStorage, getImportV2Task, getImportV2Task, getOG, getPermission, getPermission, getPoll, getPoll, getPollOption, getPollOption, getPushTemplates, getRateLimits, getRateLimits, getTask, getTask, getUserGroup, getUserGroup, getUserLiveLocations, getUserLiveLocations, importBlockList, listBlockLists, listBlockLists, listDevices, listDevices, listExternalStorage, listExternalStorage, listImports, listImports, listImportV2Tasks, listImportV2Tasks, listPermissions, listPermissions, listPushProviders, listPushProviders, listRoles, listRoles, listUserGroups, listUserGroups, queryPolls, queryPolls, queryPollVotes, queryPollVotes, queryUsers, queryUsers, reactivateUser, reactivateUser, reactivateUsers, removeUserGroupMembers, restoreUsers, searchRoles, searchUserGroups, unblockUsers, updateApp, updateApp, updateBlockList, updateBlockList, updateExternalStorage, updateLiveLocation, updatePermission, updatePoll, updatePollOption, updatePollPartial, updatePollPartial, updatePushNotificationPreferences, updateUserGroup, updateUserGroup, updateUsers, updateUsersPartial, uploadFile, uploadFile, uploadImage, uploadImage, upsertImporterExternalStorage, upsertPushProvider, upsertPushProvider, upsertPushTemplate, validateImporterExternalStorage, validateImporterExternalStorage

Constructor Details

StreamSDKClient

public StreamSDKClient(@NotNull
 String apiKey,
 @NotNull
 String apiSecret)

StreamSDKClient

public StreamSDKClient(@NotNull
 String apiKey,
 @NotNull
 String apiSecret,
 @NotNull
 StreamClientOptions options)

StreamSDKClient

public StreamSDKClient()

StreamSDKClient

public StreamSDKClient(Properties properties)

StreamSDKClient

public StreamSDKClient(@NotNull
 String apiKey,
 @NotNull
 String apiSecret,
 @NotNull
 okhttp3.OkHttpClient httpClient)

StreamSDKClient

public StreamSDKClient(StreamHTTPClient httpClient)

Method Details

video

public Video video()

getHttpClient

public StreamHTTPClient getHttpClient()

chat

public Chat chat()

feeds

public Feeds feeds()

moderation

public Moderation moderation()

tokenBuilder

public TokenBuilder tokenBuilder()

getSDKClient

public StreamSDKClient getSDKClient()

Specified by:

getSDKClient in interface Common

verifySignature

public boolean verifySignature(byte[] body,
 String signature)

Verify a webhook signature using this client's API secret.

Convenience wrapper around Webhook.verifySignature(byte[], String, String).

Parameters:

body - the raw HTTP request body bytes

signature - the value of the X-Signature header

Returns:

true if the signature matches

verifyAndParseWebhook

public Object verifyAndParseWebhook(byte[] body,
 String signature)
                             throws Webhook.InvalidWebhookError

Verify and parse a webhook payload in one call, using this client's API secret.

Handles gzip-compressed bodies transparently via magic-byte detection. Throws Webhook.InvalidWebhookError on signature mismatch or parse failures.

Parameters:

body - the raw HTTP request body bytes (possibly gzip-compressed)

signature - the value of the X-Signature header

Returns:

the parsed event (typed event or Webhook.UnknownEvent)

Throws:

Webhook.InvalidWebhookError

parseSqs

public Object parseSqs(String messageBody)
                throws Webhook.InvalidWebhookError

Decode + parse a Stream-delivered SQS message body.

Convenience wrapper around Webhook.parseSqs(String). No signature is required; SQS deliveries are authenticated via AWS IAM.

Parameters:

messageBody - the SQS message body string

Returns:

the parsed event (typed event or Webhook.UnknownEvent)

Throws:

Webhook.InvalidWebhookError

parseSns

public Object parseSns(String notificationBody)
                throws Webhook.InvalidWebhookError

Decode + parse a Stream-delivered SNS notification body.

Accepts either the raw SNS HTTP envelope JSON or the pre-extracted Message string. Convenience wrapper around Webhook.parseSns(String). No signature is required; SNS deliveries are authenticated via AWS IAM.

Parameters:

notificationBody - the SNS notification body (envelope JSON or extracted Message)

Returns:

the parsed event (typed event or Webhook.UnknownEvent)

Throws:

Webhook.InvalidWebhookError

waitForTask

@NotNull
public GetTaskResponse waitForTask(@NotNull
 String taskId)
                            throws StreamException

Polls getTask(taskId) until the task reaches a terminal status. Uses a 1-second poll interval and a 60-second timeout.

Returns:

the terminal GetTaskResponse when status == "completed"

Throws:

StreamTaskException - if the task ends with status == "failed"

StreamTransportException - with errorType == "timeout" if the wait elapses

StreamException - for any other underlying transport / API failure

waitForTask

@NotNull
public GetTaskResponse waitForTask(@NotNull
 String taskId,
 @NotNull
 Duration pollInterval,
 @NotNull
 Duration timeout)
                            throws StreamException

Polls getTask(taskId) until the task reaches a terminal status.

Parameters:

taskId - the task identifier returned by the operation that enqueued the task

pollInterval - delay between polls; clamped to a non-negative value

timeout - max total wait; the timeout window starts before the first poll

Throws:

StreamTaskException - if the task ends with status == "failed"

StreamTransportException - with errorType == "timeout" if the wait elapses

StreamException - for any other underlying transport / API failure