Liblinphone  5.5.0
Linphone.PushNotificationConfig Class Reference
Inheritance diagram for Linphone.PushNotificationConfig:
Linphone.LinphoneObject

Public Member Functions

Linphone.PushNotificationConfig Clone ()
 
bool IsEqual (Linphone.PushNotificationConfig otherConfig)
 

Properties

string BundleIdentifier [get, set]
 
string CallSnd [get, set]
 
string CallStr [get, set]
 
string GroupChatStr [get, set]
 
string MsgSnd [get, set]
 
string MsgStr [get, set]
 
string Param [get, set]
 
string Prid [get, set]
 
string Provider [get, set]
 
string RemotePushInterval [set]
 
string RemoteToken [get, set]
 
string TeamId [get, set]
 
string VoipToken [get, set]
 

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 holding push notification configuration that will be set in the contact URI parameters of the Contact header in the REGISTER, if the Linphone.AccountParams is configured to allow push notifications, see Linphone.AccountParams.PushNotificationAllowed.

This object can be accessed through the Linphone.AccountParams object, which can be obtained from your Linphone.Account object.

Member Function Documentation

Linphone.PushNotificationConfig Linphone.PushNotificationConfig.Clone ( )
inline

Instantiate a new push notification parameters with values from source.

Returns
The newly created Linphone.PushNotificationConfig object.
bool Linphone.PushNotificationConfig.IsEqual ( Linphone.PushNotificationConfig  otherConfig)
inline

Checks if two Push Notification Configurations are identical.

Parameters
otherConfigThe Linphone.PushNotificationConfig object to compare to.
Returns
True only if the two configurations are identical.

Property Documentation

string Linphone.PushNotificationConfig.BundleIdentifier
getset

Gets the app's bundle identifier for "contact uri parameter".

Returns
The app's bundle identifier if set, null otherwise.
string Linphone.PushNotificationConfig.CallSnd
getset

Gets the call_snd for "contact uri parameter".

Returns
The call_snd, default value "notes_of_the_optimistic.caf".
string Linphone.PushNotificationConfig.CallStr
getset

Gets the call_str for "contact uri parameter".

Returns
The call_str, default value "IC_MSG".
string Linphone.PushNotificationConfig.GroupChatStr
getset

Gets the groupchat_str for "contact uri parameter".

Returns
The groupchat_str, default value "GC_MSG".
string Linphone.PushNotificationConfig.MsgSnd
getset

Gets the msg_snd for "contact uri parameter".

Returns
The msg_snd, default value "msg.caf".
string Linphone.PushNotificationConfig.MsgStr
getset

Gets the msg_str for "contact uri parameter".

Returns
The msg_str, default value "IM_MSG".
string Linphone.PushNotificationConfig.Param
getset

Gets the param for "contact uri parameter".

Returns
The param if set, null otherwise.
string Linphone.PushNotificationConfig.Prid
getset

Gets the prid for "contact uri parameter".

Returns
The prid if set, null otherwise.
string Linphone.PushNotificationConfig.Provider
getset

Gets the provider for "contact uri parameter".

Returns
The provider if set, null otherwise.
string Linphone.PushNotificationConfig.RemotePushInterval
set

Specifies the interval in seconds between to subsequent remote push notifications when remote push notifications are used to notify a call invite to clients that haven't published any token for VoIP and background push notifications.

In that case, several PNs are sent subsequently until the call is picked up, declined or canceled. This parameter sets a value for 'pn-call-remote-push-interval' Contact header inside SIP REGISTER requests. A value of zero will cause the deactivation of push notification repetitions and the sending of the final notification. Thus, only the first push notification will be sent. If specified the value must be in [0;30] If not specified 'pn-call-remote-push-interval' will not be added to Contact header.

Parameters
remotePushIntervalThe new remote push interval set for push notification config.
string Linphone.PushNotificationConfig.RemoteToken
getset

Gets the remote token for "contact uri parameter".

Returns
The remote token if set, null otherwise.
string Linphone.PushNotificationConfig.TeamId
getset

Gets the team id for "contact uri parameter".

Returns
The team id if set, null otherwise.
string Linphone.PushNotificationConfig.VoipToken
getset

Gets the voip token for "contact uri parameter".

Returns
The voip token if set, null otherwise.

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