Class PostsAPI

Hierarchy

APIRequest
- PostsAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostsAPI(opts: RequestOpts): PostsAPI

Overrides APIRequest.constructor
- Defined in api/posts.ts:18
Parameters
- opts: RequestOpts
Returns PostsAPI

Properties

Protected _api

_api: IRequestStrategy

Protected _endpoint

_endpoint: string

Protected _headers

_headers: object

Protected _okuna

_okuna: Client

Defines an API request.

param

Protected _params

_params: RequestParams

Protected _paths

_paths: string[] = []

Protected _url

_url: string

requiresToken

requiresToken: boolean = true

Methods

_constructFormdata

_constructFormdata(opts?: object | null): FormData

Inherited from APIRequest._constructFormdata
- Defined in utils/APIRequest.ts:72
constructFormdata() Constructs a FormData instance from an object.

Parameters
- Default value opts: object | null = null
  
  the object to generate the FormData from
Returns FormData

addMediaToPost

addMediaToPost(uuid: string, opts: IAddMediaOpts): Promise<any>

- Defined in api/posts.ts:65
Parameters
- uuid: string
- opts: IAddMediaOpts
Returns Promise<any>

closePost

closePost(uuid: string): Promise<any>

- Defined in api/posts.ts:360
Parameters
- uuid: string
Returns Promise<any>

commentOnPost

commentOnPost(uuid: string, text: string): Promise<any>

- Defined in api/posts.ts:207
Parameters
- uuid: string
- text: string
Returns Promise<any>

createPost

createPost(opts: ICreatePost): Promise<any>

- Defined in api/posts.ts:47
Parameters
- opts: ICreatePost
Returns Promise<any>

Protected delete

delete(): Promise<any>

Inherited from APIRequest.delete
- Defined in utils/APIRequest.ts:158
delete() DELETE request

Returns Promise<any>

deletePostComment

deletePostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:227
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

deletePostCommentReaction

deletePostCommentReaction(postUuid: string, commentId: number, reactionId: number): Promise<any>

- Defined in api/posts.ts:299
Parameters
- postUuid: string
- commentId: number
- reactionId: number
Returns Promise<any>

deletePostReaction

deletePostReaction(postUuid: string, reactionId: number): Promise<any>

- Defined in api/posts.ts:260
Parameters
- postUuid: string
- reactionId: number
Returns Promise<any>

deletePostWithUuid

deletePostWithUuid(uuid: string): Promise<any>

- Defined in api/posts.ts:149
Parameters
- uuid: string
Returns Promise<any>

disableCommentsForPost

disableCommentsForPost(uuid: string): Promise<any>

- Defined in api/posts.ts:345
Parameters
- uuid: string
Returns Promise<any>

editPost

editPost(opts: IEditPost): Promise<any>

- Defined in api/posts.ts:129
Parameters
- opts: IEditPost
Returns Promise<any>

editPostComment

editPostComment(postUuid: string, commentId: number, text: string): Promise<any>

- Defined in api/posts.ts:217
Parameters
- postUuid: string
- commentId: number
- text: string
Returns Promise<any>

enableCommentsForPost

enableCommentsForPost(uuid: string): Promise<any>

- Defined in api/posts.ts:350
Parameters
- uuid: string
Returns Promise<any>

generateHeaders

generateHeaders(contentType?: string | null): object

Inherited from APIRequest.generateHeaders
- Defined in utils/APIRequest.ts:42
generateHeaders() A function used to generate the headers that need to be passed to the request performee.

Parameters
- Default value contentType: string | null = null
Returns object

Protected get

get(): Promise<any>

Inherited from APIRequest.get
- Defined in utils/APIRequest.ts:98
get() GET request

Returns Promise<any>

getCommentsForPost

getCommentsForPost(uuid: string, opts: ExtraLimitationParams): Promise<any>

- Defined in api/posts.ts:155
Parameters
- uuid: string
- opts: ExtraLimitationParams
Returns Promise<any>

getPostComment

getPostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:212
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

getPostMedia

getPostMedia(uuid: string): Promise<any>

- Defined in api/posts.ts:74
Parameters
- uuid: string
Returns Promise<any>

getPostParticipants

getPostParticipants(opts: IGetPostParticipants): Promise<any>

- Defined in api/posts.ts:413
Parameters
- opts: IGetPostParticipants
Returns Promise<any>

getPostStatus

getPostStatus(uuid: string): Promise<any>

- Defined in api/posts.ts:84
Parameters
- uuid: string
Returns Promise<any>

getPostWithUuid

getPostWithUuid(uuid: string): Promise<any>

- Defined in api/posts.ts:143
Parameters
- uuid: string
Returns Promise<any>

getPreviewData

getPreviewData(uuid: string): Promise<any>

- Defined in api/posts.ts:403
Parameters
- uuid: string
Returns Promise<any>

getReactionEmojiGroups

getReactionEmojiGroups(): Promise<any>

- Defined in api/posts.ts:365
Returns Promise<any>

getReactionsEmojiCountForPost

getReactionsEmojiCountForPost(uuid: string): Promise<any>

- Defined in api/posts.ts:250
Parameters
- uuid: string
Returns Promise<any>

getReactionsEmojiCountForPostComment

getReactionsEmojiCountForPostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:283
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

getReactionsForPost

getReactionsForPost(uuid: string, opts: IGetReactionsForPost): Promise<any>

- Defined in api/posts.ts:232
Parameters
- uuid: string
- opts: IGetReactionsForPost
Returns Promise<any>

getReactionsForPostComment

getReactionsForPostComment(postUuid: string, commentId: number, opts: IGetReactionsForPost): Promise<any>

- Defined in api/posts.ts:265
Parameters
- postUuid: string
- commentId: number
- opts: IGetReactionsForPost
Returns Promise<any>

getRepliesForPostComment

getRepliesForPostComment(postUuid: string, postCommentId: number, opts: ExtraLimitationParams): Promise<any>

- Defined in api/posts.ts:181
Parameters
- postUuid: string
- postCommentId: number
- opts: ExtraLimitationParams
Returns Promise<any>

getTimelinePosts

getTimelinePosts(opts: IGetTimelinePosts): Promise<any>

- Defined in api/posts.ts:23
Parameters
- opts: IGetTimelinePosts
Returns Promise<any>

getTopPosts

getTopPosts(opts: IGetTopPostsOpts): Promise<any>

- Defined in api/posts.ts:89
Parameters
- opts: IGetTopPostsOpts
Returns Promise<any>

getTrendingPosts

getTrendingPosts(opts: IGetTrendingPostsOpts): Promise<any>

- Defined in api/posts.ts:111
Parameters
- opts: IGetTrendingPostsOpts
Returns Promise<any>

mutePost

mutePost(uuid: string): Promise<any>

- Defined in api/posts.ts:335
Parameters
- uuid: string
Returns Promise<any>

mutePostComment

mutePostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:311
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

openPost

openPost(uuid: string): Promise<any>

- Defined in api/posts.ts:355
Parameters
- uuid: string
Returns Promise<any>

Protected patch

patch(body: object): Promise<any>

Inherited from APIRequest.patch
- Defined in utils/APIRequest.ts:143
patch() PATCH request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected patchFormdata

patchFormdata(body: object): Promise<any>

Inherited from APIRequest.patchFormdata
- Defined in utils/APIRequest.ts:202
patchFormdata() PATCH request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

Protected post

post(body: object): Promise<any>

Inherited from APIRequest.post
- Defined in utils/APIRequest.ts:128
post() POST request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected postFormdata

postFormdata(body: object): Promise<any>

Inherited from APIRequest.postFormdata
- Defined in utils/APIRequest.ts:187
postFormdata() POST request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

publishPost

publishPost(uuid: string): Promise<any>

- Defined in api/posts.ts:79
Parameters
- uuid: string
Returns Promise<any>

Protected put

put(body: object): Promise<any>

Inherited from APIRequest.put
- Defined in utils/APIRequest.ts:113
put() PUT request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected putFormdata

putFormdata(body: object): Promise<any>

Inherited from APIRequest.putFormdata
- Defined in utils/APIRequest.ts:172
putFormdata() PUT request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

reactToPost

reactToPost(uuid: string, emojiId: number): Promise<any>

- Defined in api/posts.ts:255
Parameters
- uuid: string
- emojiId: number
Returns Promise<any>

reactToPostComment

reactToPostComment(postUuid: string, commentId: number, emojiId: number): Promise<any>

- Defined in api/posts.ts:294
Parameters
- postUuid: string
- commentId: number
- emojiId: number
Returns Promise<any>

replyPostComment

replyPostComment(postUuid: string, commentId: number, text: string): Promise<any>

- Defined in api/posts.ts:222
Parameters
- postUuid: string
- commentId: number
- text: string
Returns Promise<any>

reportPost

reportPost(opts: IReportPost): Promise<any>

- Defined in api/posts.ts:370
Parameters
- opts: IReportPost
Returns Promise<any>

reportPostComment

reportPostComment(opts: IReportPostComment): Promise<any>

- Defined in api/posts.ts:384
Parameters
- opts: IReportPostComment
Returns Promise<any>

searchPostParticipants

searchPostParticipants(opts: ISearchPostParticipants): Promise<any>

- Defined in api/posts.ts:423
Parameters
- opts: ISearchPostParticipants
Returns Promise<any>

translatePost

translatePost(uuid: string): Promise<any>

- Defined in api/posts.ts:398
Parameters
- uuid: string
Returns Promise<any>

translatePostComment

translatePostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:408
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

unmutePost

unmutePost(uuid: string): Promise<any>

- Defined in api/posts.ts:340
Parameters
- uuid: string
Returns Promise<any>

unmutePostComment

unmutePostComment(postUuid: string, commentId: number): Promise<any>

- Defined in api/posts.ts:323
Parameters
- postUuid: string
- commentId: number
Returns Promise<any>

Generated using TypeDoc