Friends on Third-Party Platforms

Before continuing, please familiarize yourself with the general interfaces of the Friends module

Retrieving Friends on Third-Party Platforms

The following interface can be used to retrieve the current player’s friends (mutual followers) on third-party platforms (like TapTap) who have played the same game. Besides the friend list, the interface also returns a cursor. You can implement pagination by providing the cursor and a limit when performing the query. The players in the result can be sorted by online status (those who are online will be placed at the beginning).

The returned list of friends on the third-party platform will include each player’s ID, nickname, and profile picture on the platform. As mentioned above, only those who have played the same game (i.e., logged in to the game with their third-party account) will be included in the friend list. In general, those friends have logged in to the game with their third-party accounts that are based on the built-in account system, so the TDSFriendInfo of each player will be included in the friend list as well.

In special cases, if a friend is logged in with their third-party account without using the built-in account system, the friend will still be included in the friend list, but their TDSFriendInfo will be null. For example, assuming a game has two variations of APKs, variation A logs players in with F using the built-in account system and supports the Friends service while variation B also logs players in with F but without using the built-in account system and doesn’t support the Friends service. Player D and Player E are friends on F and they each use a different variation of the game (Player D uses the variation A) but both log in with F. Now if Player D retrieves their friends on F with the following interface, the returned list will include Player E, but the TDSFriendInfo of Player E will be null.

Unity

// First query
string platform = "taptap";
string cursor = null;
// Defaults to 50; no larger than 500
int limit = 50;
// Sort by online status
SortCondition sortCondition = SortCondition.OnlineCondition
ThirdPartyFriendResult result = await TDSFriends.QueryThirdPartyFriendList(platform, cursor, limit, condition: sortCondition);

ReadOnlyCollection<ThirdPartyFriend> friends = result.FriendList;
foreach (ThirdPartyFriend friend in friends) {
    string thirdPartyId = friend.Id;
    string thirdPartyNickName = friend.Name;
    string thirdPartyAvatarUrl = friend.Avatar;
    TDSFriendInfo info = friend.FriendInfo;
}

// Pagination
string cursor = result.Cursor;
ThirdPartyFriendResult more = await TDSFriends.QueryThirdPartyFriendList(platform, cursor, limit, condition: sortCondition);

Android

ThirdPartyFriendRequestConfig config = new ThirdPartyFriendRequestConfig.Builder()
    .platform(ThirdPartyFriendRequestConfig.PLATFORM_TAPTAP)
    .pageSize(50)  /* Defaults to 50; no larger than 500 */
    .sortCondition(SortCondition.getOnlineCondition()) /* Sort by online status */
    .build();
// First query
TDSFollows.queryThirdPartyMutualList(config, null, new Callback<ThirdPartyFriendResult>() {
    @Override
    public void onSuccess(ThirdPartyFriendResult result) {
        List<ThirdPartyFriend> friends = result.getFriendList();
        for (ThirdPartyFriend friend : friends) {
            String thirdPartyId = friend.getUserId();
            String thirdPartyNickName = friend.getUserName();
            String thirdPartyAvatarUrl = friend.getUserAvatar();
            TDSFriendInfo info = friend.getTdsFriendInfo();
        }

        // Pagination
        String cursor = result.getCursor();
        TDSFollows.queryThirdPartyMutualList(config, cursor, new Callback<ThirdPartyFriendResult>() {
            /* Other things to do */
        }
    }
    @Override
    public void onFail(TDSFriendError error) {
        toast("query error = " + error.code + " msg = " + error.detailMessage);
    }
});

iOS

TDSThirdPartyFriendQueryOption *option = [TDSThirdPartyFriendQueryOption new];
option.platform = TDSThirdPartyFriendPlatformTaptap;
option.limit = 50;// Defaults to 50; no larger than 500
__block NSString *cursor; // Cursor

[TDSFriends queryThirdPartyFriendListWithOption:option
callback:^(TDSThirdPartyFriendResult * _Nullable result, NSError * _Nullable error) {
    for (TDSThirdPartyFriend* friend in result.friendList) {
        NSString *thirdPartyId = friend.userId;
        NSString *thirdPartyNickName = friend.userName;
        NSString *thirdPartyAvatarUrl = friend.userAvatar;
        TDSFriendInfo *info = friend.tdsFriendInfo;
    }
    cursor = result.cursor;
}];

// Pagination
option.from = cursor;
[TDSThirdPartyFriend queryThirdPartyFriendListWithOption:option
callback:^(TDSThirdPartyFriendResult * _Nullable result, NSError * _Nullable error) {
    // Other things to do
}];

By default, the SDK will fetch the result from the local cache. To always fetch the result from the cloud, you can specify the caching strategy when performing the query. The SDK will always cache the result regardless of the caching strategy you specify. In other words, the caching strategy only affects whether the cache will be read. It won’t affect whether the result will be cached.

Unity

ThirdPartyFriendResult result = await TDSFriends.QueryThirdPartyFriendList(platform, cursor, limit,
    TDSFriends.ThirdPartyFriendRequestCachePolicy.OnlyNetwork, sortCondition);

Android

ThirdPartyFriendRequestConfig config = new ThirdPartyFriendRequestConfig.Builder()
    .platform(ThirdPartyFriendRequestConfig.PLATFORM_TAPTAP)
    .sortCondition(SortCondition.getOnlineCondition())
    .cachePolicy(ThirdPartyFriendRequestConfig.CachePolicy.ONLY_NETWORK)
    .pageSize(50)
    .build();

iOS

option.cachePolicy = TDSThirdPartyFriendCachePolicyOnlyNetwork;

At this moment, the following third-party platforms are supported:

• taptap (Please submit a ticket to us to enable it)