Interface ClientSecretService
-
- All Implemented Interfaces:
public interface ClientSecretService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceClientSecretService.WithRawResponseA view of ClientSecretService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract ClientSecretService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract ClientSecretServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. ClientSecretCreateResponsecreate()Create a Realtime client secret with an associated session configuration. abstract ClientSecretCreateResponsecreate(ClientSecretCreateParams params, RequestOptions requestOptions)ClientSecretCreateResponsecreate(ClientSecretCreateParams params)ClientSecretCreateResponsecreate(RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract ClientSecretService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract ClientSecretService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
ClientSecretCreateResponse create()
Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main API key. You can configure a custom TTL for each client secret.
You can also attach session configuration options to the client secret, which will be applied to any sessions created using that client secret, but these can also be overridden by the client connection.
Learn more about authentication with client secrets over * WebRTC.
Returns the created client secret and the effective session object. The client secret is a string that looks like
ek_1234.
-
create
abstract ClientSecretCreateResponse create(ClientSecretCreateParams params, RequestOptions requestOptions)
-
create
ClientSecretCreateResponse create(ClientSecretCreateParams params)
-
create
ClientSecretCreateResponse create(RequestOptions requestOptions)
-
-
-
-