WSCSessionBuilder Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | WSCSessionBuilder.h |
+ create:
Creates a new WSCSessionBuilder.
+ (WSCSessionBuilder *)create:(NSURL *)webSocketURLParameters
webSocketURL |
web socket URL |
|---|
Return Value
WSCSessionBuilder
Discussion
Creates a new WSCSessionBuilder.
Declared In
WSCSessionBuilder.h
– withConnectionDelegate:
Returns the same instance with a connection callback listener.
- (WSCSessionBuilder *)withConnectionDelegate:(id<WSCSessionConnectionDelegate>)valueParameters
value |
Callback object |
|---|
Return Value
WSCSessionBuilder
Discussion
Returns the same instance with a connection callback listener.
Declared In
WSCSessionBuilder.h
– withHttpContext:
Returns the same instance with a HTTP context.
- (WSCSessionBuilder *)withHttpContext:(WSCHttpContext *)valueParameters
value |
Http context |
|---|
Return Value
WSCSessionBuilder
Discussion
Returns the same instance with a HTTP context.
Declared In
WSCSessionBuilder.h
– withObserverDelegate:
Returns the same instance with an observer.
- (WSCSessionBuilder *)withObserverDelegate:(id<WSCSessionObserverDelegate>)valueParameters
value |
Observer |
|---|
Return Value
Builder
Discussion
Returns the same instance with an observer.
Declared In
WSCSessionBuilder.h
– withSessionId:
Returns the same instance with a session id. Should only be set when attempting to rehydrate an existing session.
- (WSCSessionBuilder *)withSessionId:(NSString *)valueParameters
value |
Session id value |
|---|
Return Value
Builder
Discussion
Returns the same instance with a session id. Should only be set when attempting to rehydrate an existing session.
Declared In
WSCSessionBuilder.h
– withUserName:
Returns the same instance with a username which will be sent with session connect message.
- (WSCSessionBuilder *)withUserName:(NSString *)valueParameters
value |
Username value |
|---|
Return Value
Builder
Discussion
Returns the same instance with a username which will be sent with session connect message.
Declared In
WSCSessionBuilder.h
– withExtHeaders:
Returns the same instance with extension headers which will be sent as part of session connect.
- (WSCSessionBuilder *)withExtHeaders:(NSDictionary *)valueParameters
value |
Headers |
|---|
Return Value
Builder
Discussion
Returns the same instance with extension headers which will be sent as part of session connect.
Declared In
WSCSessionBuilder.h
– withProperty:value:
Returns the same instance with a property that allows configuration of various internal behaviors.
- (WSCSessionBuilder *)withProperty:(NSString *)name value:(NSObject *)valueParameters
name |
Property name |
|---|---|
value |
Property value |
Return Value
Builder
Discussion
Returns the same instance with a property that allows configuration of various internal behaviors.
Declared In
WSCSessionBuilder.h
– withPackage:
Returns the same instance with a package.
- (WSCSessionBuilder *)withPackage:(WSCPackage *)valueParameters
value |
Package |
|---|
Return Value
Builder
Discussion
Returns the same instance with a package.
Declared In
WSCSessionBuilder.h
– withServiceAuthHandler:
Returns the same instance with a service authentication handler.
- (WSCSessionBuilder *)withServiceAuthHandler:(id<WSCServiceAuthHandler>)handlerParameters
handler |
ServiceAuthHandler |
|---|
Return Value
Builder
Discussion
Returns the same instance with a service authentication handler.
Declared In
WSCSessionBuilder.h
– withIceServerConfig:
Returns the same instance with an ICE server configuration.
- (WSCSessionBuilder *)withIceServerConfig:(WSCIceServerConfig *)valueParameters
value |
ICE server config |
|---|
Return Value
Builder
Discussion
Returns the same instance with an ICE server configuration.
Declared In
WSCSessionBuilder.h
– withHibernationHandler:
Returns the same instance with hibernation handler configuration.
- (WSCSessionBuilder *)withHibernationHandler:(id<WSCHibernationHandler>)handlerParameters
handler |
|---|
Return Value
Builder
Discussion
Returns the same instance with hibernation handler configuration.
Declared In
WSCSessionBuilder.h
– withDeviceToken:
Returns the same instance with a device token configuration.
- (WSCSessionBuilder *)withDeviceToken:(NSData *)tokenParameters
token |
NSData |
|---|
Return Value
Builder
Discussion
Returns the same instance with a device token configuration.
Declared In
WSCSessionBuilder.h
– withStateInfo:
Returns the same instance with a state information configuration.
- (WSCSessionBuilder *)withStateInfo:(NSString *)stateInfoParameters
stateInfo |
NSString |
|---|
Return Value
Builder
Discussion
Returns the same instance with a state information configuration.
Declared In
WSCSessionBuilder.h
– build
Builds the session out of this builder.
- (WSCSession *)buildReturn Value
session
Discussion
Builds the session out of this builder.
Declared In
WSCSessionBuilder.h