This type defines the Client main entry point for the Friends feature. More...
Public Member Functions | |
| SocialApi (IUserContext ctx, IBeamableRequester requester) | |
| Promise< SocialList > | Get () |
| Get the current player's SocialList. If the social list has never been downloaded, this will use the RefreshSocialList method. However, once the social list has been downloaded, this method will return immediately with the cached data. More... | |
| Promise< EmptyResponse > | ImportFriends (SocialThirdParty source, string token) |
| Import friends from a third party provider. More... | |
| Promise< FriendStatus > | BlockPlayer (long playerId) |
| Block a player from the current player's social list. When a player is blocked, they'll appear in the SocialList.blocked list. Use the UnblockPlayer method to revert. More... | |
| Promise< FriendStatus > | UnblockPlayer (long playerId) |
| Unblock a player from the current player's SocialList.blocked list. More... | |
| Promise< EmptyResponse > | CancelFriendRequest (long playerId) |
| Promise< EmptyResponse > | RemoveFriend (long playerId) |
| Remove a player from the current player's SocialList.friends list. More... | |
| Promise< SocialList > | RefreshSocialList () |
| Get the current player's SocialList More... | |
Properties | |
| IBeamableRequester | Requester [get] |
 Properties inherited from Beamable.Common.Api.IHasBeamableRequester | |
| IBeamableRequester | Requester [get] |
| Access the IBeamableRequester | |
Detailed Description
This type defines the Client main entry point for the Friends feature.
Related Links
- See the Social feature documentation
- See Beamable.API script reference
Member Function Documentation
◆ BlockPlayer()
|
inline |
Block a player from the current player's social list. When a player is blocked, they'll appear in the SocialList.blocked list. Use the UnblockPlayer method to revert.
- Parameters
-
gamerTag The gamertag of the player to block
- Returns
- A Promise containing a FriendStatus for the given gamertag
Implements Beamable.Common.Api.Social.ISocialApi.
◆ Get()
|
inline |
Get the current player's SocialList. If the social list has never been downloaded, this will use the RefreshSocialList method. However, once the social list has been downloaded, this method will return immediately with the cached data.
- Returns
- A Promise containing the player's SocialList
Implements Beamable.Common.Api.Social.ISocialApi.
◆ ImportFriends()
|
inline |
Import friends from a third party provider.
- Parameters
-
source The third party to find friends from. token An access token issued from the third party that can be sent to Beamable so that the Beamable Cloud can perform the friend import.
- Returns
- A Promise representing the network call.
Implements Beamable.Common.Api.Social.ISocialApi.
◆ RefreshSocialList()
|
inline |
Get the current player's SocialList
- Returns
- A Promise containing the player's SocialList
Implements Beamable.Common.Api.Social.ISocialApi.
◆ RemoveFriend()
|
inline |
Remove a player from the current player's SocialList.friends list.
- Parameters
-
gamerTag The gamertag of the player to remove.
- Returns
- A Promise representing the network call.
Implements Beamable.Common.Api.Social.ISocialApi.
◆ UnblockPlayer()
|
inline |
Unblock a player from the current player's SocialList.blocked list.
- Parameters
-
gamerTag The gamertag of the player to unblock
- Returns
- A Promise containing a FriendStatus for the given gamertag
Implements Beamable.Common.Api.Social.ISocialApi.
The documentation for this class was generated from the following file:
- com.beamable/Common/Runtime/Api/Social/SocialApi.cs
