FPWCSApi2  2.5.2
WCS iOS SDK
Instance Methods
FPWCSApi2Session Class Reference

#import <FPWCSApi2Session.h>

Inheritance diagram for FPWCSApi2Session:

Instance Methods

(FPWCSApi2Stream *) - createStream:error:
 
(FPWCSApi2Call *) - createCall:error:
 
(void) - connect
 
(void) - disconnect
 
(NSString *) - getServerUrl
 
(FPWCSApi2Stream *) - getStream:
 
(NSArray *) - getStreams
 
(NSString *) - getSessionID
 
(FPWCSApi2Session *) - on:callback:
 
(FPWCSApi2Session *) - onAppDataCallback:
 
(FPWCSApi2Session *) - onIncomingCallCallback:
 
(kFPWCSSessionStatus- getStatus
 
(void) - sendData:
 
(void) - sendData:handler:
 

Detailed Description

Represents connection to REST App. Can create and store Streams.

Method Documentation

§ connect()

- (void) connect

Connect to server. Note that connect can be called only once.

§ createCall:error:()

- (FPWCSApi2Call *) createCall: (FPWCSApi2CallOptions *)  options
error: (NSError **)  error 

§ createStream:error:()

- (FPWCSApi2Stream *) createStream: (FPWCSApi2StreamOptions *)  options
error: (NSError **)  error 

Create stream.

Parameters
optionsFPWCSApi2StreamOptions stream configuration options
errorNSError object to fill with info if error occurs
Returns
FPWCSApi2Stream newly created stream

§ disconnect()

- (void) disconnect

Disconnect from server

§ getServerUrl()

- (NSString *) getServerUrl

Get server address.

Returns
NSString server address

§ getSessionID()

- (NSString *) getSessionID

Get session id

Returns
NSStrien session id

§ getStatus()

- (kFPWCSSessionStatus) getStatus

Get session status

Returns
kFPWCSSessionStatus session status

§ getStream:()

- (FPWCSApi2Stream *) getStream: (NSString *)  streamID

Get stream by id.

Parameters
streamIDNSString stream identificator
Returns
FPWCSApi2Stream stream

§ getStreams()

- (NSArray *) getStreams

Get streams.

Returns
NSArray streams

§ on:callback:()

- (FPWCSApi2Session *) on: (kFPWCSSessionStatus event
callback: (SessionCallback callback 

Add session event callback.

Parameters
eventkFPWCSSessionStatus event type
callbackSessionCallback callback block
Returns
FPWCSApi2Session session

§ onAppDataCallback:()

- (FPWCSApi2Session *) onAppDataCallback: (SessionAppDataCallback callback

Add session event callback.

Parameters
eventkFPWCSSessionStatus event type
callbackSessionCallback callback block
Returns
FPWCSApi2Session session

§ onIncomingCallCallback:()

- (FPWCSApi2Session *) onIncomingCallCallback: (IncomingCallCallback)  callback

§ sendData:()

- (void) sendData: (NSDictionary *)  data

§ sendData:handler:()

- (void) sendData: (NSDictionary *)  data
handler: (FPWCSApi2DataHandler *)  handler 

The documentation for this class was generated from the following file: