zdk.objc
Instance Methods | Properties | List of all members
<ZDKPushConfig> Protocol Reference

Push notification specific configuration. More...

#import <ZDKPushConfig.h>

Inheritance diagram for <ZDKPushConfig>:
<ZDKZHandle>

Instance Methods

(BOOL) - isEqual:
 Compares the current configuration with the given one. More...
 
(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

BOOL enabled
 Sets the use of push notifications. More...
 
BOOL rtpMediaProxy
 Sets the use of the push notifications proxy also acting as media proxy. More...
 
ZDKTransportType transport
 Selects the transport to be used to reach the push proxy. More...
 
NSString *_Nullable uri
 Sets the URI part of the "pn-uri" parameter used for registering a device at the Push Proxy. More...
 
NSString *_Nullable token
 Sets the Push Device TOKEN part of the "pn-uri" parameter used for registering a device at the Push Proxy. More...
 
NSString *_Nullable type
 Sets the Push TYPE ("pn-type" parameter) used for registering a device at the Push Proxy. More...
 
NSString *_Nullable cid
 Sets the Push ID ("pn-cid" parameter) used for registering a device at the Push Proxy. More...
 
NSString *_Nullable proxy
 Sets the Push Proxy address all SIP messages go through. More...
 

Detailed Description

Push notification specific configuration.

Mobile platforms only (Android and iOS)!

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

◆ isEqual:

- (BOOL) isEqual: (id< ZDKPushConfig >)  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

- (NSString* _Nullable) cid
readwritenonatomicassign

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) enabled
readwritenonatomicassign

Sets the use of push notifications.

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

◆ proxy

- (NSString* _Nullable) proxy
readwritenonatomicassign

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) rtpMediaProxy
readwritenonatomicassign

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

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

◆ token

- (NSString* _Nullable) token
readwritenonatomicassign

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

- (ZDKTransportType) transport
readwritenonatomicassign

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

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

◆ type

- (NSString* _Nullable) type
readwritenonatomicassign

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

- (NSString* _Nullable) uri
readwritenonatomicassign

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 protocol was generated from the following file: