SocialService
Profiles, friends, follows, communities (groups) and blocking.
On this page
- Summary
- Methods
- GetProfile
- UpdateProfile
- SearchUsers
- SendFriendRequest
- AcceptFriendRequest
- DeclineFriendRequest
- RemoveFriend
- ListFriends
- ListFriendRequests
- Follow
- Unfollow
- CreateGroup
- JoinGroup
- LeaveGroup
- GetGroup
- ListMyGroups
- SearchGroups
- ListGroupMembers
- Block
- Unblock
- ListBlocked
- Types
- BlockRequest
- BlockResponse
- CreateGroupRequest
- FollowRequest
- FollowResponse
- Friend
- FriendRequestRef
- FriendRequestResponse
- GetProfileRequest
- Group
- GroupMember
- GroupRef
- ListBlockedRequest
- ListFriendRequestsRequest
- ListFriendRequestsResponse
- ListFriendsRequest
- ListFriendsResponse
- ListGroupMembersResponse
- ListGroupsResponse
- ListMyGroupsRequest
- Profile
- SearchGroupsRequest
- SearchUsersRequest
- SearchUsersResponse
- UpdateProfileRequest
- See also
Profiles, friends, follows and groups. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| GetProfile | Optional | |
| UpdateProfile | Account | |
| SearchUsers | None | |
| SendFriendRequest | Account | |
| AcceptFriendRequest | Account | |
| DeclineFriendRequest | Account | |
| RemoveFriend | Account | |
| ListFriends | Optional | |
| ListFriendRequests | Account | |
| Follow | Account | |
| Unfollow | Account | |
| CreateGroup | Account | |
| JoinGroup | Account | |
| LeaveGroup | Account | |
| GetGroup | Optional | |
| ListMyGroups | Account | |
| SearchGroups | Optional | |
| ListGroupMembers | None | |
| Block | Account | |
| Unblock | Account | |
| ListBlocked | Account |
Methods#
GetProfile#
POST /neo.platform.v1.SocialService/GetProfile
Content-Type: application/jsonAuth: Optional. Signed-in callers get personalised fields.
Request: GetProfileRequest. Response: Profile.
UpdateProfile#
POST /neo.platform.v1.SocialService/UpdateProfile
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: UpdateProfileRequest. Response: Profile.
SearchUsers#
POST /neo.platform.v1.SocialService/SearchUsers
Content-Type: application/jsonAuth: None.
Request: SearchUsersRequest. Response: SearchUsersResponse.
SendFriendRequest#
POST /neo.platform.v1.SocialService/SendFriendRequest
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FriendRequestRef. Response: FriendRequestResponse.
AcceptFriendRequest#
POST /neo.platform.v1.SocialService/AcceptFriendRequest
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FriendRequestRef. Response: FriendRequestResponse.
DeclineFriendRequest#
POST /neo.platform.v1.SocialService/DeclineFriendRequest
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FriendRequestRef. Response: FriendRequestResponse.
RemoveFriend#
POST /neo.platform.v1.SocialService/RemoveFriend
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FriendRequestRef. Response: FriendRequestResponse.
ListFriends#
POST /neo.platform.v1.SocialService/ListFriends
Content-Type: application/jsonAuth: Optional. Signed-in callers get personalised fields.
Request: ListFriendsRequest. Response: ListFriendsResponse.
ListFriendRequests#
POST /neo.platform.v1.SocialService/ListFriendRequests
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListFriendRequestsRequest. Response: ListFriendRequestsResponse.
Follow#
POST /neo.platform.v1.SocialService/Follow
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FollowRequest. Response: FollowResponse.
Unfollow#
POST /neo.platform.v1.SocialService/Unfollow
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: FollowRequest. Response: FollowResponse.
CreateGroup#
POST /neo.platform.v1.SocialService/CreateGroup
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: CreateGroupRequest. Response: Group.
JoinGroup#
POST /neo.platform.v1.SocialService/JoinGroup
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: GroupRef. Response: Group.
LeaveGroup#
POST /neo.platform.v1.SocialService/LeaveGroup
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: GroupRef. Response: Group.
GetGroup#
POST /neo.platform.v1.SocialService/GetGroup
Content-Type: application/jsonAuth: Optional. Signed-in callers get personalised fields.
Request: GroupRef. Response: Group.
ListMyGroups#
POST /neo.platform.v1.SocialService/ListMyGroups
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListMyGroupsRequest. Response: ListGroupsResponse.
SearchGroups#
POST /neo.platform.v1.SocialService/SearchGroups
Content-Type: application/jsonAuth: Optional. Signed-in callers get personalised fields.
Request: SearchGroupsRequest. Response: ListGroupsResponse.
ListGroupMembers#
POST /neo.platform.v1.SocialService/ListGroupMembers
Content-Type: application/jsonAuth: None.
Request: GroupRef. Response: ListGroupMembersResponse.
Block#
POST /neo.platform.v1.SocialService/Block
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: BlockRequest. Response: BlockResponse.
Unblock#
POST /neo.platform.v1.SocialService/Unblock
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: BlockRequest. Response: BlockResponse.
ListBlocked#
POST /neo.platform.v1.SocialService/ListBlocked
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListBlockedRequest. Response: SearchUsersResponse.
Types#
BlockRequest#
| Field | Type | Description |
|---|---|---|
userId | string |
BlockResponse#
| Field | Type | Description |
|---|---|---|
blocked | boolean |
CreateGroupRequest#
| Field | Type | Description |
|---|---|---|
name | string | |
description | string |
FollowRequest#
| Field | Type | Description |
|---|---|---|
userId | string |
FollowResponse#
| Field | Type | Description |
|---|---|---|
following | boolean |
Friend#
| Field | Type | Description |
|---|---|---|
user | UserSummary | |
presence | string | online, in_game, offline |
experienceId | string |
FriendRequestRef#
| Field | Type | Description |
|---|---|---|
userId | string |
FriendRequestResponse#
| Field | Type | Description |
|---|---|---|
relationship | string |
GetProfileRequest#
| Field | Type | Description |
|---|---|---|
userId | string | Either the id or the username. |
username | string |
Group#
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
description | string | |
owner | UserSummary | |
memberCount | string (int64) | |
myRank | number | The caller's rank (0 = not a member, 255 = owner). |
GroupMember#
| Field | Type | Description |
|---|---|---|
user | UserSummary | |
rank | number | |
role | string | Owner (255), Admin (200-254), Member (1-199). |
joinedAt | string |
GroupRef#
| Field | Type | Description |
|---|---|---|
groupId | string |
ListBlockedRequest#
No fields: send {}.
ListFriendRequestsRequest#
No fields: send {}.
ListFriendRequestsResponse#
| Field | Type | Description |
|---|---|---|
incoming | array of UserSummary | |
outgoing | array of UserSummary |
ListFriendsRequest#
| Field | Type | Description |
|---|---|---|
userId | string |
ListFriendsResponse#
| Field | Type | Description |
|---|---|---|
friends | array of Friend |
ListGroupMembersResponse#
| Field | Type | Description |
|---|---|---|
members | array of GroupMember |
ListGroupsResponse#
| Field | Type | Description |
|---|---|---|
groups | array of Group |
ListMyGroupsRequest#
No fields: send {}.
Profile#
| Field | Type | Description |
|---|---|---|
user | UserSummary | |
bio | string | |
friendCount | string (int64) | |
followerCount | string (int64) | |
followingCount | string (int64) | |
relationship | string | Relationship to the caller: none, friends, request_sent, request_received, self. |
following | boolean | |
createdAt | string |
SearchGroupsRequest#
| Field | Type | Description |
|---|---|---|
query | string | |
limit | number |
SearchUsersRequest#
| Field | Type | Description |
|---|---|---|
query | string | |
limit | number |
SearchUsersResponse#
| Field | Type | Description |
|---|---|---|
users | array of UserSummary |
UpdateProfileRequest#
| Field | Type | Description |
|---|---|---|
displayName | string | |
bio | string |