Class SIPEventDialogInfo

Represents the top level XML element on a SIP event dialog payload as described in: RFC4235 "An INVITE-Initiated Dialog Event Package for the Session Initiation Protocol (SIP)".

Inheritance
System.Object
SIPEventDialogInfo
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.SIP
Assembly: SIPSorcery.dll
Syntax
public class SIPEventDialogInfo
Remarks

RFC4235 on Dialog Event Packages:

  • To establish a subscription to a specific dialog the call-id, to-tag and from-tag must be specified,
  • To establish a subscription to a set of dialogs the call-id and to-tag must be specified. Treatment of the Event header:
  • If the Event header contains dialog identifiers a notification is sent for any dialogs that match them AND the user in the SUBSCRIBE URI.
  • If the Event header does not contain any dialog identifiers then a notification is sent for every dialog that matches the user in the SUBSCRIBE URI.
  • Notifications contain the identities of the dialog participants, the target URIs and the dialog identifiers.
  • The format of the NOTIFY bodies must be in a format specified in a SUBSCRIBE Accept header or if omitted a default format of "application/dialog-info+xml".

Example of an empty dialog notification body:

 <?xml version="1.0"?>
 <dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="0" notify-state="full" entity="sip:alice@example.com" />

Example of a single entry dialog notification body:

<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="0" state="partial" entity="sip:alice@example.com">
  <dialog id="as7d900as8" call-id="a84b4c76e66710" local-tag="1928301774" direction="initiator">
   <state event="rejected" code="486">terminated</state> <!-- The state element is the only mandatory child element for a dialog element. -->
   <duration>145</duration>
  </dialog>
 </dialog-info>

Constructors

| Improve this Doc View Source

SIPEventDialogInfo()

Declaration
public SIPEventDialogInfo()
| Improve this Doc View Source

SIPEventDialogInfo(Int32, SIPEventDialogInfoStateEnum, SIPURI)

Declaration
public SIPEventDialogInfo(int version, SIPEventDialogInfoStateEnum state, SIPURI entity)
Parameters
Type Name Description
System.Int32 version
SIPEventDialogInfoStateEnum state
SIPURI entity

Fields

| Improve this Doc View Source

DialogItems

Declaration
public List<SIPEventDialog> DialogItems
Field Value
Type Description
System.Collections.Generic.List<SIPEventDialog>
| Improve this Doc View Source

Entity

Declaration
public SIPURI Entity
Field Value
Type Description
SIPURI
| Improve this Doc View Source

m_dialogXMLNS

Declaration
public static readonly string m_dialogXMLNS
Field Value
Type Description
System.String
| Improve this Doc View Source

State

Declaration
public SIPEventDialogInfoStateEnum State
Field Value
Type Description
SIPEventDialogInfoStateEnum
| Improve this Doc View Source

Version

Declaration
public int Version
Field Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Load(String)

Declaration
public void Load(string dialogInfoXMLStr)
Parameters
Type Name Description
System.String dialogInfoXMLStr
| Improve this Doc View Source

Parse(String)

Declaration
public static SIPEventDialogInfo Parse(string dialogInfoXMLStr)
Parameters
Type Name Description
System.String dialogInfoXMLStr
Returns
Type Description
SIPEventDialogInfo
| Improve this Doc View Source

ToXMLText()

Declaration
public string ToXMLText()
Returns
Type Description
System.String

Extension Methods