com.zoiper.zdk.Configurations

Class PushConfig

java.lang.Object

com.zoiper.zdk.Configurations.PushConfig

public class PushConfig
extends java.lang.Object

Push notification specific configuration Mobile platforms only (Android and iOS)!

Constructor Summary

Constructors

Constructor and Description
PushConfig(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
java.lang.String	cid() Gets the Push ID ("pn-cid" parameter) used for registering a device at the Push Proxy
void	cid(java.lang.String value) Sets the Push ID ("pn-cid" parameter) used for registering a device at the Push Proxy
boolean	enabled() Gets the use of push notifications
void	enabled(boolean value) Sets the use of push notifications
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
boolean	isEqual(PushConfig comp) Compares the current configuration with the given one
java.lang.String	proxy() Gets the Push Proxy address all SIP messages go through The Push Proxy is used as SIP Outbound Proxy.
void	proxy(java.lang.String value) Sets the Push Proxy address all SIP messages go through The Push Proxy is used as SIP Outbound Proxy.
boolean	rtpMediaProxy() Gets the use of the push notifications proxy also acting as media proxy
void	rtpMediaProxy(boolean value) Sets the use of the push notifications proxy also acting as media proxy
java.lang.String	token() Gets the Push Device TOKEN part of the "pn-uri" parameter used for registering a device at the Push Proxy
void	token(java.lang.String value) Sets the Push Device TOKEN part of the "pn-uri" parameter used for registering a device at the Push Proxy
TransportType	transport() Gets the selected transport being used to reach the push proxy
void	transport(TransportType value) Selects the transport to be used to reach the push proxy
java.lang.String	type() Gets the Push TYPE ("pn-type" parameter) used for registering a device at the Push Proxy
void	type(java.lang.String value) Sets the Push TYPE ("pn-type" parameter) used for registering a device at the Push Proxy
java.lang.String	uri() Gets the URI part of the "pn-uri" parameter used for registering a device at the Push Proxy
void	uri(java.lang.String value) Sets the URI part of the "pn-uri" parameter used for registering a device at the Push Proxy

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushConfig

public PushConfig(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

enabled

public boolean enabled()

Gets the use of push notifications

Returns:

• 0 - disabled
• 1 - enabled

enabled

public void enabled(boolean value)

Sets the use of push notifications

Parameters:

value -

• 0 - disabled
• 1 - enabled

rtpMediaProxy

public boolean rtpMediaProxy()

Gets the use of the push notifications proxy also acting as media proxy

Returns:

• 0 - disabled
• 1 - enabled

rtpMediaProxy

public void rtpMediaProxy(boolean value)

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

Parameters:

value -

• 0 - disabled
• 1 - enabled

transport

public TransportType transport()

Gets the selected transport being used to reach the push proxy

Returns:

The selected transport in use

See Also:

TransportType

transport

public void transport(TransportType value)

Selects the transport to be used to reach the push proxy

Parameters:

value - The transport to be used

See Also:

TransportType

uri

public java.lang.String uri()

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

Returns:

The URI part of the "pn-uri" parameter

uri

public void uri(java.lang.String value)

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

Parameters:

value - The URI part of the "pn-uri" parameter

token

public java.lang.String token()

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

Returns:

The Push Device TOKEN part of the "pn-uri" parameter

token

public void token(java.lang.String value)

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

Parameters:

value - The Push Device TOKEN part of the "pn-uri" parameter

type

public java.lang.String type()

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

Returns:

The Push Type ("pn-type" parameter)

type

public void type(java.lang.String value)

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

Parameters:

value - The Push Type ("pn-type" parameter)

cid

public java.lang.String cid()

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

Returns:

The Push ID ("pn-cid" parameter)

cid

public void cid(java.lang.String value)

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

Parameters:

value - The Push ID ("pn-cid" parameter)

proxy

public java.lang.String proxy()

Gets the Push Proxy address all SIP messages go through The Push Proxy is used as SIP Outbound Proxy.

Returns:

The Push Proxy

proxy

public void proxy(java.lang.String value)

Sets the Push Proxy address all SIP messages go through The Push Proxy is used as SIP Outbound Proxy.

Parameters:

value - The Push Proxy

isEqual

public boolean isEqual(PushConfig comp)

Compares the current configuration with the given one

Parameters:

comp - Push configuration to be compared

Returns:

• 0 - not equal
• 1 - equal