Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LemmyWebsocket

Helps build lemmy websocket message requests, that you can use in your Websocket sends.

You'll receive back a WebSocketResponse.

The return types for these are given in LemmyHttp

Hierarchy

  • LemmyWebsocket

Index

Constructors

constructor

Methods

addAdmin

addModToCommunity

approveRegistrationApplication

banFromCommunity

banPerson

blockCommunity

blockPerson

changePassword

communityJoin

  • A websocket join for a given community.

    Allows your user to receive community updates.

    Note: community_id: 0, is your front page.

    Parameters

    Returns string

createComment

createCommentReport

createCommunity

createPost

createPostReport

createPrivateMessage

createSite

deleteAccount

deleteComment

deleteCommunity

deletePost

deletePrivateMessage

editComment

editCommunity

editPost

editPrivateMessage

editSite

followCommunity

getBannedPersons

getCaptcha

  • getCaptcha(): string

getComments

getCommunity

getModlog

getPersonDetails

getPersonMentions

getPost

getPosts

getPrivateMessages

getReplies

getReportCount

getSite

getSiteConfig

getSiteMetadata

getUnreadCount

getUnreadRegistrationApplicationCount

leaveAdmin

likeComment

likePost

listCommentReports

listCommunities

listPostReports

listRegistrationApplications

lockPost

  • A moderator can lock a post ( IE disable new comments ).

    Parameters

    Returns string

login

  • login(form: Login): string

markAllAsRead

markCommentAsRead

markPersonMentionAsRead

markPostAsRead

markPrivateMessageAsRead

passwordChange

passwordReset

postJoin

  • A websocket join for the current post room.

    Allows your user to receive new comments and updates for that post.

    Parameters

    Returns string

register

removeComment

removeCommunity

removePost

resolveCommentReport

resolveObject

resolvePostReport

saveComment

savePost

saveSiteConfig

saveUserSettings

search

  • search(form: Search): string

stickyPost

  • A moderator can sticky a post ( IE stick it to the top of a community ).

    Parameters

    Returns string

transferCommunity

userJoin

  • A websocket join for your user.

    Allows your user to receive private messages and notifications.

    Parameters

    Returns string

verifyEmail

Generated using TypeDoc