Salesforce InAppMessaging SDK – Does not conform to the protocol HiddenPreChatDelegate

by

Summary

A developer integrating the Salesforce In-App Messaging (MIAW) SDK via Swift Package Manager encounters a compilation error stating that a class does not conform to the HiddenPreChatDelegate protocol. This issue typically arises due to incorrect method signatures, missing access modifiers, or improper SDK initialization in Swift projects. The root cause is often a mismatch between the expected Objective-C interface and the Swift implementation, specifically regarding optional protocol methods or argument labels.

Root Cause

The primary causes for this conformance error include:

  • Incorrect Method Signature: The implementation method in the Swift class does not exactly match the protocol’s required signature (e.g., missing argument labels or mismatched parameter types).
  • Missing @objc Attribute: Since the Salesforce SDK is likely bridged from Objective-C, the delegate class and its methods must be marked with @objc to be visible to the SDK’s runtime.
  • Access Control Issues: The delegate methods are not marked as public or open, preventing the SDK (which runs outside the module) from accessing them.
  • Protocol Inheritance Chain: HiddenPreChatDelegate might inherit from another protocol (like NSObjectProtocol), requiring the class to inherit from NSObject.

Why This Happens in Real Systems

  • Objective-C/Swift Interoperability: Salesforce SDKs often originate from Objective-C. Swift enforces stricter type safety and label requirements. When Swift imports an Objective-C protocol, subtle signature mismatches can break conformance.
  • Dynamic Dispatch: The SDK uses delegation patterns that rely on dynamic dispatch. If the Swift class isn’t exposed to the Objective-C runtime (via @objc), the SDK cannot find or call the method, resulting in a runtime or compile-time failure.
  • Documentation Ambiguity: SDK documentation may show Objective-C examples, and developers might translate them literally to Swift without adjusting for Swift’s stricter naming conventions.

Real-World Impact

  • Blocked Integration: The application fails to compile, halting development progress on the chat feature.
  • Delayed Time-to-Market: Developers spend hours debugging obscure protocol conformance errors instead of building business logic.
  • Runtime Crashes: Even if the code compiles by suppressing warnings, the delegate might not receive callbacks, leading to missing pre-chat data and poor user experience.

Example or Code

Here is a correct implementation of a HiddenPreChatDelegate in Swift that resolves the conformance issue.

import Foundation
import SalesforceInAppMessaging

// 1. The class must be marked @objc to be visible to the SDK.
// 2. It usually needs to inherit from NSObject if the protocol requires it.
// 3. It must explicitly conform to HiddenPreChatDelegate.

@objc class MyChatDelegate: NSObject, HiddenPreChatDelegate {

    // Ensure the signature matches exactly.
    // The SDK expects specific argument labels (often 'for' or 'with').
    // Check the SDK header files if unsure.

    func getHiddenPreChatData(for context: Any?) -> [String: Any]? {

        // Capture valuable information here
        let userInfo: [String: Any] = [
            "email": "customer@example.com",
            "caseSubject": "Technical Issue",
            "priority": "High"
        ]

        return userInfo
    }
}

How Senior Engineers Fix It

Senior engineers fix this by isolating the problem through systematic verification:

  • Consulting Header Files: They ignore the documentation for a moment and look directly at the generated Swift interface (or Objective-C headers) to see the exact required method signature.
  • Explicit @objc Implementation: They ensure the delegate class and methods are strictly @objc and public.
  • Type Erasure Check: They verify that the return type matches (Any? or [String: Any] exactly as defined by the SDK, avoiding Swift-specific types like [String: String] if the SDK expects Any.
  • Minimal Reproducible Example: They strip the class down to just the protocol conformance to verify it works in isolation before adding it back to the complex view controller.

Why Juniors Miss It

Junior developers often miss this due to a lack of experience with the Swift/Objective-C bridge:

  • Reliance on Swift-Only Concepts: They might assume the SDK works purely with Swift protocols, ignoring the need for @objc attributes.
  • Ignoring Argument Labels: Swift developers are used to unnamed parameters or different labels; they might not realize that func getData() and func getHiddenPreChatData(for context:) are fundamentally different signatures to an Objective-C runtime.
  • Overlooking Access Control: They might write the method in an internal extension or a private scope, preventing the external SDK from invoking it.