Quickblox.framework v 2.13

Author: pro100andrey

Framework/Quickblox.framework/Headers/QBSettings.h

@@ -11,145 +11,108 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-typedef NS_ENUM(NSUInteger, QBConnectionZoneType) {
-    
-    QBConnectionZoneTypeAutomatic       = 1, //Default. Endpoints are loaded from QuickBlox
-    QBConnectionZoneTypeProduction      = 2,
-    QBConnectionZoneTypeDevelopment     = 3,
-    QBConnectionZoneTypeStage           = 4
-};
-
 /** 
- *  QBSettings class interface.
- *  Class for framework setup.
+ QBSettings class interface.
+ Class for framework setup.
  */
 @interface QBSettings : NSObject
 
-/**
- *  Allows to set api endpoint and chat endpoint for service zone.
- *
- *  @note QBConnectionZoneTypeAutomatic is used by default.
- *  If you are using shared server and you are migrating to enterprise account,
- *  then you don't need to resubmit your application, endpoints will be updated automatically.
- 
- *  To set custom endpoints use QBConnectionZoneTypeProduction or QBConnectionZoneTypeDevelopment service zone.
- *  Then you should manually activate your service zone by calling setServiceZone:
- *
- *  @param apiEndpoint  apiEndpoint - Endpoint for service i.e. http://my_custom_endpoint.com. Possible to pass nil to return to default settings
- *  @param chatEndpoint chat endpoint
- *  @param zone         QBConnectionZoneType - service zone
- */
-+ (void)setApiEndpoint:(nullable NSString *)apiEndpoint chatEndpoint:(nullable NSString *)chatEndpoint forServiceZone:(QBConnectionZoneType)zone;
+/** Storing Application ID */
+@property (nonatomic, class) NSUInteger applicationID;
+/** Setting API Key for Quickblox API */
+@property (nonatomic, class, nullable) NSString *authKey;
 
-//MARK: - Chat settings
+/** Setting API Secret for Quickblox API */
+@property (nonatomic, class, nullable) NSString *authSecret;
 
-/**
- *  Enable or disable chat auto reconnect
- *
- *  @param autoReconnectEnabled The default value is NO
- */
-+ (void)setAutoReconnectEnabled:(BOOL)autoReconnectEnabled;
+/**Set account key (from admin.quickblox.com). This parameter is skipped for custom endpoints. */
+@property (nonatomic, class, nullable) NSString *accountKey;
 
-/**
- *  Enable or disable message carbons
- *
- *  @note Call this method after chat connection has been established
- *  @param carbonsEnabled BOOL value
- */
-+ (void)setCarbonsEnabled:(BOOL)carbonsEnabled;
+/** Setting application group identifier */
+@property (nonatomic, class, nullable) NSString *applicationGroupIdentifier;
 
-/// Set timeout value for Stream Management send a message operation
-+ (void)setStreamManagementSendMessageTimeout:(NSUInteger)streamManagementSendMessageTimeout;
+/** Setting Api Endpoint. Default - https://api.quickblox.com*/
+@property (nonatomic, class, null_resettable) NSString *apiEndpoint;
 
-/** A reconnect timer may optionally be used to attempt a reconnect periodically.
-    Default value is 5 seconds */
-+ (void)setReconnectTimerInterval:(NSTimeInterval)reconnectTimerInterval;
+/** Setting Chat endpoint. Default - chat.quickblox.com */
+@property (nonatomic, class, null_resettable) NSString *chatEndpoint;
 
 /**
- * Many routers will teardown a socket mapping if there is no activity on the socket.
- * For this reason, the stream supports sending keep-alive data.
- * This is simply whitespace, which is ignored by the protocol.
- *
- * Keep-alive data is only sent in the absence of any other data being sent/received.
- *
- * The default value is 20s.
- * The minimum value for TARGET_OS_IPHONE is 10s, else 20s.
- *
- * To disable keep-alive, set the interval to zero (or any non-positive number).
- *
- * The keep-alive timer (if enabled) fires every (keepAliveInterval / 4) seconds.
- * Upon firing it checks when data was last sent/received,
- * and sends keep-alive data if the elapsed time has exceeded the keepAliveInterval.
- * Thus the effective resolution of the keepalive timer is based on the interval.
- */
-+ (void)setKeepAliveInterval:(NSTimeInterval)keepAliveInterval;
-
-//MARK: - Credentials
-
-/// Storing Application ID
-+ (void)setApplicationID:(NSUInteger)applicationID;
+ Load QuickBlox application settings from QBSettings-Info.plist.
+ 
+ @warning This method should be used only for Continuous Integration (CI), because of security reasons
+ 
+ @discussion Raises an exception if any configuration step fails.
+ @note This method should be called after the app is launched and before using Quickblox services.
+ 
+ @code
+ Required keys:
 
-/**
- Set account key
+ applicationID : Number
+ authorizationKey : String
+ authorizationSecret : String
+ accountKey : String
+ 
+ Optional keys:
  
- @param accountKey Account key - from admin.quickblox.com
+ apiEndpoint : String
+ chatEndpoint : String
+ autoReconnectEnabled : BOOL
+ carbonsEnabled : BOOL
+ streamManagementSendMessageTimeout : Integer
+ reconnectTimerInterval : Double
+ keepAliveInterval : Double
+ chatEndpointPort : Integer
+ @endcode
  */
-+ (void)setAccountKey:(NSString *)accountKey;
++ (void)settingsFromPlist;
 
 /**
- * Setting API Key for Quickblox API
- *
- * @param authKey - NSString value of API Key.
+ Load QuickBlox application settings from specific plist with name.
+ 
+ @param name plist file name
  */
-+ (void)setAuthKey:(NSString *)authKey;
++ (void)settingsFromPlistWithName:(NSString *)name;
 
-/**
- * Setting API Secret for Quickblox API
- *
- * @param authSecret - NSString value of API Secret.
- */
-+ (void)setAuthSecret:(NSString *)authSecret;
+@end
 
-/**
- * Setting application group identifier
- *
- * @param appGroupIdentifier - NSString value of identifier.
- */
 
-+ (void)setApplicationGroupIdentifier:(NSString *)appGroupIdentifier;
 
-//MARK: - Endpoints
+@interface QBSettings (QBChat)
 
-/**
- * Allows to change Services Zone to work with Production, Development and Staging environments
- *
- * @param serviceZone - Service Zone. One from QBConnectionZoneType. Default - QBConnectionZoneTypeAutomatic.
- */
-+ (void)setServiceZone:(QBConnectionZoneType)serviceZone;
+/**Enable or disable chat auto reconnect. The default value is NO */
+@property (nonatomic, class) BOOL autoReconnectEnabled;
 
-/**
- *  Return current Service Zone
- *
- *  @note serviceZone - Service Zone. One from QBConnectionZoneType. Default - QBConnectionZoneTypeAutomatic
- */
-+ (QBConnectionZoneType)currentServiceZone;
+/** Enable or disable message carbons */
+@property (nonatomic, class) BOOL carbonsEnabled;
+
+/** Set timeout value for Stream Management send a message operation */
+@property (nonatomic, class) NSUInteger streamManagementSendMessageTimeout;
 
 /**
- *  Returns Api Endpoint for current zone
- *
- *  @return NSString value of Api Endpoint
+ A reconnect timer may optionally be used to attempt a reconnect periodically.
+ Default value is 5 seconds
  */
-+ (nullable NSString *)apiEndpoint;
-
-//MARK: - Chat Endpoints
+@property (nonatomic, class) NSTimeInterval reconnectTimerInterval;
 
 /**
- Get server's Chat endpoint
-
- @note you have to prepend http or https prefix
- @return Current server's Chat endpoint
+ Many routers will teardown a socket mapping if there is no activity on the socket.
+ For this reason, the stream supports sending keep-alive data.
+ This is simply whitespace, which is ignored by the protocol.
+ 
+ Keep-alive data is only sent in the absence of any other data being sent/received.
+ 
+ The default value is 20s.
+ The minimum value for TARGET_OS_IPHONE is 10s, else 20s.
+ 
+ To disable keep-alive, set the interval to zero (or any non-positive number).
+ 
+ The keep-alive timer (if enabled) fires every (keepAliveInterval / 4) seconds.
+ Upon firing it checks when data was last sent/received,
+ and sends keep-alive data if the elapsed time has exceeded the keepAliveInterval.
+ Thus the effective resolution of the keepalive timer is based on the interval.
  */
-+ (NSString *)chatEndpoint;
+@property (nonatomic, class) NSTimeInterval keepAliveInterval;
 
 /**
  The port the xmpp server is running on.
@@ -158,83 +121,131 @@ typedef NS_ENUM(NSUInteger, QBConnectionZoneType) {
  
  The default port is 5223.
  **/
-@property (assign, nonatomic, class) NSUInteger chatEndpointPort;
+@property (nonatomic, class) NSUInteger chatEndpointPort;
+
+@end
+
 
-//MARK: - Network Indicator
+
+@interface QBSettings (UIKit)
 
 /**
- * A Boolean value indicating whether the manager is enabled.
+ A Boolean value indicating whether the manager is enabled.
+ 
+ @note If YES, the manager will change status bar network activity indicator according to network
+ operation notifications it receives. The default value is NO.
  
- * If YES, the manager will change status bar network activity indicator according to network operation notifications it receives.
- * The default value is NO.
+ @param enabled
  */
 #if TARGET_OS_IOS
-+ (void)setNetworkIndicatorManagerEnabled:(BOOL)enabled;
+@property (nonatomic, class) BOOL networkIndicatorManagerEnabled;
 
 /**
- A Boolean value indicating whether the network activity indicator is currently displayed in the status bar.
+ A Boolean value indicating whether the network activity indicator is currently displayed in the
+ status bar.
  */
 + (BOOL)isNetworkIndicatorVisible;
 
 #endif
 
-//MARK: - Logging
+@end
 
-/**
- Set SDK log level (by default: QBLogLevelDebug). Possible values: QBLogLevelDebug, QBLogLevelNothing.
- 
- @param logLevel New log level
- */
-+ (void)setLogLevel:(QBLogLevel)logLevel;
 
-/**
- *  Enable full XMPP Framework logging to console. By default is disabled.
- */
+
+@interface QBSettings (Logging)
+
+/** Set SDK log level (by default: QBLogLevelDebug). Possible values: QBLogLevelDebug, QBLogLevelNothing. */
+@property (nonatomic, class) QBLogLevel logLevel;
+
+/** Enable full XMPP Framework logging to console. By default is disabled. */
 + (void)enableXMPPLogging;
 
+/** Disable full XMPP Framework logging to console. */
++ (void)disableXMPPLogging;
+
 /**
- *  Enable log to file
- *  The approximate maximum size to allow log files to grow.
- *  If a log file is larger than this value after a log statement is appended,
- *  then the log file is rolled.
- *  @param maximumFileSize maximum file size in bytes, for example: 1024 * 1024 * 10 = 10Mb
+ Enable log to file
+ 
+ The approximate maximum size to allow log files to grow.
+ If a log file is larger than this value after a log statement is appended,
+ then the log file is rolled.
+ 
+ @param maximumFileSize maximum file size in bytes, for example: 1024 * 1024 * 10 = 10Mb
  */
 + (void)enableFileLoggingWithMaximumFileSize:(unsigned long long)maximumFileSize;
 
-/**
- *  Disable logging to file
- */
+/** Disable logging to file */
 + (void)disableFileLogging;
 
 /**
- *  Returns log file paths if loggint to file is enabled
- *  Example name of log file: /var/mobile/Containers/Data/Application/518F9FD2-BB4C-4AF4-89D8-7FF85B0518B7/Library/Caches/Logs/com.quickblox.supersample 2016-03-25 11-23.log
- *
- *  @return Array of log file paths or nil if logging to file is disabled
+ Returns log file paths if loggint to file is enabled
+ Example name of log file:
+ /var/mobile/Containers/Data/Application/<UDID>/Library/Caches/Logs/com.quickblox.<app_name> 2016-03-25 11-23.log
+ 
+ @return Array of log file paths or nil if logging to file is disabled
  */
 + (nullable NSArray<NSString *> *)logFilePaths;
 
+@end
+
+@interface QBSettings (NSURLSessionConfiguration)
+
 /**
- *   Disable full XMPP Framework logging to console.
+ Set custom session configuration that will be used for REST API requests.
+ '[NSURLSessionConfiguration defaultSessionConfiguration]' is used if nil is passed.
  */
-+ (void)disableXMPPLogging;
 
-//MARK: - NSURLSessionConfiguration
+@property (nonatomic, class, nullable) NSURLSessionConfiguration *sessionConfiguration;
+
+@end
+
+typedef NS_ENUM(NSUInteger, QBConnectionZoneType) {
+    
+    QBConnectionZoneTypeAutomatic       = 1, //Default. Endpoints are loaded from QuickBlox
+    QBConnectionZoneTypeProduction      = 2,
+    QBConnectionZoneTypeDevelopment     = 3,
+    QBConnectionZoneTypeStage           = 4
+} DEPRECATED_ATTRIBUTE;
+
+@interface QBSettings (DEPRECATED)
+
+/**
+ Allows to set api endpoint and chat endpoint for service zone.
+
+ @note QBConnectionZoneTypeAutomatic is used by default.
+ If you are using shared server and you are migrating to enterprise account,
+ then you don't need to resubmit your application, endpoints will be updated automatically.
+
+ To set custom endpoints use QBConnectionZoneTypeProduction or QBConnectionZoneTypeDevelopment service zone.
+ Then you should manually activate your service zone by calling setServiceZone:
+
+ @param apiEndpoint  apiEndpoint - Endpoint for service i.e. http://my_custom_endpoint.com. Possible to pass nil to return to default settings
+ @param chatEndpoint chat endpoint
+ @param zone         QBConnectionZoneType - service zone
+ @warning Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints
+ */
++ (void)setApiEndpoint:(nullable NSString *)apiEndpoint
+          chatEndpoint:(nullable NSString *)chatEndpoint
+        forServiceZone:(QBConnectionZoneType)zone
+DEPRECATED_MSG_ATTRIBUTE("Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints");
 
 /**
- *  Set custom session configuration that will be used for REST API requests.
- *  '[NSURLSessionConfiguration defaultSessionConfiguration]' is used if nil is passed.
- *
- *  @param configuration Your NSURLSessionConfiguration object.
+Allows to change Services Zone to work with Production, Development and Staging environments
+
+@param serviceZone - Service Zone. One from QBConnectionZoneType. Default - QBConnectionZoneTypeAutomatic.
+ @warning Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints
  */
-+ (void)setSessionConfiguration:(nullable NSURLSessionConfiguration *)configuration;
++ (void)setServiceZone:(QBConnectionZoneType)serviceZone
+DEPRECATED_MSG_ATTRIBUTE("Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints");
 
 /**
- *  Get custom session configuration.
- *
- *  @return Your NSURLSessionConfiguration object.
+ Return current Service Zone
+
+ @note serviceZone - Service Zone. One from QBConnectionZoneType. Default - QBConnectionZoneTypeAutomatic
+ @warning Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints
  */
-+ (nullable NSURLSessionConfiguration *)sessionConfiguration;
++ (QBConnectionZoneType)currentServiceZone
+DEPRECATED_MSG_ATTRIBUTE("Deprecated in 2.12. Use QBSettings.apiEndpoint and QBSettings.chatEndpoint to set custom endpoints");
 
 @end
 

Framework/Quickblox.framework/Headers/Quickblox.h

@@ -16,5 +16,5 @@
 #import <Quickblox/QBChatHeader.h>
 #import <Quickblox/QBAddressBookHeader.h>
 
-//! Framework version 2.12
+//! Framework version 2.13
 FOUNDATION_EXPORT NSString * const QuickbloxFrameworkVersion;