Class GetPageMediaResponse

Class that represents a response from a Page Media request.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Hierarchy

AbstractGetManyMediaResponse
- GetPageMediaResponse

Constructors

constructor

new GetPageMediaResponse(body: {
data: MediaData[];
paging: PagingData;
}): GetPageMediaResponse
The constructor.
Parameters
- body: {
  data: MediaData[];
  paging: PagingData;
  }
  
  the body of the response
  - data: MediaData[]
  - paging: PagingData
Returns GetPageMediaResponse
Overrides AbstractGetManyMediaResponse.constructor
- Defined in main/requests/page/media/GetPageMediaResponse.ts:22

Properties

`Protected` data

data: MediaData[]

The response data.

`Private` `Readonly` paging

paging: Paging

The paging of the response.

Methods

getCaptions

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

Returns
an array with the caption of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getCaptions
- Defined in main/requests/AbstractGetManyMediaResponse.ts:46

getCaptionsMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getCaptionsMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:56

getChildren

getChildren(): (undefined | Children)[]
Gets an array with the children of the all the media objects. If a media object does not have the 'children' field, 'undefined' is returned for that object.

Returns
an array with the children of the all the media objects.

Returns (undefined | Children)[]
Inherited from AbstractGetManyMediaResponse.getChildren
- Defined in main/requests/AbstractGetManyMediaResponse.ts:22

getChildrenMap

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

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

Returns Map<string, undefined | Children>
Inherited from AbstractGetManyMediaResponse.getChildrenMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:32

getCommentsCount

getCommentsCount(): (undefined | number)[]
Gets an array with the comments count of the all the media objects. If a media object does not have the 'comments_count' field, 'undefined' is returned for that object.

Returns
an array with the 'comments_count' of the all the media objects.

Returns (undefined | number)[]
Inherited from AbstractGetManyMediaResponse.getCommentsCount
- Defined in main/requests/AbstractGetManyMediaResponse.ts:70

getCommentsCountMap

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

Returns
a map from the id of the media objects to whether their 'comments_count'.

Returns Map<string, undefined | number>
Inherited from AbstractGetManyMediaResponse.getCommentsCountMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:80

getCommentsEnabled

getCommentsEnabled(): (undefined | boolean)[]
Gets an array with the 'is_comment_enabled' of the all the media objects. If a media object does not have the 'is_comment_enabled' field, 'undefined' is returned for that object.

Returns
an array with the 'is_comment_enabled' of the all the media objects.

Returns (undefined | boolean)[]
Inherited from AbstractGetManyMediaResponse.getCommentsEnabled
- Defined in main/requests/AbstractGetManyMediaResponse.ts:118

getCommentsEnabledMap

getCommentsEnabledMap(): Map<string, undefined | boolean>
Gets a map from the id of the media objects to whether they have comments enabled. If a media object does have not a the 'is_comment_enabled' field, 'undefined' is returned for that object.

Returns
a map from the id of the media objects to whether they have comments enabled.

Returns Map<string, undefined | boolean>
Inherited from AbstractGetManyMediaResponse.getCommentsEnabledMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:128

getData

getData(): MediaData[]
Gets the response data.

Returns
the response data.

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

getIds

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

Returns
an array with the ids of all the media objects.

Returns string[]
Inherited from AbstractGetManyMediaResponse.getIds
- Defined in main/requests/AbstractGetManyMediaResponse.ts:12

getIgIds

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

Returns
an array with the ig_id of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getIgIds
- Defined in main/requests/AbstractGetManyMediaResponse.ts:94

getIgIdsMap

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

Returns
a map from the ig of the media objects to their 'ig_id'.

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getIgIdsMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:104

getLikes

getLikes(): (undefined | number)[]
Gets an array with the like counts of the all the media objects. If a media object does not have the 'like_count' field, 'undefined' is returned for that object.

Returns
an array with the like counts of the all the media objects.

Returns (undefined | number)[]
Inherited from AbstractGetManyMediaResponse.getLikes
- Defined in main/requests/AbstractGetManyMediaResponse.ts:142

getLikesMap

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

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

Returns Map<string, undefined | number>
Inherited from AbstractGetManyMediaResponse.getLikesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:152

getMediaOwnerIds

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

Returns
an array with the id of media owner of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getMediaOwnerIds
- Defined in main/requests/AbstractGetManyMediaResponse.ts:238

getMediaOwnerIdsMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getMediaOwnerIdsMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:248

getMediaOwners

getMediaOwners(): (undefined | {
id: string;
})[]
Gets an array with the media owner of the all the media object. If a media object does not have the 'owner' field, 'undefined' is returned for that object.

Returns
an array with the media owner of the all the media objects.

Returns (undefined | {
id: string;
})[]
Inherited from AbstractGetManyMediaResponse.getMediaOwners
- Defined in main/requests/AbstractGetManyMediaResponse.ts:214

getMediaOwnersMap

getMediaOwnersMap(): Map<string, undefined | {
id: string;
}>
Gets a map from the id of the media objects to their media owner. If a media object does have not a the 'owner' field, 'undefined' is returned for that object.

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

Returns Map<string, undefined | {
id: string;
}>
Inherited from AbstractGetManyMediaResponse.getMediaOwnersMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:224

getMediaProductTypes

getMediaProductTypes(): (undefined | MediaProductType)[]
Gets an array with the media product type of the all the media objects. If a media object does not have the 'media_product_type' field, 'undefined' is returned for that object.

Returns
an array with the media product type of the all the media objects.

Returns (undefined | MediaProductType)[]
Inherited from AbstractGetManyMediaResponse.getMediaProductTypes
- Defined in main/requests/AbstractGetManyMediaResponse.ts:358

getMediaProductTypesMap

getMediaProductTypesMap(): Map<string, undefined | MediaProductType>
Gets a map from the id of the media objects to their media product type. If a media object does have not a the 'media_product_type' field, 'undefined' is returned for that object.

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

Returns Map<string, undefined | MediaProductType>
Inherited from AbstractGetManyMediaResponse.getMediaProductTypesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:368

getMediaTypes

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

Returns
an array with the media types of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getMediaTypes
- Defined in main/requests/AbstractGetManyMediaResponse.ts:166

getMediaTypesMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getMediaTypesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:176

getMediaUrls

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

Returns
an array with the media URLs of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getMediaUrls
- Defined in main/requests/AbstractGetManyMediaResponse.ts:190

getMediaUrlsMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getMediaUrlsMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:200

getPaging

getPaging(): Paging
Gets the paging of the response.

Returns
the paging of the response.

Returns Paging
- Defined in main/requests/page/media/GetPageMediaResponse.ts:32

getPermalinks

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

Returns
an array with the permalinks of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getPermalinks
- Defined in main/requests/AbstractGetManyMediaResponse.ts:262

getPermalinksMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getPermalinksMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:272

getShortcodes

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

Returns
an array with the shortcodes of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getShortcodes
- Defined in main/requests/AbstractGetManyMediaResponse.ts:286

getShortcodesMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getShortcodesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:296

getTimestamps

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

Returns
an array with the timestamps of the all the media objects.

Returns (undefined | Date)[]
Inherited from AbstractGetManyMediaResponse.getTimestamps
- Defined in main/requests/AbstractGetManyMediaResponse.ts:310

getTimestampsMap

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

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

Returns Map<string, undefined | Date>
Inherited from AbstractGetManyMediaResponse.getTimestampsMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:320

getUsernames

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

Returns
an array with the usernames of the all the media objects.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getUsernames
- Defined in main/requests/AbstractGetManyMediaResponse.ts:334

getUsernamesMap

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

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

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getUsernamesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:344

getVideoTitles

getVideoTitles(): (undefined | string)[]
Gets an array with the video titles of the all the media objects. If a media object does not have the 'video_title' field, 'undefined' is returned for that object.

Returns
an array with the video titles of the all the media objects.

Deprecated
this is no longer returned when using the latest versions of the API.

Returns (undefined | string)[]
Inherited from AbstractGetManyMediaResponse.getVideoTitles
- Defined in main/requests/AbstractGetManyMediaResponse.ts:384

getVideoTitlesMap

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

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

Deprecated
this is no longer returned when using the latest versions of the API.

Returns Map<string, undefined | string>
Inherited from AbstractGetManyMediaResponse.getVideoTitlesMap
- Defined in main/requests/AbstractGetManyMediaResponse.ts:396

Class GetPageMediaResponse

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

body: { data: MediaData[]; paging: PagingData; }

data: MediaData[]

paging: PagingData

Returns GetPageMediaResponse

Properties

Protected data

Private Readonly paging

Methods

getCaptions

Returns

Returns (undefined | string)[]

getCaptionsMap

Returns

Returns Map<string, undefined | string>

getChildren

Returns

Returns (undefined | Children)[]

getChildrenMap

Returns

Returns Map<string, undefined | Children>

getCommentsCount

Returns

Returns (undefined | number)[]

getCommentsCountMap

Returns

Returns Map<string, undefined | number>

getCommentsEnabled

Returns

Returns (undefined | boolean)[]

getCommentsEnabledMap

Returns

Returns Map<string, undefined | boolean>

getData

Returns

Returns MediaData[]

getIds

Returns

Returns string[]

getIgIds

Returns

Returns (undefined | string)[]

getIgIdsMap

Returns

Returns Map<string, undefined | string>

getLikes

Returns

Returns (undefined | number)[]

getLikesMap

Returns

Returns Map<string, undefined | number>

getMediaOwnerIds

Returns

Returns (undefined | string)[]

getMediaOwnerIdsMap

Returns

Returns Map<string, undefined | string>

getMediaOwners

Returns

Returns (undefined | { id: string; })[]

getMediaOwnersMap

Returns

Returns Map<string, undefined | { id: string; }>

getMediaProductTypes

Returns

Returns (undefined | MediaProductType)[]

getMediaProductTypesMap

Returns

Returns Map<string, undefined | MediaProductType>

getMediaTypes

body: {
data: MediaData[];
paging: PagingData;
}

`Protected` data

`Private` `Readonly` paging

Returns (undefined | {
id: string;
})[]

Returns Map<string, undefined | {
id: string;
}>