Class LemmyHttp

Helps build lemmy HTTP requests.

Hierarchy

Controller
- LemmyHttp

Index

Constructors

Methods

addAdmin addModToCommunity adminAllowInstance adminBlockInstance approveCommunityPendingFollow approveRegistrationApplication authenticateWithOAuth banFromCommunity banPerson blockCommunity blockPerson changePassword createComment createCommentReport createCommunity createCommunityReport createCommunityTag createCustomEmoji createMultiCommunity createMultiCommunityEntry createOAuthProvider createPost createPostReport createPrivateMessage createPrivateMessageReport createSite createTagline deleteAccount deleteComment deleteCommunity deleteCommunityBanner deleteCommunityIcon deleteCommunityTag deleteCustomEmoji deleteMedia deleteMediaAdmin deleteMultiCommunityEntry deleteOAuthProvider deletePost deletePrivateMessage deleteSiteBanner deleteSiteIcon deleteTagline deleteUserAvatar deleteUserBanner distinguishComment donationDialogShown editComment editCommunity editCustomEmoji editOAuthProvider editPost editPrivateMessage editSite editTagline exportSettings featurePost followCommunity followMultiCommunity generateTotpSecret getCaptcha getComment getComments getCommentsSlim getCommunity getCommunityPendingFollowsCount getFederatedInstances getHeader getHeaders getModlog getMultiCommunity getMyUser getPersonDetails getPost getPosts getRandomCommunity getRegistrationApplication getReportCount getSite getSiteMetadata getStatus getUnreadCount getUnreadRegistrationApplicationCount hideCommunity hidePost imageHealth importSettings leaveAdmin likeComment likePost listCommentLikes listCommunities listCommunityPendingFollows listCustomEmojis listLogins listMedia listMediaAdmin listMultiCommunities listNotifications listPersonContent listPersonHidden listPersonLiked listPersonRead listPersonSaved listPostLikes listRegistrationApplications listReports listTaglines listUsers lockPost login logout markAllNotificationsAsRead markManyPostAsRead markNotificationAsRead markPostAsRead markPrivateMessageAsRead modEditPost notePerson passwordChangeAfterReset passwordReset purgeComment purgeCommunity purgePerson purgePost register removeComment removeCommunity removePost resendVerificationEmail resolveCommentReport resolveCommunityReport resolveObject resolvePostReport resolvePrivateMessageReport saveComment savePost saveUserSettings search setHeader setHeaders setStatus transferCommunity updateCommunityNotifications updateCommunityTag updateMultiCommunity updatePostNotifications updateTotp uploadCommunityBanner uploadCommunityIcon uploadImage uploadSiteBanner uploadSiteIcon uploadUserAvatar uploadUserBanner userBlockInstanceCommunities userBlockInstancePersons validateAuth verifyEmail

Constructors

constructor

new LemmyHttp(
    baseUrl: string,
    options?: {
        fetchFunction?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        headers?: { [key: string]: string };
    },
): 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
- Optionaloptions: {
      fetchFunction?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      headers?: { [key: string]: string };
  }
  - OptionalfetchFunction?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalheaders?: { [key: string]: string }
Returns LemmyHttp
Overrides Controller.constructor
- Defined in src/http.ts:257

Methods

addAdmin

addAdmin(form: AddAdmin, options?: RequestOptions): Promise<AddAdminResponse>
Parameters
- form: AddAdmin
- Optionaloptions: RequestOptions
Returns Promise<AddAdminResponse>
- Defined in src/http.ts:2012

addModToCommunity

addModToCommunity(
form: AddModToCommunity,
options?: RequestOptions,
): Promise<AddModToCommunityResponse>
Parameters
- form: AddModToCommunity
- Optionaloptions: RequestOptions
Returns Promise<AddModToCommunityResponse>
- Defined in src/http.ts:840

adminAllowInstance

adminAllowInstance(
form: AdminAllowInstanceParams,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: AdminAllowInstanceParams
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2519

adminBlockInstance

adminBlockInstance(
form: AdminBlockInstanceParams,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: AdminBlockInstanceParams
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2501

approveCommunityPendingFollow

approveCommunityPendingFollow(
form: ApproveCommunityPendingFollower,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: ApproveCommunityPendingFollower
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:714

approveRegistrationApplication

approveRegistrationApplication(
form: ApproveRegistrationApplication,
options?: RequestOptions,
): Promise<RegistrationApplicationResponse>
Parameters
- form: ApproveRegistrationApplication
- Optionaloptions: RequestOptions
Returns Promise<RegistrationApplicationResponse>
- Defined in src/http.ts:2060

authenticateWithOAuth

authenticateWithOAuth(
form: AuthenticateWithOauth,
options?: RequestOptions,
): Promise<LoginResponse>
Parameters
- form: AuthenticateWithOauth
- Optionaloptions: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:2415

banFromCommunity

banFromCommunity(
form: BanFromCommunity,
options?: RequestOptions,
): Promise<BanFromCommunityResponse>
Parameters
- form: BanFromCommunity
- Optionaloptions: RequestOptions
Returns Promise<BanFromCommunityResponse>
- Defined in src/http.ts:822

banPerson

banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>
Parameters
- form: BanPerson
- Optionaloptions: RequestOptions
Returns Promise<BanPersonResponse>
- Defined in src/http.ts:1667

blockCommunity

blockCommunity(
form: BlockCommunity,
options?: RequestOptions,
): Promise<BlockCommunityResponse>
Parameters
- form: BlockCommunity
- Optionaloptions: RequestOptions
Returns Promise<BlockCommunityResponse>
- Defined in src/http.ts:732

blockPerson

blockPerson(
form: BlockPerson,
options?: RequestOptions,
): Promise<BlockPersonResponse>
Parameters
- form: BlockPerson
- Optionaloptions: RequestOptions
Returns Promise<BlockPersonResponse>
- Defined in src/http.ts:1700

changePassword

changePassword(
form: ChangePassword,
options?: RequestOptions,
): Promise<LoginResponse>
Parameters
- form: ChangePassword
- Optionaloptions: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1837

createComment

createComment(
form: CreateComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: CreateComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1227

createCommentReport

createCommentReport(
form: CreateCommentReport,
options?: RequestOptions,
): Promise<CommentReportResponse>
Parameters
- form: CreateCommentReport
- Optionaloptions: RequestOptions
Returns Promise<CommentReportResponse>
- Defined in src/http.ts:1428

createCommunity

createCommunity(
form: CreateCommunity,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: CreateCommunity
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:590

createCommunityReport

createCommunityReport(
form: CreateCommunityReport,
options?: RequestOptions,
): Promise<CommunityReportResponse>
Parameters
- form: CreateCommunityReport
- Optionaloptions: RequestOptions
Returns Promise<CommunityReportResponse>
- Defined in src/http.ts:877

createCommunityTag

createCommunityTag(
form: CreateCommunityTag,
options?: RequestOptions,
): Promise<Tag>
Parameters
- form: CreateCommunityTag
- Optionaloptions: RequestOptions
Returns Promise<Tag>
- Defined in src/http.ts:2307

createCustomEmoji

createCustomEmoji(
form: CreateCustomEmoji,
options?: RequestOptions,
): Promise<CustomEmojiResponse>
Parameters
- form: CreateCustomEmoji
- Optionaloptions: RequestOptions
Returns Promise<CustomEmojiResponse>
- Defined in src/http.ts:2161

createMultiCommunity

createMultiCommunity(
form: CreateMultiCommunity,
options?: RequestOptions,
): Promise<GetMultiCommunityResponse>
Parameters
- form: CreateMultiCommunity
- Optionaloptions: RequestOptions
Returns Promise<GetMultiCommunityResponse>
- Defined in src/http.ts:2758

createMultiCommunityEntry

createMultiCommunityEntry(
form: CreateOrDeleteMultiCommunityEntry,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: CreateOrDeleteMultiCommunityEntry
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2802

createOAuthProvider

createOAuthProvider(
form: CreateOAuthProvider,
options?: RequestOptions,
): Promise<OAuthProvider>
Parameters
- form: CreateOAuthProvider
- Optionaloptions: RequestOptions
Returns Promise<OAuthProvider>
- Defined in src/http.ts:2361

createPost

createPost(form: CreatePost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: CreatePost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:913

createPostReport

createPostReport(
form: CreatePostReport,
options?: RequestOptions,
): Promise<PostReportResponse>
Parameters
- form: CreatePostReport
- Optionaloptions: RequestOptions
Returns Promise<PostReportResponse>
- Defined in src/http.ts:1173

createPrivateMessage

createPrivateMessage(
form: CreatePrivateMessage,
options?: RequestOptions,
): Promise<PrivateMessageResponse>
Parameters
- form: CreatePrivateMessage
- Optionaloptions: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1464

createPrivateMessageReport

createPrivateMessageReport(
form: CreatePrivateMessageReport,
options?: RequestOptions,
): Promise<PrivateMessageReportResponse>
Parameters
- form: CreatePrivateMessageReport
- Optionaloptions: RequestOptions
Returns Promise<PrivateMessageReportResponse>
- Defined in src/http.ts:1536

createSite

createSite(form: CreateSite, options?: RequestOptions): Promise<SiteResponse>
Parameters
- form: CreateSite
- Optionaloptions: RequestOptions
Returns Promise<SiteResponse>
- Defined in src/http.ts:297

createTagline

createTagline(
form: CreateTagline,
options?: RequestOptions,
): Promise<TaglineResponse>
Parameters
- form: CreateTagline
- Optionaloptions: RequestOptions
Returns Promise<TaglineResponse>
- Defined in src/http.ts:2234

deleteAccount

deleteAccount(
form: DeleteAccount,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteAccount
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1732

deleteComment

deleteComment(
form: DeleteComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: DeleteComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1263

deleteCommunity

deleteCommunity(
form: DeleteCommunity,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: DeleteCommunity
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:750

deleteCommunityBanner

deleteCommunityBanner(
form: CommunityIdQuery,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: CommunityIdQuery
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2641

deleteCommunityIcon

deleteCommunityIcon(
form: CommunityIdQuery,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: CommunityIdQuery
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2609

deleteCommunityTag

deleteCommunityTag(
form: DeleteCommunityTag,
options?: RequestOptions,
): Promise<Tag>
Parameters
- form: DeleteCommunityTag
- Optionaloptions: RequestOptions
Returns Promise<Tag>
- Defined in src/http.ts:2343

deleteCustomEmoji

deleteCustomEmoji(
form: DeleteCustomEmoji,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteCustomEmoji
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2197

deleteMedia

deleteMedia(
form: DeleteImageParamsI,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteImageParamsI
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:459

deleteMediaAdmin

deleteMediaAdmin(
form: DeleteImageParamsI,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteImageParamsI
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:477

deleteMultiCommunityEntry

deleteMultiCommunityEntry(
form: CreateOrDeleteMultiCommunityEntry,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: CreateOrDeleteMultiCommunityEntry
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2817

deleteOAuthProvider

deleteOAuthProvider(
form: DeleteOAuthProvider,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteOAuthProvider
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2397

deletePost

deletePost(form: DeletePost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: DeletePost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:983

deletePrivateMessage

deletePrivateMessage(
form: DeletePrivateMessage,
options?: RequestOptions,
): Promise<PrivateMessageResponse>
Parameters
- form: DeletePrivateMessage
- Optionaloptions: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1500

deleteSiteBanner

deleteSiteBanner(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2702

deleteSiteIcon

deleteSiteIcon(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2672

deleteTagline

deleteTagline(
form: DeleteTagline,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: DeleteTagline
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2270

deleteUserAvatar

deleteUserAvatar(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2550

deleteUserBanner

deleteUserBanner(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2580

distinguishComment

distinguishComment(
form: DistinguishComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: DistinguishComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1353

donationDialogShown

donationDialogShown(options?: RequestOptions): Promise<SuccessResponse>
Mark donation dialog as shown, so it isn't displayed anymore.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2746

editComment

editComment(
form: EditComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: EditComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1245

editCommunity

editCommunity(
form: EditCommunity,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: EditCommunity
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:627

editCustomEmoji

editCustomEmoji(
form: EditCustomEmoji,
options?: RequestOptions,
): Promise<CustomEmojiResponse>
Parameters
- form: EditCustomEmoji
- Optionaloptions: RequestOptions
Returns Promise<CustomEmojiResponse>
- Defined in src/http.ts:2179

editOAuthProvider

editOAuthProvider(
form: EditOAuthProvider,
options?: RequestOptions,
): Promise<OAuthProvider>
Parameters
- form: EditOAuthProvider
- Optionaloptions: RequestOptions
Returns Promise<OAuthProvider>
- Defined in src/http.ts:2379

editPost

editPost(form: EditPost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: EditPost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:950

editPrivateMessage

editPrivateMessage(
form: EditPrivateMessage,
options?: RequestOptions,
): Promise<PrivateMessageResponse>
Parameters
- form: EditPrivateMessage
- Optionaloptions: RequestOptions
Returns Promise<PrivateMessageResponse>
- Defined in src/http.ts:1482

editSite

editSite(form: EditSite, options?: RequestOptions): Promise<SiteResponse>
Parameters
- form: EditSite
- Optionaloptions: RequestOptions
Returns Promise<SiteResponse>
- Defined in src/http.ts:315

editTagline

editTagline(
form: UpdateTagline,
options?: RequestOptions,
): Promise<TaglineResponse>
Parameters
- form: UpdateTagline
- Optionaloptions: RequestOptions
Returns Promise<TaglineResponse>
- Defined in src/http.ts:2252

exportSettings

exportSettings(options?: RequestOptions): Promise<string>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<string>
- Defined in src/http.ts:381

featurePost

featurePost(form: FeaturePost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: FeaturePost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1085

followCommunity

followCommunity(
form: FollowCommunity,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: FollowCommunity
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:664

followMultiCommunity

followMultiCommunity(
form: FollowMultiCommunity,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: FollowMultiCommunity
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2845

generateTotpSecret

generateTotpSecret(
options?: RequestOptions,
): Promise<GenerateTotpSecretResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GenerateTotpSecretResponse>
- Defined in src/http.ts:348

getCaptcha

getCaptcha(options?: RequestOptions): Promise<GetCaptchaResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetCaptchaResponse>
- Defined in src/http.ts:1717

getComment

getComment(
form: GetCommentI,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: GetCommentI
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1410

getComments

getComments(
form?: GetCommentsI,
options?: RequestOptions,
): Promise<GetCommentsResponse>
Parameters
- form: GetCommentsI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetCommentsResponse>
- Defined in src/http.ts:1372

getCommentsSlim

getCommentsSlim(
form?: GetCommentsI,
options?: RequestOptions,
): Promise<GetCommentsSlimResponse>
Parameters
- form: GetCommentsI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetCommentsSlimResponse>
- Defined in src/http.ts:1391

getCommunity

getCommunity(
form?: GetCommunityI,
options?: RequestOptions,
): Promise<GetCommunityResponse>
Parameters
- form: GetCommunityI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetCommunityResponse>
- Defined in src/http.ts:609

getCommunityPendingFollowsCount

getCommunityPendingFollowsCount(
form: GetCommunityPendingFollowsCountI,
options?: RequestOptions,
): Promise<GetCommunityPendingFollowsCountResponse>
Parameters
- form: GetCommunityPendingFollowsCountI
- Optionaloptions: RequestOptions
Returns Promise<GetCommunityPendingFollowsCountResponse>
- Defined in src/http.ts:682

getFederatedInstances

getFederatedInstances(
options?: RequestOptions,
): Promise<GetFederatedInstancesResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetFederatedInstancesResponse>
- Defined in src/http.ts:2432

getHeader

getHeader(name: string): undefined | string | string[]
Parameters
- name: string
Returns undefined | string | string[]
Inherited from Controller.getHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:11

getHeaders

getHeaders(): { [name: string]: undefined | string | string[] }
Returns { [name: string]: undefined | string | string[] }
Inherited from Controller.getHeaders
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:12

getModlog

getModlog(
form?: GetModlogI,
options?: RequestOptions,
): Promise<GetModlogResponse>
Parameters
- form: GetModlogI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetModlogResponse>
- Defined in src/http.ts:537

getMultiCommunity

getMultiCommunity(
form: GetMultiCommunityI,
options?: RequestOptions,
): Promise<GetMultiCommunityResponse>
Parameters
- form: GetMultiCommunityI
- Optionaloptions: RequestOptions
Returns Promise<GetMultiCommunityResponse>
- Defined in src/http.ts:2787

getMyUser

getMyUser(options?: RequestOptions): Promise<MyUserInfo>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<MyUserInfo>
- Defined in src/http.ts:363

getPersonDetails

getPersonDetails(
form?: GetPersonDetailsI,
options?: RequestOptions,
): Promise<GetPersonDetailsResponse>
Parameters
- form: GetPersonDetailsI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetPersonDetailsResponse>
- Defined in src/http.ts:1612

getPost

getPost(form?: GetPostI, options?: RequestOptions): Promise<GetPostResponse>
Parameters
- form: GetPostI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetPostResponse>
- Defined in src/http.ts:932

getPosts

getPosts(form?: GetPostsI, options?: RequestOptions): Promise<GetPostsResponse>
Parameters
- form: GetPostsI = {}
- Optionaloptions: RequestOptions
Returns Promise<GetPostsResponse>
- Defined in src/http.ts:1104

getRandomCommunity

getRandomCommunity(
form: GetRandomCommunityI,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: GetRandomCommunityI
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:859

getRegistrationApplication

getRegistrationApplication(
form: GetRegistrationApplicationI,
options?: RequestOptions,
): Promise<RegistrationApplicationResponse>
Parameters
- form: GetRegistrationApplicationI
- Optionaloptions: RequestOptions
Returns Promise<RegistrationApplicationResponse>
- Defined in src/http.ts:2076

getReportCount

getReportCount(
form: GetReportCountI,
options?: RequestOptions,
): Promise<GetReportCountResponse>
Parameters
- form: GetReportCountI
- Optionaloptions: RequestOptions
Returns Promise<GetReportCountResponse>
- Defined in src/http.ts:1855

getSite

getSite(options?: RequestOptions): Promise<GetSiteResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetSiteResponse>
- Defined in src/http.ts:282

getSiteMetadata

getSiteMetadata(
form: GetSiteMetadataI,
options?: RequestOptions,
): Promise<GetSiteMetadataResponse>
Parameters
- form: GetSiteMetadataI
- Optionaloptions: RequestOptions
Returns Promise<GetSiteMetadataResponse>
- Defined in src/http.ts:1209

getStatus

getStatus(): undefined | number
Returns undefined | number
Inherited from Controller.getStatus
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:8

getUnreadCount

getUnreadCount(options?: RequestOptions): Promise<GetUnreadCountResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetUnreadCountResponse>
- Defined in src/http.ts:1873

getUnreadRegistrationApplicationCount

getUnreadRegistrationApplicationCount(
options?: RequestOptions,
): Promise<GetUnreadRegistrationApplicationCountResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetUnreadRegistrationApplicationCountResponse>
- Defined in src/http.ts:2027

hideCommunity

hideCommunity(
form: HideCommunity,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: HideCommunity
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:768

hidePost

hidePost(form: HidePost, options?: RequestOptions): Promise<SuccessResponse>
Parameters
- form: HidePost
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1055

imageHealth

imageHealth(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2731

importSettings

importSettings(form: any, options?: RequestOptions): Promise<SuccessResponse>
Parameters
- form: any
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:396

leaveAdmin

leaveAdmin(options?: RequestOptions): Promise<GetSiteResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<GetSiteResponse>
- Defined in src/http.ts:330

likeComment

likeComment(
form: CreateCommentLike,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: CreateCommentLike
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1299

likePost

likePost(form: CreatePostLike, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: CreatePostLike
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1122

listCommentLikes

listCommentLikes(
form: ListCommentLikesI,
options?: RequestOptions,
): Promise<ListCommentLikesResponse>
Parameters
- form: ListCommentLikesI
- Optionaloptions: RequestOptions
Returns Promise<ListCommentLikesResponse>
- Defined in src/http.ts:1317

listCommunities

listCommunities(
form?: ListCommunitiesI,
options?: RequestOptions,
): Promise<ListCommunitiesResponse>
Parameters
- form: ListCommunitiesI = {}
- Optionaloptions: RequestOptions
Returns Promise<ListCommunitiesResponse>
- Defined in src/http.ts:646

listCommunityPendingFollows

listCommunityPendingFollows(
form: ListCommunityPendingFollowsI,
options?: RequestOptions,
): Promise<ListCommunityPendingFollowsResponse>
Parameters
- form: ListCommunityPendingFollowsI
- Optionaloptions: RequestOptions
Returns Promise<ListCommunityPendingFollowsResponse>
- Defined in src/http.ts:698

listCustomEmojis

listCustomEmojis(
form: ListCustomEmojisI,
options?: RequestOptions,
): Promise<ListCustomEmojisResponse>
Parameters
- form: ListCustomEmojisI
- Optionaloptions: RequestOptions
Returns Promise<ListCustomEmojisResponse>
- Defined in src/http.ts:2216

listLogins

listLogins(options?: RequestOptions): Promise<ListLoginsResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<ListLoginsResponse>
- Defined in src/http.ts:411

listMedia

listMedia(
form?: ListMediaI,
options?: RequestOptions,
): Promise<ListMediaResponse>
Parameters
- form: ListMediaI = {}
- Optionaloptions: RequestOptions
Returns Promise<ListMediaResponse>
- Defined in src/http.ts:441

listMediaAdmin

listMediaAdmin(
form?: ListMediaI,
options?: RequestOptions,
): Promise<ListMediaResponse>
Parameters
- form: ListMediaI = {}
- Optionaloptions: RequestOptions
Returns Promise<ListMediaResponse>
- Defined in src/http.ts:495

listMultiCommunities

listMultiCommunities(
form: ListMultiCommunitiesI,
options?: RequestOptions,
): Promise<ListMultiCommunitiesResponse>
Parameters
- form: ListMultiCommunitiesI
- Optionaloptions: RequestOptions
Returns Promise<ListMultiCommunitiesResponse>
- Defined in src/http.ts:2831

listNotifications

listNotifications(
form: ListNotificationsI,
options?: RequestOptions,
): Promise<ListNotificationsResponse>
Parameters
- form: ListNotificationsI
- Optionaloptions: RequestOptions
Returns Promise<ListNotificationsResponse>
- Defined in src/http.ts:1888

listPersonContent

listPersonContent(
form?: ListPersonContentI,
options?: RequestOptions,
): Promise<ListPersonContentResponse>
Parameters
- form: ListPersonContentI = {}
- Optionaloptions: RequestOptions
Returns Promise<ListPersonContentResponse>
- Defined in src/http.ts:1631

listPersonHidden

listPersonHidden(
form: ListPersonHiddenI,
options?: RequestOptions,
): Promise<ListPersonHiddenResponse>
Parameters
- form: ListPersonHiddenI
- Optionaloptions: RequestOptions
Returns Promise<ListPersonHiddenResponse>
- Defined in src/http.ts:1976

listPersonLiked

listPersonLiked(
form: ListPersonLikedI,
options?: RequestOptions,
): Promise<ListPersonLikedResponse>
Parameters
- form: ListPersonLikedI
- Optionaloptions: RequestOptions
Returns Promise<ListPersonLikedResponse>
- Defined in src/http.ts:1994

listPersonRead

listPersonRead(
form: ListPersonReadI,
options?: RequestOptions,
): Promise<ListPersonReadResponse>
Parameters
- form: ListPersonReadI
- Optionaloptions: RequestOptions
Returns Promise<ListPersonReadResponse>
- Defined in src/http.ts:1958

listPersonSaved

listPersonSaved(
form: ListPersonSavedI,
options?: RequestOptions,
): Promise<ListPersonSavedResponse>
Parameters
- form: ListPersonSavedI
- Optionaloptions: RequestOptions
Returns Promise<ListPersonSavedResponse>
- Defined in src/http.ts:1940

listPostLikes

listPostLikes(
form: ListPostLikesI,
options?: RequestOptions,
): Promise<ListPostLikesResponse>
Parameters
- form: ListPostLikesI
- Optionaloptions: RequestOptions
Returns Promise<ListPostLikesResponse>
- Defined in src/http.ts:1140

listRegistrationApplications

listRegistrationApplications(
form: ListRegistrationApplicationsI,
options?: RequestOptions,
): Promise<ListRegistrationApplicationsResponse>
Parameters
- form: ListRegistrationApplicationsI
- Optionaloptions: RequestOptions
Returns Promise<ListRegistrationApplicationsResponse>
- Defined in src/http.ts:2044

listReports

listReports(
form: ListReportsI,
options?: RequestOptions,
): Promise<ListReportsResponse>
Parameters
- form: ListReportsI
- Optionaloptions: RequestOptions
Returns Promise<ListReportsResponse>
- Defined in src/http.ts:2447

listTaglines

listTaglines(
form: ListTaglinesI,
options?: RequestOptions,
): Promise<ListTaglinesResponse>
Parameters
- form: ListTaglinesI
- Optionaloptions: RequestOptions
Returns Promise<ListTaglinesResponse>
- Defined in src/http.ts:2289

listUsers

listUsers(
form?: AdminListUsersI,
options?: RequestOptions,
): Promise<AdminListUsersResponse>
Parameters
- form: AdminListUsersI = {}
- Optionaloptions: RequestOptions
Returns Promise<AdminListUsersResponse>
- Defined in src/http.ts:1682

lockPost

lockPost(form: LockPost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: LockPost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1070

login(form: Login, options?: RequestOptions): Promise<LoginResponse>
Parameters
- form: Login
- Optionaloptions: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1581

logout

logout(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1596

markAllNotificationsAsRead

markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1786

markManyPostAsRead

markManyPostAsRead(
form: MarkManyPostsAsRead,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: MarkManyPostsAsRead
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1037

markNotificationAsRead

markNotificationAsRead(
form: MarkNotificationAsRead,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: MarkNotificationAsRead
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1801

markPostAsRead

markPostAsRead(
form: MarkPostAsRead,
options?: RequestOptions,
): Promise<PostResponse>
Parameters
- form: MarkPostAsRead
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1019

markPrivateMessageAsRead

markPrivateMessageAsRead(
form: MarkPrivateMessageAsRead,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: MarkPrivateMessageAsRead
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1518

modEditPost

modEditPost(form: ModEditPost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: ModEditPost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:965

notePerson

notePerson(form: NotePerson, options?: RequestOptions): Promise<SuccessResponse>
Parameters
- form: NotePerson
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1649

passwordChangeAfterReset

passwordChangeAfterReset(
form: PasswordChangeAfterReset,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: PasswordChangeAfterReset
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1768

passwordReset

passwordReset(
form: PasswordReset,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: PasswordReset
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1750

purgeComment

purgeComment(
form: PurgeComment,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: PurgeComment
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2143

purgeCommunity

purgeCommunity(
form: PurgeCommunity,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: PurgeCommunity
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2110

purgePerson

purgePerson(
form: PurgePerson,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: PurgePerson
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2092

purgePost

purgePost(form: PurgePost, options?: RequestOptions): Promise<SuccessResponse>
Parameters
- form: PurgePost
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2128

register

register(form: Register, options?: RequestOptions): Promise<LoginResponse>
Parameters
- form: Register
- Optionaloptions: RequestOptions
Returns Promise<LoginResponse>
- Defined in src/http.ts:1567

removeComment

removeComment(
form: RemoveComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: RemoveComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1281

removeCommunity

removeCommunity(
form: RemoveCommunity,
options?: RequestOptions,
): Promise<CommunityResponse>
Parameters
- form: RemoveCommunity
- Optionaloptions: RequestOptions
Returns Promise<CommunityResponse>
- Defined in src/http.ts:786

removePost

removePost(form: RemovePost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: RemovePost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1001

resendVerificationEmail

resendVerificationEmail(
form: ResendVerificationEmail,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: ResendVerificationEmail
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1922

resolveCommentReport

resolveCommentReport(
form: ResolveCommentReport,
options?: RequestOptions,
): Promise<CommentReportResponse>
Parameters
- form: ResolveCommentReport
- Optionaloptions: RequestOptions
Returns Promise<CommentReportResponse>
- Defined in src/http.ts:1446

resolveCommunityReport

resolveCommunityReport(
form: ResolveCommunityReport,
options?: RequestOptions,
): Promise<CommunityReportResponse>
Parameters
- form: ResolveCommunityReport
- Optionaloptions: RequestOptions
Returns Promise<CommunityReportResponse>
- Defined in src/http.ts:895

resolveObject

resolveObject(
form: ResolveObjectI,
options?: RequestOptions,
): Promise<SearchResponse>
Parameters
- form: ResolveObjectI
- Optionaloptions: RequestOptions
Returns Promise<SearchResponse>
- Defined in src/http.ts:572

resolvePostReport

resolvePostReport(
form: ResolvePostReport,
options?: RequestOptions,
): Promise<PostReportResponse>
Parameters
- form: ResolvePostReport
- Optionaloptions: RequestOptions
Returns Promise<PostReportResponse>
- Defined in src/http.ts:1191

resolvePrivateMessageReport

resolvePrivateMessageReport(
form: ResolvePrivateMessageReport,
options?: RequestOptions,
): Promise<PrivateMessageReportResponse>
Parameters
- form: ResolvePrivateMessageReport
- Optionaloptions: RequestOptions
Returns Promise<PrivateMessageReportResponse>
- Defined in src/http.ts:1552

saveComment

saveComment(
form: SaveComment,
options?: RequestOptions,
): Promise<CommentResponse>
Parameters
- form: SaveComment
- Optionaloptions: RequestOptions
Returns Promise<CommentResponse>
- Defined in src/http.ts:1335

savePost

savePost(form: SavePost, options?: RequestOptions): Promise<PostResponse>
Parameters
- form: SavePost
- Optionaloptions: RequestOptions
Returns Promise<PostResponse>
- Defined in src/http.ts:1158

saveUserSettings

saveUserSettings(
form: SaveUserSettings,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: SaveUserSettings
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1819

search

search(form: SearchI, options?: RequestOptions): Promise<SearchResponse>
Parameters
- form: SearchI
- Optionaloptions: RequestOptions
Returns Promise<SearchResponse>
- Defined in src/http.ts:556

setHeader

setHeader<H extends keyof OutgoingHttpHeaders>(
name: H,
value?: HeaderValue<H>,
): void
Type Parameters
- H extends keyof OutgoingHttpHeaders
Parameters
- name: H
- Optionalvalue: HeaderValue<H>
Returns void
Inherited from Controller.setHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:9
setHeader(name: string, value?: string | string[]): void
Parameters
- name: string
- Optionalvalue: string | string[]
Returns void
Inherited from Controller.setHeader
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:10

setHeaders

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

setStatus

setStatus(statusCode: number): void
Parameters
- statusCode: number
Returns void
Inherited from Controller.setStatus
- Defined in node_modules/.pnpm/@tsoa+runtime@6.6.0/node_modules/@tsoa/runtime/dist/interfaces/controller.d.ts:7

transferCommunity

transferCommunity(
form: TransferCommunity,
options?: RequestOptions,
): Promise<GetCommunityResponse>
Parameters
- form: TransferCommunity
- Optionaloptions: RequestOptions
Returns Promise<GetCommunityResponse>
- Defined in src/http.ts:804

updateCommunityNotifications

updateCommunityNotifications(
form: UpdateCommunityNotifications,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: UpdateCommunityNotifications
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2863

updateCommunityTag

updateCommunityTag(
form: UpdateCommunityTag,
options?: RequestOptions,
): Promise<Tag>
Parameters
- form: UpdateCommunityTag
- Optionaloptions: RequestOptions
Returns Promise<Tag>
- Defined in src/http.ts:2325

updateMultiCommunity

updateMultiCommunity(
form: UpdateMultiCommunity,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: UpdateMultiCommunity
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2773

updatePostNotifications

updatePostNotifications(
form: UpdatePostNotifications,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: UpdatePostNotifications
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2881

updateTotp

updateTotp(
form: UpdateTotp,
options?: RequestOptions,
): Promise<UpdateTotpResponse>
Parameters
- form: UpdateTotp
- Optionaloptions: RequestOptions
Returns Promise<UpdateTotpResponse>
- Defined in src/http.ts:518

uploadCommunityBanner

uploadCommunityBanner(
    query: CommunityIdQueryI,
    image: UploadImage,
    options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- query: CommunityIdQueryI
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2627

uploadCommunityIcon

uploadCommunityIcon(
    query: CommunityIdQueryI,
    image: UploadImage,
    options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- query: CommunityIdQueryI
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2595

uploadImage

uploadImage(
image: UploadImage,
options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2719

uploadSiteBanner

uploadSiteBanner(
image: UploadImage,
options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2689

uploadSiteIcon

uploadSiteIcon(
image: UploadImage,
options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2659

uploadUserAvatar

uploadUserAvatar(
image: UploadImage,
options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2537

uploadUserBanner

uploadUserBanner(
image: UploadImage,
options?: RequestOptions,
): Promise<UploadImageResponse>
Parameters
- image: UploadImage
- Optionaloptions: RequestOptions
Returns Promise<UploadImageResponse>
- Defined in src/http.ts:2567

userBlockInstanceCommunities

userBlockInstanceCommunities(
form: UserBlockInstanceCommunitiesParams,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: UserBlockInstanceCommunitiesParams
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2465

userBlockInstancePersons

userBlockInstancePersons(
form: UserBlockInstancePersonsParams,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: UserBlockInstancePersonsParams
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:2483

validateAuth

validateAuth(options?: RequestOptions): Promise<SuccessResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:426

verifyEmail

verifyEmail(
form: VerifyEmail,
options?: RequestOptions,
): Promise<SuccessResponse>
Parameters
- form: VerifyEmail
- Optionaloptions: RequestOptions
Returns Promise<SuccessResponse>
- Defined in src/http.ts:1905

Class LemmyHttp

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalfetchFunction?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalheaders?: { [key: string]: string }

Returns LemmyHttp

Methods

addAdmin

Parameters

Returns Promise<AddAdminResponse>

addModToCommunity

Parameters

Returns Promise<AddModToCommunityResponse>

adminAllowInstance

Parameters

Returns Promise<SuccessResponse>

adminBlockInstance

Parameters

Returns Promise<SuccessResponse>

approveCommunityPendingFollow

Parameters

Returns Promise<SuccessResponse>

approveRegistrationApplication

Parameters

Returns Promise<RegistrationApplicationResponse>

authenticateWithOAuth

Parameters

Returns Promise<LoginResponse>

banFromCommunity

Parameters

Returns Promise<BanFromCommunityResponse>

banPerson

Parameters

Returns Promise<BanPersonResponse>

blockCommunity

Parameters

Returns Promise<BlockCommunityResponse>

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>

createCommunityReport

Parameters

Returns Promise<CommunityReportResponse>

createCommunityTag

Parameters

Returns Promise<Tag>

createCustomEmoji

Parameters

Returns Promise<CustomEmojiResponse>

createMultiCommunity

Parameters

Returns Promise<GetMultiCommunityResponse>

createMultiCommunityEntry

Parameters

Returns Promise<SuccessResponse>

createOAuthProvider

Parameters

Returns Promise<OAuthProvider>

createPost

Parameters

Returns Promise<PostResponse>

createPostReport

Parameters

`Optional`fetchFunction?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

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