Skip to main content

Upgrading from 1.9.0 to 4.x

Important
Helpshift’s Legacy SDKs (SDK Version <=7.x.x) reached their end of life on 31 Dec 2022, and end of support on 31 March 2023. Please upgrade to the Latest SDKif you haven't already.

Upgrading from 1.9.0 to 4.x

The Helpshift Cocos2d-x SDK v4.x is a major update; we have deprecated some APIs, which are replaced by newer APIs. If you have questions or feedback, please Contact Us

List of deprecated APIs​

Deprecated APIsNew API
HelpshiftCocos2dx::setNameAndEmail(const char *name, const char *email)HelpshiftCocos2dx::login(HelpshiftCocosUser *user)
HelpshiftCocos2dx::setUserIdentifier(const char *userIdentifier)HelpshiftCocos2dx::login(HelpshiftCocosUser *user)
HelpshiftCocos2dx::login(const char *identifier, const char *name, const char *email)HelpshiftCocos2dx::login(HelpshiftCocosUser *user)
Note

  • Users will be able to continue speaking on an open issue only if you were using the Login API. If you were using setUserIdentifier (now deprecated), if the user has an open Issue, using the login API will result in the creation of a new Issue. However, the previous Issue will be available to Agents under 'Other Issues'

  • Users will be able to see messages in the Campaigns Inbox only if you were using the Login API. If you were using the setUserIdentifier API (now deprecated), using the Login API will result in the creation of a new logged-in user and therefore a new Campaign Inbox. However, the user will be able to see messages in the Campaigns Inbox when you call Logout (and if the anonymous user hasn't been cleared via the clearAnonymousUser API).

New Login API​

    HelpshiftCocosUserBuilder *userBuilder = new HelpshiftCocosUserBuilder("unique-user-id-746501", "john.doe@app.co");
    userBuilder->setName("John Doe");
    HelpshiftCocosUser *user = userBuilder->build();
    HelpshiftCocos2dx::login(user);