Overview

SIPPhoneDelegate protocol.

The SIPPhoneDelegate protocol provides callback methods to inform the delegate on certain call and messaging events.

Tasks

Instance Methods

connected:

Notifies the delegate on a call connected event.

- (void)connected:(id)phone

Discussion

The connected event occurs on an outbound call, when the remote party has accepted the call. In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

hangUp:

Notifies the delegate on a call hang up event.

- (void)hangUp:(id)phone

Discussion

The connected event occurs on an established call when the call has been disconnected. In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

inboundCall:fromUser:

Notifies the delegate on an inbound call event.

- (void)inboundCall:(id)phone fromUser:(id)userid

Discussion

In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

initializationFailed:withReason:

Notifies the delegate on initialization failure.

- (void)initializationFailed:(id)phone withReason:(id)reason

Parameters

phone
reason
  • Failure reason

Discussion

On SIPPhone startup the SIP client auto discovers the network environment like firewall and NAT, external and internal IP address and ports and establish a connection to the C2Call SIP Proxy. In case the connection the SIP Proxy cannot be established, initializationFailed will be called. In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

initializationSuccess:

Notifies the delegate on initialization success.

- (void)initializationSuccess:(id)phone

Parameters

phone

Discussion

On SIPPhone startup the SIP client auto discovers the network environment like firewall and NAT, external and internal IP address and ports and establish a connection to the C2Call SIP Proxy. initializationSuccess will be called after the auto discover and connect process has been successfully completed. In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

message:

Notifies the delegate on an incoming message event.

- (void)message:(id)msg

Discussion

In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

notifySIPEvent:andData:

Notifies the delegate on C2Call specific SIP events like presence, invite and group call events.

- (void)notifySIPEvent:(id)event andData:(id)data

Discussion

In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

onlineStatusUpdate

Notifies the delegate on onlinestatus changes.

- (void)onlineStatusUpdate

Discussion

The online status can change if the network connection is temporary lost. See C2NetworkStatusHandler to get the current network status. In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

outboundCall:

Notifies the delegate on an outbound call event.

- (void)outboundCall:(id)phone

Discussion

In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

responseError:withErrorCode:

Notifies the delegate on a responseError event.

- (void)responseError:(id)phone withErrorCode:(id)errorCode

Discussion

The responseError event occurs on an outbound call when the remote party cannot be reached (busy, call rejected, etc.) In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h

ringing:

Notifies the delegate on a ringing event.

- (void)ringing:(id)phone

Discussion

The ringing event occurs on an outbound call when the receiver sends a ringing or session progress notification (remote party rings). In C2Call SDK the C2CallAppDelegate class will be called on all SIPPhoneDelegate events. To change the default behavior of the specific event handling, please overwrite the corresponding method in C2CallAppDelegate class.

Declared In

SIPPhone.h