Reference
Every public method of the Screeb iOS SDK, with its signature.
Complete reference for the Screeb iOS SDK: static methods of the Screeb class. New to Screeb? Start with the install guide.
Methods by capability
Section titled “Methods by capability”Lifecycle
Section titled “Lifecycle”| Method | Description | More |
|---|---|---|
initSdk(context: UIViewController?, channelId: String, identity: String? = nil, visitorProperty: [String: Any] = [:], initOptions: InitOptions = InitOptions(), hooks: GlobalHooks? = nil, language: String? = nil) |
Initialize the Screeb SDK. | Guide |
closeSdk() |
Stop the SDK. | Guide |
Identity
Section titled “Identity”| Method | Description | More |
|---|---|---|
setIdentity(uniqueVisitorId: String, visitorProperty: [String: Any] = [:]) |
Identify the current user with optional properties. | Guide |
resetIdentity() |
Reset the current visitor identity. | Guide |
setAnonymousId(anonymousId: String) |
Adopts the anonymous id your CDP already uses (Amplitude device id, Segment or RudderStack anonymous id) on the current respondent, which stays anonymous. When the CDP integration already created a respondent for that id, Screeb switches to it, unless the current respondent is identified. Call it right after initSdk: the command is queued and resolved during init. 5 to 128 characters. |
Guide |
visitorProperty(visitorProperty: [String: Any]) |
Send visitor properties without changing the identity. | - |
getIdentity(callback: @escaping ([String: Any]?, Error?) -> Void) |
Get the current visitor identity and properties. | Guide |
Groups
Section titled “Groups”| Method | Description | More |
|---|---|---|
assignGroup(type: String?, name: String, properties: [String: Any] = [:]) |
Assign the current user to a group. | Guide |
unassignGroup(type: String?, name: String, properties: [String: Any] = [:]) |
Remove the current user from a group. | Guide |
Tracking
Section titled “Tracking”| Method | Description | More |
|---|---|---|
trackEvent(name: String, trackingEventProperties: [String: Any] = [:]) |
Track a custom event. | Guide |
trackScreen(name: String, trackingEventProperties: [String: Any] = [:]) |
Track a screen navigation event. | Guide |
Surveys
Section titled “Surveys”| Method | Description | More |
|---|---|---|
startSurvey(surveyId: String, allowMultipleResponses: Bool = true, hiddenFields: [String: Any] = [:], ignoreSurveyStatus: Bool = true, hooks: SurveyHooks? = nil, language: String? = nil, distributionId: String? = nil) |
Start a specific survey programmatically. | Guide |
closeSurvey(surveyId: String? = nil) |
Close the currently displayed survey. | - |
Messages
Section titled “Messages”| Method | Description | More |
|---|---|---|
startMessage(messageId: String, allowMultipleResponses: Bool = true, hiddenFields: [String: Any] = [:], ignoreMessageStatus: Bool = true, hooks: SurveyHooks? = nil, language: String? = nil, distributionId: String? = nil) |
Start a specific message programmatically. | Guide |
closeMessage(messageId: String? = nil) |
Close the currently displayed message. | Guide |
Session replay
Section titled “Session replay”| Method | Description | More |
|---|---|---|
sessionReplayStart() |
Start session replay recording. | Guide |
sessionReplayStop() |
Stop session replay recording. | Guide |
| Method | Description | More |
|---|---|---|
debug(callback: ((String?, Error?) -> Void)? = nil) |
Get SDK debug information. | Guide |
debugTargeting(callback: ((String?, Error?) -> Void)? = nil) |
Get targeting debug information. | Guide |
Privacy helpers
Section titled “Privacy helpers”| Method | Description | More |
|---|---|---|
UIView.screebMaskText() |
Mask a view or component in session replay. | Guide |
UIView.screebNoCapture() |
Exclude a view or component from session replay capture. | Guide |
UIView.screebId(_ id: String) |
Set a stable Screeb element ID for IAM targeting. | Guide |
| Method | Description | More |
|---|---|---|
handleDeepLink(url: URL?) |
Forward a Screeb deep link to the SDK, so editor, survey and message links open in-app. | - |
setColorScheme(_ scheme: String) |
Sets the color scheme the surveys and messages use: “light”, “dark” or “auto” (follow the app’s appearance). Overrides the colorScheme init option. |
Guide |
API signatures
Section titled “API signatures”Lifecycle
Section titled “Lifecycle”initSdk(context: UIViewController?, channelId: String, identity: String? = nil, visitorProperty: [String: Any] = [:], initOptions: InitOptions = InitOptions(), hooks: GlobalHooks? = nil, language: String? = nil)closeSdk()Identity
Section titled “Identity”setIdentity(uniqueVisitorId: String, visitorProperty: [String: Any] = [:])resetIdentity()setAnonymousId(anonymousId: String)visitorProperty(visitorProperty: [String: Any])getIdentity(callback: @escaping ([String: Any]?, Error?) -> Void)Groups
Section titled “Groups”assignGroup(type: String?, name: String, properties: [String: Any] = [:])unassignGroup(type: String?, name: String, properties: [String: Any] = [:])Tracking
Section titled “Tracking”trackEvent(name: String, trackingEventProperties: [String: Any] = [:])trackScreen(name: String, trackingEventProperties: [String: Any] = [:])Surveys
Section titled “Surveys”startSurvey(surveyId: String, allowMultipleResponses: Bool = true, hiddenFields: [String: Any] = [:], ignoreSurveyStatus: Bool = true, hooks: SurveyHooks? = nil, language: String? = nil, distributionId: String? = nil)closeSurvey(surveyId: String? = nil)Messages
Section titled “Messages”startMessage(messageId: String, allowMultipleResponses: Bool = true, hiddenFields: [String: Any] = [:], ignoreMessageStatus: Bool = true, hooks: SurveyHooks? = nil, language: String? = nil, distributionId: String? = nil)closeMessage(messageId: String? = nil)Session replay
Section titled “Session replay”sessionReplayStart()sessionReplayStop()debug(callback: ((String?, Error?) -> Void)? = nil)debugTargeting(callback: ((String?, Error?) -> Void)? = nil)Privacy helpers
Section titled “Privacy helpers”UIView.screebMaskText()UIView.screebNoCapture()UIView.screebId(_ id: String)handleDeepLink(url: URL?)setColorScheme(_ scheme: String)