Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.

Protocol Friend

Rick Mak edited this page Apr 7, 2017 · 1 revision

Overview

friend:fetch

Overview

Returns friend list of a user.

Parameters

  • access_token (string, required)

  • type (string, required)

    Friend relation type.

  • user_id (string, optional)

    Friends list of the user to be returned. If this key is omitted, the friend list of the current user will be returned.

Returns

  • result (array of objects)

    The user record who are in the friend list of the specified user is included here.

Discussions

  • Is it possible to get friends list of another user? Will it be configurable by the developer/user? Is there a privacy concern?

friend:save

Request to add another user to the friend list of the current user.

If confirmation is required before the other user can be added, the user will be added to friend request list.

Parameters

  • access_token (string, required)

  • type (string, required)

    Friend relation type.

  • target_user (string, required)

    The identifier of the user to be friend with.

friend:delete

Remove another user from the friend list of the current user.

Parameters

  • access_token (string, required)

  • type (string, required)

    Friend relation type.

  • target_user (string, required)

    The identifier of the user to be unfriend with.

friend:fetch_request

(TBD) Fetch a list of pending friend request.

friend:confirm_request

(TBD) Confirm a friend request.

friend:ignore_request

(TBD) Ignore a friend request.