Friends Introduction
Introduction
TapTap Developer Services (TDS) offers the solution for you to quickly add friending-related features into your game.
What We Offer
Easy-to-use APIs that improve your productivity
The Friends service provides features like adding, deleting, and searching for friends so you don’t have to build them yourself.
Real-time data tracking that allows you to perform refined operations
As a developer, you can utilize our tools to perform admin operations like looking up players’ connections and activity logs.
Access to TapTap’s ecosystem
Obtain the connections among TapTap users and boost your game’s experience with them.
Basic Concepts
Game friends
Game friends are based on the built-in TDS account system. Interfaces applicable to them include adding, deleting, and searching for friends. There are two modes available for game friends: Follow mode and Friend mode.
Follow mode
Player A can follow Player B to become their follower. Player B now becomes a followee of Player A. If Player B then follows Player A, Player A and Player B will become mutual followers.
Friend mode
Player A can send a friend request to Player B. Once Player B accepts the request, Player A and Player B become friends.
You can choose either Follow mode or Friend mode for your game, but not both.
TapTap friends
For users logged in with TapTap, you can obtain the mutual followers of these users from your game.
Both game friends and TapTap friends depend on the built-in TDS account system. Make sure to enable TDS Authentication before you use Friends in your game.
Functions
Game Friends
Follow Mode
| Function | Scenarios |
|---|---|
| Get followee list | Players can view the other players they are following. |
| Get mutual follower list | Players can view a list of their mutual followers. |
| Get blocklist | Players can view the other players they have blocked. |
| Follow | Players can follow other players from player lists or scoreboards. |
| Unfollow | Players can unfollow other players. |
| Block | Players can block other players from player lists or scoreboards. At this time, each player can have a maximum of 100 players on their blocklist. |
| Unblock | Players can remove other players from their blocklist. |
| Search and follow players | Players can search and follow other players with their nicknames, friend codes (a 6-digit code containing lowercase letters), and objectIds. |
| Share follow invites | Players can share links for follow invites on their social media. |
| Get follower list | Players can view the other players who are following them. |
| Rich presence | Display a player’s status information like their online status, current hero, and current game mode. |
| Sort by online status | A player’s followee list and mutual follower list can be sorted by online status. The follower list doesn’t support this function yet. |
Friend Mode
| Function | Scenarios |
|---|---|
| Get friend list | Players can view a list of their friends. |
| Check friendship status | Check if any two players are friends. |
| Add friends | Players can send friend requests to other players from player lists or scoreboards. Players can also view the friend requests they have received. |
| Search and add friends | Players can search and send friend requests to other players with their nicknames, friend codes (a 6-digit code containing lowercase letters), and objectIds. |
| Share friend invites | Players can share links for friend invites on their social media. |
| Delete friends | Players can delete their friends. |
| Get pending friend requests | Players can view the friend requests they have received. |
| Accept friend requests | Players can accept other players’ requests to be their friends. |
| Decline friend requests | Players can decline other players’ requests to be their friends. |
| Get blocklist | Players can view the other players they have blocked. |
| Block | Players can block other players from player lists or scoreboards. At this time, each player can have a maximum of 100 players on their blocklist. |
| Unblock | Players can remove other players from their blocklist. |
| Sort by online status | A player’s friend list can be sorted by online status. |
| Set friend limit | You can set the maximum number of friends each player can have by going to Developer Center > Game Services > Cloud Services > Friends. The maximum value for this setting is 2000. |
| Rich presence | Display a player’s status information like their online status, current hero, and current game mode. |
TapTap Friends
| Function | Scenarios |
|---|---|
| Follow TapTap account (please contact us to enable this interface) | Players can follow other players’ TapTap accounts in your game. |
| Get TapTap mutual followers (please contact us to enable this interface) | If two players are following each other and they both authorized your game to access their friend lists, your game will be able to obtain their connection. |
Pricing
You will be billed for the Friends service according to the number of API requests made. This number will be counted into the number of API requests made for the Data Storage service. The two services together share the free quota of 30,000 requests per day. $0.04 will be charged for every 1,000 requests exceeding the free quota.
Access to TapTap Friends is currently free. Please contact us to enable it.
Q&A
Q: Can I use the Follow mode together with the Friend mode?
A: No. You can only pick one of them for your game.
Q: Is there a limit for the number of followees for the Follow mode?
A: Yes. A player can follow at most 5000 people in each game. This number is not adjustable.
Q: Can I customize the text for sharing invites?
A: Yes. We recommend that you use something like “xx invited you to follow them” for the Follow mode and “xx invited you to become their friend” for the Friend mode.
If you have any other questions, feel free to submit a ticket to us from the Developer Center.