hunter v0.1.0 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

Functions

Block a user

Follow a user

Mute a user

Get the relationships of authenticated user towards given other users

Unblock a user

Unfollow a user

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
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
relationships(ids)
relationships([non_neg_integer]) :: [Hunter.Relationship.t]

Get the relationships of authenticated user towards given other users

Parameters

  • 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
unfollow(conn, id)
unfollow(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unfollow a user

Parameters

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

Unmute a user

Parameters

  • conn - Connection credentials
  • id