Inheritance diagram for Linphone.Event:

Public Member Functions
void	AcceptPublish ()

void	AcceptSubscription ()

void	AddCustomHeader (string name, string val)

void	DenyPublish (Linphone.Reason reason)

void	DenySubscription (Linphone.Reason reason)

string	GetCustomHeader (string name)

void	Notify (Linphone.Content body)

void	PausePublish ()

void	RefreshPublish ()

void	RefreshSubscribe ()

void	RemoveCustomHeader (string name)

void	SendPublish (Linphone.Content body)

void	SendSubscribe (Linphone.Content body)

void	Terminate ()

void	UpdatePublish (Linphone.Content body)

void	UpdateSubscribe (Linphone.Content body)

Properties
EventListener	Listener `[get, set]`

string	CallId `[get]`

Linphone.Core	Core `[get]`

Linphone.ErrorInfo	ErrorInfo `[get]`

Linphone.Address	From `[get]`

Linphone.Address	FromAddress `[get]`

string	Name `[get]`

Linphone.PublishState	PublishState `[get]`

Linphone.Reason	Reason `[get]`

Linphone.Address	RemoteContact `[get]`

Linphone.Address	RequestAddress `[get, set]`

Linphone.Address	Resource `[get]`

Linphone.SubscriptionDir	SubscriptionDir `[get]`

Linphone.SubscriptionState	SubscriptionState `[get]`

Linphone.Address	To `[get]`

Linphone.Address	ToAddress `[get]`

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)

static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)

IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)

void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Object representing an event state, which is subcribed or published.

See : Linphone.Core.Publish()

See : Linphone.Core.Subscribe()

Member Function Documentation

void Linphone.Event.AcceptPublish ( )

inline

Accept an incoming publish.

Returns: 0 if successful, error code otherwise

void Linphone.Event.AcceptSubscription ( )

inline

Accept an incoming subcription.

Returns: 0 if successful, error code otherwise

void Linphone.Event.AddCustomHeader	(	string	name,
		string	val
	)

inline

Add a custom header to an outgoing susbscription or publish.

Parameters

name	header's name
val	the header's value.

void Linphone.Event.DenyPublish ( Linphone.Reason reason )

inline

Deny an incoming publish with given reason.

Parameters

reason The Linphone.Reason of denial.

Returns: 0 if successful, error code otherwise

void Linphone.Event.DenySubscription ( Linphone.Reason reason )

inline

Deny an incoming subscription with given reason.

Parameters

reason The Linphone.Reason of denial.

Returns: 0 if successful, error code otherwise

string Linphone.Event.GetCustomHeader ( string name )

inline

Obtain the value of a given header for an incoming subscription.

Parameters

name	header's name

Returns: the header's value or null if such header doesn't exist.

void Linphone.Event.Notify ( Linphone.Content body )

inline

Send a notification.

Parameters

body	an optional body containing the actual notification data.

Returns: 0 if successful, -1 otherwise.

void Linphone.Event.PausePublish ( )

inline

Prevent an event from refreshing its publish.

This is useful to let registrations to expire naturally (or) when the application wants to keep control on when refreshes are sent. The refreshing operations can be resumed with Linphone.ProxyConfig.RefreshRegister().

void Linphone.Event.RefreshPublish ( )

inline

Refresh an outgoing publish keeping the same body.

Returns: 0 if successful, -1 otherwise.

void Linphone.Event.RefreshSubscribe ( )

inline

Refresh an outgoing subscription keeping the same body.

Returns: 0 if successful, -1 otherwise.

void Linphone.Event.RemoveCustomHeader ( string name )

inline

Remove custom header to an outgoing susbscription or publish.

Parameters

name	header's name

void Linphone.Event.SendPublish ( Linphone.Content body )

inline

Send a publish created by Linphone.Core.CreatePublish().

Parameters

body	the new data to be published

Returns: 0 if successful, -1 otherwise.

void Linphone.Event.SendSubscribe ( Linphone.Content body )

inline

Send a subscription previously created by Linphone.Core.CreateSubscribe().

Parameters

body	optional content to attach with the subscription.

Returns: 0 if successful, -1 otherwise.

void Linphone.Event.Terminate ( )

inline

Terminate an incoming or outgoing subscription that was previously acccepted, or a previous publication.

The Linphone.Event shall not be used anymore after this operation.

void Linphone.Event.UpdatePublish ( Linphone.Content body )

inline

Update (refresh) a publish.

Parameters

body	the new data to be published

Returns: 0 if successful, error code otherwise

void Linphone.Event.UpdateSubscribe ( Linphone.Content body )

inline

Update (refresh) an outgoing subscription, changing the body.

Parameters

body	an optional body to include in the subscription update, may be null.

Returns: 0 if successful, error code otherwise

Property Documentation

string Linphone.Event.CallId

get

Get the call ID of the subscription.

Returns: The call ID used by the call as a string.

Linphone.Core Linphone.Event.Core

get

Returns back pointer to the Linphone.Core that created this Linphone.Event.

Returns: the Linphone.Core object associated.

Linphone.ErrorInfo Linphone.Event.ErrorInfo

get

Get full details about an error occured.

Returns: a Linphone.ErrorInfo object.

Linphone.Address Linphone.Event.From

get

Get the "from" address of the subscription.

Returns: the from Linphone.Address.

Deprecated : 19/07/2020 use Linphone.Event.FromAddress instead

Linphone.Address Linphone.Event.FromAddress

get

Get the "from" address of the subscription.

Returns: the from Linphone.Address.

string Linphone.Event.Name

get

Get the name of the event as specified in the event package RFC.

Returns: the event name.

Linphone.PublishState Linphone.Event.PublishState

get

Get publish state.

If the event object was not created by a publish mechanism, Linphone.PublishState.None is returned.

Returns: the current Linphone.PublishState

Linphone.Reason Linphone.Event.Reason

get

Return reason code (in case of error state reached).

Returns: a Linphone.Reason enum

Linphone.Address Linphone.Event.RemoteContact

get

Get the "contact" address of the subscription.

Returns: The "contact" address of the subscription

Linphone.Address Linphone.Event.RequestAddress

getset

Get the "request uri" address of the subscription.

Returns: the request uri Linphone.Address.

Linphone.Address Linphone.Event.Resource

get

Get the resource address of the subscription or publish.

Returns: the resource Linphone.Address.

Linphone.SubscriptionDir Linphone.Event.SubscriptionDir

get

Get subscription direction.

If the object wasn't created by a subscription mechanism, Linphone.SubscriptionDir.InvalidDir is returned.

Returns: the Linphone.SubscriptionDir

Linphone.SubscriptionState Linphone.Event.SubscriptionState

get

Get subscription state.

If the event object was not created by a subscription mechanism, Linphone.SubscriptionState.None is returned.

Returns: the current Linphone.SubscriptionState

Linphone.Address Linphone.Event.To

get

Get the "to" address of the subscription.

Returns: the to Linphone.Address.

Deprecated : 19/07/2020 use Linphone.Event.ToAddress instead

Linphone.Address Linphone.Event.ToAddress

get

Get the "to" address of the subscription.

Returns: the to Linphone.Address.

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

LinphoneWrapper.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation