Web.Hastodon

Documentation

module Web.Hastodon.Option

data StreamingPayload

Constructors

SUpdate Status

SNotification Notification

SDelete StatusId

Thump

Instances

Show StreamingPayload

Methods

showsPrec :: Int -> StreamingPayload -> ShowS

show :: StreamingPayload -> String

showList :: [StreamingPayload] -> ShowS

type StreamingResponse m = forall m. MonadResource m => ConduitT () StreamingPayload m ()

streamUser :: HastodonClient -> StreamingResponse m

streamPublic :: HastodonClient -> StreamingResponse m

streamLocal :: HastodonClient -> StreamingResponse m

streamHashtag :: HastodonClient -> String -> StreamingResponse m

streamList :: HastodonClient -> String -> StreamingResponse m

data OAuthResponse

Constructors

OAuthResponse

Fields

• accessToken :: String

Instances

Show OAuthResponse

Methods

showsPrec :: Int -> OAuthResponse -> ShowS

show :: OAuthResponse -> String

showList :: [OAuthResponse] -> ShowS

FromJSON OAuthResponse

Methods

parseJSON :: Value -> Parser OAuthResponse

parseJSONList :: Value -> Parser [OAuthResponse]

data Account

Constructors

Account

Fields

• accountId :: AccountId
• accountUsername :: String
• accountAcct :: String
• accountDisplayName :: String
• accountLocked :: Bool
• accountCreatedAt :: String
• accountFollowersCount :: Int
• accountFollowingCount :: Int
• accountStatusesCount :: Int
• accountNote :: String
• accountUrl :: String
• accountAvatar :: String
• accountAvatarStatic :: String
• accountHeader :: String
• accountHeaderStatic :: String

Instances

Show Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

FromJSON Account

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

newtype AccountId

Constructors

AccountId

Fields

• unAccountId :: String

Instances

Show AccountId

Methods

showsPrec :: Int -> AccountId -> ShowS

show :: AccountId -> String

showList :: [AccountId] -> ShowS

IsString AccountId

Methods

fromString :: String -> AccountId

FromJSON AccountId

Methods

parseJSON :: Value -> Parser AccountId

parseJSONList :: Value -> Parser [AccountId]

data Application

Constructors

Application

Fields

• applicationName :: String
• applicationWebsite :: Maybe String

Instances

Show Application

Methods

showsPrec :: Int -> Application -> ShowS

show :: Application -> String

showList :: [Application] -> ShowS

FromJSON Application

Methods

parseJSON :: Value -> Parser Application

parseJSONList :: Value -> Parser [Application]

data Attachment

Constructors

Attachment

Fields

• attachmentId :: AttachmentId
• attachmentType :: String
• attachmentUrl :: String
• attachmentRemoteUrl :: Maybe String
• attachmentPreviewUrl :: String
• attachmentTextUrl :: Maybe String

Instances

Show Attachment

Methods

showsPrec :: Int -> Attachment -> ShowS

show :: Attachment -> String

showList :: [Attachment] -> ShowS

FromJSON Attachment

Methods

parseJSON :: Value -> Parser Attachment

parseJSONList :: Value -> Parser [Attachment]

newtype AttachmentId

Constructors

AttachmentId

Fields

• unAttachmentId :: String

Instances

Show AttachmentId

Methods

showsPrec :: Int -> AttachmentId -> ShowS

show :: AttachmentId -> String

showList :: [AttachmentId] -> ShowS

IsString AttachmentId

Methods

fromString :: String -> AttachmentId

FromJSON AttachmentId

Methods

parseJSON :: Value -> Parser AttachmentId

parseJSONList :: Value -> Parser [AttachmentId]

data Card

Constructors

Card

Fields

• cardUrl :: String
• cardTitle :: String
• cardDescription :: String
• cardImage :: String

Instances

Show Card

Methods

showsPrec :: Int -> Card -> ShowS

show :: Card -> String

showList :: [Card] -> ShowS

FromJSON Card

Methods

parseJSON :: Value -> Parser Card

parseJSONList :: Value -> Parser [Card]

data Context

Constructors

Context

Fields

• contextAncestors :: [Status]
• contextDescendants :: [Status]

Instances

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

FromJSON Context

Methods

parseJSON :: Value -> Parser Context

parseJSONList :: Value -> Parser [Context]

data Instance

Constructors

Instance

Fields

• instanceUri :: String
• instanceTitle :: String
• instanceDescription :: String
• instanceEmail :: String

Instances

Show Instance

Methods

showsPrec :: Int -> Instance -> ShowS

show :: Instance -> String

showList :: [Instance] -> ShowS

FromJSON Instance

Methods

parseJSON :: Value -> Parser Instance

parseJSONList :: Value -> Parser [Instance]

newtype MediaId

Constructors

MediaId

Fields

• unMediaId :: String

Instances

Show MediaId

Methods

showsPrec :: Int -> MediaId -> ShowS

show :: MediaId -> String

showList :: [MediaId] -> ShowS

IsString MediaId

Methods

fromString :: String -> MediaId

FromJSON MediaId

Methods

parseJSON :: Value -> Parser MediaId

parseJSONList :: Value -> Parser [MediaId]

data Mention

Constructors

Mention

Fields

• mentionUrl :: String
• mentionUsername :: String
• mentionAcct :: String
• mentionId :: AccountId

Instances

Show Mention

Methods

showsPrec :: Int -> Mention -> ShowS

show :: Mention -> String

showList :: [Mention] -> ShowS

FromJSON Mention

Methods

parseJSON :: Value -> Parser Mention

parseJSONList :: Value -> Parser [Mention]

data Notification

Constructors

Notification

Fields

• notificationId :: NotificationId
• notificationType :: String
• notificationCreatedAt :: String
• notificationAccount :: Account
• notificationStatus :: Maybe Status

Instances

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

FromJSON Notification

Methods

parseJSON :: Value -> Parser Notification

parseJSONList :: Value -> Parser [Notification]

newtype NotificationId

Constructors

NotificationId

Fields

• unNotificationId :: String

Instances

Show NotificationId

Methods

showsPrec :: Int -> NotificationId -> ShowS

show :: NotificationId -> String

showList :: [NotificationId] -> ShowS

IsString NotificationId

Methods

fromString :: String -> NotificationId

FromJSON NotificationId

Methods

parseJSON :: Value -> Parser NotificationId

parseJSONList :: Value -> Parser [NotificationId]

data OAuthClient

Constructors

OAuthClient

Fields

• oauthClientId :: OAuthClientId
• oauthClientRedirectUri :: String
• oauthClientClientId :: String
• oauthClientClientSecret :: String

Instances

Show OAuthClient

Methods

showsPrec :: Int -> OAuthClient -> ShowS

show :: OAuthClient -> String

showList :: [OAuthClient] -> ShowS

FromJSON OAuthClient

Methods

parseJSON :: Value -> Parser OAuthClient

parseJSONList :: Value -> Parser [OAuthClient]

newtype OAuthClientId

Constructors

OAuthClientId

Fields

• unOAuthClientId :: String

Instances

Show OAuthClientId

Methods

showsPrec :: Int -> OAuthClientId -> ShowS

show :: OAuthClientId -> String

showList :: [OAuthClientId] -> ShowS

IsString OAuthClientId

Methods

fromString :: String -> OAuthClientId

FromJSON OAuthClientId

Methods

parseJSON :: Value -> Parser OAuthClientId

parseJSONList :: Value -> Parser [OAuthClientId]

data Relationship

Constructors

Relationship

Fields

• relationshipId :: RelationshipId
• relationshipFollowing :: Bool
• relationshipFollowed_by :: Bool
• relationshipBlocking :: Bool
• relationshipMuting :: Bool
• relationshipRequested :: Bool

Instances

Show Relationship

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

FromJSON Relationship

Methods

parseJSON :: Value -> Parser Relationship

parseJSONList :: Value -> Parser [Relationship]

newtype RelationshipId

Constructors

RelationshipId

Fields

• unRelationshipId :: String

Instances

Show RelationshipId

Methods

showsPrec :: Int -> RelationshipId -> ShowS

show :: RelationshipId -> String

showList :: [RelationshipId] -> ShowS

IsString RelationshipId

Methods

fromString :: String -> RelationshipId

FromJSON RelationshipId

Methods

parseJSON :: Value -> Parser RelationshipId

parseJSONList :: Value -> Parser [RelationshipId]

data Report

Constructors

Report

Fields

• reportId :: ReportId
• reportActionToken :: String

Instances

Show Report

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

FromJSON Report

Methods

parseJSON :: Value -> Parser Report

parseJSONList :: Value -> Parser [Report]

newtype ReportId

Constructors

ReportId

Fields

• unReportId :: String

Instances

Show ReportId

Methods

showsPrec :: Int -> ReportId -> ShowS

show :: ReportId -> String

showList :: [ReportId] -> ShowS

IsString ReportId

Methods

fromString :: String -> ReportId

FromJSON ReportId

Methods

parseJSON :: Value -> Parser ReportId

parseJSONList :: Value -> Parser [ReportId]

data Results

Constructors

Results

Fields

• resultAccounts :: [Account]
• resultStatus :: [Status]
• resultHashtags :: [String]

Instances

Show Results

Methods

showsPrec :: Int -> Results -> ShowS

show :: Results -> String

showList :: [Results] -> ShowS

FromJSON Results

Methods

parseJSON :: Value -> Parser Results

parseJSONList :: Value -> Parser [Results]

data Status

Constructors

Status

Fields

• statusId :: StatusId
• statusUri :: String
• statusUrl :: String
• statusAccount :: Account
• statusInReplyToId :: Maybe Int
• statusInReplyToAccountId :: Maybe Int
• statusReblog :: Maybe Status
• statusContent :: String
• statusCreatedAt :: String
• statusReblogsCount :: Int
• statusFavouritesCount :: Int
• statusReblogged :: Maybe Bool
• statusFavourited :: Maybe Bool
• statusMuted :: Maybe Bool
• statusSensitive :: Maybe Bool
• statusSpoilerText :: String
• statusVisibility :: String
• statusMediaAttachments :: [Attachment]
• statusMentions :: [Mention]
• statusTags :: [Tag]
• statusApplication :: Maybe Application
• statusEmojis :: [Emoji]
• statusLanguage :: Maybe String

Instances

Show Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

FromJSON Status

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

newtype StatusId

Constructors

StatusId

Fields

• unStatusId :: String

Instances

Show StatusId

Methods

showsPrec :: Int -> StatusId -> ShowS

show :: StatusId -> String

showList :: [StatusId] -> ShowS

IsString StatusId

Methods

fromString :: String -> StatusId

FromJSON StatusId

Methods

parseJSON :: Value -> Parser StatusId

parseJSONList :: Value -> Parser [StatusId]

data Tag

Constructors

Tag

Fields

• name :: String
• url :: String

Instances

Show Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

FromJSON Tag

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

type OptionVal = Either [ByteString] (Maybe ByteString)

type OptionImpl = Map ByteString OptionVal

class IsOption a where

Minimal complete definition

fromOptionImpl, toOptionImpl

Methods

fromOptionImpl :: OptionImpl -> a

toOptionImpl :: a -> OptionImpl

Instances

IsOption PostMuteOption

Methods

fromOptionImpl :: OptionImpl -> PostMuteOption

toOptionImpl :: PostMuteOption -> OptionImpl

IsOption PostStatusOption

Methods

fromOptionImpl :: OptionImpl -> PostStatusOption

toOptionImpl :: PostStatusOption -> OptionImpl

IsOption StatusSearchOption

Methods

fromOptionImpl :: OptionImpl -> StatusSearchOption

toOptionImpl :: StatusSearchOption -> OptionImpl

IsOption AccountSearchOption

Methods

fromOptionImpl :: OptionImpl -> AccountSearchOption

toOptionImpl :: AccountSearchOption -> OptionImpl

IsOption GetNotificationsOption

Methods

fromOptionImpl :: OptionImpl -> GetNotificationsOption

toOptionImpl :: GetNotificationsOption -> OptionImpl

IsOption GetAccountStatusesOption

Methods

fromOptionImpl :: OptionImpl -> GetAccountStatusesOption

toOptionImpl :: GetAccountStatusesOption -> OptionImpl

IsOption TimelineOption

Methods

fromOptionImpl :: OptionImpl -> TimelineOption

toOptionImpl :: TimelineOption -> OptionImpl

IsOption RangeOption

Methods

fromOptionImpl :: OptionImpl -> RangeOption

toOptionImpl :: RangeOption -> OptionImpl

data HastodonClient

Constructors

HastodonClient

Fields

• host :: String
• token :: String

mkHastodonClient :: String -> String -> String -> String -> String -> IO (Maybe HastodonClient)

getAccountById :: HastodonClient -> AccountId -> IO (Either JSONException Account)

getCurrentAccount :: HastodonClient -> IO (Either JSONException Account)

getFollowers :: HastodonClient -> AccountId -> IO (Either JSONException [Account])

getFollowersWithOption :: HastodonClient -> RangeOption -> AccountId -> IO (Either JSONException [Account])

getFollowing :: HastodonClient -> AccountId -> IO (Either JSONException [Account])

getFollowingWithOption :: HastodonClient -> RangeOption -> AccountId -> IO (Either JSONException [Account])

getAccountStatuses :: HastodonClient -> AccountId -> IO (Either JSONException [Status])

getAccountStatusesWithOption :: HastodonClient -> GetAccountStatusesOption -> AccountId -> IO (Either JSONException [Status])

postFollow :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

postUnfollow :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

postBlock :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

postUnblock :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

postMute :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

postMuteWithOption :: HastodonClient -> PostMuteOption -> AccountId -> IO (Either JSONException Relationship)

postUnmute :: HastodonClient -> AccountId -> IO (Either JSONException Relationship)

getRelationships :: HastodonClient -> [AccountId] -> IO (Either JSONException [Relationship])

getSearchedAccounts :: HastodonClient -> String -> IO (Either JSONException [Account])

getSearchedAccountsWithOption :: HastodonClient -> AccountSearchOption -> String -> IO (Either JSONException [Account])

postApps :: String -> String -> IO (Either JSONException OAuthClient)

getBlocks :: HastodonClient -> IO (Either JSONException [Account])

getBlocksWithOption :: HastodonClient -> RangeOption -> IO (Either JSONException [Account])

getFavorites :: HastodonClient -> IO (Either JSONException [Status])

getFavoritesWithOption :: HastodonClient -> RangeOption -> IO (Either JSONException [Status])

getFollowRequests :: HastodonClient -> IO (Either JSONException [Account])

getFollowRequestsWithOption :: HastodonClient -> RangeOption -> IO (Either JSONException [Account])

postAuthorizeRequest :: HastodonClient -> AccountId -> IO Bool

postRejectRequest :: HastodonClient -> AccountId -> IO Bool

getInstance :: HastodonClient -> IO (Either JSONException Instance)

postMediaFile :: HastodonClient -> String -> String -> IO (Either JSONException Attachment)

getMutes :: HastodonClient -> IO (Either JSONException [Account])

getMutesWithOption :: HastodonClient -> RangeOption -> IO (Either JSONException [Account])

getNotifications :: HastodonClient -> IO (Either JSONException [Notification])

getNotificationsWithOption :: HastodonClient -> GetNotificationsOption -> IO (Either JSONException [Notification])

getNotificationById :: HastodonClient -> NotificationId -> IO (Either JSONException Notification)

postNotificationsClear :: HastodonClient -> IO Bool

getReports :: HastodonClient -> IO (Either JSONException [Report])

getSearchedResults :: HastodonClient -> String -> IO (Either JSONException [Results])

getSearchedResultsWithOption :: HastodonClient -> StatusSearchOption -> String -> IO (Either JSONException [Results])

getStatus :: HastodonClient -> StatusId -> IO (Either JSONException Status)

getCard :: HastodonClient -> StatusId -> IO (Either JSONException Card)

getContext :: HastodonClient -> StatusId -> IO (Either JSONException Context)

getRebloggedBy :: HastodonClient -> StatusId -> IO (Either JSONException [Account])

getRebloggedByWithOption :: HastodonClient -> RangeOption -> StatusId -> IO (Either JSONException [Account])

getFavoritedBy :: HastodonClient -> StatusId -> IO (Either JSONException [Account])

getFavoritedByWithOption :: HastodonClient -> RangeOption -> StatusId -> IO (Either JSONException [Account])

postStatus :: HastodonClient -> String -> IO (Either JSONException Status)

postStatusWithOption :: HastodonClient -> PostStatusOption -> String -> IO (Either JSONException Status)

postStatusWithMediaIds :: HastodonClient -> String -> [MediaId] -> IO (Either JSONException Status)

postReblog :: HastodonClient -> StatusId -> IO (Either JSONException Status)

postUnreblog :: HastodonClient -> StatusId -> IO (Either JSONException Status)

postFavorite :: HastodonClient -> StatusId -> IO (Either JSONException Status)

postUnfavorite :: HastodonClient -> StatusId -> IO (Either JSONException Status)

getHomeTimeline :: HastodonClient -> IO (Either JSONException [Status])

getHomeTimelineWithOption :: HastodonClient -> TimelineOption -> IO (Either JSONException [Status])

getPublicTimeline :: HastodonClient -> IO (Either JSONException [Status])

getPublicTimelineWithOption :: HastodonClient -> TimelineOption -> IO (Either JSONException [Status])

getTaggedTimeline :: HastodonClient -> String -> IO (Either JSONException [Status])

getTaggedTimelineWithOption :: HastodonClient -> TimelineOption -> String -> IO (Either JSONException [Status])

streamUser :: HastodonClient -> StreamingResponse m

streamPublic :: HastodonClient -> StreamingResponse m

streamLocal :: HastodonClient -> StreamingResponse m

streamHashtag :: HastodonClient -> String -> StreamingResponse m

streamList :: HastodonClient -> String -> StreamingResponse m