Public Member Functions | |
| 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 gamerTag) |
| 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 gamerTag) |
| Unblock a player from the current player's SocialList.blocked list. More... | |
| Promise< EmptyResponse > | RemoveFriend (long gamerTag) |
| Remove a player from the current player's SocialList.friends list. More... | |
| Promise< SocialList > | RefreshSocialList () |
| Get the current player's SocialList More... | |
Additional Inherited Members | |
 Properties inherited from Beamable.Common.Api.IHasBeamableRequester | |
| IBeamableRequester | Requester [get] |
| Access the IBeamableRequester | |
Member Function Documentation
◆ BlockPlayer()
| Promise< FriendStatus > Beamable.Common.Api.Social.ISocialApi.BlockPlayer | ( | long | gamerTag | ) |
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
Implemented in Beamable.Common.Api.Social.SocialApi.
◆ Get()
| Promise< SocialList > Beamable.Common.Api.Social.ISocialApi.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.
- Returns
- A Promise containing the player's SocialList
Implemented in Beamable.Common.Api.Social.SocialApi.
◆ ImportFriends()
| Promise< EmptyResponse > Beamable.Common.Api.Social.ISocialApi.ImportFriends | ( | SocialThirdParty | source, |
| string | token | ||
| ) |
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.
Implemented in Beamable.Common.Api.Social.SocialApi.
◆ RefreshSocialList()
| Promise< SocialList > Beamable.Common.Api.Social.ISocialApi.RefreshSocialList | ( | ) |
Get the current player's SocialList
- Returns
- A Promise containing the player's SocialList
Implemented in Beamable.Common.Api.Social.SocialApi.
◆ RemoveFriend()
| Promise< EmptyResponse > Beamable.Common.Api.Social.ISocialApi.RemoveFriend | ( | long | gamerTag | ) |
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.
Implemented in Beamable.Common.Api.Social.SocialApi.
◆ UnblockPlayer()
| Promise< FriendStatus > Beamable.Common.Api.Social.ISocialApi.UnblockPlayer | ( | long | gamerTag | ) |
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
Implemented in Beamable.Common.Api.Social.SocialApi.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/Api/Social/ISocialApi.cs
