Class Alert
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 AlertType enum. An application is notified of new alerts through the CoreListener interface. Once raised, the application may use the AlertListener interface to get notified when the alert stops. For each kind of alert, a Dictionary is filled with relevant informations, returned by Informations. The keys available are documented per-type in AlertType enum.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class Alert : LinphoneObject
Properties
Call
Return the call from the alert.
Declaration
public Call Call { get; }
Property Value
Type | Description |
---|---|
Call | A Call from the alert. |
EndTime
Return the end time of the alert.
Declaration
public long EndTime { get; }
Property Value
Type | Description |
---|---|
System.Int64 | the end time of the alert. |
Informations
Return more informations about the alerts.
Declaration
public Dictionary Informations { get; }
Property Value
Type | Description |
---|---|
Dictionary | A Dictionary containing informations about the current alert. |
Listener
Declaration
public AlertListener Listener { get; set; }
Property Value
Type | Description |
---|---|
AlertListener |
StartTime
Return the start time of the alert.
Declaration
public long StartTime { get; }
Property Value
Type | Description |
---|---|
System.Int64 | the start time of the alert. |
State
Return the state of the alert.
Declaration
public bool State { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if and only if the alert is active. |
Type
Return the type of the alert.
Declaration
public AlertType Type { get; }
Property Value
Type | Description |
---|---|
AlertType | A AlertType corresponding to the current alert. |
Methods
Clone()
Clone the given alert.
Declaration
public Alert Clone()
Returns
Type | Description |
---|---|
Alert | A new alert with exactly same informations that param. |
NotifyOnTerminated()
Notify the alert if it is terminated.
Declaration
public void NotifyOnTerminated()
TypeToString(AlertType)
Provide a string describing the alert type.
Declaration
public static string TypeToString(AlertType type)
Parameters
Type | Name | Description |
---|---|---|
AlertType | type | the AlertType |
Returns
Type | Description |
---|---|
System.String | a string |