Inheritance diagram for RFAboutViewController:

Instance Methods
(id)	- initWithAppName:appVersion:appBuild:copyrightHolderName:contactEmail:titleForEmail:websiteURL:titleForWebsiteURL:andPublicationYear:

(void)	- addAdditionalButtonWithTitle:andContent:

Properties
UIColor *	tintColor

UIColor *	backgroundColor

UIColor *	headerBackgroundColor

UIColor *	headerTextColor

UIColor *	headerBorderColor

UIColor *	acknowledgementsHeaderColor

UIColor *	navigationViewBackgroundColor

UIColor *	navigationBarBarTintColor

UIColor *	navigationBarTintColor

UIColor *	navigationBarTitleTextColor

UIColor *	tableViewBackgroundColor

UIColor *	tableViewCellSelectColor

UIColor *	tableViewTextColor

UIImage *	headerBackgroundImage

UIImage *	closeButtonImage

BOOL	blurHeaderBackground

UIBlurEffectStyle	blurStyle

BOOL	includeDiagnosticInformationInEmail

BOOL	showAcknowledgements

BOOL	showsScrollIndicator

NSString *	acknowledgementsFilename

NSString *	appName

NSString *	appVersion

NSString *	appBuild

NSString *	copyrightHolderName

NSString *	contactEmail

NSString *	contactEmailTitle

NSURL *	websiteURL

NSString *	websiteURLTitle

NSString *	pubYear

Method Documentation

- (void) addAdditionalButtonWithTitle:	(NSString *)	title
andContent:	(NSString *)	content

Adds an additional button (as a TableView cell) below the header. Use it to supply further information, like TOS, Privacy Policy etc.

Parameters

title	The title of the button
content	The text to display in the detail view

- (id) initWithAppName:	(NSString *)	appName
appVersion:	(NSString *)	appVersion
appBuild:	(NSString *)	appBuild
copyrightHolderName:	(NSString *)	copyrightHolderName
contactEmail:	(NSString *)	contactEmail
titleForEmail:	(NSString *)	contactEmailTitle
websiteURL:	(NSURL *)	websiteURL
titleForWebsiteURL:	(NSString *)	websiteURLTitle
andPublicationYear:	(NSString *)	pubYear

Initializes the RFAboutViewController with the given parameters.

Parameters

appName	The name of the app. Leave nil to use the CFBundleName.
appVersion	The current version of the app. Leave nil to use CFBundleShortVersionString.
appBuild	The current build of the app. Leave nil to use CFBundleVersion.
copyrightHolderName	The name of the person or entity who should appear as the copyright holder.
contactEmail	The email address users can send inquiries to (for example a support email address). Leave nil to skip.
contactEmailTitle	The text to use for the email link. Leave nil to use the email address as text.
websiteURL	The URL for the website link. Leave nil to skip.
websiteURLTitle	The title for the website link. Leave nil to use the website URL.
pubYear	The year the app's version was published. Used in the copyright text. Leave nil to use the current year.

Returns: RFAboutViewController instance.

Property Documentation

- (NSString*) acknowledgementsFilename

readwritenonatomicweak

File name of the acknowledgements plist without extension. Defaults to "Acknowledgements".

- (UIColor*) acknowledgementsHeaderColor

readwritenonatomicstrong

Acknowledgements header text color. Defaults to black color.

- (NSString*) appBuild

readwritenonatomicstrong

The current build of the app. Leave nil to use CFBundleVersion.

- (NSString*) appName

readwritenonatomicstrong

The name of the app. Leave nil to use the CFBundleName.

- (NSString*) appVersion

readwritenonatomicstrong

The current version of the app. Leave nil to use CFBundleShortVersionString.

- (UIColor*) backgroundColor

readwritenonatomicstrong

Background color of the RFAboutViewController. Defaults to a light gray color.

- (BOOL) blurHeaderBackground

readwritenonatomicassign

Determines if the header background image should be blurred. Defaults to YES.

- (UIBlurEffectStyle) blurStyle

readwritenonatomicassign

Effect style of the header blur. Defaults to UIBlurEffectStyleLight.

- (UIImage*) closeButtonImage

readwritenonatomicweak

The image for the button to dismiss the RFAboutViewController. Defaults to image of "X".

- (NSString*) contactEmail

readwritenonatomicstrong

The email address users can send inquiries to (for example a support email address). Leave nil to skip.

- (NSString*) contactEmailTitle

readwritenonatomicstrong

The text to use for the email link. Leave nil to use the email address as text.

- (NSString*) copyrightHolderName

readwritenonatomicstrong

The name of the person or entity who should appear as the copyright holder.

- (UIColor*) headerBackgroundColor

readwritenonatomicstrong

Background color of the header. Defaults to white color.

- (UIImage*) headerBackgroundImage

readwritenonatomicstrong

The background of the about header. Defaults to nil.

- (UIColor*) headerBorderColor

readwritenonatomicstrong

Border color of the header. Defaults to light gray color.

- (UIColor*) headerTextColor

readwritenonatomicstrong

Color of the text in the header. Defaults to black color.

- (BOOL) includeDiagnosticInformationInEmail

readwritenonatomicassign

Determines if diagnostic information (app title, version, build, device etc.) should be included in the email when the user taps the email link. This information can be very useful to debug certain problems and can be deleted by the user if they don't want to send this information. Defaults to YES.

- (UIColor*) navigationBarBarTintColor

readwritenonatomicstrong

Bar Tint Color of the Navigation Bar.

- (UIColor*) navigationBarTintColor

readwritenonatomicstrong

Tint color of the Navigation Bar. Defaults to the view's default tint color.

- (UIColor*) navigationBarTitleTextColor

readwritenonatomicstrong

Color of the Navigation Bar Title. Defaults to blackColor.

- (UIColor*) navigationViewBackgroundColor

readwritenonatomicstrong

Background Color of the Navigation Bar.

- (NSString*) pubYear

readwritenonatomicstrong

The year the app's version was published. Used in the copyright text. Leave nil to use the current year.

- (BOOL) showAcknowledgements

readwritenonatomicassign

Determines if the acknowledgements tableview should be shown. Defaults to YES.

- (BOOL) showsScrollIndicator

readwritenonatomicassign

Determines if the main scrollview should show a scroll indicator. Defaults to YES.

- (UIColor*) tableViewBackgroundColor

readwritenonatomicstrong

TableView background color. Defaults to white color.

- (UIColor*) tableViewCellSelectColor

readwritenonatomicstrong

Color of the a selected tableview cell.

- (UIColor*) tableViewTextColor

readwritenonatomicstrong

TableView text color. Defaults to black color.

- (UIColor*) tintColor

readwritenonatomicstrong

Tint color of the RFAboutViewController. Defaults to black color.

- (NSURL*) websiteURL

readwritenonatomicstrong

The URL for the website link. Leave nil to skip.

- (NSString*) websiteURLTitle

readwritenonatomicstrong

The title for the website link. Leave nil to use the website URL.

The documentation for this class was generated from the following files:

Vendors/RFAboutView/Pod/Classes/RFAboutViewController.h
Vendors/RFAboutView/Pod/Classes/RFAboutViewController.m

Instance Methods

Properties

Method Documentation

Property Documentation