Linphone.Alert Class Reference

Inheritance diagram for Linphone.Alert:

Public Member Functions
Linphone.Alert	Clone ()
void	NotifyOnTerminated ()

Static Public Member Functions
static string	TypeToString (Linphone.AlertType type)

Properties
AlertListener	Listener [get, set]
Linphone.Call	Call [get]
long	EndTime [get]
Linphone.Dictionary	Informations [get]
long	StartTime [get]
bool	State [get]
Linphone.AlertType	Type [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 that represents an alert.

Alerts are raised at run-time when particular conditions are met, for example bad network quality. The full list of available alert types is described by the Linphone.AlertType enum. An application is notified of new alerts through the Linphone.CoreListener interface. Once raised, the application may use the Linphone.AlertListener interface to get notified when the alert stops. For each kind of alert, a Linphone.Dictionary is filled with relevant informations, returned by Linphone.Alert.Informations. The keys available are documented per-type in Linphone.AlertType enum.

Member Function Documentation

Linphone.Alert Linphone.Alert.Clone ( )

inline

Clone the given alert.

Returns

A new alert with exactly same informations that param.

void Linphone.Alert.NotifyOnTerminated ( )

inline

Notify the alert if it is terminated.

static string Linphone.Alert.TypeToString ( Linphone.AlertType  type )

inlinestatic

Provide a string describing the alert type.

Parameters

type	the Linphone.AlertType

Returns

a string

Property Documentation

Linphone.Call Linphone.Alert.Call

get

Return the call from the alert.

Returns

A Linphone.Call from the alert.

long Linphone.Alert.EndTime

get

Return the end time of the alert.

Returns

the end time of the alert.

Linphone.Dictionary Linphone.Alert.Informations

get

Return more informations about the alerts.

Returns

A Linphone.Dictionary containing informations about the current alert.

long Linphone.Alert.StartTime

get

Return the start time of the alert.

Returns

the start time of the alert.

bool Linphone.Alert.State

get

Return the state of the alert.

Returns

true if and only if the alert is active.

Linphone.AlertType Linphone.Alert.Type

get

Return the type of the alert.

Returns

A Linphone.AlertType corresponding to the current alert.

---

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

• LinphoneWrapper.cs