net.rim.blackberry.api.bbm.platform
Class SettingsManager

java.lang.Object
  |
  +--net.rim.blackberry.api.bbm.platform.SettingsManager

public abstract class SettingsManager

extends Object

Allows the application to query user settings for the application. These settings can be set manually by the user within BBM.

Since:

BBM SDK 1.2

Field Summary

static int	SETTING_ALWAYS_ALLOW_PUBLIC_CONN This setting controls whether a prompt is shown when making a connection public or requesting to join a public connection.
static int	SETTING_PROFILE_BOX This setting controls whether the application appears in the current user's BBM profile.
static int	VALUE_DISABLED Represents a setting value of disabled.
static int	VALUE_ENABLED Represents a setting value of enabled.
static int	VALUE_PROMPT Represents a setting value of prompt.

Method Summary

abstract int

getSetting(int setting) Returns the value of a setting for the calling application.

Field Detail

SETTING_ALWAYS_ALLOW_PUBLIC_CONN

public static final int SETTING_ALWAYS_ALLOW_PUBLIC_CONN

This setting controls whether a prompt is shown when making a connection public or requesting to join a public connection. If VALUE_ENABLED then the prompt is never shown, if VALUE_PROMPT then the prompt is shown.

See Also:

BBMPlatformConnection.setPublic(), MessagingService.sendJoinRequest(int, java.lang.String, java.lang.String)

Since:

BBM SDK 1.3

SETTING_PROFILE_BOX

public static final int SETTING_PROFILE_BOX

This setting controls whether the application appears in the current user's BBM profile.

See Also:

UserProfileBox

Since:

BBM SDK 1.2

VALUE_DISABLED

public static final int VALUE_DISABLED

Represents a setting value of disabled.

Since:

BBM SDK 1.2

VALUE_ENABLED

public static final int VALUE_ENABLED

Represents a setting value of enabled.

Since:

BBM SDK 1.2

VALUE_PROMPT

public static final int VALUE_PROMPT

Represents a setting value of prompt.

Since:

BBM SDK 1.3

Method Detail

getSetting

public abstract int getSetting(int setting)

Returns the value of a setting for the calling application.

Parameters:

setting - The setting to check. One of the SETTING_* constants.

Returns:

The value for setting. One of the VALUE_* constants.

Throws:

IllegalArgumentException - if setting is invalid.

Since:

BBM SDK 1.2