zdk.objc
Instance Methods | List of all members
<ZDKSIPProbeEventsHandler> Protocol Reference
Inheritance diagram for <ZDKSIPProbeEventsHandler>:
<ZDKEventHandle>

Instance Methods

(void) - onProbeError:curState:error:
 Notify if Probe error occurs. More...
 
(void) - onProbeState:newState:
 Notify if Probe change in state occurs. More...
 
(void) - onProbeSuccess:transport:
 Notify if Probe was successful. More...
 
(void) - onProbeFailed:error:
 Notify if Probe fails. More...
 
(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKEventHandle>
(long int) - eventHandle
 
(NSString *) - handlesDescription
 

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription
optional

Reimplemented from <ZDKEventHandle>.

◆ onProbeError:curState:error:

- (void) onProbeError: (id< ZDKAccount >)  account
curState: (ZDKProbeState)  curState
error: (id< ZDKExtendedError >)  error 
optional

Notify if Probe error occurs.

An error occured during user probing. The process might continue with a different protocol.

Parameters
[in]accountThe account
[in]curStateThe state that generated the error.
[in]errorCode of the error
See also
ZDKAccount, ProbeState, ZDKExtendedError

◆ onProbeFailed:error:

- (void) onProbeFailed: (id< ZDKAccount >)  account
error: (id< ZDKExtendedError >)  error 
optional

Notify if Probe fails.

The probing process was unsuccesful. The process has ended.

Parameters
[in]accountThe account
[in]errorThe final error code
See also
ZDKAccount, ZDKExtendedError

◆ onProbeState:newState:

- (void) onProbeState: (id< ZDKAccount >)  account
newState: (ZDKProbeState)  newState 
optional

Notify if Probe change in state occurs.

The probing process has entered another stage

Parameters
[in]accountThe account
[in]newStateThe new state
See also
ZDKAccount, ProbeState

◆ onProbeSuccess:transport:

- (void) onProbeSuccess: (id< ZDKAccount >)  account
transport: (ZDKTransportType)  transport 
optional

Notify if Probe was successful.

The probing was successful. The process has ended.

Parameters
[in]accountThe account
[in]transportThe recommended transport
See also
ZDKAccount, TransportType

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