Class GetCommentResponse

Class that represents a response from the Get Comment Request.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.6.0

Hierarchy

AbstractResponse<CommentData>
- GetCommentResponse

Index

Constructors

Properties

Methods

getData getId getLikeCount getParentMedia getParentMediaId getReplies getText getTimestamp getUser getUserId getUsername isHidden

Constructors

constructor

new GetCommentResponse(data: CommentData): GetCommentResponse
The constructor.
Parameters
- data: CommentData
  
  the response data.
Returns GetCommentResponse
Inherited from AbstractResponse.constructor
- Defined in main/requests/AbstractResponse.ts:20

Properties

`Protected` data

data: CommentData

The response data.

Methods

getData

getData(): CommentData
Gets the response data.

Returns
the response data.

Returns CommentData
Inherited from AbstractResponse.getData
- Defined in main/requests/AbstractResponse.ts:29

getId

getId(): string
Gets the id of the comment.

Returns
the id of the comment.

Returns string
- Defined in main/requests/comment/GetCommentResponse.ts:17

getLikeCount

getLikeCount(): undefined | number
Gets the number of likes in the comment.

Returns
the number of likes in the comment.

Returns undefined | number
- Defined in main/requests/comment/GetCommentResponse.ts:35

getParentMedia

getParentMedia(): undefined | InnerId
Gets the parent media of the comment.

Returns
the parent media of the comment.

Returns undefined | InnerId
- Defined in main/requests/comment/GetCommentResponse.ts:44

getParentMediaId

getParentMediaId(): undefined | string
Gets the parent media id of the comment.

Returns
the parent media id of the comment.

Returns undefined | string
- Defined in main/requests/comment/GetCommentResponse.ts:53

getReplies

getReplies(): undefined | CommentReplyData[]
Gets the replies to the comment.

Returns
the replies to the comment.

Returns undefined | CommentReplyData[]
- Defined in main/requests/comment/GetCommentResponse.ts:62

getText

getText(): undefined | string
Gets the text of the comment.

Returns
the text of the comment.

Returns undefined | string
- Defined in main/requests/comment/GetCommentResponse.ts:71

getTimestamp

getTimestamp(): undefined | string
Gets the timestamp of the comment.

Returns
the timestamp of the comment.

Returns undefined | string
- Defined in main/requests/comment/GetCommentResponse.ts:80

getUser

getUser(): undefined | InnerId
Gets the user that owns the comment.

Returns
the user that owns the comment.

Returns undefined | InnerId
- Defined in main/requests/comment/GetCommentResponse.ts:89

getUserId

getUserId(): undefined | string
Gets the id user that owns the comment.

Returns
the id user that owns the comment.

Returns undefined | string
- Defined in main/requests/comment/GetCommentResponse.ts:98

getUsername

getUsername(): undefined | string
Gets the username of the owner of the comment.

Returns
the username of the owner of the comment.

Returns undefined | string
- Defined in main/requests/comment/GetCommentResponse.ts:107

isHidden

isHidden(): undefined | boolean
Gets whether the comment is hidden.

Returns
whether the comment is hidden.

Returns undefined | boolean
- Defined in main/requests/comment/GetCommentResponse.ts:26

Generated using TypeDoc