Sip Endpoint SDK for Apple OS
 All Classes Functions Properties
<GSSessionControlService> Protocol Reference

List of all members.

Public Member Functions

(GSResult) - dialFrom:to:
(GSResult) - dialVideoFrom:to:
(GSResult) - dialFrom:to:withData:
(GSResult) - answerSession:
(GSResult) - answerVideoSession:
(GSResult) - hangupSession:
(GSResult) - holdSession:
(GSResult) - retrieveSession:
(NSString *) - createAddress:to:
(GSResult) - sendDtmf:forSession:

Detailed Description

Definition at line 14 of file GSSessionControlService.h.


Member Function Documentation

- (GSResult) answerSession: (id< GSSession >)  session

Sends SIP 200OK to the incoming session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) answerVideoSession: (id< GSSession >)  session

Sends SIP 200OK to the incoming video session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (NSString*) createAddress: (id)  connection
to: (id)  destination 

Helps to create destination address

Parameters:
connectionobject.
stringwith destination name.
Returns:
a string with full address to the destination.
- (GSResult) dialFrom: (id< GSConnection >)  connection
to: (NSString *)  destination 

Sends SIP INVITE to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
Returns:
the result of the operation.
- (GSResult) dialFrom: (id< GSConnection >)  connection
to: (NSString *)  destination
withData: (NSString *)  data 

Sends SIP INVITE with user data header to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
stringwith user data.
Returns:
the result of the operation.
- (GSResult) dialVideoFrom: (id< GSConnection >)  connection
to: (NSString *)  destination 

Sends SIP INVITE with video in SDP to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
Returns:
the result of the operation.
- (GSResult) hangupSession: (id< GSSession >)  session

Sends SIP BYE to the session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) holdSession: (id< GSSession >)  session

Put the session on Hold

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) retrieveSession: (id< GSSession >)  session

Retrive the session from Hold

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) sendDtmf: (NSString *)  digits
forSession: (id< GSSession >)  session 

Sends DTMF to the other parties in the session. The DTMF method is determined by the policy configured for this session's session manager.

Parameters:
digitsthe DTMF digits to be sent.
Returns:
the result of the operation.

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