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

Instance Methods

(void) - onAccount:status:changed:
 Notify upon Account status is changed. More...
 
(void) - onAccount:retryingRegistration:inSeconds:
 Notify upon Account is retrying registration. More...
 
(void) - onAccount:incomingCall:
 Notify upon Incoming Call. More...
 
(void) - onAccount:chatMessageReceived:pContent:
 Notify upon Chat message was received. More...
 
(void) - onAccount:extendedError:
 Notify upon account extended error occurs. More...
 
(void) - onAccountuserSipOutboundMissing:
 Warning for missing SIP Outbound support at the server. More...
 
(void) - onAccount:call:ownershipChanged:
 Notify upon call ownership changed. More...
 
(void) - onAccount:sipHeaderFields:
 SIP header dump for a user registration. More...
 
(void) - onStunNetworkDiscovered:networkType:
 Notify upon STUN discovered network type. More...
 
(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKEventHandle>
(long int) - eventHandle
 
(NSString *) - handlesDescription
 

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription
optional

Reimplemented from <ZDKEventHandle>.

◆ onAccount:call:ownershipChanged:

- (void) onAccount: (id< ZDKAccount >)  account
call: (id< ZDKCall >)  call
ownershipChanged: (ZDKOwnershipChange)  action 
optional

Notify upon call ownership changed.

Providing information upon call ownership change.

The OwnershipChange objects holds the information if the call is Relieved or Acquired.

Parameters
[in]accountAccount whose call ownership is changed
[in]callThe call which ownership is changed
[in]actionThe type of change that is happend (Relieve, Acquired or NA)
See also
ZDKAccount, ZDKCall, OwnershipChange

◆ onAccount:chatMessageReceived:pContent:

- (void) onAccount: (id< ZDKAccount >)  account
chatMessageReceived: (NSString *)  pPeer
pContent: (NSString *)  pContent 
optional

Notify upon Chat message was received.

Notify upon Chat message was received , provides the sender and the content of the message

Parameters
[in]accountAccount that receives the message
[in]pPeerThe message sender
[in]pContentContents of the message
See also
ZDKAccount

◆ onAccount:extendedError:

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

Notify upon account extended error occurs.

Event fired when extended error in account occurs, providing detailed information for the error in the ExtendedError object.

Parameters
[in]accountAccount that received the error
[in]errorThe error object that provides full information regarding the error
See also
ZDKAccount, ZDKExtendedError

◆ onAccount:incomingCall:

- (void) onAccount: (id< ZDKAccount >)  account
incomingCall: (id< ZDKCall >)  call 
optional

Notify upon Incoming Call.

Notification for incoming call

Parameters
[in]accountAccount that receives the call
[in]callThe call object holding handle to the incoming call
See also
ZDKAccount, ZDKCall

◆ onAccount:retryingRegistration:inSeconds:

- (void) onAccount: (id< ZDKAccount >)  account
retryingRegistration: (int)  isRetrying
inSeconds: (int)  inSeconds 
optional

Notify upon Account is retrying registration.

Registration or unregistration is going to be retried automatically

Parameters
[in]accountAccount object of the account which registration is retrying
[in]isRetryingGives information if the event is register or unregister 1 = registering, 0 = unregistering
[in]inSecondsThe (un)registration will be retried in this many seconds approximately (the event could have been in the queue for unknown period already)
See also
ZDKAccount

◆ onAccount:sipHeaderFields:

- (void) onAccount: (id< ZDKAccount >)  account
sipHeaderFields: (NSArray *)  headerFields 
optional

SIP header dump for a user registration.

Dumps the header of a SIP message from a SIP registration. This is the header of the 200 response to the REGISTER request.

Each header field from the SIP header is represented as an entry in headerFields.

Each header field can have one or more values associated with it in the Values array.

The header field Name and the Values are UTF-8 strings.

The structure is valid only for the duration of this callback.

To enable this callback, use zdksipConfig::HeaderDump().

Parameters
[in]accountThe account which got the registration response
[in]headerFieldsThe header fields array
See also
ZDKHeaderField

◆ onAccount:status:changed:

- (void) onAccount: (id< ZDKAccount >)  account
status: (ZDKAccountStatus)  status
changed: (int)  statusCode 
optional

Notify upon Account status is changed.

Notify upon Account status is changed, provide which account and the status it is changed to.

Parameters
[in]accountThe account which status is changed
[in]statusWhat status the account is changed to
[in]statusCodeThe status representation as integer
See also
ZDKAccount, ZDKAccountStatus

◆ onAccountuserSipOutboundMissing:

- (void) onAccountuserSipOutboundMissing: (id< ZDKAccount >)  account
optional

Warning for missing SIP Outbound support at the server.

Happens when there is a SIP account with SIP Outbound enabled but the server rejects the registrations with the error code 439, usually with the text "First Hop Lacks Outbound Support".

The full error information is passed in the registration error failure as usual. This event is pushed immediately after the registration failure event.

The library will NOT alter its configuration automatically but if this behavior is desired the API user can just do the needed reconfiguration in this callback and issue a new registerUser() request afterwards for immediate retry.

Parameters
[in]accountThe user which got the registration error
See also
ZDKAccount, ZDKExtendedError

◆ onStunNetworkDiscovered:networkType:

- (void) onStunNetworkDiscovered: (id< ZDKAccount >)  account
networkType: (ZDKNetworkType)  networkType 
optional

Notify upon STUN discovered network type.

Parameters
[in]accountThe account which status is changed
[in]networkTypeThe discovered network type
See also
ZDKAccount, NetworkType

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