hunter

v0.4.1

hunter v0.4.1 Hunter.Relationship

Relationship entity

This module defines a Hunter.Relationship struct and the main functions for working with Relationship.

Fields

  • following - Whether the user is currently following the account
  • followed_by - Whether the user is currently being followed by the account
  • blocking - Whether the user is currently blocking the account
  • muting - Whether the user is currently muting the account
  • requested - Whether the user has requested to follow the account

Summary

Types

t()

Functions

block(conn, id)

Block a user

follow(conn, id)

Follow a user

mute(conn, id)

Mute a user

relationships(conn, ids)

Get the relationships of authenticated user towards given other users

unblock(conn, id)

Unblock a user

unfollow(conn, id)

Unfollow a user

unmute(conn, id)

Unmute a user

Types

t() 
t() :: %Hunter.Relationship{blocking: boolean, followed_by: boolean, following: boolean, muting: boolean, requested: boolean}

Functions

block(conn, id) 
block(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Block a user

Parameters

  • conn - Connection credentials
  • id - user id
follow(conn, id) 
follow(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Follow a user

Parameters

  • conn - Connection credentials
  • id - user id
mute(conn, id) 
mute(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Mute a user

Parameters

  • conn - Connection credentials
  • id - user id
relationships(conn, ids) 
relationships(Hunter.Client.t, [non_neg_integer]) :: [Hunter.Relationship.t]

Get the relationships of authenticated user towards given other users

Parameters

  • conn - connection credentials
  • id - list of relationship IDs
unblock(conn, id) 
unblock(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unblock a user

  • conn - Connection credentials
  • id - user id
unfollow(conn, id) 
unfollow(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unfollow a user

Parameters

  • conn - Connection credentials
  • id - user id
unmute(conn, id) 
unmute(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unmute a user

Parameters

  • conn - Connection credentials
  • id - user id