hunter v0.3.0 Hunter.Status
Status entity
Fields
id
- status iduri
- a Fediverse-unique resource IDurl
- URL to the status page (can be remote)account
- theHunter.Account
which posted the statusin_reply_to_id
-nil
or the ID of the status it replies toin_reply_to_account_id
-nil
or the ID of the account it replies toreblog
-nil
or the rebloggedHunter.Status
content
- body of the status; this will contain HTML (remote HTML already sanitized)created_at
- time the status was createdreblogs_count
- number of reblogs for the statusfavourites_count
- number of favourites for the statusreblogged
- whether the authenticated user has reblogged the statusfavourited
- whether the authenticated user has favourited the statussensitive
- whether media attachments should be hidden by defaultspoiler_text
- if not empty, warning text that should be displayed before the actual contentvisibility
- one of:public
,unlisted
,private
,direct
media_attachments
- A list ofHunter.Attachment
mentions
- list ofHunter.Mention
tags
- list ofHunter.Tag
application
-Hunter.Application
from which the status was posted
Summary
Functions
Create new status
Destroy status
Favorite a status
Fetch a user’s favourites
Retrieve statuses from a hashtag
Retrieve statuses from the home timeline
Retrieve statuses from the public timeline
Reblog a status
Retrieve status
Get a list of statuses by a user
Undo a favorite of a status
Undo a reblog of a status
Types
t()
t() :: %Hunter.Status{account: Hunter.Account.t, application: Hunter.Application.t, content: String.t, created_at: String.t, favourited: boolean, favourites_count: non_neg_integer, id: non_neg_integer, in_reply_to_account_id: term, in_reply_to_id: non_neg_integer, media_attachments: [Hunter.Attachment.t], mentions: [Hunter.Mention.t], reblog: Hunter.Status.t | nil, reblogged: boolean, reblogs_count: non_neg_integer, sensitive: boolean, spoiler_text: String.t, tags: [Hunter.Tag.t], uri: URI.t, url: URI.t, visibility: term}
Functions
create_status(conn, text, in_reply_to_id \\ nil, media_ids \\ [])
create_status(Hunter.Client.t, String.t, non_neg_integer, [non_neg_integer]) :: Hunter.Status.t
Create new status
Parameters
conn
- connection credentialstext
- [String]in_reply_to_id
- status identifiermedia_ids
- [Array]
hashtag_timeline(conn, hashtag, options \\ [])
hashtag_timeline(Hunter.Client.t, [String.t], Keyword.t) :: [Hunter.Status.t]
Retrieve statuses from a hashtag
Parameters
conn
- connection credentialshashtag
- string listoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Retrieve statuses from the home timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
public_timeline(conn, options \\ [])
public_timeline(Hunter.Client.t, Keyword.t) :: [Hunter.Status.t]
Retrieve statuses from the public timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
statuses(conn, account_id, options \\ [])
statuses(Hunter.Client.t, non_neg_integer, Keyword.t) :: [Hunter.Status.t]
Get a list of statuses by a user
Parameters
conn
- connection credentialsaccount_id
- account identifieroptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]