Callbacks and Delegates

Delegates

fullstoryDidStartSession (both variants) gets invoked once Fullstory has been fully initialized and has started the capture.

fullstoryDidStopSession gets invoked when capture has stopped (by backgrounding the app or calling FS.shutdown()). The session may be resumed in the future.

fullstoryDidDisableSession gets invoked when the current session was disabled but may start the next time the app is foregrounded. (This may be due to a connectivity issue or the org running out of sessions.) It's passed an FSReason object with code and message fields.

fullstoryDidDisable gets invoked when the Fullstory SDK is disabled. This may be due to an incompatible device or OS version, or because FullStory was not properly instrumented (e.g., missing configuration). It's passed an FSReason object with code and message fields. Because the message can be fired very early in the app's lifecycle, it will be buffered until a delegate is set.

fullstoryDidTerminateWithError gets invoked when Fullstory has been terminated due to an error.

fullstoryWillRetry gets invoked when a Fullstory network request is being retried. It's passed an FSRetryReason object with fields for type, code, count, delay, and optionally sessionId and error.

fullstoryDidRemove gets invoked when a bundle upload is removed from the queue. It's passed an FSRemovalReason object with fields for type, reason, and optionally sessionId and error.

Additional Information

• FS.currentSessionURL
• Retrieving a session URL at time of recording
• Getting Started with iOS Data Capture

Objective-C

@protocol FSDelegate <NSObject>
- (void)fullstoryDidStartSession:(NSString *)sessionUrl;
- (void)fullstoryDidStartSession:(NSString *)sessionUrl withSessionId:(NSString *)sessionId;
- (void)fullstoryDidStopSession;
- (void)fullstoryDidDisableSession:(FSReason *)reason;
- (void)fullstoryDidDisable:(FSReason *)reason;
- (void)fullstoryDidTerminateWithError:(NSError *)error;
- (void)fullstoryWillRetry:(FSRetryReason *)reason;
- (void)fullstoryDidRemove:(FSRemovalReason *)reason;
@end

Example Invocation

// File: Appdelegate.m

// Set the FS delegate in `didFinishLaunchingWithOptions`
FS.delegate = self;

// Implement the optional methods
- (void)fullstoryDidStartSession:(NSString *)sessionUrl {
  NSLog(@"Fullstory did start session with URL %@", sessionUrl);
}
- (void)fullstoryDidStartSession:(NSString *)sessionUrl withSessionId:(NSString *)sessionId {
  NSLog(@"Fullstory did start session with URL %@ and session ID %@", sessionUrl, sessionId);
}
- (void)fullstoryDidStopSession {
  NSLog(@"Fullstory capture stopped");
}
- (void)fullstoryDidDisableSession:(FSReason *)reason {
  NSLog(@"Fullstory session disabled: %@", reason);
}
- (void)fullstoryDidDisable:(FSReason *)reason {
  NSLog(@"Fullstory SDK disabled: %@", reason);
}
- (void)fullstoryDidTerminateWithError:(NSError *)error {
  NSLog(@"Fullstory did terminate with error: %@", error.localizedDescription);
}
- (void)fullstoryWillRetry:(FSRetryReason *)reason {
  if (reason.type == FS_SESSION_REQUEST) {
    NSLog(@"FS session request failed, retrying: %@", reason);
  } else if (reason.type == FS_SETTINGS_REQUEST) {
    NSLog(@"FS settings request failed, retrying: %@", reason);
  } else if (reason.type == FS_SESSION_BUNDLE_UPLOAD) {
    NSLog(@"FS bundle upload failed, retrying: %@", reason);
  } else {
    NSLog(@"FS request failed, retrying: %@", reason);
  }
}
- (void)fullstoryDidRemove:(FSRemovalReason *)reason {
  if (reason.type == FS_BUNDLE) {
    NSLog(@"FS bundle upload removed from queue: %@", reason);
  } else {
    NSLog(@"FS non-bundle upload removed from queue: %@", reason);
  }
}

Swift

protocol FSDelegate: NSObject {
  func fullstoryDidStartSession(_ sessionUrl: String)
  func fullstoryDidStartSession(_ sessionUrl: String, withSessionId sessionId: String)
  func fullstoryDidStopSession()
  func fullstoryDidDisableSession(_ reason: FSReason)
  func fullstoryDidDisable(_ reason: FSReason)
  func fullstoryDidTerminateWithError(_ error: Error)
  func fullstoryWillRetry(_ reason: FSRetryReason)
  func fullstoryDidRemove(_ reason: FSRemovalReason)
}

Example Invocation

// File: AppDelegate.swift

import UIKit
import FullStory

@main
class AppDelegate: UIResponder, UIApplicationDelegate, FSDelegate {
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Set the FS delegate in `didFinishLaunchingWithOptions`
    FS.delegate = self
    return true
  }

  // Implement the optional methods
  func fullstoryDidStartSession(_ sessionUrl: String) {
    print("Fullstory did start session with URL " + sessionUrl)
  }
  func fullstoryDidStartSession(_ sessionUrl: String, withSessionId sessionId: String) {
    print("Fullstory did start session with URL " + sessionUrl + " and session ID " + sessionId)
  }
  func fullstoryDidStopSession() {
    print("Fullstory capture stopped")
  }
  func fullstoryDidDisableSession(_ reason: FSReason) {
    print("Fullstory session disabled: \(reason)")
  }
  func fullstoryDidDisable(_ reason: FSReason) {
    print("Fullstory SDK disabled: \(reason)")
  }
  func fullstoryDidTerminateWithError(_ error: Error) {
    print("Fullstory did terminate with error: " + error.localizedDescription)
  }
  func fullstoryWillRetry(_ reason: FSRetryReason) {
    if (reason.type == .SESSION_REQUEST) {
      print("FS session request failed, retrying: \(reason)")
    } else if (reason.type == .SETTINGS_REQUEST) {
      print("FS settings request failed, retrying: \(reason)")
    } else if (reason.type == .SESSION_BUNDLE_UPLOAD) {
      print("FS bundle upload failed, retrying: \(reason)")
    } else {
      print("FS request failed, retrying: \(reason)")
    }
  }
  func fullstoryDidRemove(_ reason: FSRemovalReason) {
    if (reason.type == .BUNDLE) {
      print("FS bundle upload removed from queue: \(reason)")
    } else {
      print("FS non-bundle upload removed from queue: \(reason)")
    }
  }
}