SBBBridgeInfo Class Reference

Inherits from NSObject
Conforms to SBBBridgeInfoProtocol
Declared in SBBBridgeInfo.h
SBBBridgeInfo.m

– studyIdentifier

The study identifier used to set up the study with Bridge.

- (NSString *)studyIdentifier

Declared In

SBBBridgeInfoProtocol.h

– setStudyIdentifier:

The study identifier used to set up the study with Bridge.

- (void)setStudyIdentifier:(NSString *)studyIdentifier

Declared In

SBBBridgeInfoProtocol.h

– cacheDaysAhead

If using BridgeSDK’s built-in caching, number of days ahead to cache. Set both this and cacheDaysBehind to 0 to disable caching in BridgeSDK.

- (NSInteger)cacheDaysAhead

Declared In

SBBBridgeInfoProtocol.h

– setCacheDaysAhead:

If using BridgeSDK’s built-in caching, number of days ahead to cache. Set both this and cacheDaysBehind to 0 to disable caching in BridgeSDK.

- (void)setCacheDaysAhead:(NSInteger)cacheDaysAhead

Declared In

SBBBridgeInfoProtocol.h

– cacheDaysBehind

If using BridgeSDK’s built-in caching, number of days behind to cache. Set both this and cacheDaysAhead to 0 to disable caching in BridgeSDK.

- (NSInteger)cacheDaysBehind

Declared In

SBBBridgeInfoProtocol.h

– setCacheDaysBehind:

If using BridgeSDK’s built-in caching, number of days behind to cache. Set both this and cacheDaysAhead to 0 to disable caching in BridgeSDK.

- (void)setCacheDaysBehind:(NSInteger)cacheDaysBehind

Declared In

SBBBridgeInfoProtocol.h

– environment

The server environment to use. Generally you should not set this to anything other than SBBEnvironmentProd unless you are running your own Bridge server, and then only to test changes to the server which you have not yet deployed to production.

- (SBBEnvironment)environment

Declared In

SBBBridgeInfoProtocol.h

– setEnvironment:

The server environment to use. Generally you should not set this to anything other than SBBEnvironmentProd unless you are running your own Bridge server, and then only to test changes to the server which you have not yet deployed to production.

- (void)setEnvironment:(SBBEnvironment)environment

Declared In

SBBBridgeInfoProtocol.h

– certificateName

The name of .pem certificate file to use for uploading to Bridge (without the .pem extension).

- (NSString *)certificateName

Declared In

SBBBridgeInfoProtocol.h

– setCertificateName:

The name of .pem certificate file to use for uploading to Bridge (without the .pem extension).

- (void)setCertificateName:(NSString *)certificateName

Declared In

SBBBridgeInfoProtocol.h

– appGroupIdentifier

This property, if set, is used for the suite name of NSUserDefaults (if userDefaultsSuiteName is not explicitly set), and for the name of the shared container, which is used both to configure the background session and as the place to store temporary copies of files being uploaded to Bridge (if provided).

- (NSString *)appGroupIdentifier

Declared In

SBBBridgeInfoProtocol.h

– setAppGroupIdentifier:

This property, if set, is used for the suite name of NSUserDefaults (if userDefaultsSuiteName is not explicitly set), and for the name of the shared container, which is used both to configure the background session and as the place to store temporary copies of files being uploaded to Bridge (if provided).

- (void)setAppGroupIdentifier:(NSString *)appGroupIdentifier

Declared In

SBBBridgeInfoProtocol.h

– keychainAccessGroup

This property, if set, is used for the keychain access group in which to store the session token, reauth token, and (if any) password. If not set, the default keychain is used.

- (NSString *)keychainAccessGroup

Declared In

SBBBridgeInfoProtocol.h

– setKeychainAccessGroup:

This property, if set, is used for the keychain access group in which to store the session token, reauth token, and (if any) password. If not set, the default keychain is used.

- (void)setKeychainAccessGroup:(NSString *)keychainAccessGroup

Declared In

SBBBridgeInfoProtocol.h

– usesStandardUserDefaults

Tells the Bridge libraries to use the standard user defaults suite.

- (BOOL)usesStandardUserDefaults

Discussion

Note: This flag is intended only for backward compatibility when upgrading apps built with older versions of Bridge libraries that used the standard user defaults suite. It will be ignored in any case if either userDefaultsSuiteName or appGroupIdentifier are set.

Declared In

SBBBridgeInfoProtocol.h

– setUsesStandardUserDefaults:

Tells the Bridge libraries to use the standard user defaults suite.

- (void)setUsesStandardUserDefaults:(BOOL)usesStandardUserDefaults

Discussion

Note: This flag is intended only for backward compatibility when upgrading apps built with older versions of Bridge libraries that used the standard user defaults suite. It will be ignored in any case if either userDefaultsSuiteName or appGroupIdentifier are set.

Declared In

SBBBridgeInfoProtocol.h

– userDefaultsSuiteName

The name of the user defaults suite for the Bridge libraries to use internally. Only needs to be set if you want the Bridge libraries to use something other than their default internal suite name (org.sagebase.Bridge) or, in conjunction with appGroupIdentifier, to have them use a different suite other than the shared suite.

- (NSString *)userDefaultsSuiteName

Declared In

SBBBridgeInfoProtocol.h

– setUserDefaultsSuiteName:

The name of the user defaults suite for the Bridge libraries to use internally. Only needs to be set if you want the Bridge libraries to use something other than their default internal suite name (org.sagebase.Bridge) or, in conjunction with appGroupIdentifier, to have them use a different suite other than the shared suite.

- (void)setUserDefaultsSuiteName:(NSString *)userDefaultsSuiteName

Declared In

SBBBridgeInfoProtocol.h