One Logo Pool Ball
Foundation · IOS API REFERENCE

URLSessionWebSocketTask

class · iOS 13.0+ · SDK 27.1

class URLSessionWebSocketTask

Members (10)

method · iOS 13.0+

cancel

TypeScript
cancel(closeCode: URLSessionWebSocketTask_CloseCode, reason?: (ArrayBuffer) | null): void
Swift declaration
func cancel(with closeCode: URLSessionWebSocketTask.CloseCode, reason: Data?)
method · iOS 13.0+

sendPing

TypeScript
sendPing(pongReceiveHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func sendPing(pongReceiveHandler: @escaping @Sendable ((any Error)?) -> Void)
get · iOS 13.0+

closeCode

TypeScript
get closeCode(): URLSessionWebSocketTask_CloseCode
Swift declaration
var closeCode: URLSessionWebSocketTask.CloseCode { get }
get · iOS 13.0+

closeReason

TypeScript
get closeReason(): (ArrayBuffer) | null
Swift declaration
var closeReason: Data? { get }
get · iOS 13.0+

maximumMessageSize

TypeScript
get maximumMessageSize(): number
Swift declaration
var maximumMessageSize: Int { get set }
set · iOS 13.0+

maximumMessageSize

TypeScript
set maximumMessageSize(value: number)
Swift declaration
var maximumMessageSize: Int { get set }
method · iOS 13.0+

send

TypeScript
sendCompletionHandler(message: URLSessionWebSocketTask_Message, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
@preconcurrency func send(_ message: URLSessionWebSocketTask.Message, completionHandler: @escaping @Sendable ((any Error)?) -> Void)
method · iOS 13.0+

send

TypeScript
send(message: URLSessionWebSocketTask_Message): Promise<void>
Swift declaration
func send(_ message: URLSessionWebSocketTask.Message) async throws
method · iOS 13.0+

receive

TypeScript
receiveCompletionHandler(completionHandler: ((arg0: SDKHandle) => void)): void
Swift declaration
@preconcurrency func receive(completionHandler: @escaping @Sendable (Result<URLSessionWebSocketTask.Message, any Error>) -> Void)
method · iOS 13.0+

receive

TypeScript
receive(): Promise<URLSessionWebSocketTask_Message>
Swift declaration
func receive() async throws -> URLSessionWebSocketTask.Message

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

URLSessionWebSocketTask.init()

inherited init: clang: 'init' is unavailable

All Foundation types →