Xamarin developer APIs for iOS

Last updated:

This document describes the Pendo Xamarin SDK Public APIs for iOS. 

Note: The information here is relevant for SDK versions lower than 3.0. For API documentation for the latest Pendo SDK versions and information about the integration process, refer to our GitHub.

Pendo Class Public API - SDK Version 2.10+

Return type Public API method C# Description
static PendoManager SharedManger() Returns a shared instance of the PendoManager.
Void Setup (string appKey)

Initializes the Pendo SDK. Call this API in FinishedLaunching.

Use this API instead of initSDK and initSDKWithoutVisitor, which will be deprecated in future versions. 

Void StartSession (string? visitorId, string? accountId, NSDictionary? visitorData, NSDictionary? accountData)

Starts mobile session with provided visitor and account information. If a session is already in progress, the session will end and a new session will start.

To generate an anonymous visitor, pass null as the  visitorId.

Use this API instead of switchVisitor, which will be deprecated in future versions. 

Must be called after the SDK is initialized.

Void EndSession()

Ends the active session and stops collecting analytics or showing guides to the user. More details here.

Must be called after the SDK is initialized.

Void ClearVisitor()

Ends the active session and starts a new session with an anonymous visitor.

Must be called after the SDK is initialized.

Void SetVisitorData (NSDictionary visitorData)

Updates the visitor metadata. 

Must be called after the SDK is initialized.

Void SetAccountData (NSDictionary AccountData)

Updates the account metadata

Must be called after the SDK is initialized.

String GetVisitorId() Returns the ID of the visitor in the active session.
String GetAccountId() Returns the ID for the account in the active session. 
Void AccountId Sets the ID for the account in the active session. 
Void Track (string eventName, NSDictionary? @params)

Sends a track event with the specified properties.

Must be called after the SDK is initialized.

Void DismissVisibleGuides() Dismisses all visible guides.
Void PauseGuides (bool dismissGuides)

Pauses any guides from showing during an active session. If dismissGuides is TRUE, then all visible guides will be dismissed.

Must be called after the SDK is initialized.

Void ResumeGuides()

Resumes showing guides during the active session. Should only be used after pauseGuides. 

Must be called after the SDK is initialized.

String GetDeviceId() Returns the device's unique Pendo-generated id. The device id is used by Pendo to generate a unique id for each anonymous visitor. This id is unique per application.

 

Was this article helpful?
0 out of 0 found this helpful