BBApplicationLaunchParameters

BBApplicationLaunchParameters is the class that encapsulates the various ways in which you can configure the Symphony App's behavior.

Typically you will allocate one of these at the time of application:didFinishLaunchingWithOptions:. You then set the parameters however you would like then you add the BBApplicationLaunchParameters to the launchOptions dictionary with the key BBApplicationParameters.

Once you have passed the BBApplicationLaunchParameters to the BBAppDelegate through application:didFinishLaunchingWithOptions:, changes to the BBApplicationLaunchParameters will not be reflected in the app.

Properties

PodDomain
PodDomain
@property (nonatomic, strong) NSString *podDomain

PodDomain When set, this controls the domain name to which the application can connect. For example: If you pass "home" the application will try to connect to home.symphony.com. If you pass "home.com" the application will try to connect to home.com Default is nil, which allows connection to any pod in the default Authentication UI.

PodSSOURL
PodSSOURL
@property (nonatomic) NSURL *podSSOURL

PodSSOURL If the pod's SSO URL is specified (and disableSSO is not set to YES), the application will jump to this URL as though SSO were selected by the user. If specified, the host of this URL is used as the pod's domain, and the podDomain & userEmailAddress fields are ignored. Default is nil.

userEmailAddress
userEmailAddress
@property (nonatomic, strong) NSString *userEmailAddress;

UserEmailAddress If the user's email address is specified, the sign-in control will be pre-populated with this value.

AllowPhotoPicker
AllowPhotoPicker
@property (nonatomic) BOOL allowPhotoPicker;

AllowPhotoPicker Set this to YES if you would like to permit your users to attach photos from their camera roll (or taken from their camera) to messages sent within the application. Default is YES.

Objective-C
Objective-C
@property (nonatomic) BOOL disableAccessToPhotoGallery;

disableAccessToPhotoGallery Set this to YES if you would like to block your users from attaching photos from their camera roll to messages sent within the application. Default is NO.

AllowWebView
AllowWebView
@property (nonatomic) BOOL allowWebView;

AllowWebView Set this to YES if you would like to permit your users to view non-image attachments and URLs sent within the application. Default is YES.

AllowSharing
AllowSharing
@property (nonatomic) BOOL allowSharing;

AllowSharing Set this to YES if you would like to permit your users to share image attachments out to other applications through the OS installed share extensions. Default is YES.

AllowCrashlytics
AllowCrashlytics
@property (nonatomic) BOOL allowCrashlytics;

AllowCrashlytics Set this to YES if you would like to permit the Symphony application to submit crash reports through the 3rd party application named Crashlytics. The Public AppStore version of the application does this and it is helpful for collecting crash reports and monitoring. Default is YES.

AllowAnalytics
AllowAnalytics
@property (nonatomic) BOOL allowAnalytics;

AllowAnalytics Set this to YES if you would like to permit the Symphony application to record anonymous usage statistics. Default is YES.

AllowAddressBook
AllowAddressBook
@property (nonatomic) BOOL allowAddressBook;

AllowAddressBook Set this to YES if you would like to permit your users to access their OS Address Book when inviting new contacts to the application. Default is YES.

AllowCopy
AllowCopy
@property (nonatomic) BOOL allowCopy;

AllowCopy Set this to YES if you would like to permit your users to copy the contents of messages they receive within the application. Default is YES.

NetworkDebugging
NetworkDebugging
@property (nonatomic) BOOL networkDebugging;

NetworkDebugging Set this to YES if you would like the Symphony application to emit logging which may be helpful to debug network-related issues. This is probably only helpful during the bring-up/integration phase. Default is NO.

ShowClearCacheOnSignOut
ShowClearCacheOnSignOut
@property (nonatomic) BOOL showClearCacheOnSignOut;

ShowClearCacheOnSignOut Set this to YES if you would like the Symphony application to show the "Clear Cache on Sign out" control in the Settings view. The "Clear Cache on Sign out" allows the user to retain all of his information in a local (encrypted) cache when signed out of the application. This could be useful for occasions when signing-in while offline to access data cached locally. Default is NO.

DisablePincode
DisablePincode
@property (nonatomic) BOOL disablePincode;

DisablePincode Set this to YES if you would like the Symphony application to hide the "Turn On Pincode" control in the Settings view. The "Turn On Pincode" allows the application to require a 6 digit pin code to launch the application. This is in addition to the username & password required to login initially. This could be useful for situations where you are providing your own layer of security to the application. If the user has the Pincode enabled, as from a previous version of the app, the "Turn Off Pincode" option will be available, but the "Unlock with Touch ID" option will not be enabled. Once the pincode is disabled, the "Turn On Pincode" option will not be enabled. Default is NO.

DisableIntroduction
DisableIntroduction
@property (nonatomic) BOOL disableIntroduction;
enforcePincode
enforcePincode
@property (nonatomic) BOOL enforcePincode;

EnforcePincode Set this to YES if you would like the Symphony application to force user to define a 6 digit pin code to launch the application. If enabled, the "Turn Off Pincode" control in the Settings view must be hidden. This option overrides disablePincode. It means if both disablePincode and enforcePincode are enabled, enforcePincode wins and the user must define the pin code. If the user is already logged from a previous version of the app or with the enforcePincode disabled when logged, a prompt must ask the user to define the pin code to launch the application Default is NO

DisableIntroduction Set this to YES if you would like the Symphony application to hide First Launch introduction screens. Default is NO.

allowFeedback
allowFeedback
@property (nonatomic) BOOL allowFeedback;

AllowFeedback Set this to YES if you would like the Symphony application to show the feedback feature in settings. Default is YES.

enforceBBAccess
enforceBBAccess
@property (nonatomic) BOOL enforceBBAccess;

EnforceBBAccess Set this to YES if you would like to enforce Symphony application to open links in BlackBerry Access app. (applies to Symphony for BlackBerry only). Default is NO.

allowSendingEmojis
allowSendingEmojis
@property (nonatomic) BOOL allowSendingEmojis;

AllowSendingEmojis Set this to YES if you would like the Symphony application to render emojis sent or received by the user. Default is YES.

Objective-C
Objective-C
@property (nonatomic, strong) NSNumber *refreshTokenPeriod;

refreshTokenPeriod Define the refresh token delay If not defined the default value will be used 24h.

Objective-C
Objective-C
@property (nonatomic) BOOL allowOpeningEmailAddress;

allowOpeningEmailAddress Set this to YES if you would like to permit your users to open email address in an external application Default is YES

Methods

init

- (id)init NS_DESIGNATED_INITIALIZER;

This is the designated initializer for BBApplicationLaunchParameters. Use this to create a BBApplicationLaunchParameters which you pass to the shared instance of BBAppDelegate through the method application:didFinishLaunchingWithOptions:

setText:forCustomViewID
setText:forCustomViewID
- (void)setText:(NSString *)text forCustomViewID:(BBCustomViewID)customization;

setText:forCustomViewID: This is how you can pass custom text for various UI customizations. @param text NSString of the text you would like displayed to the user. @param customization BBCustomViewID enumeration value specifying where the text should be displayed.

textForCustomViewID
textForCustomViewID
- (NSString *)textForCustomViewID:(BBCustomViewID)customization;

textForCustomViewID: This is how you can retrieve the custom text for various UI customizations. This method is used by the Symphony App when setting up the associated UI elements. @param customization BBCustomViewID enumeration value of the text you would like to retrieve @return NSString of the customized value