Class LemmyHttp

Helps build lemmy HTTP requests.

Index

Constructors

Properties

#apiUrl #fetchFunction #headers #pictrsUrl

Methods

#buildFullUrl #wrapper addAdmin addModToCommunity approveRegistrationApplication banFromCommunity banPerson blockCommunity blockInstance blockPerson changePassword createComment createCommentReport createCommunity createCustomEmoji createPost createPostReport createPrivateMessage createPrivateMessageReport createSite deleteAccount deleteComment deleteCommunity deleteCustomEmoji deleteImage deletePost deletePrivateMessage distinguishComment donation_dialog_shown editComment editCommunity editCustomEmoji editPost editPrivateMessage editSite exportSettings featurePost followCommunity generateTotpSecret getBannedPersons getCaptcha getComment getComments getCommunity getFederatedInstances getModlog getPersonDetails getPersonMentions getPost getPosts getPrivateMessages getRegistrationApplication getReplies getReportCount getSite getSiteMetadata getUnreadCount getUnreadRegistrationApplicationCount hideCommunity hidePost importSettings leaveAdmin likeComment likePost listAllMedia listCommentLikes listCommentReports listCommunities listLogins listMedia listPostLikes listPostReports listPrivateMessageReports listRegistrationApplications lockPost login logout markAllAsRead markCommentReplyAsRead markPersonMentionAsRead markPostAsRead markPrivateMessageAsRead passwordChangeAfterReset passwordReset purgeComment purgeCommunity purgePerson purgePost register removeComment removeCommunity removePost resolveCommentReport resolveObject resolvePostReport resolvePrivateMessageReport saveComment savePost saveUserSettings search setHeaders transferCommunity updateTotp uploadImage validateAuth verifyEmail

Constructors

constructor

new LemmyHttp(baseUrl, options?): LemmyHttp
Generates a new instance of LemmyHttp.
Parameters
- baseUrl: string
  the base url, without the vX version: https://lemmy.ml -> goes to https://lemmy.ml/api/vX
- Optional options: {
      fetchFunction?: {
          (input, init?): Promise<Response>;
          (input, init?): Promise<Response>;
      };
      headers?: {
          [key: string]: string;
      };
  }
  - Optional fetchFunction?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
    }
    - (input, init?): Promise<Response>
      MDN Reference
      
      Parameters
      input: RequestInfo | URL
      Optional init: RequestInit
      Returns Promise<Response>
      (input, init?): Promise<Response>
      Parameters
      input: string | Request | URL
      Optional init: RequestInit
      Returns Promise<Response>
  - Optional headers?: {
    [key: string]: string;
    }
    - [key: string]: string
Returns LemmyHttp
- Defined in src/http.ts:166

Properties

`Private` #apiUrl

#apiUrl: string

`Private` #fetchFunction

#fetchFunction: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
} = ...

Type declaration

- (input, init?): Promise<Response>
- MDN Reference
  Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>
- (input, init?): Promise<Response>
- Parameters
  - input: string | Request | URL
  - Optional init: RequestInit
  Returns Promise<Response>

`Private` #headers

#headers: {
[key: string]: string;
} = {}

Type declaration

[key: string]: string

`Private` #pictrsUrl

#pictrsUrl: string

Methods

`Private` #buildFullUrl

#buildFullUrl(endpoint): string
Parameters
- endpoint: string
Returns string
- Defined in src/http.ts:1679

`Private` #wrapper

#wrapper<BodyType, ResponseType>(type_, endpoint, form, options): Promise<ResponseType>
Type Parameters
- BodyType extends object
- ResponseType
Parameters
- type_: HttpType
- endpoint: string
- form: BodyType
- options: undefined | RequestOptions
Returns Promise<ResponseType>
- Defined in src/http.ts:1683

addAdmin

addAdmin(form, options?): Promise<AddAdminResponse>
Add an admin to your site.

HTTP.POST /admin/add
Parameters
- form: AddAdmin
- Optional options: RequestOptions
Returns Promise<AddAdminResponse>
- Defined in src/http.ts:1415

addModToCommunity

addModToCommunity(form, options?): Promise<AddModToCommunityResponse>
Add a moderator to your community.

HTTP.POST /community/mod
Parameters
- form: AddModToCommunity
- Optional options: RequestOptions
Returns Promise<AddModToCommunityResponse>
- Defined in src/http.ts:560

approveRegistrationApplication

approveRegistrationApplication(form, options?): Promise<RegistrationApplicationResponse>
Approve a registration application

HTTP.PUT /admin/registration_application/approve
Parameters
- form: ApproveRegistrationApplication
- Optional options: RequestOptions
Returns Promise<RegistrationApplicationResponse>
- Defined in src/http.ts:1458

banFromCommunity

banFromCommunity(form, options?): Promise<BanFromCommunityResponse>
Ban a user from a community.

HTTP.POST /community/ban_user
Parameters
- form: BanFromCommunity
- Optional options: RequestOptions
Returns Promise<BanFromCommunityResponse>
- Defined in src/http.ts:546

banPerson

banPerson(form, options?): Promise<BanPersonResponse>
Ban a person from your site.

HTTP.POST /user/ban
Parameters
- form: BanPerson
- Optional options: RequestOptions
Returns Promise<BanPersonResponse>
- Defined in src/http.ts:1230

blockCommunity

blockCommunity(form, options?): Promise<BlockCommunityResponse>
Block a community.

HTTP.POST /community/block
Parameters
- form: BlockCommunity
- Optional options: RequestOptions
Returns Promise<BlockCommunityResponse>
- Defined in src/http.ts:476

blockInstance

blockInstance(form, options?): Promise<BlockInstanceResponse>
Block an instance.

HTTP.Post /site/block
Parameters
- form: BlockInstance
- Optional options: RequestOptions
Returns Promise<BlockInstanceResponse>
- Defined in src/http.ts:1600

blockPerson

blockPerson(form, options?): Promise<BlockPersonResponse>
Block a person.

HTTP.POST /user/block
Parameters
- form: BlockPerson
- Optional options: RequestOptions
Returns Promise<BlockPersonResponse>
- Defined in src/http.ts:1258

changePassword

changePassword(form, options?): Promise<LoginResponse>
Change your user password.

HTTP.PUT /user/change_password
Parameters
- form: ChangePassword
- Optional options: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1359

createComment

createComment(form, options?): Promise<CommentResponse>
Create a comment.

HTTP.POST /comment
Parameters
- form: CreateComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:812

createCommentReport

createCommentReport(form, options?): Promise<CommentReportResponse>
Report a comment.

HTTP.POST /comment/report
Parameters
- form: CreateCommentReport
- Optional options: RequestOptions
Returns Promise<CommentReportResponse>
- Defined in src/http.ts:969

createCommunity

createCommunity(form, options?): Promise<CommunityResponse>
Create a new community.

HTTP.POST /community
Parameters
- form: CreateCommunity
- Optional options: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:406

createCustomEmoji

createCustomEmoji(form, options?): Promise<CustomEmojiResponse>
Create a new custom emoji

HTTP.POST /custom_emoji
Parameters
- form: CreateCustomEmoji
- Optional options: RequestOptions
Returns Promise<CustomEmojiResponse>
- Defined in src/http.ts:1544

createPost

createPost(form, options?): Promise<PostResponse>
Create a post.

HTTP.POST /post
Parameters
- form: CreatePost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:574

createPostReport

createPostReport(form, options?): Promise<PostReportResponse>
Report a post.

HTTP.POST /post/report
Parameters
- form: CreatePostReport
- Optional options: RequestOptions
Returns Promise<PostReportResponse>
- Defined in src/http.ts:756

createPrivateMessage

createPrivateMessage(form, options?): Promise<PrivateMessageResponse>
Create a private message.

HTTP.POST /private_message
Parameters
- form: CreatePrivateMessage
- Optional options: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1025

createPrivateMessageReport

createPrivateMessageReport(form, options?): Promise<PrivateMessageReportResponse>
Create a report for a private message.

HTTP.POST /private_message/report
Parameters
- form: CreatePrivateMessageReport
- Optional options: RequestOptions
Returns Promise<PrivateMessageReportResponse>
- Defined in src/http.ts:1084

createSite

createSite(form, options?): Promise<SiteResponse>
Create your site.

HTTP.POST /site
Parameters
- form: CreateSite
- Optional options: RequestOptions
Returns Promise<SiteResponse>
- Defined in src/http.ts:203

deleteAccount

deleteAccount(form, options?): Promise<SuccessResponse>
Delete your account.

HTTP.POST /user/delete_account
Parameters
- form: DeleteAccount
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1286

deleteComment

deleteComment(form, options?): Promise<CommentResponse>
Delete a comment.

HTTP.POST /comment/delete
Parameters
- form: DeleteComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:840

deleteCommunity

deleteCommunity(form, options?): Promise<CommunityResponse>
Delete a community.

HTTP.POST /community/delete
Parameters
- form: DeleteCommunity
- Optional options: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:490

deleteCustomEmoji

deleteCustomEmoji(form, options?): Promise<SuccessResponse>
Delete a custom emoji

HTTP.Post /custom_emoji/delete
Parameters
- form: DeleteCustomEmoji
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1572

deleteImage

deleteImage(__namedParameters, options?): Promise<boolean>
Delete a pictrs image
Parameters
- __namedParameters: DeleteImage
- Optional options: RequestOptions
Returns Promise<boolean>
- Defined in src/http.ts:1650

deletePost

deletePost(form, options?): Promise<PostResponse>
Delete a post.

HTTP.POST /post/delete
Parameters
- form: DeletePost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:616

deletePrivateMessage

deletePrivateMessage(form, options?): Promise<PrivateMessageResponse>
Delete a private message.

HTTP.POST /private_message/delete
Parameters
- form: DeletePrivateMessage
- Optional options: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1053

distinguishComment

distinguishComment(form, options?): Promise<CommentResponse>
Distinguishes a comment (speak as moderator)

HTTP.POST /comment/distinguish
Parameters
- form: DistinguishComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:927

donation_dialog_shown

donation_dialog_shown(options?): Promise<SuccessResponse>
Mark donation dialog as shown, so it isn't displayed anymore.

HTTP.POST /user/donation_dialog_shown
Parameters
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1670

editComment

editComment(form, options?): Promise<CommentResponse>
Edit a comment.

HTTP.PUT /comment
Parameters
- form: EditComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:826

editCommunity

editCommunity(form, options?): Promise<CommunityResponse>
Edit a community.

HTTP.PUT /community
Parameters
- form: EditCommunity
- Optional options: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:434

editCustomEmoji

editCustomEmoji(form, options?): Promise<CustomEmojiResponse>
Edit an existing custom emoji

HTTP.PUT /custom_emoji
Parameters
- form: EditCustomEmoji
- Optional options: RequestOptions
Returns Promise<CustomEmojiResponse>
- Defined in src/http.ts:1558

editPost

editPost(form, options?): Promise<PostResponse>
Edit a post.

HTTP.PUT /post
Parameters
- form: EditPost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:602

editPrivateMessage

editPrivateMessage(form, options?): Promise<PrivateMessageResponse>
Edit a private message.

HTTP.PUT /private_message
Parameters
- form: EditPrivateMessage
- Optional options: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1039

editSite

editSite(form, options?): Promise<SiteResponse>
Edit your site.

HTTP.PUT /site
Parameters
- form: EditSite
- Optional options: RequestOptions
Returns Promise<SiteResponse>
- Defined in src/http.ts:217

exportSettings

exportSettings(options?): Promise<string>
Export a backup of your user settings, including your saved content, followed communities, and blocks.

HTTP.GET /user/export_settings
Parameters
- Optional options: RequestOptions
Returns Promise<string>
- Defined in src/http.ts:262

featurePost

featurePost(form, options?): Promise<PostResponse>
A moderator can feature a community post ( IE stick it to the top of a community ).

HTTP.POST /post/feature
Parameters
- form: FeaturePost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:686

followCommunity

followCommunity(form, options?): Promise<CommunityResponse>
Follow / subscribe to a community.

HTTP.POST /community/follow
Parameters
- form: FollowCommunity
- Optional options: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:462

generateTotpSecret

generateTotpSecret(options?): Promise<GenerateTotpSecretResponse>
Generate a TOTP / two-factor secret.

Afterwards you need to call /user/totp/update with a valid token to enable it.

HTTP.POST /user/totp/generate
Parameters
- Optional options: RequestOptions
Returns Promise<GenerateTotpSecretResponse>
- Defined in src/http.ts:247

getBannedPersons

getBannedPersons(options?): Promise<BannedPersonsResponse>
Get a list of banned users

HTTP.GET /user/banned
Parameters
- Optional options: RequestOptions
Returns Promise<BannedPersonsResponse>
- Defined in src/http.ts:1244

getCaptcha

getCaptcha(options?): Promise<GetCaptchaResponse>
Fetch a Captcha.

HTTP.GET /user/get_captcha
Parameters
- Optional options: RequestOptions
Returns Promise<GetCaptchaResponse>
- Defined in src/http.ts:1272

getComment

getComment(form, options?): Promise<CommentResponse>
Get / fetch comment.

HTTP.GET /comment
Parameters
- form: GetComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:955

getComments

getComments(form?, options?): Promise<GetCommentsResponse>
Get / fetch comments.

HTTP.GET /comment/list
Parameters
- form: GetComments = {}
- Optional options: RequestOptions
Returns Promise<GetCommentsResponse>
- Defined in src/http.ts:941

getCommunity

getCommunity(form?, options?): Promise<GetCommunityResponse>
Get / fetch a community.

HTTP.GET /community
Parameters
- form: GetCommunity = {}
- Optional options: RequestOptions
Returns Promise<GetCommunityResponse>
- Defined in src/http.ts:420

getFederatedInstances

getFederatedInstances(options?): Promise<GetFederatedInstancesResponse>
Fetch federated instances.

HTTP.Get /federated_instances
Parameters
- Optional options: RequestOptions
Returns Promise<GetFederatedInstancesResponse>
- Defined in src/http.ts:1586

getModlog

getModlog(form?, options?): Promise<GetModlogResponse>
Get the modlog.

HTTP.GET /modlog
Parameters
- form: GetModlog = {}
- Optional options: RequestOptions
Returns Promise<GetModlogResponse>
- Defined in src/http.ts:364

getPersonDetails

getPersonDetails(form?, options?): Promise<GetPersonDetailsResponse>
Get the details for a person.

HTTP.GET /user
Parameters
- form: GetPersonDetails = {}
- Optional options: RequestOptions
Returns Promise<GetPersonDetailsResponse>
- Defined in src/http.ts:1171

getPersonMentions

getPersonMentions(form, options?): Promise<GetPersonMentionsResponse>
Get mentions for your user.

HTTP.GET /user/mention
Parameters
- form: GetPersonMentions
- Optional options: RequestOptions
Returns Promise<GetPersonMentionsResponse>
- Defined in src/http.ts:1185

getPost

getPost(form?, options?): Promise<GetPostResponse>
Get / fetch a post.

HTTP.GET /post
Parameters
- form: GetPost = {}
- Optional options: RequestOptions
Returns Promise<GetPostResponse>
- Defined in src/http.ts:588

getPosts

getPosts(form?, options?): Promise<GetPostsResponse>
Get / fetch posts, with various filters.

HTTP.GET /post/list
Parameters
- form: GetPosts = {}
- Optional options: RequestOptions
Returns Promise<GetPostsResponse>
- Defined in src/http.ts:700

getPrivateMessages

getPrivateMessages(form, options?): Promise<PrivateMessagesResponse>
Get / fetch private messages.

HTTP.GET /private_message/list
Parameters
- form: GetPrivateMessages
- Optional options: RequestOptions
Returns Promise<PrivateMessagesResponse>
- Defined in src/http.ts:1011

getRegistrationApplication

getRegistrationApplication(form, options?): Promise<RegistrationApplicationResponse>
Get the application a user submitted when they first registered their account

HTTP.GET /admin/registration_application
Parameters
- form: GetRegistrationApplication
- Optional options: RequestOptions
Returns Promise<RegistrationApplicationResponse>
- Defined in src/http.ts:1473

getReplies

getReplies(form, options?): Promise<GetRepliesResponse>
Get comment replies.

HTTP.GET /user/replies
Parameters
- form: GetReplies
- Optional options: RequestOptions
Returns Promise<GetRepliesResponse>
- Defined in src/http.ts:1216

getReportCount

getReportCount(form, options?): Promise<GetReportCountResponse>
Get counts for your reports

HTTP.GET /user/report_count
Parameters
- form: GetReportCount
- Optional options: RequestOptions
Returns Promise<GetReportCountResponse>
- Defined in src/http.ts:1373

getSite

getSite(options?): Promise<GetSiteResponse>
Gets the site, and your user data.

HTTP.GET /site
Parameters
- Optional options: RequestOptions
Returns Promise<GetSiteResponse>
- Defined in src/http.ts:189

getSiteMetadata

getSiteMetadata(form, options?): Promise<GetSiteMetadataResponse>
Fetch metadata for any given site.

HTTP.GET /post/site_metadata
Parameters
- form: GetSiteMetadata
- Optional options: RequestOptions
Returns Promise<GetSiteMetadataResponse>
- Defined in src/http.ts:798

getUnreadCount

getUnreadCount(options?): Promise<GetUnreadCountResponse>
Get your unread counts

HTTP.GET /user/unread_count
Parameters
- Optional options: RequestOptions
Returns Promise<GetUnreadCountResponse>
- Defined in src/http.ts:1387

getUnreadRegistrationApplicationCount

getUnreadRegistrationApplicationCount(options?): Promise<GetUnreadRegistrationApplicationCountResponse>
Get the unread registration applications count.

HTTP.GET /admin/registration_application/count
Parameters
- Optional options: RequestOptions
Returns Promise<GetUnreadRegistrationApplicationCountResponse>
- Defined in src/http.ts:1429

hideCommunity

hideCommunity(form, options?): Promise<SuccessResponse>
Hide a community from public / "All" view. Admins only.

HTTP.PUT /community/hide
Parameters
- form: HideCommunity
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:504

hidePost

hidePost(form, options?): Promise<SuccessResponse>
Hide a post from list views.

HTTP.POST /post/hide
Parameters
- form: HidePost
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:658

importSettings

importSettings(form, options?): Promise<SuccessResponse>
Import a backup of your user settings.

HTTP.POST /user/import_settings
Parameters
- form: any
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:276

leaveAdmin

leaveAdmin(options?): Promise<GetSiteResponse>
Leave the Site admins.

HTTP.POST /user/leave_admin
Parameters
- Optional options: RequestOptions
Returns Promise<GetSiteResponse>
- Defined in src/http.ts:231

likeComment

likeComment(form, options?): Promise<CommentResponse>
Like / vote on a comment.

HTTP.POST /comment/like
Parameters
- form: CreateCommentLike
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:885

likePost

likePost(form, options?): Promise<PostResponse>
Like / vote on a post.

HTTP.POST /post/like
Parameters
- form: CreatePostLike
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:714

listAllMedia

listAllMedia(form?, options?): Promise<ListMediaResponse>
List all the media known to your instance.

HTTP.GET /admin/list_all_media
Parameters
- form: ListMedia = {}
- Optional options: RequestOptions
Returns Promise<ListMediaResponse>
- Defined in src/http.ts:332

listCommentLikes

listCommentLikes(form, options?): Promise<ListCommentLikesResponse>
List a comment's likes. Admin-only.

HTTP.GET /comment/like/list
Parameters
- form: ListCommentLikes
- Optional options: RequestOptions
Returns Promise<ListCommentLikesResponse>
- Defined in src/http.ts:899

listCommentReports

listCommentReports(form, options?): Promise<ListCommentReportsResponse>
List comment reports.

HTTP.GET /comment/report/list
Parameters
- form: ListCommentReports
- Optional options: RequestOptions
Returns Promise<ListCommentReportsResponse>
- Defined in src/http.ts:997

listCommunities

listCommunities(form?, options?): Promise<ListCommunitiesResponse>
List communities, with various filters.

HTTP.GET /community/list
Parameters
- form: ListCommunities = {}
- Optional options: RequestOptions
Returns Promise<ListCommunitiesResponse>
- Defined in src/http.ts:448

listLogins

listLogins(options?): Promise<LoginToken[]>
List login tokens for your user

HTTP.GET /user/list_logins
Parameters
- Optional options: RequestOptions
Returns Promise<LoginToken[]>
- Defined in src/http.ts:290

listMedia

listMedia(form?, options?): Promise<ListMediaResponse>
List all the media for your user

HTTP.GET /account/list_media
Parameters
- form: ListMedia = {}
- Optional options: RequestOptions
Returns Promise<ListMediaResponse>
- Defined in src/http.ts:318

listPostLikes

listPostLikes(form, options?): Promise<ListPostLikesResponse>
List a post's likes. Admin-only.

HTTP.GET /post/like/list
Parameters
- form: ListPostLikes
- Optional options: RequestOptions
Returns Promise<ListPostLikesResponse>
- Defined in src/http.ts:728

listPostReports

listPostReports(form, options?): Promise<ListPostReportsResponse>
List post reports.

HTTP.GET /post/report/list
Parameters
- form: ListPostReports
- Optional options: RequestOptions
Returns Promise<ListPostReportsResponse>
- Defined in src/http.ts:784

listPrivateMessageReports

listPrivateMessageReports(form, options?): Promise<ListPrivateMessageReportsResponse>
List private message reports.

HTTP.GET /private_message/report/list
Parameters
- form: ListPrivateMessageReports
- Optional options: RequestOptions
Returns Promise<ListPrivateMessageReportsResponse>
- Defined in src/http.ts:1114

listRegistrationApplications

listRegistrationApplications(form, options?): Promise<ListRegistrationApplicationsResponse>
List the registration applications.

HTTP.GET /admin/registration_application/list
Parameters
- form: ListRegistrationApplications
- Optional options: RequestOptions
Returns Promise<ListRegistrationApplicationsResponse>
- Defined in src/http.ts:1443

lockPost

lockPost(form, options?): Promise<PostResponse>
A moderator can lock a post ( IE disable new comments ).

HTTP.POST /post/lock
Parameters
- form: LockPost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:672

login

login(form, options?): Promise<LoginResponse>
Log into lemmy.

HTTP.POST /user/login
Parameters
- form: Login
- Optional options: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1143

logout

logout(options?): Promise<SuccessResponse>
Invalidate the currently used auth token.

HTTP.POST /user/logout
Parameters
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1157

markAllAsRead

markAllAsRead(options?): Promise<GetRepliesResponse>
Mark all replies as read.

HTTP.POST /user/mark_all_as_read
Parameters
- Optional options: RequestOptions
Returns Promise<GetRepliesResponse>
- Defined in src/http.ts:1331

markCommentReplyAsRead

markCommentReplyAsRead(form, options?): Promise<CommentReplyResponse>
Mark a comment as read.

HTTP.POST /comment/mark_as_read
Parameters
- form: MarkCommentReplyAsRead
- Optional options: RequestOptions
Returns Promise<CommentReplyResponse>
- Defined in src/http.ts:868

markPersonMentionAsRead

markPersonMentionAsRead(form, options?): Promise<PersonMentionResponse>
Mark a person mention as read.

HTTP.POST /user/mention/mark_as_read
Parameters
- form: MarkPersonMentionAsRead
- Optional options: RequestOptions
Returns Promise<PersonMentionResponse>
- Defined in src/http.ts:1199

markPostAsRead

markPostAsRead(form, options?): Promise<SuccessResponse>
Mark a post as read.

HTTP.POST /post/mark_as_read
Parameters
- form: MarkPostAsRead
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:644

markPrivateMessageAsRead

markPrivateMessageAsRead(form, options?): Promise<PrivateMessageResponse>
Mark a private message as read.

HTTP.POST /private_message/mark_as_read
Parameters
- form: MarkPrivateMessageAsRead
- Optional options: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1067

passwordChangeAfterReset

passwordChangeAfterReset(form, options?): Promise<SuccessResponse>
Change your password from an email / token based reset.

HTTP.POST /user/password_change
Parameters
- form: PasswordChangeAfterReset
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1314

passwordReset

passwordReset(form, options?): Promise<SuccessResponse>
Reset your password.

HTTP.POST /user/password_reset
Parameters
- form: PasswordReset
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1300

purgeComment

purgeComment(form, options?): Promise<SuccessResponse>
Purge / Delete a comment from the database.

HTTP.POST /admin/purge/comment
Parameters
- form: PurgeComment
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1530

purgeCommunity

purgeCommunity(form, options?): Promise<SuccessResponse>
Purge / Delete a community from the database.

HTTP.POST /admin/purge/community
Parameters
- form: PurgeCommunity
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1502

purgePerson

purgePerson(form, options?): Promise<SuccessResponse>
Purge / Delete a person from the database.

HTTP.POST /admin/purge/person
Parameters
- form: PurgePerson
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1488

purgePost

purgePost(form, options?): Promise<SuccessResponse>
Purge / Delete a post from the database.

HTTP.POST /admin/purge/post
Parameters
- form: PurgePost
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1516

register

register(form, options?): Promise<LoginResponse>
Register a new user.

HTTP.POST /user/register
Parameters
- form: Register
- Optional options: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1129

removeComment

removeComment(form, options?): Promise<CommentResponse>
A moderator remove for a comment.

HTTP.POST /comment/remove
Parameters
- form: RemoveComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:854

removeCommunity

removeCommunity(form, options?): Promise<CommunityResponse>
A moderator remove for a community.

HTTP.POST /community/remove
Parameters
- form: RemoveCommunity
- Optional options: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:518

removePost

removePost(form, options?): Promise<PostResponse>
A moderator remove for a post.

HTTP.POST /post/remove
Parameters
- form: RemovePost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:630

resolveCommentReport

resolveCommentReport(form, options?): Promise<CommentReportResponse>
Resolve a comment report. Only a mod can do this.

HTTP.PUT /comment/report/resolve
Parameters
- form: ResolveCommentReport
- Optional options: RequestOptions
Returns Promise<CommentReportResponse>
- Defined in src/http.ts:983

resolveObject

resolveObject(form, options?): Promise<ResolveObjectResponse>
Fetch a non-local / federated object.

HTTP.GET /resolve_object
Parameters
- form: ResolveObject
- Optional options: RequestOptions
Returns Promise<ResolveObjectResponse>
- Defined in src/http.ts:392

resolvePostReport

resolvePostReport(form, options?): Promise<PostReportResponse>
Resolve a post report. Only a mod can do this.

HTTP.PUT /post/report/resolve
Parameters
- form: ResolvePostReport
- Optional options: RequestOptions
Returns Promise<PostReportResponse>
- Defined in src/http.ts:770

resolvePrivateMessageReport

resolvePrivateMessageReport(form, options?): Promise<PrivateMessageReportResponse>
Resolve a report for a private message.

HTTP.PUT /private_message/report/resolve
Parameters
- form: ResolvePrivateMessageReport
- Optional options: RequestOptions
Returns Promise<PrivateMessageReportResponse>
- Defined in src/http.ts:1099

saveComment

saveComment(form, options?): Promise<CommentResponse>
Save a comment.

HTTP.PUT /comment/save
Parameters
- form: SaveComment
- Optional options: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:913

savePost

savePost(form, options?): Promise<PostResponse>
Save a post.

HTTP.PUT /post/save
Parameters
- form: SavePost
- Optional options: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:742

saveUserSettings

saveUserSettings(form, options?): Promise<SuccessResponse>
Save your user settings.

HTTP.PUT /user/save_user_settings
Parameters
- form: SaveUserSettings
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1345

search

search(form, options?): Promise<SearchResponse>
Search lemmy.

HTTP.GET /search
Parameters
- form: Search
- Optional options: RequestOptions
Returns Promise<SearchResponse>
- Defined in src/http.ts:378

setHeaders

setHeaders(headers): void
Set the headers (can be used to set the auth header)
Parameters
- headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns void
- Defined in src/http.ts:1732

transferCommunity

transferCommunity(form, options?): Promise<GetCommunityResponse>
Transfer your community to an existing moderator.

HTTP.POST /community/transfer
Parameters
- form: TransferCommunity
- Optional options: RequestOptions
Returns Promise<GetCommunityResponse>
- Defined in src/http.ts:532

updateTotp

updateTotp(form, options?): Promise<UpdateTotpResponse>
Enable / Disable TOTP / two-factor authentication.

To enable, you need to first call /user/totp/generate and then pass a valid token to this.

Disabling is only possible if 2FA was previously enabled. Again it is necessary to pass a valid token.

HTTP.POST /user/totp/update
Parameters
- form: UpdateTotp
- Optional options: RequestOptions
Returns Promise<UpdateTotpResponse>
- Defined in src/http.ts:350

uploadImage

uploadImage(__namedParameters, options?): Promise<UploadImageResponse>
Upload an image to the server.
Parameters
- __namedParameters: UploadImage
- Optional options: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:1612

validateAuth

validateAuth(options?): Promise<SuccessResponse>
Returns an error message if your auth token is invalid

HTTP.GET /user/validate_auth
Parameters
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:304

verifyEmail

verifyEmail(form, options?): Promise<SuccessResponse>
Verify your email

HTTP.POST /user/verify_email
Parameters
- form: VerifyEmail
- Optional options: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1401

Class LemmyHttp

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional fetchFunction?: { (input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Optional headers?: { [key: string]: string; }

[key: string]: string

Returns LemmyHttp

Properties

Private #apiUrl

Private #fetchFunction

Type declaration

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Private #headers

Type declaration

[key: string]: string

Private #pictrsUrl

Methods

Private #buildFullUrl

Parameters

Returns string

Private #wrapper

Type Parameters

Parameters

Returns Promise<ResponseType>

addAdmin

Parameters

Returns Promise<AddAdminResponse>

addModToCommunity

Parameters

Returns Promise<AddModToCommunityResponse>

approveRegistrationApplication

Parameters

Returns Promise<RegistrationApplicationResponse>

banFromCommunity

Parameters

Returns Promise<BanFromCommunityResponse>

banPerson

Parameters

Returns Promise<BanPersonResponse>

blockCommunity

Parameters

Returns Promise<BlockCommunityResponse>

blockInstance

Parameters

Returns Promise<BlockInstanceResponse>

blockPerson

Parameters

Returns Promise<BlockPersonResponse>

changePassword

Parameters

Returns Promise<LoginResponse>

createComment

Parameters

Returns Promise<CommentResponse>

createCommentReport

Parameters

Returns Promise<CommentReportResponse>

createCommunity

Parameters

Returns Promise<CommunityResponse>

createCustomEmoji

Parameters

Returns Promise<CustomEmojiResponse>

createPost

Parameters

Returns Promise<PostResponse>

createPostReport

Parameters

`Optional` fetchFunction?: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
}

`Optional` headers?: {
[key: string]: string;
}

`Private` #apiUrl

`Private` #fetchFunction

`Private` #headers

`Private` #pictrsUrl

`Private` #buildFullUrl

`Private` #wrapper