Hunter.Report (hunter v0.6.0)

Copy Markdown View Source

Report entity

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

Fields

  • id - id of the report
  • action_taken - action taken in response to the report

Summary

Types

t()

Functions

report(conn, account_id, status_ids, comment)

Report a user

Types

t()

@type t() :: %Hunter.Report{action_taken: String.t(), id: non_neg_integer()}

Functions

report(conn, account_id, status_ids, comment)

@spec report(Hunter.Client.t(), non_neg_integer(), [non_neg_integer()], String.t()) ::
  t()

Report a user

Parameters

  • conn - connection credentials
  • account_id - the ID of the account to report
  • status_ids - the IDs of statuses to report
  • comment - a comment to associate with the report