Inherits from NSObject
Declared in WSCSessionBuilder.h

Overview

Builder for the WSCSession class.

Class Methods

create:

Creates a new WSCSessionBuilder.

+ (WSCSessionBuilder *)create:(NSURL *)webSocketURL

Parameters

webSocketURL

web socket URL.

Return Value

WSCSessionBuilder

Discussion

Creates a new WSCSessionBuilder.

Declared In

WSCSessionBuilder.h

Instance Methods

build

Build the session,

- (WSCSession *)build

Discussion

Build the session,

Declared In

WSCSessionBuilder.h

withConnectionDelegate:

Creates a new WSCSessionBuilder with a connection callback listener.

- (WSCSessionBuilder *)withConnectionDelegate:(id<WSCSessionConnectionDelegate>)value

Parameters

value

Callback object

Return Value

WSCSessionBuilder

Discussion

Creates a new WSCSessionBuilder with a connection callback listener.

Declared In

WSCSessionBuilder.h

withExtHeaders:

Creates a new WSCSessionBuilder with extension headers which will be sent as part of session connect.

- (WSCSessionBuilder *)withExtHeaders:(NSDictionary *)value

Parameters

value

Headers

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with extension headers which will be sent as part of session connect.

Declared In

WSCSessionBuilder.h

withHttpContext:

Creates a new WSCSessionBuilder with an http context.

- (WSCSessionBuilder *)withHttpContext:(WSCHttpContext *)value

Parameters

value

Http context

Return Value

WSCSessionBuilder

Discussion

Creates a new WSCSessionBuilder with an http context.

Declared In

WSCSessionBuilder.h

withIceServerConfig:

Creates a new WSCSessionBuilder with an ICE server configuration.

- (WSCSessionBuilder *)withIceServerConfig:(WSCIceServerConfig *)value

Parameters

value

ICE server config.

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with an ICE server configuration.

Declared In

WSCSessionBuilder.h

withIceServerDelegate:

Creates a new WSCSessionBuilder with an ICE server delegate.

- (WSCSessionBuilder *)withIceServerDelegate:(id<WSCSessionIceServerDelegate>)value

Parameters

value

WSCSessionIceServerDelegate

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with an ICE server delegate.

Declared In

WSCSessionBuilder.h

withObserverDelegate:

Creates a new WSCSessionBuilder with an observer.

- (WSCSessionBuilder *)withObserverDelegate:(id<WSCSessionObserverDelegate>)value

Parameters

value

Observer

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with an observer.

Declared In

WSCSessionBuilder.h

withPackage:

Creates a new WSCSessionBuilder with a package.

- (WSCSessionBuilder *)withPackage:(WSCPackage *)value

Parameters

value

Package

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with a package.

Declared In

WSCSessionBuilder.h

withProperty:value:

Creates a new WSCSessionBuilder with a property that allows configuration of various internal behaviors.

- (WSCSessionBuilder *)withProperty:(NSString *)name value:(NSObject *)value

Parameters

name

Property name

value

Property value

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with a property that allows configuration of various internal behaviors.

Declared In

WSCSessionBuilder.h

withServiceAuthHandler:

Creates a new WSCSessionBuilder with a service authentication handler.

- (WSCSessionBuilder *)withServiceAuthHandler:(id<WSCServiceAuthHandler>)handler

Parameters

handler

ServiceAuthHandler

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with a service authentication handler.

Declared In

WSCSessionBuilder.h

withSessionId:

Creates a new WSCSessionBuilder with a session id. Should only be set when attempting to rehydrate an existing session.

- (WSCSessionBuilder *)withSessionId:(NSString *)value

Parameters

value

Session id value

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with a session id. Should only be set when attempting to rehydrate an existing session.

Declared In

WSCSessionBuilder.h

withUserName:

Creates a new WSCSessionBuilder with a username which will be sent with session connect message.

- (WSCSessionBuilder *)withUserName:(NSString *)value

Parameters

value

Username value

Return Value

Builder

Discussion

Creates a new WSCSessionBuilder with a username which will be sent with session connect message.

Declared In

WSCSessionBuilder.h