QBSettings (workspace API)

java.lang.Object
- com.quickblox.auth.session.QBSettings

```
public final class QBSettings
extends java.lang.Object
```
The QBSettings is a hub to setup your QuickBlox application/account settings

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QBSettings.AutoUpdateMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`QBSettings.AutoUpdateMode`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkInit()` Checks the QuickBlox settings and throws an exception if something wrong
`QBSettings`	`fastConfigInit(java.lang.String applicationId, java.lang.String authorizationKey, java.lang.String authorizationSecret)` Deprecated. As of release 2.4, Use 'init' then.
`java.lang.String`	`getAccountKey()` Gets the account key
`java.lang.String`	`getApiEndpoint()` Get the API server endpoint
`java.lang.String`	`getApiVersion()` Get the current REST API version
`java.lang.String`	`getApplicationId()` Get the application ID
`java.lang.String`	`getAuthorizationKey()` Get the authorization key
`java.lang.String`	`getAuthorizationSecret()` Get the authorization secret
`java.lang.String`	`getChatDefaultResource()` Retrieves the chat default resource
`java.lang.String`	`getChatEndpoint()` Get the chat server endpoint
`java.lang.String`	`getChatServerDomain()` Deprecated. As of release 2.4, Use 'getChatEndpoint' then.
`java.lang.String`	`getContentBucketName()` Deprecated. As of release 2.4, don't need to use this method anymore.
`Context`	`getContext()` Get the context
`static QBSettings`	`getInstance()` Obtains QBSettings singleton instance
`LogLevel`	`getLogLevel()` Get the log level
`java.lang.String`	`getServerApiDomain()` Deprecated. As of release 2.4, Use 'getApiEndpoint' then.
`StoringMechanism`	`getStoringMehanism()`
`SubscribePushStrategy`	`getSubscribePushStrategy()` Get the subscribePushStrategy
`QBSettings.AutoUpdateMode`	`getUpdateMode()` Gets the update mode of services endpoints
`java.lang.String`	`getVersionName()` Get the current SDK version
`ServiceZone`	`getZone()` Gets the current service zone
`QBSettings`	`init(Context context, java.lang.String applicationId, java.lang.String authorizationKey, java.lang.String authorizationSecret)` Init the QuickBlox settings
`boolean`	`isAutoCreateSession()` Get the autoCreateSession
`boolean`	`isEnablePushNotification()` Get the enablePushNotification
`QBSettings`	`setAccountKey(java.lang.String accountKey)` Sets the account key
`QBSettings`	`setApiVersion(java.lang.String restApiVersion)` Sets the current REST API version
`QBSettings`	`setApplicationId(java.lang.String applicationId)` Deprecated. As of release 2.4, Use 'init' then.
`QBSettings`	`setAuthorizationKey(java.lang.String authKey)` Deprecated. As of release 2.4, Use 'init' then.
`QBSettings`	`setAuthorizationSecret(java.lang.String authSecret)` Deprecated. As of release 2.4, Use 'init' then.
`void`	`setAutoCreateSession(boolean autoCreateSession)` Sets the autoCreateSession
`QBSettings`	`setChatServerDomain(java.lang.String chatServerDomain)` Deprecated. As of release 2.4, Use 'setEndpoints' then.
`QBSettings`	`setContentBucketName(java.lang.String contentBucketDomain)` Deprecated. As of release 2.4, don't need to use this method anymore.
`void`	`setEnablePushNotification(boolean enablePushNotification)` Sets the enablePushNotification
`QBSettings`	`setEndpoints(java.lang.String apiEndpoint, java.lang.String chatEndpoint, ServiceZone zone)` Sets the current server API and Chat domains for zone
`QBSettings`	`setLogLevel(LogLevel logLevel)` Sets the log level
`QBSettings`	`setServerApiDomain(java.lang.String serverDomain)` Deprecated. As of release 2.4, Use 'setEndpoints' then.
`void`	`setStoringMehanism(StoringMechanism mechanism)`
`void`	`setSubscribePushStrategy(SubscribePushStrategy subscribePushStrategy)` Set the subscribePushStrategy
`QBSettings`	`setZone(ServiceZone zone)` Allow to change service zone to work with Development and Staging environments
`java.lang.String`	`toString()`

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

- Method Detail
  - getInstance
```
public static QBSettings getInstance()
```
    Obtains QBSettings singleton instance
    
    Returns:
    
    QBSettings instance
  - fastConfigInit
```
@Deprecated
public QBSettings fastConfigInit(java.lang.String applicationId,
                                             java.lang.String authorizationKey,
                                             java.lang.String authorizationSecret)
```
    Deprecated. As of release 2.4, Use 'init' then.
  - init
```
public QBSettings init(Context context,
                       java.lang.String applicationId,
                       java.lang.String authorizationKey,
                       java.lang.String authorizationSecret)
```
    Init the QuickBlox settings
    
    Parameters:
    
    applicationId - the application Id
    
    authorizationKey - the authorization key
    
    authorizationSecret - the authorization secret
    
    Returns:
    
    QBSettings instance
  - getContext
```
public Context getContext()
```
    Get the context
  - getServerApiDomain
```
public java.lang.String getServerApiDomain()
```
    Deprecated. As of release 2.4, Use 'getApiEndpoint' then.
  - getApiEndpoint
```
public java.lang.String getApiEndpoint()
```
    Get the API server endpoint
  - setServerApiDomain
```
@Deprecated
public QBSettings setServerApiDomain(java.lang.String serverDomain)
```
    Deprecated. As of release 2.4, Use 'setEndpoints' then.
  - getChatServerDomain
```
@Deprecated
public java.lang.String getChatServerDomain()
```
    Deprecated. As of release 2.4, Use 'getChatEndpoint' then.
  - getChatEndpoint
```
public java.lang.String getChatEndpoint()
```
    Get the chat server endpoint
  - setChatServerDomain
```
@Deprecated
public QBSettings setChatServerDomain(java.lang.String chatServerDomain)
```
    Deprecated. As of release 2.4, Use 'setEndpoints' then.
  - setEndpoints
```
public QBSettings setEndpoints(java.lang.String apiEndpoint,
                               java.lang.String chatEndpoint,
                               ServiceZone zone)
```
    Sets the current server API and Chat domains for zone
    
    Parameters:
    
    apiEndpoint - the API server domain to set
    
    chatEndpoint - the Chat server API domain to set
    
    zone - the server API domain to set
    
    Returns:
    
    QBSettings instance
  - setZone
```
public QBSettings setZone(ServiceZone zone)
```
    Allow to change service zone to work with Development and Staging environments
    
    Parameters:
    
    zone - Service zone. One from ZoneType. Default - ZoneType.AUTOMATIC
  - getZone
```
public ServiceZone getZone()
```
    Gets the current service zone
  - getContentBucketName
```
@Deprecated
public java.lang.String getContentBucketName()
```
    Deprecated. As of release 2.4, don't need to use this method anymore.
  - setContentBucketName
```
@Deprecated
public QBSettings setContentBucketName(java.lang.String contentBucketDomain)
```
    Deprecated. As of release 2.4, don't need to use this method anymore.
  - getAuthorizationKey
```
public java.lang.String getAuthorizationKey()
```
    Get the authorization key
  - setAuthorizationKey
```
@Deprecated
public QBSettings setAuthorizationKey(java.lang.String authKey)
```
    Deprecated. As of release 2.4, Use 'init' then.
  - getApplicationId
```
public java.lang.String getApplicationId()
```
    Get the application ID
  - setApplicationId
```
@Deprecated
public QBSettings setApplicationId(java.lang.String applicationId)
```
    Deprecated. As of release 2.4, Use 'init' then.
  - getAuthorizationSecret
```
public java.lang.String getAuthorizationSecret()
```
    Get the authorization secret
  - setAuthorizationSecret
```
@Deprecated
public QBSettings setAuthorizationSecret(java.lang.String authSecret)
```
    Deprecated. As of release 2.4, Use 'init' then.
  - getLogLevel
```
public LogLevel getLogLevel()
```
    Get the log level
  - setLogLevel
```
public QBSettings setLogLevel(LogLevel logLevel)
```
    Sets the log level
    
    Parameters:
    
    logLevel - the log level to set
    
    Returns:
    
    QBSettings instance
  - isAutoCreateSession
```
public boolean isAutoCreateSession()
```
    Get the autoCreateSession
  - setAutoCreateSession
```
public void setAutoCreateSession(boolean autoCreateSession)
```
    Sets the autoCreateSession
    
    Parameters:
    
    autoCreateSession - the autoCreateSession to set
  - getSubscribePushStrategy
```
public SubscribePushStrategy getSubscribePushStrategy()
```
    Get the subscribePushStrategy
  - setSubscribePushStrategy
```
public void setSubscribePushStrategy(SubscribePushStrategy subscribePushStrategy)
```
    Set the subscribePushStrategy
    
    Parameters:
    
    subscribePushStrategy - to subscribe Pushes to set
  - isEnablePushNotification
```
public boolean isEnablePushNotification()
```
    Get the enablePushNotification
  - setEnablePushNotification
```
public void setEnablePushNotification(boolean enablePushNotification)
```
    Sets the enablePushNotification
    
    Parameters:
    
    enablePushNotification - to show Push to set
  - setStoringMehanism
```
public void setStoringMehanism(StoringMechanism mechanism)
```
  - getStoringMehanism
```
public StoringMechanism getStoringMehanism()
```
  - getApiVersion
```
public java.lang.String getApiVersion()
```
    Get the current REST API version
  - setApiVersion
```
public QBSettings setApiVersion(java.lang.String restApiVersion)
```
    Sets the current REST API version
    
    Parameters:
    
    restApiVersion - the server API domain to set
    
    Returns:
    
    QBSettings instance
  - getVersionName
```
public java.lang.String getVersionName()
```
    Get the current SDK version
  - getAccountKey
```
public java.lang.String getAccountKey()
```
    Gets the account key
  - setAccountKey
```
public QBSettings setAccountKey(java.lang.String accountKey)
```
    Sets the account key
    
    Parameters:
    
    accountKey - the account key to set
  - checkInit
```
public void checkInit()
```
    Checks the QuickBlox settings and throws an exception if something wrong
  - getChatDefaultResource
```
public java.lang.String getChatDefaultResource()
```
    Retrieves the chat default resource
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getUpdateMode
```
public QBSettings.AutoUpdateMode getUpdateMode()
```
    Gets the update mode of services endpoints

Class QBSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

fastConfigInit

init

getContext

getServerApiDomain

getApiEndpoint

setServerApiDomain

getChatServerDomain

getChatEndpoint

setChatServerDomain

setEndpoints

setZone

getZone

getContentBucketName

setContentBucketName

getAuthorizationKey

setAuthorizationKey

getApplicationId

setApplicationId

getAuthorizationSecret

setAuthorizationSecret

getLogLevel

setLogLevel

isAutoCreateSession

setAutoCreateSession

getSubscribePushStrategy

setSubscribePushStrategy

isEnablePushNotification

setEnablePushNotification

setStoringMehanism

getStoringMehanism

getApiVersion

setApiVersion

getVersionName

getAccountKey

setAccountKey

checkInit

getChatDefaultResource

toString

getUpdateMode