IZoiperEvent Interface Reference

Events interface. More...

Public Member Functions
void	OnZoiperFilter ([in] BSTR text)
	Event called when the user type in the filter filed of the phone. More...
void	OnZoiperCallHang ([in] IZoiperCall *call)
	Event generated when a call is ended. More...
void	OnZoiperCallRing ([in] IZoiperCall *call)
	Event generated when the call has just finished the dialing and the remote peer has started to ring. More...
void	OnZoiperCallHold ([in] IZoiperCall *call)
	Event generated when the remote peer puts the call on hold. More...
void	OnZoiperCallUnhold ([in] IZoiperCall *call)
	Event generated when remote peer unholds the call. More...
void	OnZoiperCallAccept ([in] IZoiperCall *call)
	Event generated when remote peer accept the call. More...
void	OnZoiperCallReject ([in] IZoiperCall *call, [in] LONG cause_code)
	Event generated when remote peer rejects the call. More...
void	OnZoiperCallFail ([in] IZoiperCall *call, [in] LONG cause_code)
	Event generated when a call fails. More...
void	OnZoiperCallIncoming ([in] IZoiperCall *call)
	Event generated when there is a new incoming call. More...
void	OnZoiperCallStartRecording ([in] IZoiperCall *call, [in] BSTR filename)
	Event generated when a call has start to record in file. More...
void	OnZoiperCallStopRecording ([in] IZoiperCall *call, [in] BSTR filename)
	Event generated when a call has stop to record in file. More...
void	OnZoiperCallRecvDTMF ([in] IZoiperCall *call, [in] BSTR dtmf)
	Event generated when there is an incoming DTMF. More...
void	OnZoiperTransferSuccess ([in] IZoiperCall *call)
	Event generated when a blind transfer request has succeeded. More...
void	OnZoiperTransferFailed ([in] IZoiperCall *call)
	Event generated when a blind transfer request failed. More...
void	OnZoiperCallSipHeader ([in] IZoiperCall *call, [in] IZoiperHeaders *headers)
	Event generated when there is an available SIP header. More...
void	OnZoiperCallHoldLocal ([in] IZoiperCall *call)
	Event generated when a call was put on hold locally either from the GUI or form the API. More...
void	OnZoiperCallUnholdLocal ([in] IZoiperCall *call)
	Event generated when a phone call was unholded locally either from the GUI or form the API. More...
void	OnZoiperCallIncomingURL ([in] IZoiperCall *call, [in] BSTR url)
	Event generated when a URL was received from the remote peer. More...
void	OnZoiperContactCreate ([in] IZoiperContact *contact, [in] BSTR name)
	Event generated when a contact is created. More...
void	OnZoiperContactDelete ([in] IZoiperContact *contact)
	Event generated when a contact is deleted. More...
void	OnZoiperContactChange ([in] IZoiperContact *contact)
	Event generated when a contact property has changed. More...
void	OnZoiperContactStatus ([in] IZoiperContact *contact, [in] EContactExtendedState status)
	Event generated when the state of the contact has changed. More...
void	OnZoiperContactSubscribe ([in] IZoiperContact *contact)
	Event generated when a contact has subscribed. More...
void	OnZoiperContactMessageRecv ([in] IZoiperContact *contact, [in] BSTR message)
	Event generated when a text message was received. More...
void	OnZoiperContactMessageSent ([in] IZoiperContact *contact, [in] BSTR message)
	Event generated when a text message is sent. More...
void	OnZoiperContactMessageFailed ([in] IZoiperContact *contact, [in] BSTR message, [in] LONG reason)
	Event generated when a message sending has failed. More...
void	OnZoiperAccountRegister ([in] IZoiperAccount *account)
	Event generated when an account was successfuly registered to the server. More...
void	OnZoiperAccountUnregister ([in] IZoiperAccount *account)
	Event generated when an account was successfuly unregistered from the server. More...
void	OnZoiperAccountRegisterFail ([in] IZoiperAccount *account, [in] LONG cause_code)
	Event generated when the account registeristration has failed. More...
void	OnZoiperPlaybackFinished ([in] IZoiperPlayback *playback)
	Event generated when a playback sound has finished. More...
void	OnZoiperPlaybackSoundURLLoaded ([in] IDispatch *playback, [in] VARIANT_BOOL result, [in] BSTR response)
	Event generated when a playback sound object was loaded form URL. More...
void	OnZoiperSMSDelete ([in] IZoiperPhone *phone, [in] BSTR ident)
	Event generated when a SMS was deleted. More...
void	OnZoiperSMSSend ([in] IZoiperPhone *phone, [in] BSTR message, [in] BSTR number)
	Event generated when a SMS was sent. More...
void	OnZoiperConferenceHold ([in] IZoiperPhone *phone)
	Event generated when the conference was put on hold. More...
void	OnZoiperConferenceUnhold ([in] IZoiperPhone *phone)
	Event generated when the conference was unholded. More...

Detailed Description

Events interface.

All the events that may occur in the phone

Member Function Documentation

void IZoiperEvent::OnZoiperAccountRegister

(

[in] IZoiperAccount *

account

)

Event generated when an account was successfuly registered to the server.

Parameters

[in]

account

the account object that generated the event.

void IZoiperEvent::OnZoiperAccountRegisterFail	(	[in] IZoiperAccount *	account,
		[in] LONG	cause_code
	)

Event generated when the account registeristration has failed.

Parameters

[in]	account	the account object that generated the event.
[in]	cause_code	the reason why the registration has failed.

void IZoiperEvent::OnZoiperAccountUnregister

(

[in] IZoiperAccount *

account

)

Event generated when an account was successfuly unregistered from the server.

Parameters

[in]

account

the account object that generated the event.

void IZoiperEvent::OnZoiperCallAccept

(

[in] IZoiperCall *

call

)

Event generated when remote peer accept the call.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallFail	(	[in] IZoiperCall *	call,
		[in] LONG	cause_code
	)

Event generated when a call fails.

All the references to this call object MUST be deleted because after this event the call object will be destoryed.

Parameters

[in]	call	the call object that generated the event.
[in]	cause_code	the reason why the call failed.

void IZoiperEvent::OnZoiperCallHang

(

[in] IZoiperCall *

call

)

Event generated when a call is ended.

All the references to this call object MUST be deleted because after this event the call object will be destoryed.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallHold

(

[in] IZoiperCall *

call

)

Event generated when the remote peer puts the call on hold.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallHoldLocal

(

[in] IZoiperCall *

call

)

Event generated when a call was put on hold locally either from the GUI or form the API.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallIncoming

(

[in] IZoiperCall *

call

)

Event generated when there is a new incoming call.

Parameters

[in]

call

the call object of the new call.

void IZoiperEvent::OnZoiperCallIncomingURL	(	[in] IZoiperCall *	call,
		[in] BSTR	url
	)

Event generated when a URL was received from the remote peer.

Parameters

[in]	call	the call object that generated the event.
[in]	url	the URL.

void IZoiperEvent::OnZoiperCallRecvDTMF	(	[in] IZoiperCall *	call,
		[in] BSTR	dtmf
	)

Event generated when there is an incoming DTMF.

Parameters

[in]	call	the call object that generated the event.
[in]	dtmf	the DTMF character. The posible values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C, D.

void IZoiperEvent::OnZoiperCallReject	(	[in] IZoiperCall *	call,
		[in] LONG	cause_code
	)

Event generated when remote peer rejects the call.

All the references to this call object MUST be deleted because after this event the call object will be destoryed.

Parameters

[in]	call	the call object that generated the event.
[in]	cause_code	the reason why the remote peer has rejected tha call.

void IZoiperEvent::OnZoiperCallRing

(

[in] IZoiperCall *

call

)

Event generated when the call has just finished the dialing and the remote peer has started to ring.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallSipHeader	(	[in] IZoiperCall *	call,
		[in] IZoiperHeaders *	headers
	)

Event generated when there is an available SIP header.

Parameters

[in]	call	the call object that generated the event.
[in]	headers	the headers object.

void IZoiperEvent::OnZoiperCallStartRecording	(	[in] IZoiperCall *	call,
		[in] BSTR	filename
	)

Event generated when a call has start to record in file.

Parameters

[in]	call	the call object that generated the event.
[in]	filename	the file name of the recording.

void IZoiperEvent::OnZoiperCallStopRecording	(	[in] IZoiperCall *	call,
		[in] BSTR	filename
	)

Event generated when a call has stop to record in file.

Parameters

[in]	call	the call object that generated the event.
[in]	filename	the file name of the recording.

void IZoiperEvent::OnZoiperCallUnhold

(

[in] IZoiperCall *

call

)

Event generated when remote peer unholds the call.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperCallUnholdLocal

(

[in] IZoiperCall *

call

)

Event generated when a phone call was unholded locally either from the GUI or form the API.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperConferenceHold

(

[in] IZoiperPhone *

phone

)

Event generated when the conference was put on hold.

Parameters

[in]

phone

the main phone object.

void IZoiperEvent::OnZoiperConferenceUnhold

(

[in] IZoiperPhone *

phone

)

Event generated when the conference was unholded.

Parameters

[in]

phone

the main phone object.

void IZoiperEvent::OnZoiperContactChange

(

[in] IZoiperContact *

contact

)

Event generated when a contact property has changed.

Parameters

[in]

contact

the contact object that generated the event.

void IZoiperEvent::OnZoiperContactCreate	(	[in] IZoiperContact *	contact,
		[in] BSTR	name
	)

Event generated when a contact is created.

Parameters

[in]	contact	the newly created contact object.
[in]	name	the name of the created contact.

void IZoiperEvent::OnZoiperContactDelete

(

[in] IZoiperContact *

contact

)

Event generated when a contact is deleted.

Parameters

[in]

contact

the contact object that generated the event.

void IZoiperEvent::OnZoiperContactMessageFailed	(	[in] IZoiperContact *	contact,
		[in] BSTR	message,
		[in] LONG	reason
	)

Event generated when a message sending has failed.

Parameters

[in]	contact	the contact object that generated the event.
[in]	message	the message.
[in]	reason	the reason why the sending has failed.

void IZoiperEvent::OnZoiperContactMessageRecv	(	[in] IZoiperContact *	contact,
		[in] BSTR	message
	)

Event generated when a text message was received.

Parameters

[in]	contact	the contact object that generated the event.
[in]	message	the message received.

void IZoiperEvent::OnZoiperContactMessageSent	(	[in] IZoiperContact *	contact,
		[in] BSTR	message
	)

Event generated when a text message is sent.

Parameters

[in]	contact	the contact object that generated the event.
[in]	message	the message sent.

void IZoiperEvent::OnZoiperContactStatus	(	[in] IZoiperContact *	contact,
		[in] EContactExtendedState	status
	)

Event generated when the state of the contact has changed.

Parameters

[in]	contact	the contact object that generated the event.
[in]	status	the new state of the contact.

void IZoiperEvent::OnZoiperContactSubscribe

(

[in] IZoiperContact *

contact

)

Event generated when a contact has subscribed.

Parameters

[in]

contact

the contact object that generated the event.

void IZoiperEvent::OnZoiperFilter

(

[in] BSTR

text

)

Event called when the user type in the filter filed of the phone.

Parameters

[in]

text

the current string in the filter field.

void IZoiperEvent::OnZoiperPlaybackFinished

(

[in] IZoiperPlayback *

playback

)

Event generated when a playback sound has finished.

Parameters

[in]

playback

the playback object that generated the event.

void IZoiperEvent::OnZoiperPlaybackSoundURLLoaded	(	[in] IDispatch *	playback,
		[in] VARIANT_BOOL	result,
		[in] BSTR	response
	)

Event generated when a playback sound object was loaded form URL.

Parameters

[in]	playback	this parameter is of IDispatch* type because its type depends of the result of the loading. If it is successfuly loaded the object actual type will be IZoiperPlayback*. If the loading has failed the type will be IZoiperPhone. QueryInterface could be used to determine the actual type.
[in]	result	the result of the loading.
[in]	response	the response from the server if the loading failed.

void IZoiperEvent::OnZoiperSMSDelete	(	[in] IZoiperPhone *	phone,
		[in] BSTR	ident
	)

Event generated when a SMS was deleted.

Note

SMS functionality is not currently availabale.

Parameters

[in]	phone	the main phone object.
[in]	ident	SMS identificator.

void IZoiperEvent::OnZoiperSMSSend	(	[in] IZoiperPhone *	phone,
		[in] BSTR	message,
		[in] BSTR	number
	)

Event generated when a SMS was sent.

Note

SMS functionality is not currently availabale.

Parameters

[in]	phone	the main phone object.
[in]	message	content of the SMS.
[in]	number	the phone number which we send the SMS to.

void IZoiperEvent::OnZoiperTransferFailed

(

[in] IZoiperCall *

call

)

Event generated when a blind transfer request failed.

Parameters

[in]

call

the call object that generated the event.

void IZoiperEvent::OnZoiperTransferSuccess

(

[in] IZoiperCall *

call

)

Event generated when a blind transfer request has succeeded.

Parameters

[in]

call

the call object that generated the event.

---

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

• Zoiper.idl