MSRPConfig

java.lang.Object
- com.zoiper.zdk.Configurations.MSRPConfig

```
public class MSRPConfig
extends java.lang.Object
```
MSRP (Message Session Relay Protocol) specific account configuration

Constructor Summary

Constructors
Constructor and Description

MSRPConfig(long handle)
Constructor storing the pointer/address to the underlying native object

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`enableMSRP()` Gets the use of MSRP functionality as described in RFC 4975
`void`	`enableMSRP(boolean value)` Sets the use of MSRP functionality as described in RFC 4975
`boolean`	`enableMSRPChat()` Gets the use of MSRP chat functionality for the user MSRP chat is done through the messaging class and API - Message and sendMessage All messages are sent over SIP SIMPLE while an MSRP session is not active.
`void`	`enableMSRPChat(boolean value)` Configures the use of MSRP chat functionality for the user MSRP chat is done through the messaging class and API - Message and sendMessage All messages are sent over SIP SIMPLE while an MSRP session is not active.
`boolean`	`enableMSRPFileTransfer()` Gets the use of file transfer feature for the user The default is "disabled".
`void`	`enableMSRPFileTransfer(boolean value)` Configures file transfer feature for the user The default is "disabled".
`protected void`	`finalize()` Ensures the underlying native object destruction
`long`	`handle()` Gets the pointer/address to the underlying native object
`boolean`	`isEqual(MSRPConfig comp)` Compares the current configuration with the given one
`java.lang.String`	`msrpRelayPassword()` Gets the configures MSRP relay password for the user Configures the password to be used when authenticating to a MSRP relay.
`void`	`msrpRelayPassword(java.lang.String value)` Configures MSRP relay password for the user Configures the password to be used when authenticating to a MSRP relay.
`java.lang.String`	`msrpRelayURL()` Gets the configured MSRP relay URI The use of MSRP relay must be enabled through useMSRPRelay.
`void`	`msrpRelayURL(java.lang.String value)` Configures the MSRP relay URI The use of MSRP relay must be enabled through useMSRPRelay.
`java.lang.String`	`msrpRelayUserName()` Gets the configured MSRP relay authentication username for the user Configures the authentication username to be used when authenticating to a MSRP relay.
`void`	`msrpRelayUserName(java.lang.String value)` Configures MSRP relay authentication username for the user Configures the authentication username to be used when authenticating to a MSRP relay.
`int`	`msrpTcpPort()` Gets the configured main MSRP TCP port Configures the main TCP port for MSRP.
`void`	`msrpTcpPort(int value)` Configures the main MSRP TCP port Configures the main TCP port for MSRP.
`boolean`	`useMSRPRelay()` Gets the use of MSRP relay functionality as described in RFC 4976 Routes all MSRP requests through the MSRP relay configured with msrpRelayURL.
`void`	`useMSRPRelay(boolean value)` Configures the use of MSRP relay functionality as described in RFC 4976 Routes all MSRP requests through the MSRP relay configured with msrpRelayURL.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MSRPConfig
```
public MSRPConfig(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
  - enableMSRP
```
public boolean enableMSRP()
```
    Gets the use of MSRP functionality as described in RFC 4975
    Returns:
    0 - disabled
    1 - enabled
  - enableMSRP
```
public void enableMSRP(boolean value)
```
    Sets the use of MSRP functionality as described in RFC 4975
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
  - enableMSRPChat
```
public boolean enableMSRPChat()
```
    Gets the use of MSRP chat functionality for the user MSRP chat is done through the messaging class and API - Message and sendMessage All messages are sent over SIP SIMPLE while an MSRP session is not active. The ZDK will attempt to establish the session automatically but will also use a graylist in case the remote end does not support MSRP.
    Returns:
    0 - disabled
    1 - enabled
    See Also:
    
    sendMessage
  - enableMSRPChat
```
public void enableMSRPChat(boolean value)
```
    Configures the use of MSRP chat functionality for the user MSRP chat is done through the messaging class and API - Message and sendMessage All messages are sent over SIP SIMPLE while an MSRP session is not active. The ZDK will attempt to establish the session automatically but will also use a graylist in case the remote end does not support MSRP.
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
    See Also:
    
    sendMessage
  - enableMSRPFileTransfer
```
public boolean enableMSRPFileTransfer()
```
    Gets the use of file transfer feature for the user The default is "disabled". If the file transfer functionality is not enabled for a user all incoming file transfer will be automatically rejected. initiateTransfer will return -1 (L_FAIL) immediately and onFileTransferRequest will never arrive.
    Returns:
    0 - disabled
    1 - enabled
    See Also:
    
    initiateTransfer
  - enableMSRPFileTransfer
```
public void enableMSRPFileTransfer(boolean value)
```
    Configures file transfer feature for the user The default is "disabled". If the file transfer functionality is not enabled for a user all incoming file transfer will be automatically rejected. initiateTransfer will return -1 (L_FAIL) immediately and onFileTransferRequest will never arrive.
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
    See Also:
    
    initiateTransfer
  - useMSRPRelay
```
public boolean useMSRPRelay()
```
    Gets the use of MSRP relay functionality as described in RFC 4976 Routes all MSRP requests through the MSRP relay configured with msrpRelayURL. MSRP relays are almost always needed for MSRP to work for clients behind NATs.
    Returns:
    0 - disabled
    1 - enabled
    See Also:
    
    msrpRelayURL
  - useMSRPRelay
```
public void useMSRPRelay(boolean value)
```
    Configures the use of MSRP relay functionality as described in RFC 4976 Routes all MSRP requests through the MSRP relay configured with msrpRelayURL. MSRP relays are almost always needed for MSRP to work for clients behind NATs.
    Parameters:
    value -
    
    0 - disabled
    1 - enabled
    See Also:
    
    msrpRelayURL
  - msrpRelayURL
```
public java.lang.String msrpRelayURL()
```
    Gets the configured MSRP relay URI The use of MSRP relay must be enabled through useMSRPRelay. Configures the MSRP relay URI to use for MSRP sessions done with the same user and on behalf of contacts linked to the same user. The URI can be partial (just a hostname or an IP address), can contain a port (host:port or ip:port) and can be a full msrp or msrps URI (msrps: Certain other configuration parameters may override the URI parameters.
    
    Returns:
    
    MSRP relay URI
    
    See Also:
    
    msrpRelayUserName msrpRelayPassword
  - msrpRelayURL
```
public void msrpRelayURL(java.lang.String value)
```
    Configures the MSRP relay URI The use of MSRP relay must be enabled through useMSRPRelay. Configures the MSRP relay URI to use for MSRP sessions done with the same user and on behalf of contacts linked to the same user. The URI can be partial (just a hostname or an IP address), can contain a port (host:port or ip:port) and can be a full msrp or msrps URI (msrps: Certain other configuration parameters may override the URI parameters.
    
    Parameters:
    
    value - MSRP relay URI
    
    See Also:
    
    msrpRelayUserName msrpRelayPassword
  - msrpRelayUserName
```
public java.lang.String msrpRelayUserName()
```
    Gets the configured MSRP relay authentication username for the user Configures the authentication username to be used when authenticating to a MSRP relay. It overrides the default which is to use the SIP authentication username if available, or the SIP username itself as a last resort. The username is treated as nul-terminated string, UTF-8 (due to the fact that it is sent in the MSRP header).
    
    Returns:
    
    The MSRP relay authentication username
    
    See Also:
    
    msrpRelayPassword
  - msrpRelayUserName
```
public void msrpRelayUserName(java.lang.String value)
```
    Configures MSRP relay authentication username for the user Configures the authentication username to be used when authenticating to a MSRP relay. It overrides the default which is to use the SIP authentication username if available, or the SIP username itself as a last resort. The username is treated as nul-terminated string, UTF-8 (due to the fact that it is sent in the MSRP header).
    
    Parameters:
    
    value - The MSRP relay authentication username
    
    See Also:
    
    msrpRelayPassword
  - msrpRelayPassword
```
public java.lang.String msrpRelayPassword()
```
    Gets the configures MSRP relay password for the user Configures the password to be used when authenticating to a MSRP relay. Unlike the MSRP authentication username the password has NO fallback. Its default is the empty string (a valid password for the authentication algorithm). The password is treated as nul-terminated string, disregarding encoding. It does not appear verbatim anywhere and is used as a binary string during hash calculation.
    
    Returns:
    
    The MSRP relay password
    
    See Also:
    
    msrpRelayUserName
  - msrpRelayPassword
```
public void msrpRelayPassword(java.lang.String value)
```
    Configures MSRP relay password for the user Configures the password to be used when authenticating to a MSRP relay. Unlike the MSRP authentication username the password has NO fallback. Its default is the empty string (a valid password for the authentication algorithm). The password is treated as nul-terminated string, disregarding encoding. It does not appear verbatim anywhere and is used as a binary string during hash calculation.
    
    Parameters:
    
    value - The MSRP relay password
    
    See Also:
    
    msrpRelayUserName
  - msrpTcpPort
```
public int msrpTcpPort()
```
    Gets the configured main MSRP TCP port Configures the main TCP port for MSRP. This port is used to listen on all local interfaces for incoming MSRP connections. The default MSRP port is 2855 as described in RFC4975.
    
    Returns:
    
    The MSRP TCP port
  - msrpTcpPort
```
public void msrpTcpPort(int value)
```
    Configures the main MSRP TCP port Configures the main TCP port for MSRP. This port is used to listen on all local interfaces for incoming MSRP connections. The default MSRP port is 2855 as described in RFC4975.
    
    Parameters:
    
    value - The MSRP TCP port
  - isEqual
```
public boolean isEqual(MSRPConfig comp)
```
    Compares the current configuration with the given one
    Parameters:
    
    comp - SIP configuration to be compared
    
    Returns:
    0 - not equal
    1 - equal

Class MSRPConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MSRPConfig

Method Detail

handle

finalize

enableMSRP

enableMSRP

enableMSRPChat

enableMSRPChat

enableMSRPFileTransfer

enableMSRPFileTransfer

useMSRPRelay

useMSRPRelay

msrpRelayURL

msrpRelayURL

msrpRelayUserName

msrpRelayUserName

msrpRelayPassword

msrpRelayPassword

msrpTcpPort

msrpTcpPort

isEqual