Class GetMediaInfoResponse

Class that represents a response from a Media request.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Hierarchy

AbstractResponse<MediaData>
- GetMediaInfoResponse

Index

Constructors

Properties

Methods

getCaption getCommentsCount getData getId getIgId getLikeCount getMediaProductType getMediaType getMediaUrl getOwner getOwnerId getPermalink getShortcode getTimestamp getUsername getVideoTitle isCommentsEnabled

Constructors

constructor

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

Properties

`Protected` data

data: MediaData

The response data.

Methods

getCaption

getCaption(): undefined | string
Gets the caption of the media object.

Returns
the caption of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:26

getCommentsCount

getCommentsCount(): undefined | number
Gets the comments count of the media object.

Returns
the comments count of the media object.

Returns undefined | number
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:44

getData

getData(): MediaData
Gets the response data.

Returns
the response data.

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

getId

getId(): string
Gets the id of the media object.

Returns
the id of the media object.

Returns string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:17

getIgId

getIgId(): undefined | string
Gets the ig_id of the media object.

Returns
the ig_id of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:35

getLikeCount

getLikeCount(): undefined | number
Gets the like count of the media object.

Returns
the like count of the media object.

Returns undefined | number
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:62

getMediaProductType

getMediaProductType(): undefined | MediaProductType
Gets the surface where the media is published.

Returns
the surface where the media is published.

Returns undefined | MediaProductType
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:143

getMediaType

getMediaType(): undefined | string
Gets the type of the media object.

Returns
the type of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:71

getMediaUrl

getMediaUrl(): undefined | string
Gets the URL of the media object.

Returns
the URL of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:80

getOwner

getOwner(): undefined | {
id: string;
}
Gets the owner of the media object.

Returns
the owner of the media object.

Returns undefined | {
id: string;
}
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:89

getOwnerId

getOwnerId(): undefined | string
Gets the owner id of the media object.

Returns
the owner id of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:98

getPermalink

getPermalink(): undefined | string
Gets the permalink of the media object.

Returns
the permalink of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:107

getShortcode

getShortcode(): undefined | string
Gets the shortcode of the media object.

Returns
the shortcode of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:116

getTimestamp

getTimestamp(): undefined | Date
Gets the timestamp of the media object.

Returns
the timestamp of the media object.

Returns undefined | Date
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:125

getUsername

getUsername(): undefined | string
Gets the username of the media object.

Returns
the username of the media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:134

getVideoTitle

getVideoTitle(): undefined | string
Gets the video title of the IGTV media object.

Returns
the video title of the IGTV media object.

Returns undefined | string
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:152

isCommentsEnabled

isCommentsEnabled(): undefined | boolean
Whether comments are enabled on the media object.

Returns
whether comments are enabled on the media object.

Returns undefined | boolean
- Defined in main/requests/media/info/GetMediaInfoResponse.ts:53

Generated using TypeDoc