zdk.net
Public Member Functions | Public Attributes | Properties | List of all members
ZDK_NET::PushConfig Class Reference

Push notification specific configuration. More...

#include <PushConfig.h>

Inheritance diagram for ZDK_NET::PushConfig:
ZDK_NET::ZHandle

Public Member Functions

 PushConfig (ZDK::Shared::PushConfig src)
 
bool IsEqual (ZDK_NET::PushConfig^ comp)
 Compares the current configuration with the given one. More...
 
virtual long long Handle () override
 
virtual void Initialize () override
 
virtual void ReleaseReference () override
 

Public Attributes

ZDK::IPushConfig * cppRef = nullptr
 

Properties

bool Enabled [get, set]
 Sets the use of push notifications. More...
 
bool RtpMediaProxy [get, set]
 Sets the use of the push notifications proxy also acting as media proxy. More...
 
ZDK_NET::TransportType Transport [get, set]
 Selects the transport to be used to reach the push proxy. More...
 
System::String^ URI [get, set]
 Sets the URI part of the "pn-uri" parameter used for registering a device at the Push Proxy. More...
 
System::String^ Token [get, set]
 Sets the Push Device TOKEN part of the "pn-uri" parameter used for registering a device at the Push Proxy. More...
 
System::String^ Type [get, set]
 Sets the Push TYPE ("pn-type" parameter) used for registering a device at the Push Proxy. More...
 
System::String^ CID [get, set]
 Sets the Push ID ("pn-cid" parameter) used for registering a device at the Push Proxy. More...
 
System::String^ Proxy [get, set]
 Sets the Push Proxy address all SIP messages go through. More...
 

Detailed Description

Push notification specific configuration.

Mobile platforms only (Android and iOS)!

Member Function Documentation

◆ IsEqual()

bool ZDK_NET::PushConfig::IsEqual ( ZDK_NET::PushConfig comp)

Compares the current configuration with the given one.

Parameters
[in]compPush configuration to be compared
Returns
  • 0 - not equal
  • 1 - equal

Property Documentation

◆ CID

System:: String^ ZDK_NET::PushConfig::CID
getset

Sets the Push ID ("pn-cid" parameter) used for registering a device at the Push Proxy.

Parameters
[in]valueThe Push ID ("pn-cid" parameter)

◆ Enabled

bool ZDK_NET::PushConfig::Enabled
getset

Sets the use of push notifications.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled

◆ Proxy

System:: String^ ZDK_NET::PushConfig::Proxy
getset

Sets the Push Proxy address all SIP messages go through.

The Push Proxy is used as SIP Outbound Proxy.

Parameters
[in]valueThe Push Proxy

◆ RtpMediaProxy

bool ZDK_NET::PushConfig::RtpMediaProxy
getset

Sets the use of the push notifications proxy also acting as media proxy.

Parameters
[in]value
  • 0 - disabled
  • 1 - enabled

◆ Token

System:: String^ ZDK_NET::PushConfig::Token
getset

Sets the Push Device TOKEN part of the "pn-uri" parameter used for registering a device at the Push Proxy.

Parameters
[in]valueThe Push Device TOKEN part of the "pn-uri" parameter

◆ Transport

ZDK_NET:: TransportType ZDK_NET::PushConfig::Transport
getset

Selects the transport to be used to reach the push proxy.

Parameters
[in]valueThe transport to be used
See also
TransportType

◆ Type

System:: String^ ZDK_NET::PushConfig::Type
getset

Sets the Push TYPE ("pn-type" parameter) used for registering a device at the Push Proxy.

Parameters
[in]valueThe Push Type ("pn-type" parameter)

◆ URI

System:: String^ ZDK_NET::PushConfig::URI
getset

Sets the URI part of the "pn-uri" parameter used for registering a device at the Push Proxy.

Parameters
[in]valueThe URI part of the "pn-uri" parameter

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