hunter

v0.5.1

hunter v0.5.1 Hunter.Relationship View Source

Relationship entity

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

Fields

  • id - target account id
  • 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
  • domain_blocking - whether the user is currently blocking the user's domain

Link to this section 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

Link to this section Types

Link to this type

t() View Source 
t() :: %Hunter.Relationship{
  blocking: boolean(),
  domain_blocking: boolean(),
  followed_by: boolean(),
  following: boolean(),
  id: non_neg_integer(),
  muting: boolean(),
  requested: boolean()
}

Link to this section Functions

Link to this function

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

Block a user

Parameters

  • conn - Connection credentials
  • id - user id
Link to this function

follow(conn, id) View Source 
follow(Hunter.Client.t(), non_neg_integer()) :: Hunter.Relationship.t()

Follow a user

Parameters

  • conn - Connection credentials
  • id - user id
Link to this function

mute(conn, id) View Source 
mute(Hunter.Client.t(), non_neg_integer()) :: Hunter.Relationship.t()

Mute a user

Parameters

  • conn - Connection credentials
  • id - user id
Link to this function

relationships(conn, ids) View Source 
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
Link to this function

unblock(conn, id) View Source 
unblock(Hunter.Client.t(), non_neg_integer()) :: Hunter.Relationship.t()

Unblock a user

  • conn - Connection credentials
  • id - user id
Link to this function

unfollow(conn, id) View Source 
unfollow(Hunter.Client.t(), non_neg_integer()) :: Hunter.Relationship.t()

Unfollow a user

Parameters

  • conn - Connection credentials
  • id - user id
Link to this function

unmute(conn, id) View Source 
unmute(Hunter.Client.t(), non_neg_integer()) :: Hunter.Relationship.t()

Unmute a user

Parameters

  • conn - Connection credentials
  • id - user id