Network.Reddit.Moderation

Actions related to moderation. Assume that each action in this module requires moderator privileges, unless stated otherwise

Item moderation

These actions work on Items, i.e either Comments or Submissions. This module also exports variants that take unwrapped SubmissionIDs and CommentIDs to work with just one type of item (see below)

distinguishItem :: MonadReddit m => Distinction -> ItemID -> m ()

Distinguish an item. See distinguishComment for further comment-specific options

undistinguishItem :: MonadReddit m => ItemID -> m ()

Remove the distinction from an item, also removing the sticky flag for top-level comments

removeItem

Arguments

:: MonadReddit m

=> Maybe Body

A note for other mods. This is sent in second request if Just

-> Bool

Spam flag. Will remove the item from all listings if True

-> ItemID

-> m ()

Remove an item from the subreddit with an optional note to other mods. Setting the isSpam parameter to True will entirely remove the item from subreddit listings

sendRemovalMessage :: MonadReddit m => RemovalMessage -> m ()

Send a removal message for an item. The precise action depends on the form of RemovalType

approveItem :: MonadReddit m => ItemID -> m ()

Approve an item, reverting a removal and resetting its report counter

lockItem :: MonadReddit m => ItemID -> m ()

Lock an item. See also unlockItem

unlockItem :: MonadReddit m => ItemID -> m ()

Unlock an item

ignoreItemReports :: MonadReddit m => ItemID -> m ()

Prevent all future reports on this item from sending notifications or appearing in moderation listings. See also unignoreItemReports, which reverses this action

unignoreItemReports :: MonadReddit m => ItemID -> m ()

Re-allow the item to trigger notifications and appear in moderation listings

Removal reasons

getRemovalReasons :: MonadReddit m => SubredditName -> m (Seq RemovalReason)

Get a list of RemovalReasons for the given subreddit

createRemovalReason :: MonadReddit m => SubredditName -> Title -> Body -> m RemovalReasonID

Create a new RemovalReason, returning the RemovalReasonID of the newly created reason

updateRemovalReason :: MonadReddit m => SubredditName -> RemovalReason -> m ()

Update a single RemovalReason

deleteRemovalReason :: MonadReddit m => SubredditName -> RemovalReasonID -> m ()

Delete the given removal reason

Moderation listings

Each of these retrieves a Listing ItemID ModItem. You can constrain the type of reports by passing the appropriate ItemType to the paginator options

getReports :: MonadReddit m => SubredditName -> Paginator ItemID ModItem -> m (Listing ItemID ModItem)

Get the given subreddit's reported items

getModqueue :: MonadReddit m => SubredditName -> Paginator ItemID ModItem -> m (Listing ItemID ModItem)

Get the given subreddit's moderation queue

getSpam :: MonadReddit m => SubredditName -> Paginator ItemID ModItem -> m (Listing ItemID ModItem)

Get the given subreddit's items marked as spam

getEdited :: MonadReddit m => SubredditName -> Paginator ItemID ModItem -> m (Listing ItemID ModItem)

Get the given subreddit's recently edited items

getUnmoderated :: MonadReddit m => SubredditName -> Paginator ItemID ModItem -> m (Listing ItemID ModItem)

Get the given subreddit's unmoderated items

getModlog :: MonadReddit m => SubredditName -> Paginator ModActionID ModAction -> m (Listing ModActionID ModAction)

Get a log of moderator actions for the given subreddit

Submission moderation

Includes re-exports from Network.Reddit.Submission

distinguishSubmission :: MonadReddit m => Distinction -> SubmissionID -> m ()

Distinguish a submission

undistinguishSubmission :: MonadReddit m => SubmissionID -> m ()

Remove the distinction from a submission

approveSubmission :: MonadReddit m => SubmissionID -> m ()

Approve a submission. See approveItem

lockSubmission :: MonadReddit m => SubmissionID -> m ()

Lock a submission. See lockItem

unlockSubmission :: MonadReddit m => SubmissionID -> m ()

Unlock a submission. See unlockItem

ignoreSubmissionReports :: MonadReddit m => SubmissionID -> m ()

Ignore reports for a submission. See ignoreItemReports

unignoreSubmissionReports :: MonadReddit m => SubmissionID -> m ()

Resume reports for a submission. See unignoreItemReports

unmarkNSFW :: MonadReddit m => SubmissionID -> m ()

Unmark a submission NSFW. The submission author can use this as well as the subreddit moderators

markNSFW :: MonadReddit m => SubmissionID -> m ()

Mark a submission NSFW. The submission author can use this as well as the subreddit moderators

setOC :: MonadReddit m => SubredditName -> SubmissionID -> m ()

Mark a submission as original content. In order for normal users to use this feature in addition to mods, the beta "Original Content" feature must be enabled in the subreddit settings

unsetOC :: MonadReddit m => SubredditName -> SubmissionID -> m ()

Unmark a submission as original content. In order for normal users to use this feature in addition to mods, the beta "Original Content" feature must be enabled in the subreddit settings

setSpoiler :: MonadReddit m => SubmissionID -> m ()

Mark the submission as containing spoilers

unsetSpoiler :: MonadReddit m => SubmissionID -> m ()

Unmark the submission as containing spoilers

stickySubmission

Arguments

:: MonadReddit m

=> Bool

When True, this will set the submission as the "bottom" sticky. Otherwise, the stickied submission will go to the top slot

-> SubmissionID

-> m ()

Sticky the submission in the subreddit

unstickySubmission :: MonadReddit m => SubmissionID -> m ()

Unsticky the submission in the subreddit

setSuggestedSort

Arguments

:: MonadReddit m

=> Maybe ItemSort

If Nothing, will clear the existing sort

-> SubmissionID

-> m ()

Set the suggested sort order for a submission

Comment moderation

showComment :: MonadReddit m => CommentID -> m ()

Show a comment that has been "collapsed" by crowd-control

distinguishComment

Arguments

:: MonadReddit m

=> Distinction

-> Bool

Sticky flag

-> CommentID

-> m ()

Distinguish aa comment. If True, the sticky param will set the comment at the top of the page. This only applies to top-level comments; the flg is otherwise ignored

undistinguishComment :: MonadReddit m => CommentID -> m ()

Undistinguish a comment, also removing its sticky flag if applicable

approveComment :: MonadReddit m => CommentID -> m ()

Approve a comment. See approveItem

lockComment :: MonadReddit m => CommentID -> m ()

Lock a comment. See lockItem

unlockComment :: MonadReddit m => CommentID -> m ()

Unlock a comment. See unlockItem

ignoreCommentReports :: MonadReddit m => CommentID -> m ()

Ignore reports for a comment. See ignoreItemReports

unignoreCommentReports :: MonadReddit m => CommentID -> m ()

Resume reports for a comment. See unignoreItemReports

Collections moderation

createCollection :: MonadReddit m => NewCollection -> m Collection

Create a new collection, returning the new Collection upon success

deleteCollection :: MonadReddit m => CollectionID -> m ()

Delete the entire collection from the subreddit

addSubmissionToCollection :: MonadReddit m => CollectionID -> SubmissionID -> m ()

Add a submission to a collection

removeSubmissionFromCollection :: MonadReddit m => CollectionID -> SubmissionID -> m ()

Remove a submission from a collection

reorderCollection :: (MonadReddit m, Foldable t) => CollectionID -> t SubmissionID -> m ()

Reorder the submissions that comprise the collection by providing a container of SubmissionIDs in the new intended order

updateCollectionDescription :: MonadReddit m => CollectionID -> Body -> m ()

Update the description of the collection

updateCollectionTitle :: MonadReddit m => CollectionID -> Title -> m ()

Update the title of the collection

Subreddit relationships

Moderators

getModerators :: MonadReddit m => SubredditName -> m (Seq ModAccount)

Get a list of information on all moderators for the given subreddit

getModerator :: MonadReddit m => SubredditName -> Username -> m (Maybe ModAccount)

Get information about a single moderator, if such a moderator exists

updateModerator

Arguments

:: (MonadReddit m, Foldable t)

=> Maybe (t ModPermission)

If Nothing, grants all permissions. If Just and empty, all permissions are revoked. Otherwise, each of the given container of permissions is granted

-> SubredditName

-> Username

-> m ()

Update the permissions granted to a current moderator

removeModerator :: MonadReddit m => SubredditName -> Username -> m ()

Revoke the given user's mod status

abdicateModerator :: MonadReddit m => SubredditName -> m ()

Revoke the authenticated user's mod status in the given subreddit. Caution!

Mod invitations

inviteModerator :: MonadReddit m => SubredditName -> Username -> m ()

Invite a user to moderate the subreddit. This action will implicitly grant the invitee all moderator permissions on the subreddit. To control which specific set of permissions the invitee shall be allowed instead, see inviteModeratorWithPerms

inviteModeratorWithPerms

Arguments

:: (MonadReddit m, Foldable t)

=> t ModPermission

If empty, no permissions are granted

-> SubredditName

-> Username

-> m ()

Invite a user to moderate the subreddit with a specific set of permissions

getInvitees

Arguments

:: MonadReddit m

=> Maybe ModInviteeList

A previously obtained ModInviteeList that may contain before and after fields to paginate through entries

-> SubredditName

-> m ModInviteeList

Get a listing of users invited to moderate the subreddit. This endpoint only returns 25 results at a time, and does not use the Listing mechanism that prevails elsewhere. You can paginate through all invitees by passing previous ModInviteeList results to subsequent invocations

getInvitee :: MonadReddit m => SubredditName -> Username -> m (Maybe ModInvitee)

Get information about a single invited user

updateInvitation

Arguments

:: (MonadReddit m, Foldable t)

=> Maybe (t ModPermission)

If Nothing, grants all permissions. If Just and empty, all permissions are revoked. Otherwise, each of the given container of permissions is granted

-> SubredditName

-> Username

-> m ()

Update the permissions granted to the mod invitee

revokeInvitation :: MonadReddit m => SubredditName -> Username -> m ()

Revoke an existing moderator invitation for the given user

acceptInvitation :: MonadReddit m => SubredditName -> m ()

Accept the invitation issued to the authenticated user to moderate the given subreddit

Contributors

getContributors :: MonadReddit m => SubredditName -> Paginator RelID RelInfo -> m (Listing RelID RelInfo)

Get a list of contributors on the subreddit

getContributor :: MonadReddit m => SubredditName -> Username -> m (Maybe RelInfo)

Get a single contributor, if such a user exists

addContributor :: MonadReddit m => SubredditName -> Username -> m ()

Give a user contributor status on the subreddit

removeContributor :: MonadReddit m => SubredditName -> Username -> m ()

Remove a contributor from the subreddit

abdicateContributor :: MonadReddit m => SubredditID -> m ()

AbdicateModerator your contributor status on the given subreddit

getWikiContributors :: MonadReddit m => SubredditName -> Paginator RelID RelInfo -> m (Listing RelID RelInfo)

Get a list of wiki contributors on the subreddit

getWikiContributor :: MonadReddit m => SubredditName -> Username -> m (Maybe RelInfo)

Get a single wiki contributor, if such a user exists

addWikiContributor :: MonadReddit m => SubredditName -> Username -> m ()

Give a user wiki contributor privileges on the subreddit

removeWikiContributor :: MonadReddit m => SubredditName -> Username -> m ()

Revoke wiki contributor privileges on the subreddit

Bans

getBans :: MonadReddit m => SubredditName -> Paginator RelID Ban -> m (Listing RelID Ban)

Get the banned users for a given subreddit

getBan :: MonadReddit m => SubredditName -> Username -> m (Maybe Ban)

Check to see if a given user is banned on a particular subreddit, returning the details of the Ban if so

banUser :: MonadReddit m => BanNotes -> SubredditName -> Username -> m ()

Issue a ban against a user on the given subreddit, with the provided notes and (optional) duration

unbanUser :: MonadReddit m => SubredditName -> Username -> m ()

Remove an existing ban on a user

getWikibans :: MonadReddit m => SubredditName -> Paginator RelID RelInfo -> m (Listing RelID RelInfo)

Get a list of users banned on the subreddit wiki

getWikiban :: MonadReddit m => SubredditName -> Username -> m (Maybe RelInfo)

Get information on a single user banned on the subreddit wiki, if such a ban exists

wikibanUser :: MonadReddit m => BanNotes -> SubredditName -> Username -> m ()

Ban a user from participating in the wiki

wikiUnbanUser :: MonadReddit m => SubredditName -> Username -> m ()

Reverse an existing wiki ban for a user

getMuted :: MonadReddit m => SubredditName -> Paginator MuteID MuteInfo -> m (Listing MuteID MuteInfo)

Get a list of users muted on the subreddit wiki

getMutedUser :: MonadReddit m => SubredditName -> Username -> m (Maybe MuteInfo)

Get information on a single user muted on the subreddit wiki, if such a ban exists

unmuteUser :: MonadReddit m => SubredditName -> Username -> m ()

Unmute a single user on the subreddit

muteUser :: MonadReddit m => BanNotes -> SubredditName -> Username -> m ()

Mute a single user on the subreddit

Subreddit settings

getSubredditSettings :: MonadReddit m => SubredditName -> m SubredditSettings

Get the configured SubredditSettings for a given subreddit

setSubredditSettings :: MonadReddit m => SubredditSettings -> m ()

Configure a subreddit with the provided SubredditSettings

Subreddit rules

To get a list of the current rules for a Subreddit, an action which does not require moderator privileges, see getSubredditRules. Also note that a subreddit may only configure up to 15 individual rules at a time, and that trying to add more may raise an exception

addSubredditRule :: MonadReddit m => SubredditName -> NewSubredditRule -> m SubredditRule

Add a rule to the subreddit. The newly created SubredditRule is returned upon success

deleteSubredditRule :: MonadReddit m => SubredditName -> Name -> m ()

Delete the rule identified by the given name from the subreddit

updateSubredditRule

Arguments

:: MonadReddit m

=> SubredditName

-> Name

The old name for the rule. This is required even if you are not changing the name of the rule, as Reddit has no other data to uniquely identify the rule

-> SubredditRule

-> m SubredditRule

Update an existing subreddit rule. You must provide the shortName of the existing rule as a parameter in order for Reddit to identify the rule. The shortName can be changed by updating the SubredditRule record, however

reorderSubredditRules

Arguments

:: (MonadReddit m, Foldable t)

=> SubredditName

-> t Name

The desired order of the rules. Must contain all of the shortNames of currently configured SubredditRules on the subreddit

-> m ()

Reorder the subreddit rules

Flair

configureSubredditFlair :: MonadReddit m => SubredditName -> FlairConfig -> m ()

Get a list of usernames and the flair currently assigned to them

getFlairList :: MonadReddit m => SubredditName -> Paginator UserID AssignedFlair -> m (Listing UserID AssignedFlair)

getUserFlair :: MonadReddit m => SubredditName -> Username -> m (Maybe UserFlair)

Get the UserFlair that corresponds to a Username

setUserFlair :: MonadReddit m => FlairSelection -> Username -> m ()

Set a user's flair. If the CSSClass is provided in the FlairChoice, it takes precedence over the FlairID contained in that record

setUserFlairs :: (MonadReddit m, Foldable t) => SubredditName -> t AssignedFlair -> m (Seq FlairResult)

Set, update, or deleteSRImage the flair of multiple users at once, given a container of AssignedFlairs

deleteUserFlair :: MonadReddit m => SubredditName -> Username -> m ()

Delete a user's flair on the given subreddit

createFlairTemplate :: MonadReddit m => FlairType -> SubredditName -> FlairTemplate -> m FlairTemplate

Create a new FlairTemplate for either users or submissions, returning the newly created template

updateFlairTemplate :: MonadReddit m => FlairType -> SubredditName -> FlairTemplate -> m ()

Update an existing FlairTemplate for either users or submissions

createUserFlairTemplate :: MonadReddit m => SubredditName -> FlairTemplate -> m FlairTemplate

Create a new FlairTemplate for users, returning the newly created template

createSubmissionFlairTemplate :: MonadReddit m => SubredditName -> FlairTemplate -> m FlairTemplate

Create a new FlairTemplate for submissions, returning the newly created template

updateSubmissionFlairTemplate :: MonadReddit m => SubredditName -> FlairTemplate -> m ()

Update an existing FlairTemplate for submissions

updateUserFlairTemplate :: MonadReddit m => SubredditName -> FlairTemplate -> m ()

Update an existing FlairTemplate for users

deleteFlairTemplate :: MonadReddit m => SubredditName -> FlairID -> m ()

Delete a user or submission flair template given its FlairID

clearUserFlairTemplates :: MonadReddit m => SubredditName -> m ()

Clear all of the user flair templates on the subreddit

clearSubmissionFlairTemplates :: MonadReddit m => SubredditName -> m ()

Clear all of the user flair templates on the subreddit

clearFlairTemplates :: MonadReddit m => FlairType -> SubredditName -> m ()

Clear all of the user or submission flair templates on the subreddit

Stylesheets, images and widgets

getStylesheet :: MonadReddit m => SubredditName -> m Stylesheet

Get the Stylesheet that has been configured for the given subreddit

updateStylesheet

Arguments

:: MonadReddit m

=> SubredditName

-> Maybe Text

The reason for the change, if any

-> Text

The new contents of the stylesheet

-> m ()

Update a given subreddit's stylesheet with new contents, which must be valid CSS

Images

Reddit only allows JPEG or PNG images in stylsheets, and further requires that all -- uploaded images be less than 500Kb in size. Each action that uploads an image file to stylesheets validates both of these constraints, throwing a ClientException in the event that they are not satisfied.

Note that most of the actions that delete images will appear to succeed even if the named image does not exists

uploadImage :: MonadReddit m => Text -> FilePath -> SubredditName -> m ()

Upload an image file to add to the given subreddit's stylesheet

uploadHeader :: MonadReddit m => Text -> FilePath -> SubredditName -> m ()

Upload the image header for the given subreddit's stylesheet

uploadMobileIcon :: MonadReddit m => Text -> FilePath -> SubredditName -> m ()

Upload a mobile icon for the given subreddit

uploadMobileHeader :: MonadReddit m => Text -> FilePath -> SubredditName -> m ()

Upload the mobile header for the given subreddit

deleteImage :: MonadReddit m => Text -> SubredditName -> m ()

Delete the named image from the given subreddit's stylesheet

deleteHeader :: MonadReddit m => SubredditName -> m ()

Delete header image from the given subreddit

deleteMobileIcon :: MonadReddit m => Text -> SubredditName -> m ()

Delete the named image from the given subreddit's stylesheet

uploadBanner :: MonadReddit m => SubredditName -> FilePath -> m ()

Upload a banner for the subreddit (redesign only)

deleteBanner :: MonadReddit m => SubredditName -> m ()

Delete the subreddit banner, even if it does not exist (redesign only)

uploadBannerAdditional :: MonadReddit m => Maybe StyleImageAlignment -> SubredditName -> FilePath -> m ()

Upload the additional image banner for the subreddit (redesign only)

deleteBannerAdditional :: MonadReddit m => SubredditName -> m ()

Delete all additional banners, including the hover banner (redesign only)

uploadBannerHover :: MonadReddit m => SubredditName -> FilePath -> m ()

Upload the banner hover image for the subreddit (redesign only)

deleteBannerHover :: MonadReddit m => SubredditName -> m ()

Delete the subreddit banner hover image (redesign only)

Wiki

addWikiEditor :: MonadReddit m => SubredditName -> WikiPageName -> Username -> m ()

Grant editing privileges to the given Username on the subreddit's wikipage

removeWikiEditor :: MonadReddit m => SubredditName -> WikiPageName -> Username -> m ()

Revoke the given Username's editing privileges on the subreddit's wikipage

getWikiPageSettings :: MonadReddit m => SubredditName -> WikiPageName -> m WikiPageSettings

Get the WikiPageSettings for the subreddit's given wikipage

revertWikiPage :: MonadReddit m => SubredditName -> WikiPageName -> WikiRevisionID -> m ()

Revert the wikipage to the given revision

Modmail

getModmail :: MonadReddit m => m Modmail

Get all of the authenticated user's modmail. See getModmailWithOpts in order to control how modmail is sorted or filtered

getModmailWithOpts :: MonadReddit m => ModmailOpts -> m Modmail

Get the authenticated user's modmail with the provided ModmailOpts

getModmailConversation :: MonadReddit m => ModmailID -> m ModmailConversation

Get a single ModmailConversation given its ID

getUnreadModmailCount :: MonadReddit m => m (HashMap ModmailState Word)

Get the number of unread modmail conversations according to conversation state

replyToConversation :: MonadReddit m => ModmailReply -> ModmailID -> m ModmailConversation

Reply to the modmail conversation

archiveConversation :: MonadReddit m => ModmailID -> m ()

Archive a modmail conversation

unarchiveConversation :: MonadReddit m => ModmailID -> m ()

Archive a modmail conversation

highlightConversation :: MonadReddit m => ModmailID -> m ()

Highlight a given conversation

unhighlightConversation :: MonadReddit m => ModmailID -> m ()

Unhighlight a given conversation

markConversationsRead :: (Foldable t, MonadReddit m) => t ModmailID -> m ()

Mark the conversations corresponding to a container of ModmailIDs as read

markConversationRead :: MonadReddit m => ModmailID -> m ()

Mark the conversation corresponding to a single ModmailID as read

markConversationsUnread :: (Foldable t, MonadReddit m) => t ModmailID -> m ()

Mark the conversations corresponding to a container of ModmailIDs as unread

markConversationUnread :: MonadReddit m => ModmailID -> m ()

Mark the conversation corresponding to a single ModmailID as unread

bulkReadConversations :: (MonadReddit m, Foldable t) => Maybe ModmailState -> t SubredditName -> m (Seq ModmailID)

Mark all mail belonging to the subreddits as read, returning the ModmailIDs of the newly read conversations

muteModmailUser :: MonadReddit m => Word -> ModmailID -> m ()

Mute the non-moderator user associated with the modmail conversation. Valid durations for the days parameter are 3, 7, and 28

unmuteModmailUser :: MonadReddit m => ModmailID -> m ()

Unmute the non-moderator user associated with the modmail conversation

createConversation :: MonadReddit m => NewConversation -> m ModmailConversation

Create a new ModmailConversation

Widgets

deleteWidget :: MonadReddit m => SubredditName -> WidgetID -> m ()

Delete a widget, given its ID

updateWidget :: MonadReddit m => SubredditName -> WidgetID -> Widget -> m Widget

Update an existing widget, given its ID. You must wrap the widget type in the appropriate Widget constructors, as this action may be performed on heterogeneous widget types. The update widget is returned upon success

reorderWidgets :: (MonadReddit m, Foldable t) => Maybe WidgetSection -> SubredditName -> t WidgetID -> m ()

Reorder the widgets corresponding to a container of widget IDs in the given section. At the moment, reddit does not allow for the Topbar to be reordered. If you attempt to reorder this section, you might receive an InvalidJSON exception

addButtonWidget :: MonadReddit m => SubredditName -> ButtonWidget -> m ButtonWidget

Add a button widget. Returns the created widget upon success. See the docs for ButtonWidget for the available options

addCalendarWidget

Arguments

:: MonadReddit m

=> Maybe Body

A short description of the widget, in markdown

-> SubredditName

-> CalendarWidget

-> m CalendarWidget

Add a calendar widget, which requires an active Google account and public calendar. Returns the created widget upon success. See the docs for CalendarWidget for the available options

addCommunityListWidget

Arguments

:: MonadReddit m

=> Maybe Body

A short description of the widget, in markdown

-> SubredditName

-> CommunityListWidget

-> m CommunityListWidget

Add a community list widget. Returns the created widget upon success. See the docs for CommunityListWidget for the available options

addCustomWidget :: MonadReddit m => SubredditName -> CustomWidget -> m CustomWidget

Add a custom widget. Returns the created widget upon success. See the docs for CustomWidget for the available options

addImageWidget :: MonadReddit m => SubredditName -> ImageWidget -> m ImageWidget

Add an image widget. Returns the created widget upon success. See the docs for ImageWidget for the available options

addMenuWidget :: MonadReddit m => SubredditName -> MenuWidget -> m MenuWidget

Add a menu widget. Returns the created widget upon success. See the docs for MenuWidget for the available options

addPostFlairWidget :: MonadReddit m => SubredditName -> PostFlairWidget -> m PostFlairWidget

Add a post flair widget. Returns the created widget upon success. See the docs for PostFlairWidget for the available options along with mkPostFlairWidget

addTextAreaWidget :: MonadReddit m => SubredditName -> TextAreaWidget -> m TextAreaWidget

Add a text area widget. Returns the created widget upon success. See the docs for TextAreaWidget for the available options as well as mkTextAreaWidget

uploadWidgetImage :: MonadReddit m => SubredditName -> FilePath -> m UploadURL

Upload a widget image from a filepath. This returns the URL of the new image, which is required for creating certain widgets

Emoji

addEmoji

Arguments

:: MonadReddit m

=> SubredditName

-> FilePath

Must be an image in jpeg/png format, with maximum dimensions of 128 x 128px and size of 64KB

-> Emoji

-> m ()

Add a new emoji by uploading an image. See mkEmoji to conveniently create new Emojis to add. Also note the restrictions on the filepath argument below, which are not currently validated by this action. This action can also be used to update the image for an existing emoji (see getSubredditEmoji) to get a list of emojis for a subreddit

deleteEmoji :: MonadReddit m => SubredditName -> EmojiName -> m ()

Delete a single emoji and associated s3 image

updateEmoji :: MonadReddit m => SubredditName -> Emoji -> m ()

Update an emoji. Only the boolean permissions fields will be sent. If you would like to change the image associated with the emoji name, use addEmoji with an updated filepath

setCustomEmojiSize :: MonadReddit m => SubredditName -> Maybe (Int, Int) -> m ()

Set the (h, w) dimensions for all custom emojis on the subreddit. Both dimensions must be between 16px and 40px. A Nothing argument will disable custom sizes

Misc

getTraffic :: MonadReddit m => SubredditName -> m Traffic

Get traffic statistics for the given subreddit

Types

data SubredditType

The privacy level for the subreddit

Constructors

Public

Restricted

Private

Archived

GoldRestricted

EmployeesOnly

GoldOnly

UserSubreddit

Instances

Eq SubredditType

Defined in Network.Reddit.Types.Internal

Methods

(==) :: SubredditType -> SubredditType -> Bool

(/=) :: SubredditType -> SubredditType -> Bool

Show SubredditType

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> SubredditType -> ShowS

show :: SubredditType -> String

showList :: [SubredditType] -> ShowS

Generic SubredditType

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep SubredditType :: Type -> Type

Methods

from :: SubredditType -> Rep SubredditType x

to :: Rep SubredditType x -> SubredditType

FromJSON SubredditType

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser SubredditType

parseJSONList :: Value -> Parser [SubredditType]

ToHttpApiData SubredditType

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: SubredditType -> Text

toEncodedUrlPiece :: SubredditType -> Builder

toHeader :: SubredditType -> ByteString

toQueryParam :: SubredditType -> Text

type Rep SubredditType

Defined in Network.Reddit.Types.Internal

type Rep SubredditType = D1 ('MetaData "SubredditType" "Network.Reddit.Types.Internal" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (((C1 ('MetaCons "Public" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Restricted" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Private" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Archived" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "GoldRestricted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EmployeesOnly" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "GoldOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UserSubreddit" 'PrefixI 'False) (U1 :: Type -> Type))))

data FlairPosition

Position for subreddit flair

Constructors

OnLeft

OnRight

Instances

Eq FlairPosition

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairPosition -> FlairPosition -> Bool

(/=) :: FlairPosition -> FlairPosition -> Bool

Show FlairPosition

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairPosition -> ShowS

show :: FlairPosition -> String

showList :: [FlairPosition] -> ShowS

Generic FlairPosition

Defined in Network.Reddit.Types.Flair

Associated Types

type Rep FlairPosition :: Type -> Type

Methods

from :: FlairPosition -> Rep FlairPosition x

to :: Rep FlairPosition x -> FlairPosition

ToHttpApiData FlairPosition

Defined in Network.Reddit.Types.Flair

Methods

toUrlPiece :: FlairPosition -> Text

toEncodedUrlPiece :: FlairPosition -> Builder

toHeader :: FlairPosition -> ByteString

toQueryParam :: FlairPosition -> Text

type Rep FlairPosition

Defined in Network.Reddit.Types.Flair

type Rep FlairPosition = D1 ('MetaData "FlairPosition" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "OnLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnRight" 'PrefixI 'False) (U1 :: Type -> Type))

data FlairConfig

Configuration options for subreddit flair, including both user and submission flair. Also see defaultFlairConfig

Constructors

FlairConfig Bool Bool Bool FlairPosition FlairPosition

Instances

Eq FlairConfig

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairConfig -> FlairConfig -> Bool

(/=) :: FlairConfig -> FlairConfig -> Bool

Show FlairConfig

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairConfig -> ShowS

show :: FlairConfig -> String

showList :: [FlairConfig] -> ShowS

Generic FlairConfig

Defined in Network.Reddit.Types.Flair

Associated Types

type Rep FlairConfig :: Type -> Type

Methods

from :: FlairConfig -> Rep FlairConfig x

to :: Rep FlairConfig x -> FlairConfig

ToForm FlairConfig

Defined in Network.Reddit.Types.Flair

Methods

toForm :: FlairConfig -> Form

type Rep FlairConfig

Defined in Network.Reddit.Types.Flair

type Rep FlairConfig = D1 ('MetaData "FlairConfig" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "FlairConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "selfAssign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "linkSelfAssign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairPosition) :*: S1 ('MetaSel ('Just "linkPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairPosition)))))

defaultFlairConfig :: FlairConfig

A FlairConfig with default values

data LanguageCode where

The language in which the subreddit is available, as configured in the SubredditSettings

Bundled Patterns

pattern ZH :: LanguageCode

pattern VI :: LanguageCode

pattern UK :: LanguageCode

pattern TR :: LanguageCode

pattern TH :: LanguageCode

pattern TA :: LanguageCode

pattern SV :: LanguageCode

pattern SR :: LanguageCode

pattern SL :: LanguageCode

pattern SK :: LanguageCode

pattern RU :: LanguageCode

pattern RO :: LanguageCode

pattern PT :: LanguageCode

pattern PL :: LanguageCode

pattern NO :: LanguageCode

pattern NN :: LanguageCode

pattern NL :: LanguageCode

pattern MS :: LanguageCode

pattern LV :: LanguageCode

pattern LA :: LanguageCode

pattern KO :: LanguageCode

pattern JA :: LanguageCode

pattern IT :: LanguageCode

pattern IS :: LanguageCode

pattern ID :: LanguageCode

pattern HY :: LanguageCode

pattern HU :: LanguageCode

pattern HR :: LanguageCode

pattern HI :: LanguageCode

pattern HE :: LanguageCode

pattern GD :: LanguageCode

pattern FR :: LanguageCode

pattern FI :: LanguageCode

pattern FA :: LanguageCode

pattern EU :: LanguageCode

pattern ES :: LanguageCode

pattern EO :: LanguageCode

pattern EN :: LanguageCode

pattern EL :: LanguageCode

pattern DE :: LanguageCode

pattern DA :: LanguageCode

pattern CY :: LanguageCode

pattern CS :: LanguageCode

pattern CA :: LanguageCode

pattern BS :: LanguageCode

pattern BG :: LanguageCode

pattern AR :: LanguageCode

pattern AF :: LanguageCode

pattern GL :: LanguageCode

pattern ET :: LanguageCode

pattern LT :: LanguageCode

pattern BE :: LanguageCode

Instances

Eq LanguageCode

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: LanguageCode -> LanguageCode -> Bool

(/=) :: LanguageCode -> LanguageCode -> Bool

Show LanguageCode

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> LanguageCode -> ShowS

show :: LanguageCode -> String

showList :: [LanguageCode] -> ShowS

Generic LanguageCode

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep LanguageCode :: Type -> Type

Methods

from :: LanguageCode -> Rep LanguageCode x

to :: Rep LanguageCode x -> LanguageCode

FromJSON LanguageCode

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser LanguageCode

parseJSONList :: Value -> Parser [LanguageCode]

ToHttpApiData LanguageCode

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: LanguageCode -> Text

toEncodedUrlPiece :: LanguageCode -> Builder

toHeader :: LanguageCode -> ByteString

toQueryParam :: LanguageCode -> Text

type Rep LanguageCode

Defined in Network.Reddit.Types.Moderation

type Rep LanguageCode = D1 ('MetaData "LanguageCode" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "LanguageCode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Traffic

Traffic statistics for a given subreddit

Constructors

Traffic (Seq TrafficStat) (Seq TrafficStat) (Seq TrafficStat)

Instances

Eq Traffic

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: Traffic -> Traffic -> Bool

(/=) :: Traffic -> Traffic -> Bool

Show Traffic

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> Traffic -> ShowS

show :: Traffic -> String

showList :: [Traffic] -> ShowS

Generic Traffic

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep Traffic :: Type -> Type

Methods

from :: Traffic -> Rep Traffic x

to :: Rep Traffic x -> Traffic

FromJSON Traffic

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser Traffic

parseJSONList :: Value -> Parser [Traffic]

type Rep Traffic

Defined in Network.Reddit.Types.Moderation

type Rep Traffic = D1 ('MetaData "Traffic" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Traffic" 'PrefixI 'True) (S1 ('MetaSel ('Just "hour") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq TrafficStat)) :*: (S1 ('MetaSel ('Just "day") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq TrafficStat)) :*: S1 ('MetaSel ('Just "month") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq TrafficStat)))))

data TrafficStat

An individual statistic for a subreddit's traffic

Constructors

TrafficStat UTCTime Integer Integer (Maybe Integer)

Instances

Eq TrafficStat

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: TrafficStat -> TrafficStat -> Bool

(/=) :: TrafficStat -> TrafficStat -> Bool

Show TrafficStat

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> TrafficStat -> ShowS

show :: TrafficStat -> String

showList :: [TrafficStat] -> ShowS

Generic TrafficStat

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep TrafficStat :: Type -> Type

Methods

from :: TrafficStat -> Rep TrafficStat x

to :: Rep TrafficStat x -> TrafficStat

FromJSON TrafficStat

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser TrafficStat

parseJSONList :: Value -> Parser [TrafficStat]

type Rep TrafficStat

Defined in Network.Reddit.Types.Moderation

type Rep TrafficStat = D1 ('MetaData "TrafficStat" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "TrafficStat" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "uniqueViews") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "totalViews") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "subscribers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

data StyleImageAlignment

Alignment for certain StructuredStyleImages

Constructors

LeftAligned

CenterAligned

RightAligned

Instances

Eq StyleImageAlignment

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: StyleImageAlignment -> StyleImageAlignment -> Bool

(/=) :: StyleImageAlignment -> StyleImageAlignment -> Bool

Show StyleImageAlignment

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> StyleImageAlignment -> ShowS

show :: StyleImageAlignment -> String

showList :: [StyleImageAlignment] -> ShowS

Generic StyleImageAlignment

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep StyleImageAlignment :: Type -> Type

Methods

from :: StyleImageAlignment -> Rep StyleImageAlignment x

to :: Rep StyleImageAlignment x -> StyleImageAlignment

ToHttpApiData StyleImageAlignment

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: StyleImageAlignment -> Text

toEncodedUrlPiece :: StyleImageAlignment -> Builder

toHeader :: StyleImageAlignment -> ByteString

toQueryParam :: StyleImageAlignment -> Text

type Rep StyleImageAlignment

Defined in Network.Reddit.Types.Moderation

type Rep StyleImageAlignment = D1 ('MetaData "StyleImageAlignment" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LeftAligned" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CenterAligned" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RightAligned" 'PrefixI 'False) (U1 :: Type -> Type)))

data StructuredStyleImage

Represents one of the style images that may be uploaded

Constructors

BannerBackground

BannerAdditional

BannerHover

Instances

Eq StructuredStyleImage

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: StructuredStyleImage -> StructuredStyleImage -> Bool

(/=) :: StructuredStyleImage -> StructuredStyleImage -> Bool

Show StructuredStyleImage

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> StructuredStyleImage -> ShowS

show :: StructuredStyleImage -> String

showList :: [StructuredStyleImage] -> ShowS

Generic StructuredStyleImage

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep StructuredStyleImage :: Type -> Type

Methods

from :: StructuredStyleImage -> Rep StructuredStyleImage x

to :: Rep StructuredStyleImage x -> StructuredStyleImage

ToHttpApiData StructuredStyleImage

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: StructuredStyleImage -> Text

toEncodedUrlPiece :: StructuredStyleImage -> Builder

toHeader :: StructuredStyleImage -> ByteString

toQueryParam :: StructuredStyleImage -> Text

type Rep StructuredStyleImage

Defined in Network.Reddit.Types.Moderation

type Rep StructuredStyleImage = D1 ('MetaData "StructuredStyleImage" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "BannerBackground" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BannerAdditional" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BannerHover" 'PrefixI 'False) (U1 :: Type -> Type)))

data S3ModerationLease

Used to upload style assets and images to Reddit's servers with moderator privileges

Constructors

S3ModerationLease URL (HashMap Text Text) Text URL

Instances

Eq S3ModerationLease

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: S3ModerationLease -> S3ModerationLease -> Bool

(/=) :: S3ModerationLease -> S3ModerationLease -> Bool

Show S3ModerationLease

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> S3ModerationLease -> ShowS

show :: S3ModerationLease -> String

showList :: [S3ModerationLease] -> ShowS

Generic S3ModerationLease

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep S3ModerationLease :: Type -> Type

Methods

from :: S3ModerationLease -> Rep S3ModerationLease x

to :: Rep S3ModerationLease x -> S3ModerationLease

FromJSON S3ModerationLease

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser S3ModerationLease

parseJSONList :: Value -> Parser [S3ModerationLease]

type Rep S3ModerationLease

Defined in Network.Reddit.Types.Moderation

type Rep S3ModerationLease = D1 ('MetaData "S3ModerationLease" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "S3ModerationLease" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "websocketURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL))))

data SubredditImage

An image belonging to a Stylesheet

Constructors

SubredditImage Name Text URL

Instances

Eq SubredditImage

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: SubredditImage -> SubredditImage -> Bool

(/=) :: SubredditImage -> SubredditImage -> Bool

Show SubredditImage

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> SubredditImage -> ShowS

show :: SubredditImage -> String

showList :: [SubredditImage] -> ShowS

Generic SubredditImage

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep SubredditImage :: Type -> Type

Methods

from :: SubredditImage -> Rep SubredditImage x

to :: Rep SubredditImage x -> SubredditImage

FromJSON SubredditImage

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser SubredditImage

parseJSONList :: Value -> Parser [SubredditImage]

type Rep SubredditImage

Defined in Network.Reddit.Types.Moderation

type Rep SubredditImage = D1 ('MetaData "SubredditImage" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SubredditImage" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :*: (S1 ('MetaSel ('Just "link") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL))))

data Stylesheet

The CSS stylesheet and images for a subreddit

Constructors

Stylesheet Text (Seq SubredditImage) SubredditID

Instances

Eq Stylesheet

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: Stylesheet -> Stylesheet -> Bool

(/=) :: Stylesheet -> Stylesheet -> Bool

Show Stylesheet

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> Stylesheet -> ShowS

show :: Stylesheet -> String

showList :: [Stylesheet] -> ShowS

Generic Stylesheet

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep Stylesheet :: Type -> Type

Methods

from :: Stylesheet -> Rep Stylesheet x

to :: Rep Stylesheet x -> Stylesheet

FromJSON Stylesheet

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser Stylesheet

parseJSONList :: Value -> Parser [Stylesheet]

type Rep Stylesheet

Defined in Network.Reddit.Types.Moderation

type Rep Stylesheet = D1 ('MetaData "Stylesheet" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Stylesheet" 'PrefixI 'True) (S1 ('MetaSel ('Just "stylesheet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SubredditImage)) :*: S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID))))

data ModActionType

Classification for ModActions

Constructors

BanUser

UnbanUser

SpamLink

RemoveLink

ApproveLink

SpamComment

RemoveComment

ApproveComment

AddModerator

ShowComment

InviteModerator

UninviteModerator

AcceptModeratorInvite

RemoveModerator

AddContributor

RemoveContributor

EditSettings

EditFlair

Distinguish

MarkNSFW

WikiBanned

WikiContrib

WikiUnbanned

WikiPageListed

RemoveWikiContributor

WikiRevise

WikiPermLevel

IgnoreReports

UnignoreReports

SetPermissions

SetSuggestedSort

Sticky

Unsticky

SetContestMode

UnsetContestMode

Lock

Unlock

MuteUser

UnmuteUser

CreateRule

EditRule

ReorderRules

DeleteRule

Spoiler

Unspoiler

MarkOriginalContent

Collections

Events

DeleteOverriddenClassification

OverrideClassification

ReorderModerators

SnoozeReports

UnsnoozeReports

OtherModAction

Instances

Eq ModActionType

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModActionType -> ModActionType -> Bool

(/=) :: ModActionType -> ModActionType -> Bool

Ord ModActionType

Defined in Network.Reddit.Types.Moderation

Methods

compare :: ModActionType -> ModActionType -> Ordering

(<) :: ModActionType -> ModActionType -> Bool

(<=) :: ModActionType -> ModActionType -> Bool

(>) :: ModActionType -> ModActionType -> Bool

(>=) :: ModActionType -> ModActionType -> Bool

max :: ModActionType -> ModActionType -> ModActionType

min :: ModActionType -> ModActionType -> ModActionType

Show ModActionType

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModActionType -> ShowS

show :: ModActionType -> String

showList :: [ModActionType] -> ShowS

Generic ModActionType

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModActionType :: Type -> Type

Methods

from :: ModActionType -> Rep ModActionType x

to :: Rep ModActionType x -> ModActionType

FromJSON ModActionType

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModActionType

parseJSONList :: Value -> Parser [ModActionType]

ToHttpApiData ModActionType

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ModActionType -> Text

toEncodedUrlPiece :: ModActionType -> Builder

toHeader :: ModActionType -> ByteString

toQueryParam :: ModActionType -> Text

type Rep ModActionType

Defined in Network.Reddit.Types.Moderation

type Rep ModActionType = D1 ('MetaData "ModActionType" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (((((C1 ('MetaCons "BanUser" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UnbanUser" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpamLink" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "RemoveLink" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ApproveLink" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpamComment" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "RemoveComment" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ApproveComment" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AddModerator" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ShowComment" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InviteModerator" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UninviteModerator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AcceptModeratorInvite" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "RemoveModerator" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AddContributor" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RemoveContributor" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "EditSettings" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EditFlair" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Distinguish" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MarkNSFW" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "WikiBanned" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "WikiContrib" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WikiUnbanned" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "WikiPageListed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RemoveWikiContributor" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WikiRevise" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WikiPermLevel" 'PrefixI 'False) (U1 :: Type -> Type)))))) :+: ((((C1 ('MetaCons "IgnoreReports" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UnignoreReports" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetPermissions" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "SetSuggestedSort" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Sticky" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unsticky" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "SetContestMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UnsetContestMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Lock" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Unlock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MuteUser" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UnmuteUser" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CreateRule" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "EditRule" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ReorderRules" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DeleteRule" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Spoiler" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unspoiler" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MarkOriginalContent" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Collections" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "Events" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DeleteOverriddenClassification" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OverrideClassification" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ReorderModerators" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SnoozeReports" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UnsnoozeReports" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherModAction" 'PrefixI 'False) (U1 :: Type -> Type)))))))

data ModActionID

Identifier for an issued ModAction

Instances

Eq ModActionID

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModActionID -> ModActionID -> Bool

(/=) :: ModActionID -> ModActionID -> Bool

Show ModActionID

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModActionID -> ShowS

show :: ModActionID -> String

showList :: [ModActionID] -> ShowS

Generic ModActionID

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModActionID :: Type -> Type

Methods

from :: ModActionID -> Rep ModActionID x

to :: Rep ModActionID x -> ModActionID

FromJSON ModActionID

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModActionID

parseJSONList :: Value -> Parser [ModActionID]

ToHttpApiData ModActionID

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ModActionID -> Text

toEncodedUrlPiece :: ModActionID -> Builder

toHeader :: ModActionID -> ByteString

toQueryParam :: ModActionID -> Text

Thing ModActionID

Defined in Network.Reddit.Types.Moderation

Methods

fullname :: ModActionID -> Text

type Rep ModActionID

Defined in Network.Reddit.Types.Moderation

type Rep ModActionID = D1 ('MetaData "ModActionID" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "ModActionID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ModActionOpts

Options for filtering/paginating Listings of ModActions

Constructors

ModActionOpts (Maybe ModActionType) (Maybe Username)

Instances

Eq ModActionOpts

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModActionOpts -> ModActionOpts -> Bool

(/=) :: ModActionOpts -> ModActionOpts -> Bool

Show ModActionOpts

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModActionOpts -> ShowS

show :: ModActionOpts -> String

showList :: [ModActionOpts] -> ShowS

Generic ModActionOpts

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModActionOpts :: Type -> Type

Methods

from :: ModActionOpts -> Rep ModActionOpts x

to :: Rep ModActionOpts x -> ModActionOpts

type Rep ModActionOpts

Defined in Network.Reddit.Types.Moderation

type Rep ModActionOpts = D1 ('MetaData "ModActionOpts" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModActionOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModActionType)) :*: S1 ('MetaSel ('Just "moderator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Username))))

data ModAction

An action issued by a moderator. The various fields prefixed target can refer to comments or submissions, where applicable

Constructors

ModAction ModActionID Username ModActionType UTCTime (Maybe Body) (Maybe Text) (Maybe ItemID) (Maybe Username) (Maybe Title) (Maybe URL)

Instances

Eq ModAction

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModAction -> ModAction -> Bool

(/=) :: ModAction -> ModAction -> Bool

Show ModAction

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModAction -> ShowS

show :: ModAction -> String

showList :: [ModAction] -> ShowS

Generic ModAction

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModAction :: Type -> Type

Methods

from :: ModAction -> Rep ModAction x

to :: Rep ModAction x -> ModAction

FromJSON ModAction

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModAction

parseJSONList :: Value -> Parser [ModAction]

Paginable ModAction

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions ModAction

type PaginateThing ModAction

Methods

defaultOpts :: PaginateOptions ModAction

getFullname :: ModAction -> PaginateThing ModAction

optsToForm :: PaginateOptions ModAction -> Form

type Rep ModAction

Defined in Network.Reddit.Types.Moderation

type Rep ModAction = D1 ('MetaData "ModAction" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModAction" 'PrefixI 'True) (((S1 ('MetaSel ('Just "modActionID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModActionID) :*: S1 ('MetaSel ('Just "moderator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username)) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModActionType) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body))))) :*: ((S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemID))) :*: (S1 ('MetaSel ('Just "targetAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Username)) :*: (S1 ('MetaSel ('Just "targetTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Title)) :*: S1 ('MetaSel ('Just "targetPermalink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)))))))

type PaginateOptions ModAction

Defined in Network.Reddit.Types.Moderation

type PaginateOptions ModAction = ModActionOpts

type PaginateThing ModAction

Defined in Network.Reddit.Types.Moderation

type PaginateThing ModAction = ModActionID

data NewConversation

A new, mod-created modmail conversation

Constructors

NewConversation Body Subject Username SubredditName Bool

Instances

Eq NewConversation

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: NewConversation -> NewConversation -> Bool

(/=) :: NewConversation -> NewConversation -> Bool

Show NewConversation

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> NewConversation -> ShowS

show :: NewConversation -> String

showList :: [NewConversation] -> ShowS

Generic NewConversation

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep NewConversation :: Type -> Type

Methods

from :: NewConversation -> Rep NewConversation x

to :: Rep NewConversation x -> NewConversation

ToForm NewConversation

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: NewConversation -> Form

type Rep NewConversation

Defined in Network.Reddit.Types.Moderation

type Rep NewConversation = D1 ('MetaData "NewConversation" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "NewConversation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Subject)) :*: (S1 ('MetaSel ('Just "dest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :*: S1 ('MetaSel ('Just "isAuthorHidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data ModmailReply

A new reply to a ModmailConversation

Constructors

ModmailReply Body Bool Bool

Instances

Eq ModmailReply

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailReply -> ModmailReply -> Bool

(/=) :: ModmailReply -> ModmailReply -> Bool

Show ModmailReply

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailReply -> ShowS

show :: ModmailReply -> String

showList :: [ModmailReply] -> ShowS

Generic ModmailReply

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailReply :: Type -> Type

Methods

from :: ModmailReply -> Rep ModmailReply x

to :: Rep ModmailReply x -> ModmailReply

ToForm ModmailReply

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: ModmailReply -> Form

type Rep ModmailReply

Defined in Network.Reddit.Types.Moderation

type Rep ModmailReply = D1 ('MetaData "ModmailReply" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailReply" 'PrefixI 'True) (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: (S1 ('MetaSel ('Just "isAuthorHidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isInternal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

data ModmailState

The state of the modmail, for use when filtering mail

Constructors

AllModmail

NewModmail

Appeals

Notifications

Inbox

InProgress

ArchivedMail

Highlighted

JoinRequests

ModModmail

Instances

Eq ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailState -> ModmailState -> Bool

(/=) :: ModmailState -> ModmailState -> Bool

Show ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailState -> ShowS

show :: ModmailState -> String

showList :: [ModmailState] -> ShowS

Generic ModmailState

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailState :: Type -> Type

Methods

from :: ModmailState -> Rep ModmailState x

to :: Rep ModmailState x -> ModmailState

Hashable ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

hashWithSalt :: Int -> ModmailState -> Int

hash :: ModmailState -> Int

FromJSON ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModmailState

parseJSONList :: Value -> Parser [ModmailState]

FromJSONKey ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

fromJSONKey :: FromJSONKeyFunction ModmailState

fromJSONKeyList :: FromJSONKeyFunction [ModmailState]

ToHttpApiData ModmailState

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ModmailState -> Text

toEncodedUrlPiece :: ModmailState -> Builder

toHeader :: ModmailState -> ByteString

toQueryParam :: ModmailState -> Text

type Rep ModmailState

Defined in Network.Reddit.Types.Moderation

type Rep ModmailState = D1 ('MetaData "ModmailState" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (((C1 ('MetaCons "AllModmail" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewModmail" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Appeals" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Notifications" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Inbox" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "InProgress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ArchivedMail" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Highlighted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JoinRequests" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModModmail" 'PrefixI 'False) (U1 :: Type -> Type)))))

data ModmailSort

Order to sort modmail in

Constructors

FromUser

FromMod

RecentMail

UnreadMail

Instances

Eq ModmailSort

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailSort -> ModmailSort -> Bool

(/=) :: ModmailSort -> ModmailSort -> Bool

Show ModmailSort

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailSort -> ShowS

show :: ModmailSort -> String

showList :: [ModmailSort] -> ShowS

Generic ModmailSort

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailSort :: Type -> Type

Methods

from :: ModmailSort -> Rep ModmailSort x

to :: Rep ModmailSort x -> ModmailSort

ToHttpApiData ModmailSort

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ModmailSort -> Text

toEncodedUrlPiece :: ModmailSort -> Builder

toHeader :: ModmailSort -> ByteString

toQueryParam :: ModmailSort -> Text

type Rep ModmailSort

Defined in Network.Reddit.Types.Moderation

type Rep ModmailSort = D1 ('MetaData "ModmailSort" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "FromUser" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FromMod" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RecentMail" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UnreadMail" 'PrefixI 'False) (U1 :: Type -> Type)))

data ModmailOpts

Options for filtering/paginating modmail endpoints. Notably, this is an entirely different mechanism than the usual Listings elsewhere on Reddit

Constructors

ModmailOpts (Maybe ModmailID) (Maybe [SubredditName]) (Maybe Word) (Maybe ModmailSort) (Maybe ModmailState)

Instances

Eq ModmailOpts

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailOpts -> ModmailOpts -> Bool

(/=) :: ModmailOpts -> ModmailOpts -> Bool

Show ModmailOpts

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailOpts -> ShowS

show :: ModmailOpts -> String

showList :: [ModmailOpts] -> ShowS

Generic ModmailOpts

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailOpts :: Type -> Type

Methods

from :: ModmailOpts -> Rep ModmailOpts x

to :: Rep ModmailOpts x -> ModmailOpts

ToForm ModmailOpts

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: ModmailOpts -> Form

type Rep ModmailOpts

Defined in Network.Reddit.Types.Moderation

type Rep ModmailOpts = D1 ('MetaData "ModmailOpts" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailOpts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModmailID)) :*: S1 ('MetaSel ('Just "subreddits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubredditName]))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word)) :*: (S1 ('MetaSel ('Just "itemSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModmailSort)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModmailState))))))

data ModmailAuthor

An author in a ModmailConversation; can be either a mod or a non-mod user

Constructors

ModmailAuthor Username Bool Bool Bool Bool Bool Bool

Instances

Eq ModmailAuthor

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailAuthor -> ModmailAuthor -> Bool

(/=) :: ModmailAuthor -> ModmailAuthor -> Bool

Show ModmailAuthor

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailAuthor -> ShowS

show :: ModmailAuthor -> String

showList :: [ModmailAuthor] -> ShowS

Generic ModmailAuthor

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailAuthor :: Type -> Type

Methods

from :: ModmailAuthor -> Rep ModmailAuthor x

to :: Rep ModmailAuthor x -> ModmailAuthor

FromJSON ModmailAuthor

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModmailAuthor

parseJSONList :: Value -> Parser [ModmailAuthor]

type Rep ModmailAuthor

Defined in Network.Reddit.Types.Moderation

type Rep ModmailAuthor = D1 ('MetaData "ModmailAuthor" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailAuthor" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: (S1 ('MetaSel ('Just "isAdmin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "isHidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isMod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "isOP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isParticipant") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data ModmailMessage

A single message in a ModmailConversation

Constructors

ModmailMessage Text ModmailAuthor Body Body UTCTime Bool

Instances

Eq ModmailMessage

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailMessage -> ModmailMessage -> Bool

(/=) :: ModmailMessage -> ModmailMessage -> Bool

Show ModmailMessage

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailMessage -> ShowS

show :: ModmailMessage -> String

showList :: [ModmailMessage] -> ShowS

Generic ModmailMessage

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailMessage :: Type -> Type

Methods

from :: ModmailMessage -> Rep ModmailMessage x

to :: Rep ModmailMessage x -> ModmailMessage

FromJSON ModmailMessage

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModmailMessage

parseJSONList :: Value -> Parser [ModmailMessage]

type Rep ModmailMessage

Defined in Network.Reddit.Types.Moderation

type Rep ModmailMessage = D1 ('MetaData "ModmailMessage" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modmailMessageID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModmailAuthor) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) :*: (S1 ('MetaSel ('Just "bodyHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "isInternal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data ModmailObjID

A mapping to a modmail action to its ID

Constructors

ModmailObjID Text Text

Instances

Eq ModmailObjID

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailObjID -> ModmailObjID -> Bool

(/=) :: ModmailObjID -> ModmailObjID -> Bool

Show ModmailObjID

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailObjID -> ShowS

show :: ModmailObjID -> String

showList :: [ModmailObjID] -> ShowS

Generic ModmailObjID

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailObjID :: Type -> Type

Methods

from :: ModmailObjID -> Rep ModmailObjID x

to :: Rep ModmailObjID x -> ModmailObjID

FromJSON ModmailObjID

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModmailObjID

parseJSONList :: Value -> Parser [ModmailObjID]

type Rep ModmailObjID

Defined in Network.Reddit.Types.Moderation

type Rep ModmailObjID = D1 ('MetaData "ModmailObjID" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailObjID" 'PrefixI 'True) (S1 ('MetaSel ('Just "objID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

type ModmailID = Text

The ID of a particular modmail conversation

data ModmailConversation

A single modmail conversation

Constructors

ModmailConversation ModmailID Subject (Seq ModmailMessage) Integer SubredditName (Maybe ModmailAuthor) (Seq ModmailObjID) UTCTime (Maybe UTCTime) (Maybe UTCTime) Bool Bool

Instances

Eq ModmailConversation

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModmailConversation -> ModmailConversation -> Bool

(/=) :: ModmailConversation -> ModmailConversation -> Bool

Show ModmailConversation

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModmailConversation -> ShowS

show :: ModmailConversation -> String

showList :: [ModmailConversation] -> ShowS

Generic ModmailConversation

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModmailConversation :: Type -> Type

Methods

from :: ModmailConversation -> Rep ModmailConversation x

to :: Rep ModmailConversation x -> ModmailConversation

FromJSON ModmailConversation

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModmailConversation

parseJSONList :: Value -> Parser [ModmailConversation]

type Rep ModmailConversation

Defined in Network.Reddit.Types.Moderation

type Rep ModmailConversation = D1 ('MetaData "ModmailConversation" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModmailConversation" 'PrefixI 'True) (((S1 ('MetaSel ('Just "modmailID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModmailID) :*: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Subject) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ModmailMessage)))) :*: (S1 ('MetaSel ('Just "numMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :*: S1 ('MetaSel ('Just "participant") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModmailAuthor))))) :*: ((S1 ('MetaSel ('Just "objIDs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ModmailObjID)) :*: (S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "lastUserUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)))) :*: (S1 ('MetaSel ('Just "lastModUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :*: (S1 ('MetaSel ('Just "isHighlighted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isInternal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newtype Modmail

Moderator mail. Reddit no longer supports the older, message-based interface for modmail

Constructors

Modmail (Seq ModmailConversation)

Instances

Eq Modmail

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: Modmail -> Modmail -> Bool

(/=) :: Modmail -> Modmail -> Bool

Show Modmail

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> Modmail -> ShowS

show :: Modmail -> String

showList :: [Modmail] -> ShowS

Generic Modmail

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep Modmail :: Type -> Type

Methods

from :: Modmail -> Rep Modmail x

to :: Rep Modmail x -> Modmail

FromJSON Modmail

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser Modmail

parseJSONList :: Value -> Parser [Modmail]

type Rep Modmail

Defined in Network.Reddit.Types.Moderation

type Rep Modmail = D1 ('MetaData "Modmail" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "Modmail" 'PrefixI 'True) (S1 ('MetaSel ('Just "conversations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq ModmailConversation))))

data BanNotes

Details of a new ban to apply to a user

Constructors

BanNotes Body Body (Maybe Word) Body

Instances

Eq BanNotes

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: BanNotes -> BanNotes -> Bool

(/=) :: BanNotes -> BanNotes -> Bool

Show BanNotes

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> BanNotes -> ShowS

show :: BanNotes -> String

showList :: [BanNotes] -> ShowS

Generic BanNotes

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep BanNotes :: Type -> Type

Methods

from :: BanNotes -> Rep BanNotes x

to :: Rep BanNotes x -> BanNotes

ToForm BanNotes

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: BanNotes -> Form

type Rep BanNotes

Defined in Network.Reddit.Types.Moderation

type Rep BanNotes = D1 ('MetaData "BanNotes" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "BanNotes" 'PrefixI 'True) ((S1 ('MetaSel ('Just "banMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: S1 ('MetaSel ('Just "banReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)) :*: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word)) :*: S1 ('MetaSel ('Just "note") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))))

newtype MuteID

Identifies relationships representing muted users

Constructors

MuteID Text

Instances

Eq MuteID

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: MuteID -> MuteID -> Bool

(/=) :: MuteID -> MuteID -> Bool

Show MuteID

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> MuteID -> ShowS

show :: MuteID -> String

showList :: [MuteID] -> ShowS

Generic MuteID

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep MuteID :: Type -> Type

Methods

from :: MuteID -> Rep MuteID x

to :: Rep MuteID x -> MuteID

FromJSON MuteID

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser MuteID

parseJSONList :: Value -> Parser [MuteID]

Thing MuteID

Defined in Network.Reddit.Types.Moderation

Methods

fullname :: MuteID -> Text

type Rep MuteID

Defined in Network.Reddit.Types.Moderation

type Rep MuteID = D1 ('MetaData "MuteID" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "MuteID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype RelID

Uniquely identifies a subreddit relationship, excluding mutes (see MuteID)

Constructors

RelID Text

Instances

Eq RelID

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RelID -> RelID -> Bool

(/=) :: RelID -> RelID -> Bool

Show RelID

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RelID -> ShowS

show :: RelID -> String

showList :: [RelID] -> ShowS

Generic RelID

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RelID :: Type -> Type

Methods

from :: RelID -> Rep RelID x

to :: Rep RelID x -> RelID

FromJSON RelID

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser RelID

parseJSONList :: Value -> Parser [RelID]

Thing RelID

Defined in Network.Reddit.Types.Moderation

Methods

fullname :: RelID -> Text

type Rep RelID

Defined in Network.Reddit.Types.Moderation

type Rep RelID = D1 ('MetaData "RelID" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "RelID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Ban

Represents an account that has been banned from a particular subreddit

Constructors

Ban RelID Username UserID (Maybe Text) UTCTime (Maybe Word)

Instances

Eq Ban

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: Ban -> Ban -> Bool

(/=) :: Ban -> Ban -> Bool

Show Ban

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> Ban -> ShowS

show :: Ban -> String

showList :: [Ban] -> ShowS

Generic Ban

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep Ban :: Type -> Type

Methods

from :: Ban -> Rep Ban x

to :: Rep Ban x -> Ban

FromJSON Ban

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser Ban

parseJSONList :: Value -> Parser [Ban]

Paginable Ban

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions Ban

type PaginateThing Ban

Methods

defaultOpts :: PaginateOptions Ban

getFullname :: Ban -> PaginateThing Ban

optsToForm :: PaginateOptions Ban -> Form

type Rep Ban

Defined in Network.Reddit.Types.Moderation

type Rep Ban = D1 ('MetaData "Ban" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Ban" 'PrefixI 'True) ((S1 ('MetaSel ('Just "banID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelID) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID))) :*: (S1 ('MetaSel ('Just "note") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "since") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "daysLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word))))))

type PaginateOptions Ban

Defined in Network.Reddit.Types.Moderation

type PaginateOptions Ban = RelInfoOpts

type PaginateThing Ban

Defined in Network.Reddit.Types.Moderation

type PaginateThing Ban = RelID

data Wikimode

The editing mode for a subreddit's wiki

Constructors

EditDisabled

Only mods can edit

ApprovedEdit

Only mods and approved editors can edit

ContributorEdit

Any sub contributor can edit

Instances

Eq Wikimode

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: Wikimode -> Wikimode -> Bool

(/=) :: Wikimode -> Wikimode -> Bool

Ord Wikimode

Defined in Network.Reddit.Types.Moderation

Methods

compare :: Wikimode -> Wikimode -> Ordering

(<) :: Wikimode -> Wikimode -> Bool

(<=) :: Wikimode -> Wikimode -> Bool

(>) :: Wikimode -> Wikimode -> Bool

(>=) :: Wikimode -> Wikimode -> Bool

max :: Wikimode -> Wikimode -> Wikimode

min :: Wikimode -> Wikimode -> Wikimode

Show Wikimode

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> Wikimode -> ShowS

show :: Wikimode -> String

showList :: [Wikimode] -> ShowS

Generic Wikimode

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep Wikimode :: Type -> Type

Methods

from :: Wikimode -> Rep Wikimode x

to :: Rep Wikimode x -> Wikimode

FromJSON Wikimode

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser Wikimode

parseJSONList :: Value -> Parser [Wikimode]

ToHttpApiData Wikimode

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: Wikimode -> Text

toEncodedUrlPiece :: Wikimode -> Builder

toHeader :: Wikimode -> ByteString

toQueryParam :: Wikimode -> Text

type Rep Wikimode

Defined in Network.Reddit.Types.Moderation

type Rep Wikimode = D1 ('MetaData "Wikimode" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "EditDisabled" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ApprovedEdit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ContributorEdit" 'PrefixI 'False) (U1 :: Type -> Type)))

data SpamFilter

The strength of the subreddit's spam filter

Constructors

LowFilter

HighFilter

AllFilter

Instances

Eq SpamFilter

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: SpamFilter -> SpamFilter -> Bool

(/=) :: SpamFilter -> SpamFilter -> Bool

Show SpamFilter

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> SpamFilter -> ShowS

show :: SpamFilter -> String

showList :: [SpamFilter] -> ShowS

Generic SpamFilter

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep SpamFilter :: Type -> Type

Methods

from :: SpamFilter -> Rep SpamFilter x

to :: Rep SpamFilter x -> SpamFilter

FromJSON SpamFilter

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser SpamFilter

parseJSONList :: Value -> Parser [SpamFilter]

ToHttpApiData SpamFilter

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: SpamFilter -> Text

toEncodedUrlPiece :: SpamFilter -> Builder

toHeader :: SpamFilter -> ByteString

toQueryParam :: SpamFilter -> Text

type Rep SpamFilter

Defined in Network.Reddit.Types.Moderation

type Rep SpamFilter = D1 ('MetaData "SpamFilter" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "LowFilter" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HighFilter" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AllFilter" 'PrefixI 'False) (U1 :: Type -> Type)))

data ContentOptions

Permissible submissions on the subreddit

Constructors

AnyContent

LinkOnly

SelfOnly

Instances

Eq ContentOptions

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ContentOptions -> ContentOptions -> Bool

(/=) :: ContentOptions -> ContentOptions -> Bool

Show ContentOptions

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ContentOptions -> ShowS

show :: ContentOptions -> String

showList :: [ContentOptions] -> ShowS

Generic ContentOptions

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ContentOptions :: Type -> Type

Methods

from :: ContentOptions -> Rep ContentOptions x

to :: Rep ContentOptions x -> ContentOptions

FromJSON ContentOptions

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ContentOptions

parseJSONList :: Value -> Parser [ContentOptions]

ToHttpApiData ContentOptions

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ContentOptions -> Text

toEncodedUrlPiece :: ContentOptions -> Builder

toHeader :: ContentOptions -> ByteString

toQueryParam :: ContentOptions -> Text

type Rep ContentOptions

Defined in Network.Reddit.Types.Moderation

type Rep ContentOptions = D1 ('MetaData "ContentOptions" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "AnyContent" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LinkOnly" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SelfOnly" 'PrefixI 'False) (U1 :: Type -> Type)))

data CrowdControlLevel

The setting for crowd controls, from lenient to strict

Constructors

Zero

One

Two

Three

Instances

Enum CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

succ :: CrowdControlLevel -> CrowdControlLevel

pred :: CrowdControlLevel -> CrowdControlLevel

toEnum :: Int -> CrowdControlLevel

fromEnum :: CrowdControlLevel -> Int

enumFrom :: CrowdControlLevel -> [CrowdControlLevel]

enumFromThen :: CrowdControlLevel -> CrowdControlLevel -> [CrowdControlLevel]

enumFromTo :: CrowdControlLevel -> CrowdControlLevel -> [CrowdControlLevel]

enumFromThenTo :: CrowdControlLevel -> CrowdControlLevel -> CrowdControlLevel -> [CrowdControlLevel]

Eq CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: CrowdControlLevel -> CrowdControlLevel -> Bool

(/=) :: CrowdControlLevel -> CrowdControlLevel -> Bool

Ord CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

compare :: CrowdControlLevel -> CrowdControlLevel -> Ordering

(<) :: CrowdControlLevel -> CrowdControlLevel -> Bool

(<=) :: CrowdControlLevel -> CrowdControlLevel -> Bool

(>) :: CrowdControlLevel -> CrowdControlLevel -> Bool

(>=) :: CrowdControlLevel -> CrowdControlLevel -> Bool

max :: CrowdControlLevel -> CrowdControlLevel -> CrowdControlLevel

min :: CrowdControlLevel -> CrowdControlLevel -> CrowdControlLevel

Show CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> CrowdControlLevel -> ShowS

show :: CrowdControlLevel -> String

showList :: [CrowdControlLevel] -> ShowS

Generic CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep CrowdControlLevel :: Type -> Type

Methods

from :: CrowdControlLevel -> Rep CrowdControlLevel x

to :: Rep CrowdControlLevel x -> CrowdControlLevel

FromJSON CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser CrowdControlLevel

parseJSONList :: Value -> Parser [CrowdControlLevel]

ToHttpApiData CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: CrowdControlLevel -> Text

toEncodedUrlPiece :: CrowdControlLevel -> Builder

toHeader :: CrowdControlLevel -> ByteString

toQueryParam :: CrowdControlLevel -> Text

type Rep CrowdControlLevel

Defined in Network.Reddit.Types.Moderation

type Rep CrowdControlLevel = D1 ('MetaData "CrowdControlLevel" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "Zero" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "One" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Two" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Three" 'PrefixI 'False) (U1 :: Type -> Type)))

data SubredditSettings

The settings that may be configured for a particular subreddit

Constructors

SubredditSettings SubredditID Title Body Text Text Text LanguageCode SubredditType ContentOptions RGBText Wikimode Integer Integer Integer SpamFilter SpamFilter SpamFilter CrowdControlLevel CrowdControlLevel Bool (Maybe ItemSort) (Maybe Text) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool

Instances

Eq SubredditSettings

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: SubredditSettings -> SubredditSettings -> Bool

(/=) :: SubredditSettings -> SubredditSettings -> Bool

Show SubredditSettings

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> SubredditSettings -> ShowS

show :: SubredditSettings -> String

showList :: [SubredditSettings] -> ShowS

Generic SubredditSettings

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep SubredditSettings :: Type -> Type

Methods

from :: SubredditSettings -> Rep SubredditSettings x

to :: Rep SubredditSettings x -> SubredditSettings

FromJSON SubredditSettings

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser SubredditSettings

parseJSONList :: Value -> Parser [SubredditSettings]

ToForm SubredditSettings

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: SubredditSettings -> Form

type Rep SubredditSettings

Defined in Network.Reddit.Types.Moderation

type Rep SubredditSettings = D1 ('MetaData "SubredditSettings" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SubredditSettings" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: (S1 ('MetaSel ('Just "submitText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "submitTextLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "headerHoverText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)) :*: (S1 ('MetaSel ('Just "subredditType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditType) :*: (S1 ('MetaSel ('Just "contentOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContentOptions) :*: S1 ('MetaSel ('Just "keyColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RGBText))))) :*: (((S1 ('MetaSel ('Just "wikimode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Wikimode) :*: S1 ('MetaSel ('Just "wikiEditKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "wikiEditAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: (S1 ('MetaSel ('Just "commentScoreHideMins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "spamComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SpamFilter)))) :*: ((S1 ('MetaSel ('Just "spamSelfposts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SpamFilter) :*: S1 ('MetaSel ('Just "spamLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SpamFilter)) :*: (S1 ('MetaSel ('Just "crowdControlLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CrowdControlLevel) :*: (S1 ('MetaSel ('Just "crowdControlChatLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CrowdControlLevel) :*: S1 ('MetaSel ('Just "crowdControlMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))) :*: ((((S1 ('MetaSel ('Just "suggestedCommentSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemSort)) :*: S1 ('MetaSel ('Just "welcomeMessageText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "welcomeMessageEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "allowImages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allowVideos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "allowPolls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allowCrossposts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "allowChatPostCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "spoilersEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "showMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :*: (((S1 ('MetaSel ('Just "showMediaPreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "restrictPosting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "restrictCommenting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "collapseDeletedComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "defaultSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "disableContribRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "freeFormReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "excludeBannedModqueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "ocTagEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allOC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))))

data RelInfoOpts

Options for Listings of RelInfo. Currently only takes a single field, user, to limit the listing to a single user

Constructors

RelInfoOpts (Maybe Username)

Instances

Eq RelInfoOpts

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RelInfoOpts -> RelInfoOpts -> Bool

(/=) :: RelInfoOpts -> RelInfoOpts -> Bool

Show RelInfoOpts

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RelInfoOpts -> ShowS

show :: RelInfoOpts -> String

showList :: [RelInfoOpts] -> ShowS

Generic RelInfoOpts

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RelInfoOpts :: Type -> Type

Methods

from :: RelInfoOpts -> Rep RelInfoOpts x

to :: Rep RelInfoOpts x -> RelInfoOpts

ToForm RelInfoOpts

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: RelInfoOpts -> Form

type Rep RelInfoOpts

Defined in Network.Reddit.Types.Moderation

type Rep RelInfoOpts = D1 ('MetaData "RelInfoOpts" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "RelInfoOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Username))))

data MuteInfo

Information about a muted user

Constructors

MuteInfo UserID MuteID Username UTCTime

Instances

Eq MuteInfo

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: MuteInfo -> MuteInfo -> Bool

(/=) :: MuteInfo -> MuteInfo -> Bool

Show MuteInfo

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> MuteInfo -> ShowS

show :: MuteInfo -> String

showList :: [MuteInfo] -> ShowS

Generic MuteInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep MuteInfo :: Type -> Type

Methods

from :: MuteInfo -> Rep MuteInfo x

to :: Rep MuteInfo x -> MuteInfo

FromJSON MuteInfo

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser MuteInfo

parseJSONList :: Value -> Parser [MuteInfo]

Paginable MuteInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions MuteInfo

type PaginateThing MuteInfo

Methods

defaultOpts :: PaginateOptions MuteInfo

getFullname :: MuteInfo -> PaginateThing MuteInfo

optsToForm :: PaginateOptions MuteInfo -> Form

type Rep MuteInfo

Defined in Network.Reddit.Types.Moderation

type Rep MuteInfo = D1 ('MetaData "MuteInfo" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "MuteInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :*: S1 ('MetaSel ('Just "muteID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MuteID)) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))))

type PaginateOptions MuteInfo

Defined in Network.Reddit.Types.Moderation

type PaginateOptions MuteInfo = RelInfoOpts

type PaginateThing MuteInfo

Defined in Network.Reddit.Types.Moderation

type PaginateThing MuteInfo = MuteID

data RelInfo

Information about a contributor on the subreddit

Constructors

RelInfo UserID RelID Username UTCTime

Instances

Eq RelInfo

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RelInfo -> RelInfo -> Bool

(/=) :: RelInfo -> RelInfo -> Bool

Show RelInfo

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RelInfo -> ShowS

show :: RelInfo -> String

showList :: [RelInfo] -> ShowS

Generic RelInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RelInfo :: Type -> Type

Methods

from :: RelInfo -> Rep RelInfo x

to :: Rep RelInfo x -> RelInfo

FromJSON RelInfo

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser RelInfo

parseJSONList :: Value -> Parser [RelInfo]

Paginable RelInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions RelInfo

type PaginateThing RelInfo

Methods

defaultOpts :: PaginateOptions RelInfo

getFullname :: RelInfo -> PaginateThing RelInfo

optsToForm :: PaginateOptions RelInfo -> Form

type Rep RelInfo

Defined in Network.Reddit.Types.Moderation

type Rep RelInfo = D1 ('MetaData "RelInfo" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "RelInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :*: S1 ('MetaSel ('Just "relID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelID)) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))))

type PaginateOptions RelInfo

Defined in Network.Reddit.Types.Moderation

type PaginateOptions RelInfo = RelInfoOpts

type PaginateThing RelInfo

Defined in Network.Reddit.Types.Moderation

type PaginateThing RelInfo = RelID

data ModAccount

Account information about a moderator, similar to a Account, but with less information

Constructors

ModAccount Username UserID RelID (Maybe FlairText) (Maybe CSSClass) UTCTime (Maybe [ModPermission])

Instances

Eq ModAccount

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModAccount -> ModAccount -> Bool

(/=) :: ModAccount -> ModAccount -> Bool

Show ModAccount

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModAccount -> ShowS

show :: ModAccount -> String

showList :: [ModAccount] -> ShowS

Generic ModAccount

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModAccount :: Type -> Type

Methods

from :: ModAccount -> Rep ModAccount x

to :: Rep ModAccount x -> ModAccount

FromJSON ModAccount

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModAccount

parseJSONList :: Value -> Parser [ModAccount]

type Rep ModAccount

Defined in Network.Reddit.Types.Moderation

type Rep ModAccount = D1 ('MetaData "ModAccount" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModAccount" 'PrefixI 'True) ((S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: (S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :*: S1 ('MetaSel ('Just "relID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelID))) :*: ((S1 ('MetaSel ('Just "flairText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText)) :*: S1 ('MetaSel ('Just "flairCSS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CSSClass))) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ModPermission]))))))

data ModInviteeList

A list containing users invited to moderate the subreddit. For some reason, the endpoints listing moderator invites do not use the same Listing mechanism that most other endpoints do

Constructors

ModInviteeList (Seq ModInvitee) Bool (Maybe UserID) (Maybe UserID)

Instances

Eq ModInviteeList

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModInviteeList -> ModInviteeList -> Bool

(/=) :: ModInviteeList -> ModInviteeList -> Bool

Show ModInviteeList

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModInviteeList -> ShowS

show :: ModInviteeList -> String

showList :: [ModInviteeList] -> ShowS

Generic ModInviteeList

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModInviteeList :: Type -> Type

Methods

from :: ModInviteeList -> Rep ModInviteeList x

to :: Rep ModInviteeList x -> ModInviteeList

FromJSON ModInviteeList

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModInviteeList

parseJSONList :: Value -> Parser [ModInviteeList]

ToForm ModInviteeList

This instance can be used to paginate through the listings, with a bias towards after

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: ModInviteeList -> Form

type Rep ModInviteeList

Defined in Network.Reddit.Types.Moderation

type Rep ModInviteeList = D1 ('MetaData "ModInviteeList" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModInviteeList" 'PrefixI 'True) ((S1 ('MetaSel ('Just "invited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ModInvitee)) :*: S1 ('MetaSel ('Just "allUsersLoaded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserID)) :*: S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserID)))))

data ModInvitee

Information about a user who has been invited to moderate the subreddit

Constructors

ModInvitee UserID Username (Maybe FlairText) (HashMap ModPermission Bool) UTCTime Integer

Instances

Eq ModInvitee

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModInvitee -> ModInvitee -> Bool

(/=) :: ModInvitee -> ModInvitee -> Bool

Show ModInvitee

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModInvitee -> ShowS

show :: ModInvitee -> String

showList :: [ModInvitee] -> ShowS

Generic ModInvitee

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModInvitee :: Type -> Type

Methods

from :: ModInvitee -> Rep ModInvitee x

to :: Rep ModInvitee x -> ModInvitee

FromJSON ModInvitee

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModInvitee

parseJSONList :: Value -> Parser [ModInvitee]

type Rep ModInvitee

Defined in Network.Reddit.Types.Moderation

type Rep ModInvitee = D1 ('MetaData "ModInvitee" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModInvitee" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "flairText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText)))) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap ModPermission Bool)) :*: (S1 ('MetaSel ('Just "moddedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "postKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))))

data SubredditRelationship

The types of relationships that mods can manipulate

Constructors

Mod

ModInvitation

Contributor

BannedFromWiki

WikiContributor

Banned

Muted

Instances

Eq SubredditRelationship

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: SubredditRelationship -> SubredditRelationship -> Bool

(/=) :: SubredditRelationship -> SubredditRelationship -> Bool

Show SubredditRelationship

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> SubredditRelationship -> ShowS

show :: SubredditRelationship -> String

showList :: [SubredditRelationship] -> ShowS

Generic SubredditRelationship

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep SubredditRelationship :: Type -> Type

Methods

from :: SubredditRelationship -> Rep SubredditRelationship x

to :: Rep SubredditRelationship x -> SubredditRelationship

ToHttpApiData SubredditRelationship

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: SubredditRelationship -> Text

toEncodedUrlPiece :: SubredditRelationship -> Builder

toHeader :: SubredditRelationship -> ByteString

toQueryParam :: SubredditRelationship -> Text

type Rep SubredditRelationship

Defined in Network.Reddit.Types.Moderation

type Rep SubredditRelationship = D1 ('MetaData "SubredditRelationship" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "Mod" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModInvitation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Contributor" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "BannedFromWiki" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WikiContributor" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Banned" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Muted" 'PrefixI 'False) (U1 :: Type -> Type))))

data ModPermission

Various permissions that can be afforded to moderators and invitees

Constructors

Access

Flair

Mail

Configuration

ChatConfig

ChatOperator

Posts

Wiki

Instances

Bounded ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

minBound :: ModPermission

maxBound :: ModPermission

Enum ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

succ :: ModPermission -> ModPermission

pred :: ModPermission -> ModPermission

toEnum :: Int -> ModPermission

fromEnum :: ModPermission -> Int

enumFrom :: ModPermission -> [ModPermission]

enumFromThen :: ModPermission -> ModPermission -> [ModPermission]

enumFromTo :: ModPermission -> ModPermission -> [ModPermission]

enumFromThenTo :: ModPermission -> ModPermission -> ModPermission -> [ModPermission]

Eq ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModPermission -> ModPermission -> Bool

(/=) :: ModPermission -> ModPermission -> Bool

Ord ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

compare :: ModPermission -> ModPermission -> Ordering

(<) :: ModPermission -> ModPermission -> Bool

(<=) :: ModPermission -> ModPermission -> Bool

(>) :: ModPermission -> ModPermission -> Bool

(>=) :: ModPermission -> ModPermission -> Bool

max :: ModPermission -> ModPermission -> ModPermission

min :: ModPermission -> ModPermission -> ModPermission

Show ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModPermission -> ShowS

show :: ModPermission -> String

showList :: [ModPermission] -> ShowS

Generic ModPermission

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModPermission :: Type -> Type

Methods

from :: ModPermission -> Rep ModPermission x

to :: Rep ModPermission x -> ModPermission

Hashable ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

hashWithSalt :: Int -> ModPermission -> Int

hash :: ModPermission -> Int

FromJSON ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModPermission

parseJSONList :: Value -> Parser [ModPermission]

FromJSONKey ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

fromJSONKey :: FromJSONKeyFunction ModPermission

fromJSONKeyList :: FromJSONKeyFunction [ModPermission]

ToHttpApiData ModPermission

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: ModPermission -> Text

toEncodedUrlPiece :: ModPermission -> Builder

toHeader :: ModPermission -> ByteString

toQueryParam :: ModPermission -> Text

type Rep ModPermission

Defined in Network.Reddit.Types.Moderation

type Rep ModPermission = D1 ('MetaData "ModPermission" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (((C1 ('MetaCons "Access" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Flair" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Mail" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Configuration" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ChatConfig" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChatOperator" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Posts" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Wiki" 'PrefixI 'False) (U1 :: Type -> Type))))

data NewRemovalReasonID

Instances

Show NewRemovalReasonID

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> NewRemovalReasonID -> ShowS

show :: NewRemovalReasonID -> String

showList :: [NewRemovalReasonID] -> ShowS

Generic NewRemovalReasonID

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep NewRemovalReasonID :: Type -> Type

Methods

from :: NewRemovalReasonID -> Rep NewRemovalReasonID x

to :: Rep NewRemovalReasonID x -> NewRemovalReasonID

FromJSON NewRemovalReasonID

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser NewRemovalReasonID

parseJSONList :: Value -> Parser [NewRemovalReasonID]

type Rep NewRemovalReasonID

Defined in Network.Reddit.Types.Moderation

type Rep NewRemovalReasonID = D1 ('MetaData "NewRemovalReasonID" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "NewRemovalReasonID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemovalReasonID)))

type RemovalReasonID = Text

Identifier for a RemovalReason

data RemovalReason

A subreddit-specific reason for item removal

Constructors

RemovalReason RemovalReasonID Body Title

Instances

Eq RemovalReason

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RemovalReason -> RemovalReason -> Bool

(/=) :: RemovalReason -> RemovalReason -> Bool

Show RemovalReason

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RemovalReason -> ShowS

show :: RemovalReason -> String

showList :: [RemovalReason] -> ShowS

Generic RemovalReason

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RemovalReason :: Type -> Type

Methods

from :: RemovalReason -> Rep RemovalReason x

to :: Rep RemovalReason x -> RemovalReason

FromJSON RemovalReason

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser RemovalReason

parseJSONList :: Value -> Parser [RemovalReason]

ToForm RemovalReason

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: RemovalReason -> Form

type Rep RemovalReason

Defined in Network.Reddit.Types.Moderation

type Rep RemovalReason = D1 ('MetaData "RemovalReason" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "RemovalReason" 'PrefixI 'True) (S1 ('MetaSel ('Just "removalReasonID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemovalReasonID) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title))))

data RemovalType

Controls how the RemovalMessage will be disseminated

Constructors

PublicComment

Leaves the message as a public comment

PrivateExposed

Leaves moderator note with exposed username

PrivateHidden

Leaves mod note with hidden username

Instances

Eq RemovalType

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RemovalType -> RemovalType -> Bool

(/=) :: RemovalType -> RemovalType -> Bool

Show RemovalType

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RemovalType -> ShowS

show :: RemovalType -> String

showList :: [RemovalType] -> ShowS

Generic RemovalType

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RemovalType :: Type -> Type

Methods

from :: RemovalType -> Rep RemovalType x

to :: Rep RemovalType x -> RemovalType

ToHttpApiData RemovalType

Defined in Network.Reddit.Types.Moderation

Methods

toUrlPiece :: RemovalType -> Text

toEncodedUrlPiece :: RemovalType -> Builder

toHeader :: RemovalType -> ByteString

toQueryParam :: RemovalType -> Text

type Rep RemovalType

Defined in Network.Reddit.Types.Moderation

type Rep RemovalType = D1 ('MetaData "RemovalType" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "PublicComment" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PrivateExposed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PrivateHidden" 'PrefixI 'False) (U1 :: Type -> Type)))

data RemovalMessage

A message to explain/note the removal an Item

Constructors

RemovalMessage ItemID Body Title RemovalType

Instances

Eq RemovalMessage

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: RemovalMessage -> RemovalMessage -> Bool

(/=) :: RemovalMessage -> RemovalMessage -> Bool

Show RemovalMessage

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> RemovalMessage -> ShowS

show :: RemovalMessage -> String

showList :: [RemovalMessage] -> ShowS

Generic RemovalMessage

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep RemovalMessage :: Type -> Type

Methods

from :: RemovalMessage -> Rep RemovalMessage x

to :: Rep RemovalMessage x -> RemovalMessage

ToForm RemovalMessage

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: RemovalMessage -> Form

type Rep RemovalMessage

Defined in Network.Reddit.Types.Moderation

type Rep RemovalMessage = D1 ('MetaData "RemovalMessage" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "RemovalMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "itemID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ItemID) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :*: S1 ('MetaSel ('Just "removalType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemovalType))))

data ModItemOpts

Options for Listings of ModItems. Only contains one field, only to constrain the request to a single type (i.e. comments or links)

Constructors

ModItemOpts (Maybe ItemType)

Instances

Eq ModItemOpts

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModItemOpts -> ModItemOpts -> Bool

(/=) :: ModItemOpts -> ModItemOpts -> Bool

Show ModItemOpts

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModItemOpts -> ShowS

show :: ModItemOpts -> String

showList :: [ModItemOpts] -> ShowS

Generic ModItemOpts

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModItemOpts :: Type -> Type

Methods

from :: ModItemOpts -> Rep ModItemOpts x

to :: Rep ModItemOpts x -> ModItemOpts

ToForm ModItemOpts

Defined in Network.Reddit.Types.Moderation

Methods

toForm :: ModItemOpts -> Form

type Rep ModItemOpts

Defined in Network.Reddit.Types.Moderation

type Rep ModItemOpts = D1 ('MetaData "ModItemOpts" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModItemOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "only") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemType))))

newtype ModItem

An Item of interest to moderators (spam, modqueue, etc...)

Constructors

ModItem Item

Instances

Eq ModItem

Defined in Network.Reddit.Types.Moderation

Methods

(==) :: ModItem -> ModItem -> Bool

(/=) :: ModItem -> ModItem -> Bool

Show ModItem

Defined in Network.Reddit.Types.Moderation

Methods

showsPrec :: Int -> ModItem -> ShowS

show :: ModItem -> String

showList :: [ModItem] -> ShowS

Generic ModItem

Defined in Network.Reddit.Types.Moderation

Associated Types

type Rep ModItem :: Type -> Type

Methods

from :: ModItem -> Rep ModItem x

to :: Rep ModItem x -> ModItem

FromJSON ModItem

Defined in Network.Reddit.Types.Moderation

Methods

parseJSON :: Value -> Parser ModItem

parseJSONList :: Value -> Parser [ModItem]

Paginable ModItem

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions ModItem

type PaginateThing ModItem

Methods

defaultOpts :: PaginateOptions ModItem

getFullname :: ModItem -> PaginateThing ModItem

optsToForm :: PaginateOptions ModItem -> Form

type Rep ModItem

Defined in Network.Reddit.Types.Moderation

type Rep ModItem = D1 ('MetaData "ModItem" "Network.Reddit.Types.Moderation" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "ModItem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Item)))

type PaginateOptions ModItem

Defined in Network.Reddit.Types.Moderation

type PaginateOptions ModItem = ModItemOpts

type PaginateThing ModItem

Defined in Network.Reddit.Types.Moderation

type PaginateThing ModItem = ItemID

defaultModmailOpts :: ModmailOpts

Default options for filtering modmail

mkModmailReply :: Body -> ModmailReply

ModmailReply with default values for boolean fields