Authentication

In order to use the abilities of the iOS SDK in your client app, a TapTalk instance must be initiated in each client app through user authentication with TapTalk.io server. An authenticated user account allows the instance to communicate and interact with the server. The following explains how to authenticate your user with the server.

TapTalk.io's Authentication Flow

When the user logs in to your application, your backend server will have to request an Authentication Ticket from TapTalk.io server. TapTalk.io server will return the requested Authentication Ticket and user ID to your backend server. The client application (iOS or Android) can then retrieve the ticket from your backend server to implement TapTalk.io's SDK by initializing the SDK using the obtained Authentication Ticket.

You can see the documentation on how to obtain Authentication Ticket from TapTalk.io's Server on the Authentication in TapTalk.io's Server API page.

Authenticate to TapTalk.io server with an Authentication Ticket

Note: authentication should only be called once before the user is logged in or when the callback onTapTalkRefreshTokenExpired() is triggered in TapListener

Java

TapTalk.authenticateWithAuthTicket(AUTH_TICKET, CONNECT_ON_SUCCESS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Authentication successful
    }

    @Override
    public void onError(String errorCode, String errorMessage) {

    }
});

Kotlin

TapTalk.authenticateWithAuthTicket(AUTH_TICKET, CONNECT_ON_SUCCESS, object : TapCommonListener() {
    override fun onSuccess(successMessage: String?) {
        // Authentication successful
    }

    override fun onError(errorCode: String?, errorMessage: String?) {

    }
})

Parameters AUTH_TICKET : (String) an authentication ticket is required for this method CONNECT_WHEN_SUCCESS: (BOOL) if set to YES, application will connect to TapTalk.io server after authentication is successfully completed

Check Authentication Status

You can check authentication status by calling isAuthenticated() method

Java

boolean isAuthenticated = TapTalk.isAuthenticated();

Kotlin

var isAuthenticated = TapTalk.isAuthenticated()

Logout and Clear TapTalk.io Data

Call this method when you need to logout and clear all local cached data from TapTalk.io.

Java

//Logout from TapTalk.io
TapTalk.logoutAndClearAllTapTalkData();

Kotlin

//Logout from TapTalk.io
TapTalk.logoutAndClearAllTapTalkData()

Clear TapTalk.io Data

You can clear all TapTalk.io local cached data by calling clearAllTapTalkData() method.

Java

TapTalk.clearAllTapTalkData();

Kotlin

TapTalk.clearAllTapTalkData()