Class SublinksClient

Universal Sublinks/Lemmy client that works with both APIs

Index

Constructors

Properties

baseURL cache compatible18 fetchFunction headers instance

Methods

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

Constructors

constructor

new SublinksClient(instance, options?): SublinksClient
Client library for Sublinks and, during compatibility phase, Lemmy.
Parameters
- instance: string
  should be the domain of the instance without the scheme (e.g. sublinks.example.com). HTTPS is assumed and enforced by the library.
- Optional options: HttpClientConstructorOptions
  is an object of type HttpClientConstructorOptions
Returns SublinksClient
- Defined in src/client.ts:177

Properties

baseURL

baseURL: string

cache

cache: FetchCache

compatible18

compatible18: boolean

fetchFunction

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

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>

headers

headers: HeadersObject

instance

instance: string

Methods

addAdmin

addAdmin(form): Promise<AddAdminResponse>
Parameters
- form: AddAdmin
Returns Promise<AddAdminResponse>
- Defined in src/client.ts:265

banPerson

banPerson(form): Promise<BanPersonResponse>
Parameters
- form: BanPerson
Returns Promise<BanPersonResponse>
- Defined in src/client.ts:281

blockCommunity

blockCommunity(form): Promise<BlockCommunityResponse>
Parameters
- form: BlockCommunity
Returns Promise<BlockCommunityResponse>
- Defined in src/client.ts:285

blockInstance

blockInstance(form): Promise<BlockInstanceResponse>
Parameters
- form: BlockInstance
Returns Promise<BlockInstanceResponse>
- Defined in src/client.ts:289

blockPerson

blockPerson(form): Promise<BlockPersonResponse>
Parameters
- form: BlockPerson
Returns Promise<BlockPersonResponse>
- Defined in src/client.ts:293

call

call<ResponseType, FormDataType>(method, endpoint, form?): Promise<ResponseType>
Standard fetch wrapper for native API calls.

ResponseType is the type definition to expect from the response.

FormDataType is the type definition for the form parameter data

Note: These are reversed from how Lemmy's wrapper function is implemented to allow shorter invocations for GET requests by not requiring a dummy 'object' type be passed for the non-existent form data when not needed.
Type Parameters
- ResponseType
- FormDataType extends object = object
Parameters
- method: HTTP
  HTTP method to use for the call
- endpoint: string
  The relative API endpoint (e.g. /siteinfo -> https://{instance.com}/sublinks-api/v2/siteinfo)
- form: FormDataType = ...
  The optional body payload for non-GET requests or key/values for GET query string params
Returns Promise<ResponseType>
- Defined in src/client.ts:208

changePassword

changePassword(form): Promise<LoginResponse>
Parameters
- form: ChangePassword
Returns Promise<LoginResponse>
- Defined in src/client.ts:297

createComment

createComment(form): Promise<CommentResponse>
Parameters
- form: CreateComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:301

createCommentReport

createCommentReport(form): Promise<CommentReportResponse>
Parameters
- form: CreateCommentReport
Returns Promise<CommentReportResponse>
- Defined in src/client.ts:305

createCommunity

createCommunity(form): Promise<CommunityResponse>
Parameters
- form: CreateCommunity
Returns Promise<CommunityResponse>
- Defined in src/client.ts:309

createCustomEmoji

createCustomEmoji(form): Promise<CustomEmojiResponse>
Parameters
- form: CreateCustomEmoji
Returns Promise<CustomEmojiResponse>
- Defined in src/client.ts:313

createPost

createPost(form): Promise<PostResponse>
Parameters
- form: CreatePost
Returns Promise<PostResponse>
- Defined in src/client.ts:317

createPostReport

createPostReport(form): Promise<PostReportResponse>
Parameters
- form: CreatePostReport
Returns Promise<PostReportResponse>
- Defined in src/client.ts:321

createPrivateMessage

createPrivateMessage(form): Promise<PrivateMessageResponse>
Parameters
- form: CreatePrivateMessage
Returns Promise<PrivateMessageResponse>
- Defined in src/client.ts:325

createPrivateMessageReport

createPrivateMessageReport(form): Promise<PrivateMessageReportResponse>
Parameters
- form: CreatePrivateMessageReport
Returns Promise<PrivateMessageReportResponse>
- Defined in src/client.ts:329

createSite

createSite(form): Promise<SiteResponse>
Parameters
- form: CreateSite
Returns Promise<SiteResponse>
- Defined in src/client.ts:333

deleteAccount

deleteAccount(form): Promise<SuccessResponse>
Parameters
- form: DeleteAccount
Returns Promise<SuccessResponse>
- Defined in src/client.ts:337

deleteComment

deleteComment(form): Promise<CommentResponse>
Parameters
- form: DeleteComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:341

deleteCommunity

deleteCommunity(form): Promise<CommunityResponse>
Parameters
- form: DeleteCommunity
Returns Promise<CommunityResponse>
- Defined in src/client.ts:345

deleteCustomEmoji

deleteCustomEmoji(form): Promise<SuccessResponse>
Parameters
- form: DeleteCustomEmoji
Returns Promise<SuccessResponse>
- Defined in src/client.ts:349

deleteImage

deleteImage(__namedParameters): Promise<boolean>
Parameters
- __namedParameters: DeleteImage
Returns Promise<boolean>
- Defined in src/client.ts:354

deletePost

deletePost(form): Promise<PostResponse>
Parameters
- form: DeletePost
Returns Promise<PostResponse>
- Defined in src/client.ts:358

deletePrivateMessage

deletePrivateMessage(form): Promise<PrivateMessageResponse>
Parameters
- form: DeletePrivateMessage
Returns Promise<PrivateMessageResponse>
- Defined in src/client.ts:362

distinguishComment

distinguishComment(form): Promise<CommentResponse>
Parameters
- form: DistinguishComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:366

editComment

editComment(form): Promise<CommentResponse>
Parameters
- form: EditComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:370

editCommunity

editCommunity(form): Promise<CommunityResponse>
Parameters
- form: EditCommunity
Returns Promise<CommunityResponse>
- Defined in src/client.ts:374

editCustomEmoji

editCustomEmoji(form): Promise<CustomEmojiResponse>
Parameters
- form: EditCustomEmoji
Returns Promise<CustomEmojiResponse>
- Defined in src/client.ts:378

editPost

editPost(form): Promise<PostResponse>
Parameters
- form: EditPost
Returns Promise<PostResponse>
- Defined in src/client.ts:382

editPrivateMessage

editPrivateMessage(form): Promise<PrivateMessageResponse>
Parameters
- form: EditPrivateMessage
Returns Promise<PrivateMessageResponse>
- Defined in src/client.ts:386

editSite

editSite(form): Promise<SiteResponse>
Parameters
- form: EditSite
Returns Promise<SiteResponse>
- Defined in src/client.ts:390

exportSettings

exportSettings(): Promise<string>
Returns Promise<string>
- Defined in src/client.ts:394

featurePost

featurePost(form): Promise<PostResponse>
Parameters
- form: FeaturePost
Returns Promise<PostResponse>
- Defined in src/client.ts:398

followCommunity

followCommunity(form): Promise<CommunityResponse>
Parameters
- form: FollowCommunity
Returns Promise<CommunityResponse>
- Defined in src/client.ts:402

generateTotpSecret

generateTotpSecret(): Promise<GenerateTotpSecretResponse>
Returns Promise<GenerateTotpSecretResponse>
- Defined in src/client.ts:406

getBannedPersons

getBannedPersons(): Promise<BannedPersonsResponse>
Returns Promise<BannedPersonsResponse>
- Defined in src/client.ts:410

getCaptcha

getCaptcha(): Promise<GetCaptchaResponse>
Returns Promise<GetCaptchaResponse>
- Defined in src/client.ts:414

getComment

getComment(form): Promise<CommentResponse>
Parameters
- form: GetComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:418

getComments

getComments(form?): Promise<GetCommentsResponse>
Parameters
- form: GetComments = {}
Returns Promise<GetCommentsResponse>
- Defined in src/client.ts:422

getCommunity

getCommunity(form?, cacheOptions?): Promise<GetCommunityResponse>
Parameters
- form: GetCommunity = {}
- Optional cacheOptions: CacheOptions
Returns Promise<GetCommunityResponse>
- Defined in src/client.ts:426

getFederatedInstances

getFederatedInstances(cacheOptions?): Promise<GetFederatedInstancesResponse>
Parameters
- Optional cacheOptions: CacheOptions
Returns Promise<GetFederatedInstancesResponse>
- Defined in src/client.ts:434

getModlog

getModlog(form?, cacheOptions?): Promise<GetModlogResponse>
Parameters
- form: GetModlog = {}
- Optional cacheOptions: CacheOptions
Returns Promise<GetModlogResponse>
- Defined in src/client.ts:441

getPersonDetails

getPersonDetails(form?, cacheOptions?): Promise<GetPersonDetailsResponse>
Parameters
- form: GetPersonDetails = {}
- Optional cacheOptions: CacheOptions
Returns Promise<GetPersonDetailsResponse>
- Defined in src/client.ts:449

getPersonMentions

getPersonMentions(form): Promise<GetPersonMentionsResponse>
Parameters
- form: GetPersonMentions
Returns Promise<GetPersonMentionsResponse>
- Defined in src/client.ts:456

getPost

getPost(form?): Promise<GetPostResponse>
Parameters
- form: GetPost = {}
Returns Promise<GetPostResponse>
- Defined in src/client.ts:460

getPosts

getPosts(form?): Promise<GetPostsResponse>
Parameters
- form: GetPosts = {}
Returns Promise<GetPostsResponse>
- Defined in src/client.ts:464

getPrivateMessages

getPrivateMessages(form): Promise<PrivateMessagesResponse>
Parameters
- form: GetPrivateMessages
Returns Promise<PrivateMessagesResponse>
- Defined in src/client.ts:468

getReplies

getReplies(form): Promise<GetRepliesResponse>
Parameters
- form: GetReplies
Returns Promise<GetRepliesResponse>
- Defined in src/client.ts:472

getReportCount

getReportCount(form): Promise<GetReportCountResponse>
Parameters
- form: GetReportCount
Returns Promise<GetReportCountResponse>
- Defined in src/client.ts:476

getSite

getSite(cacheOptions?): Promise<GetSiteResponse>
Gets the site info and optionally caches it.
Parameters
- Optional cacheOptions: CacheOptions
  Options to control the cache behavior
Returns Promise<GetSiteResponse>
- Defined in src/client.ts:483

getSiteMetadata

getSiteMetadata(form): Promise<GetSiteMetadataResponse>
Parameters
- form: GetSiteMetadata
Returns Promise<GetSiteMetadataResponse>
- Defined in src/client.ts:489

getUnreadCount

getUnreadCount(): Promise<GetUnreadCountResponse>
Returns Promise<GetUnreadCountResponse>
- Defined in src/client.ts:493

getUnreadRegistrationApplicationCount

getUnreadRegistrationApplicationCount(): Promise<GetUnreadRegistrationApplicationCountResponse>
Returns Promise<GetUnreadRegistrationApplicationCountResponse>
- Defined in src/client.ts:497

hideCommunity

hideCommunity(form): Promise<SuccessResponse>
Parameters
- form: HideCommunity
Returns Promise<SuccessResponse>
- Defined in src/client.ts:501

importSettings

importSettings(form): Promise<SuccessResponse>
Parameters
- form: any
Returns Promise<SuccessResponse>
- Defined in src/client.ts:505

leaveAdmin

leaveAdmin(): Promise<GetSiteResponse>
Returns Promise<GetSiteResponse>
- Defined in src/client.ts:509

likeComment

likeComment(form): Promise<CommentResponse>
Parameters
- form: CreateCommentLike
Returns Promise<CommentResponse>
- Defined in src/client.ts:513

likePost

likePost(form): Promise<PostResponse>
Parameters
- form: CreatePostLike
Returns Promise<PostResponse>
- Defined in src/client.ts:517

listCommentLikes

listCommentLikes(form): Promise<ListCommentLikesResponse>
Parameters
- form: ListCommentLikes
Returns Promise<ListCommentLikesResponse>
- Defined in src/client.ts:521

listCommentReports

listCommentReports(form): Promise<ListCommentReportsResponse>
Parameters
- form: ListCommentReports
Returns Promise<ListCommentReportsResponse>
- Defined in src/client.ts:525

listCommunities

listCommunities(form?): Promise<ListCommunitiesResponse>
Parameters
- form: ListCommunities = {}
Returns Promise<ListCommunitiesResponse>
- Defined in src/client.ts:529

listLogins

listLogins(): Promise<LoginToken[]>
Returns Promise<LoginToken[]>
- Defined in src/client.ts:533

listPostLikes

listPostLikes(form): Promise<ListPostLikesResponse>
Parameters
- form: ListPostLikes
Returns Promise<ListPostLikesResponse>
- Defined in src/client.ts:537

listPostReports

listPostReports(form): Promise<ListPostReportsResponse>
Parameters
- form: ListPostReports
Returns Promise<ListPostReportsResponse>
- Defined in src/client.ts:541

listPrivateMessageReports

listPrivateMessageReports(form): Promise<ListPrivateMessageReportsResponse>
Parameters
- form: ListPrivateMessageReports
Returns Promise<ListPrivateMessageReportsResponse>
- Defined in src/client.ts:545

listRegistrationApplications

listRegistrationApplications(form): Promise<ListRegistrationApplicationsResponse>
Parameters
- form: ListRegistrationApplications
Returns Promise<ListRegistrationApplicationsResponse>
- Defined in src/client.ts:549

lockPost

lockPost(form): Promise<PostResponse>
Parameters
- form: LockPost
Returns Promise<PostResponse>
- Defined in src/client.ts:553

login

login(form): Promise<LoginResponse>
Parameters
- form: Login
Returns Promise<LoginResponse>
- Defined in src/client.ts:557

logout

logout(): Promise<SuccessResponse>
Returns Promise<SuccessResponse>
- Defined in src/client.ts:561

markAllAsRead

markAllAsRead(): Promise<GetRepliesResponse>
Returns Promise<GetRepliesResponse>
- Defined in src/client.ts:565

markCommentReplyAsRead

markCommentReplyAsRead(form): Promise<CommentReplyResponse>
Parameters
- form: MarkCommentReplyAsRead
Returns Promise<CommentReplyResponse>
- Defined in src/client.ts:569

markPersonMentionAsRead

markPersonMentionAsRead(form): Promise<PersonMentionResponse>
Parameters
- form: MarkPersonMentionAsRead
Returns Promise<PersonMentionResponse>
- Defined in src/client.ts:573

markPostAsRead

markPostAsRead(form): Promise<SuccessResponse>
Parameters
- form: MarkPostAsRead
Returns Promise<SuccessResponse>
- Defined in src/client.ts:577

markPrivateMessageAsRead

markPrivateMessageAsRead(form): Promise<PrivateMessageResponse>
Parameters
- form: MarkPrivateMessageAsRead
Returns Promise<PrivateMessageResponse>
- Defined in src/client.ts:581

now

now(): number
Returns the current date/time as a Unix timestamp rounded down to nearest second.

Returns number
- Defined in src/client.ts:258

passwordChangeAfterReset

passwordChangeAfterReset(form): Promise<SuccessResponse>
Parameters
- form: PasswordChangeAfterReset
Returns Promise<SuccessResponse>
- Defined in src/client.ts:585

passwordReset

passwordReset(form): Promise<SuccessResponse>
Parameters
- form: PasswordReset
Returns Promise<SuccessResponse>
- Defined in src/client.ts:589

purgeComment

purgeComment(form): Promise<SuccessResponse>
Parameters
- form: PurgeComment
Returns Promise<SuccessResponse>
- Defined in src/client.ts:593

purgeCommunity

purgeCommunity(form): Promise<SuccessResponse>
Parameters
- form: PurgeCommunity
Returns Promise<SuccessResponse>
- Defined in src/client.ts:597

purgePerson

purgePerson(form): Promise<SuccessResponse>
Parameters
- form: PurgePerson
Returns Promise<SuccessResponse>
- Defined in src/client.ts:601

purgePost

purgePost(form): Promise<SuccessResponse>
Parameters
- form: PurgePost
Returns Promise<SuccessResponse>
- Defined in src/client.ts:605

register

register(form): Promise<LoginResponse>
Parameters
- form: Register
Returns Promise<LoginResponse>
- Defined in src/client.ts:609

removeComment

removeComment(form): Promise<CommentResponse>
Parameters
- form: RemoveComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:613

removeCommunity

removeCommunity(form): Promise<CommunityResponse>
Parameters
- form: RemoveCommunity
Returns Promise<CommunityResponse>
- Defined in src/client.ts:617

removePost

removePost(form): Promise<PostResponse>
Parameters
- form: RemovePost
Returns Promise<PostResponse>
- Defined in src/client.ts:621

resolveCommentReport

resolveCommentReport(form): Promise<CommentReportResponse>
Parameters
- form: ResolveCommentReport
Returns Promise<CommentReportResponse>
- Defined in src/client.ts:625

resolveObject

resolveObject(form): Promise<ResolveObjectResponse>
Parameters
- form: ResolveObject
Returns Promise<ResolveObjectResponse>
- Defined in src/client.ts:629

resolvePostReport

resolvePostReport(form): Promise<PostReportResponse>
Parameters
- form: ResolvePostReport
Returns Promise<PostReportResponse>
- Defined in src/client.ts:633

resolvePrivateMessageReport

resolvePrivateMessageReport(form): Promise<PrivateMessageReportResponse>
Parameters
- form: ResolvePrivateMessageReport
Returns Promise<PrivateMessageReportResponse>
- Defined in src/client.ts:637

saveComment

saveComment(form): Promise<CommentResponse>
Parameters
- form: SaveComment
Returns Promise<CommentResponse>
- Defined in src/client.ts:641

savePost

savePost(form): Promise<PostResponse>
Parameters
- form: SavePost
Returns Promise<PostResponse>
- Defined in src/client.ts:645

saveUserSettings

saveUserSettings(form): Promise<SuccessResponse>
Parameters
- form: SaveUserSettings
Returns Promise<SuccessResponse>
- Defined in src/client.ts:649

search

search(form): Promise<SearchResponse>
Parameters
- form: Search
Returns Promise<SearchResponse>
- Defined in src/client.ts:653

setAuth

setAuth(jwt): void
Convenience method to set the Authorization: Bearer {token} header
Parameters
- jwt: string
Returns void
- Defined in src/client.ts:660

setHeader

setHeader(key, value?): void
Sets an individual header key to the provided value or removes the key from the headers if a value is not provided.
Parameters
- key: string
- Optional value: string
Returns void
- Defined in src/client.ts:667

setHeaders

setHeaders(headers): void
Parameters
- headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns void
- Defined in src/client.ts:673

transferCommunity

transferCommunity(form): Promise<GetCommunityResponse>
Parameters
- form: TransferCommunity
Returns Promise<GetCommunityResponse>
- Defined in src/client.ts:677

updateTotp

updateTotp(form): Promise<UpdateTotpResponse>
Parameters
- form: UpdateTotp
Returns Promise<UpdateTotpResponse>
- Defined in src/client.ts:681

uploadImage

uploadImage(__namedParameters): Promise<UploadImageResponse>
Parameters
- __namedParameters: UploadImage
Returns Promise<UploadImageResponse>
- Defined in src/client.ts:685

validateAuth

validateAuth(): Promise<SuccessResponse>
Returns Promise<SuccessResponse>
- Defined in src/client.ts:719

verifyEmail

verifyEmail(form): Promise<SuccessResponse>
Parameters
- form: VerifyEmail
Returns Promise<SuccessResponse>
- Defined in src/client.ts:723

Class SublinksClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

instance: string

Optional options: HttpClientConstructorOptions

Returns SublinksClient

Properties

baseURL

cache

compatible18

fetchFunction

Type declaration

Parameters

input: RequestInfo | URL

Optional init: RequestInit

Returns Promise<Response>

Parameters

input: string | Request | URL

Optional init: RequestInit

Returns Promise<Response>

headers

instance

Methods

addAdmin

Parameters

form: AddAdmin

Returns Promise<AddAdminResponse>

addModToCommunity

Parameters

form: AddModToCommunity

Returns Promise<AddModToCommunityResponse>

approveRegistrationApplication

Parameters

form: ApproveRegistrationApplication

Returns Promise<RegistrationApplicationResponse>

banFromCommunity

Parameters

form: BanFromCommunity

Returns Promise<BanFromCommunityResponse>

banPerson

Parameters

form: BanPerson

Returns Promise<BanPersonResponse>

blockCommunity

Parameters

form: BlockCommunity

Returns Promise<BlockCommunityResponse>

blockInstance

Parameters

form: BlockInstance

Returns Promise<BlockInstanceResponse>

blockPerson

Parameters

form: BlockPerson

Returns Promise<BlockPersonResponse>

call

Type Parameters

ResponseType

FormDataType extends object = object

Parameters

method: HTTP

endpoint: string

form: FormDataType = ...

Returns Promise<ResponseType>

changePassword

Parameters

form: ChangePassword

Returns Promise<LoginResponse>

createComment

Parameters

form: CreateComment

Returns Promise<CommentResponse>

createCommentReport

Parameters

form: CreateCommentReport

`Optional` options: HttpClientConstructorOptions

`Optional` init: RequestInit

`Optional` init: RequestInit