PostHog iOS SDK

SDK Version:

PostHogSDK

The PostHogSDK class

Initialization methods

`setup`public

setup method

Parameters

Name	Type
`param0`	`PostHogConfig`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setup(param0: "param0_value")

Returns

Type
`Void`

`with`public

with method

Parameters

Name	Type
`param0`	`PostHogConfig`
The param0 parameter
`param1`	`PostHogSDK`
The param1 parameter

Examples

Swift

PostHogSDK.shared.with(param0: "param0_value", param1: "param1_value")

Returns

Type
`Void`

Capture methods

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`distinctId`	`String`
The distinctId parameter
`properties`	`String`
The properties parameter
`userProperties`	`String`
The userProperties parameter
`userPropertiesSetOnce`	`String`
The userPropertiesSetOnce parameter
`groups`	`String`
The groups parameter
`properties`	`String`
The properties parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", distinctId: "distinctId_value", properties: "properties_value", userProperties: "userProperties_value", userPropertiesSetOnce: "userPropertiesSetOnce_value", groups: "groups_value", properties: "properties_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`distinctId`	`String`
The distinctId parameter
`properties`	`String`
The properties parameter
`userProperties`	`String`
The userProperties parameter
`userPropertiesSetOnce`	`String`
The userPropertiesSetOnce parameter
`groups`	`String`
The groups parameter
`properties`	`String`
The properties parameter
`timestamp`	`Date`
The timestamp parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", distinctId: "distinctId_value", properties: "properties_value", userProperties: "userProperties_value", userPropertiesSetOnce: "userPropertiesSetOnce_value", groups: "groups_value", properties: "properties_value", timestamp: "timestamp_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`properties`	`String`
The properties parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", properties: "properties_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`properties`	`String`
The properties parameter
`userProperties`	`String`
The userProperties parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", properties: "properties_value", userProperties: "userProperties_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`properties`	`String`
The properties parameter
`userProperties`	`String`
The userProperties parameter
`userPropertiesSetOnce`	`String`
The userPropertiesSetOnce parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", properties: "properties_value", userProperties: "userProperties_value", userPropertiesSetOnce: "userPropertiesSetOnce_value")

Returns

Type
`Void`

`capture`public

capture method

Parameters

Name	Type
`event`	`String`
The event parameter
`properties`	`String`
The properties parameter
`userProperties`	`String`
The userProperties parameter
`userPropertiesSetOnce`	`String`
The userPropertiesSetOnce parameter
`groups`	`String`
The groups parameter
`properties`	`String`
The properties parameter

Examples

Swift

PostHogSDK.shared.capture(event: "event_value", properties: "properties_value", userProperties: "userProperties_value", userPropertiesSetOnce: "userPropertiesSetOnce_value", groups: "groups_value", properties: "properties_value")

Returns

Type
`Void`

`flush`public

flush method

Examples

Swift

PostHogSDK.shared.flush()

Returns

Type
`Void`

`register`public

Examples

Swift

PostHogSDK.shared.register()

Returns

Type
`Void`

`screen`public

screen method

Parameters

Name	Type
`name`	`String`
The name parameter

Examples

Swift

PostHogSDK.shared.screen(name: "name_value")

Returns

Type
`Void`

`screen`public

screen method

Parameters

Name	Type
`name`	`String`
The name parameter
`properties`	`String`
The properties parameter

Examples

Swift

PostHogSDK.shared.screen(name: "name_value", properties: "properties_value")

Returns

Type
`Void`

`unregister`public

unregister method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.unregister(param0: "param0_value")

Returns

Type
`Void`

Configuration methods

`close`public

close method

Examples

Swift

PostHogSDK.shared.close()

Returns

Type
`Void`

`debug`public

debug method

Parameters

Name	Type
`param0`	`Bool`
The param0 parameter

Examples

Swift

PostHogSDK.shared.debug(param0: true)

Returns

Type
`Void`

`group`public

group method

Parameters

Name	Type
`type`	`String`
The type parameter
`key`	`String`
The key parameter

Examples

Swift

PostHogSDK.shared.group(type: "type_value", key: "key_value")

Returns

Type
`Void`

`group`public

group method

Parameters

Name	Type
`type`	`String`
The type parameter
`key`	`String`
The key parameter
`groupProperties`	`String`
The groupProperties parameter

Examples

Swift

PostHogSDK.shared.group(type: "type_value", key: "key_value", groupProperties: "groupProperties_value")

Returns

Type
`Void`

`didStartNotification`public

didStartNotification method

Examples

Swift

PostHogSDK.shared.didStartNotification()

Returns

Type
`Void`

`shared`public

shared method

Examples

Swift

PostHogSDK.shared.shared()

Returns

Type
`Void`

Feature flags methods

`getFeatureFlag`public

getFeatureFlag method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.getFeatureFlag(param0: "param0_value")

Returns

Type
`Void`

`getFeatureFlagPayload`public

getFeatureFlagPayload method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.getFeatureFlagPayload(param0: "param0_value")

Returns

Type
`Void`

`isFeatureEnabled`public

isFeatureEnabled method

Parameters

Name	Type
`param0`	`String`
The param0 parameter
`param1`	`Bool`
The param1 parameter

Examples

Swift

PostHogSDK.shared.isFeatureEnabled(param0: "param0_value", param1: true)

Returns

Type
`Void`

`reloadFeatureFlags`public

reloadFeatureFlags method

Examples

Swift

PostHogSDK.shared.reloadFeatureFlags()

Returns

Type
`Void`

`reloadFeatureFlags`public

reloadFeatureFlags method

Examples

Swift

PostHogSDK.shared.reloadFeatureFlags()

Returns

Type
`Void`

`resetGroupPropertiesForFlags`public

Clears all group properties for feature flag evaluation.

Notes:

Clears all group properties for feature flag evaluation.

Examples

Swift

PostHogSDK.shared.resetGroupPropertiesForFlags()

Returns

Type
`Void`

`resetGroupPropertiesForFlags`public

Clears group properties for feature flag evaluation for a specific group type.

Notes:

Clears group properties for feature flag evaluation for a specific group type.

Parameters

Name	Type
`groupType`	`Any`
The group type to clear properties for

Examples

Swift

PostHogSDK.shared.resetGroupPropertiesForFlags(groupType: "groupType_value")

Returns

Type
`Void`

`resetPersonPropertiesForFlags`public

Resets all person properties that were set for feature flag evaluation.

Notes:

After calling this method, feature flag evaluation will only use server-side person properties and will not include any locally overridden properties.

Examples

Swift

PostHogSDK.shared.resetPersonPropertiesForFlags()

Returns

Type
`Void`

`setGroupPropertiesForFlags`public

Sets properties for a specific group type to include when evaluating feature flags. These properties supplement the standard group information sent to PostHog for flag evaluation, providing additional context that can be used in flag targeting conditions.

Notes:

Parameters

Name	Type
`groupType`	`Any`
The group type identifier (e.g., “organization”, “team”)
`properties`	`String`
Dictionary of properties to set for this group type

Examples

Swift

PostHogSDK.shared.setGroupPropertiesForFlags(groupType: "groupType_value", properties: "properties_value")

Returns

Type
`Void`

`setGroupPropertiesForFlags`public

Notes:

Parameters

Name	Type
`groupType`	`Any`
The group type identifier (e.g., “organization”, “team”)
`properties`	`String`
Dictionary of properties to set for this group type
`reloadFeatureFlags`	`Bool`
Whether to automatically reload feature flags after setting properties

Examples

Swift

PostHogSDK.shared.setGroupPropertiesForFlags(groupType: "groupType_value", properties: "properties_value", reloadFeatureFlags: true)

Returns

Type
`Void`

`setPersonPropertiesForFlags`public

Sets person properties that will be included in feature flag evaluation requests.

Notes:

This method allows you to override server-side person properties for immediate feature flag evaluation, solving the race condition where person properties from calls may not have been processed by the server yet. Properties are merged additively with existing properties. Feature flags are automatically reloaded after setting properties.

Parameters

Name	Type
`properties`	`Any`
Dictionary of person properties to include in flag evaluation

Examples

Swift

PostHogSDK.shared.setPersonPropertiesForFlags(properties: "properties_value")

Returns

Type
`Void`

`setPersonPropertiesForFlags`public

Sets person properties that will be included in feature flag evaluation requests.

Notes:

Parameters

Name	Type
`properties`	`Any`
Dictionary of person properties to include in flag evaluation
`reloadFeatureFlags`	`Bool`
Whether to automatically reload feature flags after setting properties

Examples

Swift

PostHogSDK.shared.setPersonPropertiesForFlags(properties: "properties_value", reloadFeatureFlags: true)

Returns

Type
`Void`

`didReceiveFeatureFlags`public

didReceiveFeatureFlags method

Examples

Swift

PostHogSDK.shared.didReceiveFeatureFlags()

Returns

Type
`Void`

Identification methods

`alias`public

alias method

Parameters

Name	Type
`alias`	`String`
The alias parameter

Examples

Swift

PostHogSDK.shared.alias(alias: "alias_value")

Returns

Type
`Void`

`getAnonymousId`public

getAnonymousId method

Examples

Swift

PostHogSDK.shared.getAnonymousId()

Returns

Type
`Void`

`getDistinctId`public

getDistinctId method

Examples

Swift

PostHogSDK.shared.getDistinctId()

Returns

Type
`Void`

`identify`public

identify method

Parameters

Name	Type
`distinctId`	`String`
The distinctId parameter

Examples

Swift

PostHogSDK.shared.identify(distinctId: "distinctId_value")

Returns

Type
`Void`

`identify`public

identify method

Parameters

Name	Type
`distinctId`	`String`
The distinctId parameter
`userProperties`	`String`
The userProperties parameter

Examples

Swift

PostHogSDK.shared.identify(distinctId: "distinctId_value", userProperties: "userProperties_value")

Returns

Type
`Void`

`identify`public

identify method

Parameters

Name	Type
`distinctId`	`String`
The distinctId parameter
`userProperties`	`String`
The userProperties parameter
`userPropertiesSetOnce`	`String`
The userPropertiesSetOnce parameter

Examples

Swift

PostHogSDK.shared.identify(distinctId: "distinctId_value", userProperties: "userProperties_value", userPropertiesSetOnce: "userPropertiesSetOnce_value")

Returns

Type
`Void`

Privacy methods

`isOptOut`public

isOptOut method

Examples

Swift

PostHogSDK.shared.isOptOut()

Returns

Type
`Void`

`optIn`public

optIn method

Examples

Swift

PostHogSDK.shared.optIn()

Returns

Type
`Void`

`optOut`public

optOut method

Examples

Swift

PostHogSDK.shared.optOut()

Returns

Type
`Void`

`reset`public

reset method

Examples

Swift

PostHogSDK.shared.reset()

Returns

Type
`Void`

Session replay methods

`endSession`public

endSession method

Examples

Swift

PostHogSDK.shared.endSession()

Returns

Type
`Void`

`getSessionId`public

getSessionId method

Examples

Swift

PostHogSDK.shared.getSessionId()

Returns

Type
`Void`

`startSession`public

startSession method

Examples

Swift

PostHogSDK.shared.startSession()

Returns

Type
`Void`

PostHogDisplaySurvey

A model representing a PostHog survey to be displayed to users

Configuration methods

`appearance`public

Optional appearance configuration for customizing the survey’s look and feel

Notes:

Optional appearance configuration for customizing the survey’s look and feel

Examples

Swift

PostHogSDK.shared.appearance()

Returns

Type
`Void`

`endDate`public

Optional date indicating when the survey should stop being shown

Notes:

Optional date indicating when the survey should stop being shown

Examples

Swift

PostHogSDK.shared.endDate()

Returns

Type
`Void`

`id`public

Unique identifier for the survey

Notes:

Unique identifier for the survey

Examples

Swift

PostHogSDK.shared.id()

Returns

Type
`Void`

`name`public

Name of the survey

Notes:

Name of the survey

Examples

Swift

PostHogSDK.shared.name()

Returns

Type
`Void`

`questions`public

Array of questions to be presented in the survey

Notes:

Array of questions to be presented in the survey

Examples

Swift

PostHogSDK.shared.questions()

Returns

Type
`Void`

`startDate`public

Optional date indicating when the survey should start being shown

Notes:

Optional date indicating when the survey should start being shown

Examples

Swift

PostHogSDK.shared.startDate()

Returns

Type
`Void`

PostHogDisplayLinkQuestion

Represents a question with a clickable link

Configuration methods

`link`public

The URL that will be opened when the link is clicked

Notes:

The URL that will be opened when the link is clicked

Examples

Swift

PostHogSDK.shared.link()

Returns

Type
`Void`

PostHogDisplayChoiceQuestion

Represents a multiple or single choice question where users can select one or more options

Configuration methods

`choices`public

The list of options for the user to choose from

Notes:

The list of options for the user to choose from

Examples

Swift

PostHogSDK.shared.choices()

Returns

Type
`Void`

`hasOpenChoice`public

Whether the question includes an “other” option for users to input free-form text

Notes:

Whether the question includes an “other” option for users to input free-form text

Examples

Swift

PostHogSDK.shared.hasOpenChoice()

Returns

Type
`Void`

`isMultipleChoice`public

Whether the user can select multiple options

Notes:

Whether the user can select multiple options

Examples

Swift

PostHogSDK.shared.isMultipleChoice()

Returns

Type
`Void`

`shuffleOptions`public

Whether the options should be shuffled to randomize the order

Notes:

Whether the options should be shuffled to randomize the order

Examples

Swift

PostHogSDK.shared.shuffleOptions()

Returns

Type
`Void`

PostHogNextSurveyQuestion

A model representing the next state of the survey progression.

Configuration methods

`isSurveyCompleted`public

Whether all questions have been answered and the survey is complete Depending on the survey appearance configuration, you may want to show the “Thank you” message or dismiss the survey at this point

Notes:

Examples

Swift

PostHogSDK.shared.isSurveyCompleted()

Returns

Type
`Void`

`questionIndex`public

The index of the next question to be displayed (0-based)

Notes:

The index of the next question to be displayed (0-based)

Examples

Swift

PostHogSDK.shared.questionIndex()

Returns

Type
`Void`

PostHogStorageManager

The PostHogStorageManager class

Configuration methods

`isIdentified`public

isIdentified method

Examples

Swift

PostHogSDK.shared.isIdentified()

Returns

Type
`Void`

`isPersonProcessing`public

isPersonProcessing method

Examples

Swift

PostHogSDK.shared.isPersonProcessing()

Returns

Type
`Void`

`setAnonymousId`public

setAnonymousId method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setAnonymousId(param0: "param0_value")

Returns

Type
`Void`

`setDistinctId`public

setDistinctId method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setDistinctId(param0: "param0_value")

Returns

Type
`Void`

`setIdentified`public

setIdentified method

Parameters

Name	Type
`param0`	`Bool`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setIdentified(param0: true)

Returns

Type
`Void`

`setPersonProcessing`public

setPersonProcessing method

Parameters

Name	Type
`param0`	`Bool`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setPersonProcessing(param0: true)

Returns

Type
`Void`

Identification methods

`getAnonymousId`public

getAnonymousId method

Examples

Swift

PostHogSDK.shared.getAnonymousId()

Returns

Type
`Void`

`getDistinctId`public

getDistinctId method

Examples

Swift

PostHogSDK.shared.getDistinctId()

Returns

Type
`Void`

Privacy methods

`reset`public

reset method

Parameters

Name	Type
`keepAnonymousId`	`Bool`
The keepAnonymousId parameter
`param1`	`Bool`
The param1 parameter

Examples

Swift

PostHogSDK.shared.reset(keepAnonymousId: true, param1: true)

Returns

Type
`Void`

PostHogDisplayOpenQuestion

Represents an open-ended question where users can input free-form text

PostHogEvent

The PostHogEvent class

Configuration methods

`distinctId`public

distinctId method

Examples

Swift

PostHogSDK.shared.distinctId()

Returns

Type
`Void`

`event`public

event method

Examples

Swift

PostHogSDK.shared.event()

Returns

Type
`Void`

`properties`public

properties method

Examples

Swift

PostHogSDK.shared.properties()

Returns

Type
`Void`

`timestamp`public

timestamp method

Examples

Swift

PostHogSDK.shared.timestamp()

Returns

Type
`Void`

`uuid`public

uuid method

Examples

Swift

PostHogSDK.shared.uuid()

Returns

Type
`Void`

PostHogSurveyResponse

A model representing a user’s response to a survey question

Configuration methods

`linkClicked`public

Whether a link was clicked (for link questions)

Notes:

Whether a link was clicked (for link questions)

Examples

Swift

PostHogSDK.shared.linkClicked()

Returns

Type
`Void`

`ratingValue`public

The numeric rating value (for rating questions)

Notes:

The numeric rating value (for rating questions)

Examples

Swift

PostHogSDK.shared.ratingValue()

Returns

Type
`Void`

`selectedOptions`public

The selected options (for multiple or single choice questions)

Notes:

The selected options (for multiple or single choice questions)

Examples

Swift

PostHogSDK.shared.selectedOptions()

Returns

Type
`Void`

`textValue`public

The text response (for open questions)

Notes:

The text response (for open questions)

Examples

Swift

PostHogSDK.shared.textValue()

Returns

Type
`Void`

`type`public

The type of response (link, rating, text, or multiple choice)

Notes:

The type of response (link, rating, text, or multiple choice)

Examples

Swift

PostHogSDK.shared.type()

Returns

Type
`Void`

`link`public

Creates a response for a link question

Notes:

Creates a response for a link question

Parameters

Name	Type
`clicked`	`Any`
Whether the link was clicked

Examples

Swift

PostHogSDK.shared.link(clicked: "clicked_value")

Returns

Type
`Void`

`multipleChoice`public

Creates a response for a multiple-choice question

Notes:

Creates a response for a multiple-choice question

Parameters

Name	Type
`multipleChoice`	`Any`
The selected options

Examples

Swift

PostHogSDK.shared.multipleChoice(multipleChoice: "multipleChoice_value")

Returns

Type
`Void`

`openEnded`public

Creates a response for an open-ended question

Notes:

Creates a response for an open-ended question

Parameters

Name	Type
`openEnded`	`Any`
The text response

Examples

Swift

PostHogSDK.shared.openEnded(openEnded: "openEnded_value")

Returns

Type
`Void`

`rating`public

Creates a response for a rating question

Notes:

Creates a response for a rating question

Parameters

Name	Type
`rating`	`Any`
The selected rating value

Examples

Swift

PostHogSDK.shared.rating(rating: "rating_value")

Returns

Type
`Void`

`singleChoice`public

Creates a response for a single-choice question

Notes:

Creates a response for a single-choice question

Parameters

Name	Type
`singleChoice`	`Any`
The selected option

Examples

Swift

PostHogSDK.shared.singleChoice(singleChoice: "singleChoice_value")

Returns

Type
`Void`

PostHogDisplaySurveyQuestion

Base class for all survey question types

Configuration methods

`buttonText`public

Optional custom text for the question’s action button

Notes:

Optional custom text for the question’s action button

Examples

Swift

PostHogSDK.shared.buttonText()

Returns

Type
`Void`

`id`public

The question ID, empty if none

Notes:

The question ID, empty if none

Examples

Swift

PostHogSDK.shared.id()

Returns

Type
`Void`

`isOptional`public

Whether the question can be skipped

Notes:

Whether the question can be skipped

Examples

Swift

PostHogSDK.shared.isOptional()

Returns

Type
`Void`

`question`public

The main question text to display

Notes:

The main question text to display

Examples

Swift

PostHogSDK.shared.question()

Returns

Type
`Void`

`questionDescription`public

Optional additional description or context for the question

Notes:

Optional additional description or context for the question

Examples

Swift

PostHogSDK.shared.questionDescription()

Returns

Type
`Void`

`questionDescriptionContentType`public

Content type for the question description (HTML or plain text)

Notes:

Content type for the question description (HTML or plain text)

Examples

Swift

PostHogSDK.shared.questionDescriptionContentType()

Returns

Type
`Void`

PostHogSessionManager

The PostHogSessionManager class

Configuration methods

`shared`public

shared method

Examples

Swift

PostHogSDK.shared.shared()

Returns

Type
`Void`

Session replay methods

`setSessionId`public

setSessionId method

Parameters

Name	Type
`param0`	`String`
The param0 parameter

Examples

Swift

PostHogSDK.shared.setSessionId(param0: "param0_value")

Returns

Type
`Void`

PostHogSurveysConfig

The PostHogSurveysConfig class

Configuration methods

`surveysDelegate`public

Delegate responsible for managing survey presentation in your app. Handles survey rendering, response collection, and lifecycle events. You can provide your own delegate for a custom survey presentation.

Notes:

Defaults to which provides a standard survey UI.

Examples

Swift

PostHogSDK.shared.surveysDelegate()

Returns

Type
`Void`

PostHogDisplayRatingQuestion

Represents a rating question where users can select a rating from a scale

Configuration methods

`lowerBoundLabel`public

The label for the lower bound of the rating scale

Notes:

The label for the lower bound of the rating scale

Examples

Swift

PostHogSDK.shared.lowerBoundLabel()

Returns

Type
`Void`

`ratingType`public

The type of rating scale (numbers, emoji)

Notes:

The type of rating scale (numbers, emoji)

Examples

Swift

PostHogSDK.shared.ratingType()

Returns

Type
`Void`

`scaleLowerBound`public

The lower bound of the rating scale

Notes:

The lower bound of the rating scale

Examples

Swift

PostHogSDK.shared.scaleLowerBound()

Returns

Type
`Void`

`scaleUpperBound`public

The upper bound of the rating scale

Notes:

The upper bound of the rating scale

Examples

Swift

PostHogSDK.shared.scaleUpperBound()

Returns

Type
`Void`

`upperBoundLabel`public

The label for the upper bound of the rating scale

Notes:

The label for the upper bound of the rating scale

Examples

Swift

PostHogSDK.shared.upperBoundLabel()

Returns

Type
`Void`

PostHogDisplaySurveyAppearance

Model that describes the appearance customization of a PostHog survey

Configuration methods

`backgroundColor`public

Optional background color as web color (e.g. “#FFFFFF” or “white”)

Notes:

Optional background color as web color (e.g. “#FFFFFF” or “white”)

Examples

Swift

PostHogSDK.shared.backgroundColor()

Returns

Type
`Void`

`borderColor`public

Optional border color as web color

Notes:

Optional border color as web color

Examples

Swift

PostHogSDK.shared.borderColor()

Returns

Type
`Void`

`descriptionTextColor`public

Optional color for description text as web color

Notes:

Optional color for description text as web color

Examples

Swift

PostHogSDK.shared.descriptionTextColor()

Returns

Type
`Void`

`displayThankYouMessage`public

Whether to show a thank you message after survey completion

Notes:

Whether to show a thank you message after survey completion

Examples

Swift

PostHogSDK.shared.displayThankYouMessage()

Returns

Type
`Void`

`fontFamily`public

Optional font family to use throughout the survey

Notes:

Optional font family to use throughout the survey

Examples

Swift

PostHogSDK.shared.fontFamily()

Returns

Type
`Void`

`placeholder`public

Optional placeholder text for input fields

Notes:

Optional placeholder text for input fields

Examples

Swift

PostHogSDK.shared.placeholder()

Returns

Type
`Void`

`ratingButtonActiveColor`public

Optional color for active/selected rating buttons as web color

Notes:

Optional color for active/selected rating buttons as web color

Examples

Swift

PostHogSDK.shared.ratingButtonActiveColor()

Returns

Type
`Void`

`ratingButtonColor`public

Optional color for rating buttons as web color

Notes:

Optional color for rating buttons as web color

Examples

Swift

PostHogSDK.shared.ratingButtonColor()

Returns

Type
`Void`

`submitButtonColor`public

Optional background color for the submit button as web color

Notes:

Optional background color for the submit button as web color

Examples

Swift

PostHogSDK.shared.submitButtonColor()

Returns

Type
`Void`

`submitButtonText`public

Optional custom text for the submit button

Notes:

Optional custom text for the submit button

Examples

Swift

PostHogSDK.shared.submitButtonText()

Returns

Type
`Void`

`submitButtonTextColor`public

Optional text color for the submit button as web color

Notes:

Optional text color for the submit button as web color

Examples

Swift

PostHogSDK.shared.submitButtonTextColor()

Returns

Type
`Void`

`thankYouMessageCloseButtonText`public

Optional text for the close button in the thank you message

Notes:

Optional text for the close button in the thank you message

Examples

Swift

PostHogSDK.shared.thankYouMessageCloseButtonText()

Returns

Type
`Void`

`thankYouMessageDescription`public

Optional description text for the thank you message

Notes:

Optional description text for the thank you message

Examples

Swift

PostHogSDK.shared.thankYouMessageDescription()

Returns

Type
`Void`

`thankYouMessageDescriptionContentType`public

Optional content type for the thank you message description

Notes:

Optional content type for the thank you message description

Examples

Swift

PostHogSDK.shared.thankYouMessageDescriptionContentType()

Returns

Type
`Void`

`thankYouMessageHeader`public

Optional header text for the thank you message

Notes:

Optional header text for the thank you message

Examples

Swift

PostHogSDK.shared.thankYouMessageHeader()

Returns

Type
`Void`

PostHog iOS SDK

PostHogSDK

Initialization methods

setuppublic

Parameters

Examples

Returns

withpublic

Parameters

Examples

Returns

Capture methods

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

capturepublic

Parameters

Examples

Returns

flushpublic

Examples

Returns

registerpublic

Examples

Returns

screenpublic

Parameters

Examples

Returns

screenpublic

Parameters

Examples

Returns

unregisterpublic

Parameters

Examples

Returns

Configuration methods

closepublic

Examples

Returns

debugpublic

Parameters

Examples

Returns

grouppublic

Parameters

Examples

Returns

grouppublic

Parameters

Examples

Returns

didStartNotificationpublic

Examples

Returns

sharedpublic

Examples

Returns

`setup`public

`with`public

`capture`public

`capture`public

`capture`public

`capture`public

`capture`public

`capture`public

`capture`public

`flush`public

`register`public

`screen`public

`screen`public

`unregister`public

`close`public

`debug`public

`group`public

`group`public

`didStartNotification`public

`shared`public

`getFeatureFlag`public

`getFeatureFlagPayload`public

`isFeatureEnabled`public

`reloadFeatureFlags`public

`reloadFeatureFlags`public

`resetGroupPropertiesForFlags`public

`resetGroupPropertiesForFlags`public

`resetPersonPropertiesForFlags`public

`setGroupPropertiesForFlags`public

`setGroupPropertiesForFlags`public

`setPersonPropertiesForFlags`public

`setPersonPropertiesForFlags`public

`didReceiveFeatureFlags`public

`alias`public

`getAnonymousId`public

`getDistinctId`public

`identify`public

`identify`public

`identify`public