Ex.Pnut v0.1.0 ExPnut.User.Blocking View Source

Blocking a user prevents the blocked user and the blocking user from seeing each other on the network except in a few necessary places.

Endpoints:

  • Get blocked users
  • Block a user
  • Unblock a user

https://pnut.io/docs/api/resources/users/blocking

Link to this section Summary

Functions

Block a user. Blocked users will not show up in future requests, the same as if they were muted. Blocked users also cannot retrieve this authorized user in their requests. Can do so even if the other user is blocking you (but will only return an ID of the blocked user).

Retrieve a list of blocked users. Users may only see their own list of blocked users.

Unblock a user. Can do so even if the other user is blocking you (but will only return an ID of the blocked user).

Link to this section Functions

Link to this function

block(client, user_id, user_params \\ %UserParams{}) View Source

Block a user. Blocked users will not show up in future requests, the same as if they were muted. Blocked users also cannot retrieve this authorized user in their requests. Can do so even if the other user is blocking you (but will only return an ID of the blocked user).

Link to this function

get_blocked(client, user_id, user_params \\ %UserParams{}) View Source

Retrieve a list of blocked users. Users may only see their own list of blocked users.

Link to this function

unblock(client, user_id) View Source

Unblock a user. Can do so even if the other user is blocking you (but will only return an ID of the blocked user).