Friendship

API References for Friendship Service

Explore the list of API functions available in TypeScript for friendship service, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Get Users Friends​

Retrieves a list of friendships for the current user based on the provided parameters.

DynamicPixels.Services.Friendship.GetMyFriends(input: GetMyFriendsParams): Promise<Friendship[]>

Get Users Friends Requests​

Retrieves a list of friendship requests received by the current user based on the provided parameters.

DynamicPixels.Services.Friendship.GetMyFriendshipRequests(input: GetMyFriendshipRequestParams): Promise<object[]>

Get User's Friends Requesting​

Retrieves a list of friendship requesting sent by the current user based on the provided parameters.

DynamicPixels.Services.Friendship.GetMyFriendshipRequesting(input: GetMyFriendshipRequestParams): Promise<object[]>

Request Friendship​

Sends a friendship request to another user based on the provided parameters.

DynamicPixels.Services.Friendship.RequestFriendship(input: RequestFriendshipParams): Promise<object>

Accept a Request​

Accepts a friendship request based on the provided parameters.

DynamicPixels.Services.Friendship.AcceptRequest(input: AcceptRequestParams): Promise<object>

Reject a Request​

Rejects a friendship request based on the provided parameters.

DynamicPixels.Services.Friendship.RejectRequest(input: RejectRequestParams): Promise<object>

Reject All Requests​

Rejects all pending friendship requests based on the provided parameters.

DynamicPixels.Services.Friendship.RejectAllRequests(): void

Delete a Friend​

Deletes a friendship with a specified user based on the provided parameters.

DynamicPixels.Services.Friendship.DeleteFriend(input: RequestFriendshipParams): Promise<boolean>