Class GetObjectCommentsResponse

Class that represents a response from requests to get the comments on an object.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.7.0

Hierarchy

AbstractResponse<CommentData[]>
- GetObjectCommentsResponse

Index

Constructors

constructor

new GetObjectCommentsResponse(body: {
data: CommentData[];
}): GetObjectCommentsResponse
The constructor.
Parameters
- body: {
  data: CommentData[];
  }
  
  the body of the response.
  - data: CommentData[]
Returns GetObjectCommentsResponse
Overrides AbstractResponse.constructor
- Defined in main/requests/common/GetObjectCommentsResponse.ts:17

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

getHidden

getHidden(): (undefined | boolean)[]
Gets an array with whether each of the comments is hidden. If a comment object does not have the 'hidden' field, 'undefined' is returned for that object.

Returns
an array with whether each of the comments is hidden.

Returns (undefined | boolean)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:84

getHiddenMap

getHiddenMap(): Map<string, undefined | boolean>
Gets a map from the id of the comments to whether they are hidden. If a comment object does not have the 'hidden' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to whether it is hidden.

Returns Map<string, undefined | boolean>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:94

getIds

getIds(): string[]
Gets an array with the ids of all the comments.

Returns
an array with the ids of all the comments.

Returns string[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:26

getLikeCounts

getLikeCounts(): (undefined | number)[]
Gets an array with the like_count of the all the comments. If a comment object does not have the 'like_count' field, 'undefined' is returned for that object.

Returns
an array with the like_count of the all the comments.

Returns (undefined | number)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:108

getLikeCountsMap

getLikeCountsMap(): Map<string, undefined | number>
Gets a map from the id of the comments to their like_count. If a comment object does not have the 'like_count' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'like_count'.

Returns Map<string, undefined | number>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:118

getMediaObjects

getMediaObjects(): (undefined | InnerId)[]
Gets an array with the media of the all the comments. If a comment object does not have the 'media' field, 'undefined' is returned for that object.

Returns
an array with the media of the all the comments.

Returns (undefined | InnerId)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:132

getMediaObjectsMap

getMediaObjectsMap(): Map<string, undefined | InnerId>
Gets a map from the id of the comments to their media. If a comment object does not have the 'media' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'media'.

Returns Map<string, undefined | InnerId>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:142

getReplies

getReplies(): (undefined | CommentReplyData[])[]
Gets an array with the replies of the all the comments. If a comment object does not have the 'replies' field, 'undefined' is returned for that object. The replies field can only be returned for top level comments.

Returns
an array with the replies of the all the comments.

Returns (undefined | CommentReplyData[])[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:157

getRepliesMap

getRepliesMap(): Map<string, undefined | CommentReplyData[]>
Gets a map from the id of the comments to their replies. If a comment object does not have the 'replies' field, 'undefined' is returned for that object. The replies field can only be returned for top level comments.

Returns
a map from the id of the comments to their 'replies'.

Returns Map<string, undefined | CommentReplyData[]>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:168

getTexts

getTexts(): (undefined | string)[]
Gets an array with the text of the all the comments. If a comment object does not have the 'text' field, 'undefined' is returned for that object.

Returns
an array with the text of the all the comments.

Returns (undefined | string)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:36

getTextsMap

getTextsMap(): Map<string, undefined | string>
Gets a map from the id of the comments to their text. If a comment object does not have the 'text' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'text'.

Returns Map<string, undefined | string>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:46

getTimestamps

getTimestamps(): (undefined | string)[]
Gets an array with the timestamp of the all the comments. If a comment object does not have the 'timestamp' field, 'undefined' is returned for that object.

Returns
an array with the timestamp of the all the comments.

Returns (undefined | string)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:60

getTimestampsMap

getTimestampsMap(): Map<string, undefined | string>
Gets a map from the id of the comments to their timestamp. If a comment object does not have the 'timestamp' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'timestamp'.

Returns Map<string, undefined | string>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:70

getUsernames

getUsernames(): (undefined | string)[]
Gets an array with the username of the all the comments. If a media object does not have the 'username' field, 'undefined' is returned for that object.

Returns
an array with the username of the all the comments.

Returns (undefined | string)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:206

getUsernamesMap

getUsernamesMap(): Map<string, undefined | string>
Gets a map from the id of the comments to their username. If a media object does not have the 'username' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'username'.

Returns Map<string, undefined | string>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:216

getUsers

getUsers(): (undefined | InnerId)[]
Gets an array with the user of the all the comments. If a media object does not have the 'user' field, 'undefined' is returned for that object.

Returns
an array with the user of the all the comments.

Returns (undefined | InnerId)[]
- Defined in main/requests/common/GetObjectCommentsResponse.ts:182

getUsersMap

getUsersMap(): Map<string, undefined | InnerId>
Gets a map from the id of the comments to their user. If a media object does not have the 'user' field, 'undefined' is returned for that object.

Returns
a map from the id of the comments to their 'user'.

Returns Map<string, undefined | InnerId>
- Defined in main/requests/common/GetObjectCommentsResponse.ts:192

Class GetObjectCommentsResponse

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

body: { data: CommentData[]; }

data: CommentData[]

Returns GetObjectCommentsResponse

Properties

Protected data

Methods

getData

Returns

Returns CommentData[]

getHidden

Returns

Returns (undefined | boolean)[]

getHiddenMap

Returns

Returns Map<string, undefined | boolean>

getIds

Returns

Returns string[]

getLikeCounts

Returns

Returns (undefined | number)[]

getLikeCountsMap

Returns

Returns Map<string, undefined | number>

getMediaObjects

Returns

Returns (undefined | InnerId)[]

getMediaObjectsMap

Returns

Returns Map<string, undefined | InnerId>

getReplies

Returns

Returns (undefined | CommentReplyData[])[]

getRepliesMap

Returns

Returns Map<string, undefined | CommentReplyData[]>

getTexts

Returns

Returns (undefined | string)[]

getTextsMap

Returns

Returns Map<string, undefined | string>

getTimestamps

Returns

Returns (undefined | string)[]

getTimestampsMap

Returns

Returns Map<string, undefined | string>

getUsernames

Returns

Returns (undefined | string)[]

getUsernamesMap

Returns

Returns Map<string, undefined | string>

getUsers

Returns

Returns (undefined | InnerId)[]

getUsersMap

Returns

Returns Map<string, undefined | InnerId>

Settings

Member Visibility

Theme

body: {
data: CommentData[];
}

`Protected` data