Class Index | File Index

## Classes

- _global_
- SIPml
- SIPml.Event
- SIPml.EventTarget
- SIPml.Session
- SIPml.Session.Call
- SIPml.Session.Configuration
- SIPml.Session.Event
- SIPml.Session.Message
- SIPml.Session.Publish
- SIPml.Session.Registration
- SIPml.Session.Subscribe
- SIPml.Stack
- SIPml.Stack.Configuration
- SIPml.Stack.Event

# Class SIPml.Session.Event

Extends SIPml.Event.
Defined in: SIPml.js.

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| SIPml.Session.Event(session, type, event) SIP session event object.

Field Summary
Field Attributes | Field Name and Description
--- | ---
| session Session associated to this event.

Fields borrowed from class SIPml.Event:
  description, type

Method Summary
Method Attributes | Method Name and Description
--- | ---
| getTransferDestinationFriendlyName() Gets the name of destination for the current call transfer.

Methods borrowed from class SIPml.Event:
  getContent, getContentString, getContentType, getSipResponseCode

Class Detail
SIPml.Session.Event(session, type, event)
SIP session event object. You should never create an instance of this class by yourself.

Parameters:
{SIPml.Session} session Optional
  The session type would be SIPml.Session.Registration, SIPml.Session.Call or SIPml.Session.Message.
{String} type
  The event type or identifier. Please check this link for more information about all supported session event types.
{tsip_event} event Optional
  Private wrapped session object.

Field Detail
{SIPml.Session} session
Session associated to this event. Would be SIPml.Session.Registration, SIPml.Session.Call or SIPml.Session.Message.
Method Detail
{String} getTransferDestinationFriendlyName()
Gets the name of destination for the current call transfer.

Returns:
  {String} The name of destination for the current call transfer (e.g. 'John Doe').

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Sep 25 2013 03:40:14 GMT+0200 (CEST)