apollo-runtime/com.apollographql.apollo.network.ws/WebSocketNetworkTransport/Builder

Builder

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v5_0_0)

class ~~Builder~~

Deprecated

The websocket implementation has moved to 'com.apollographql.apollo.network.websocket'. See https://go.apollo.dev/ak-v5-websockets for more details.

Constructors

constructor()

Functions

fun addHeader(name: String, value: String): WebSocketNetworkTransport.Builder

fun addHeaders(headers: List<HttpHeader>): WebSocketNetworkTransport.Builder

fun build(): WebSocketNetworkTransport

fun headers(headers: List<HttpHeader>): WebSocketNetworkTransport.Builder

idleTimeoutMillis

fun idleTimeoutMillis(idleTimeoutMillis: Long): WebSocketNetworkTransport.Builder

incrementalDeliveryProtocol

@ApolloExperimental

fun incrementalDeliveryProtocol(incrementalDeliveryProtocol: IncrementalDeliveryProtocol): WebSocketNetworkTransport.Builder

The incremental delivery protocol to use when using @defer and/or @stream.

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v5_0_0)

fun WebSocketNetworkTransport.Builder.~~okHttpClient~~(okHttpClient: ERROR CLASS: Symbol not found for OkHttpClient): WebSocketNetworkTransport.Builder

Configures the DeprecatedWebSocketNetworkTransport to use the okHttpCallFactory for network requests.

fun protocol(protocolFactory: WsProtocol.Factory): WebSocketNetworkTransport.Builder

fun reopenWhen(reopenWhen: suspend (Throwable, attempt: Long) -> Boolean?): WebSocketNetworkTransport.Builder

Configure the WebSocketNetworkTransport to reopen the websocket automatically when a network error happens

fun serverUrl(serverUrl: String): WebSocketNetworkTransport.Builder

fun serverUrl(serverUrl: suspend () -> String?): WebSocketNetworkTransport.Builder

Configure the server URL.

webSocketEngine

fun webSocketEngine(webSocketEngine: WebSocketEngine): WebSocketNetworkTransport.Builder