Fullstory for iOS - API Overview

Getting Started

See Getting Started with iOS Data Capture

Configuration

• OrgId
• IncludeAssets
• LogLevel
• MaxOSVersion
• PreviewMode
• RecordOnStart
• ScanAsynchronously
• ScanAsyncSliceMS
• ScanAsyncSliceNS
• ServerUrl
• SwiftUIEnabled
• SwiftUISelectorPreview
• SwiftUISelectorVersion

Importing Fullstory

Objective-C

#import <FullStory/FullStory.h>

Swift

import FullStory

iOS API

Objective-C

Fullcapture

• [FS shutdown]
• [FS restart]
• [FSDelegate fullstoryDidStartSession]
• [FSDelegate fullstoryDidStopSession]
• [FSDelegate fullstoryDidTerminateWithError]
• [FS resetIdleTimer]
• [FS log]
• WKWebViewConfiguration.fullstoryInjectionDisabled

Privacy and unmasking

• [FS mask]
• [FS unmask]
• [FS exclude]
• [UIView fsMask]
• [UIView fsUnmask]
• [UIView fsExclude]

Consent-based privacy and unmasking

• [FS consent]
• [FS maskWithoutConsent]
• [FS unmaskWithConsent]
• [FS excludeWithoutConsent]
• [UIView fsMaskWithoutConsent]
• [UIView fsUnmaskWithConsent]
• [UIView fsExcludeWithoutConsent]

View & Screen Identification

• [FS setTagName]
• [FS setAttribute]
• [FS removeAttribute]
• [FS addClass]
• [FS addClasses]
• [FS removeClass]
• [FS removeClasses]
• [FS removeAllClasses]
• [UIView fsSetTagName]
• [UIView fsSetAttribute]
• [UIView fsRemoveAttribute]
• [UIView fsAddClass]
• [UIView fsAddClasses]
• [UIView fsRemoveClass]
• [UIView fsRemoveClasses]
• [UIView fsRemoveAllClasses]
• FSScreen protocol / fullstoryScreenName

User Identification

• [FS identify]
• [FS anonymize]
• [FS setUserVars]

Capture Events

• [FS event]

Pages

• [FS page]
• [FS page.start]
• [FS page.updateProperties]
• [FS page.end]

Get Session Details

• [FS currentSessionURL]
• [FS currentSession]

Swift

Fullcapture

• FS.shutdown()
• FS.restart()
• FSDelegate.fullstoryDidStartSession()
• FSDelegate.fullstoryDidStopSession()
• FSDelegate.fullstoryDidTerminateWithError()
• FS.resetIdleTimer()
• FS.log()
• WKWebViewConfiguration.fullstoryInjectionDisabled

Privacy and unmasking

• FS.mask()
• FS.unmask()
• FS.exclude()
• view.fsMask()
• view.fsUnmask()
• view.fsExclude()

Consent-based privacy and unmasking

• FS.consent()
• FS.maskWithoutConsent()
• FS.unmaskWithConsent()
• FS.excludeWithoutConsent()
• view.fsMaskWithoutConsent()
• view.fsUnmaskWithConsent()
• view.fsExcludeWithoutConsent()

View & Screen Identification

• FS.setTagName()
• FS.setAttribute()
• FS.setAttributes()
• FS.removeAttribute()
• FS.addClass()
• FS.addClasses()
• FS.removeClass()
• FS.removeAllClasses()
• UIView.fsSetTagName()
• view.fsSetAttribute()
• view.fsSetAttributes()
• view.fsRemoveAttribute()
• view.fsAddClass()
• view.fsAddClasses()
• view.fsRemoveClass()
• view.fsRemoveAllClasses()
• FSScreen protocol / fullstoryScreenName

User Identification

• FS.identify()
• FS.anonymize()
• FS.setUserVars()

Capture Events

• FS.event()

Pages

• FS.page()
• page.start()
• page.updateProperties()
• page.end()

Get Session Details

• FS.currentSessionURL
• FS.currentSessionURL()
• FS.currentSession