Class AbstractGetManyMediaResponse

An abstract class to represent a response from the Instagram Graph API.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.2.0

Hierarchy

Constructors

constructor

Properties

data

Methods

getCaptions getCaptionsMap getChildren getChildrenMap getCommentsCount getCommentsCountMap getCommentsEnabled getCommentsEnabledMap getData getIds getIgIds getIgIdsMap getLikes getLikesMap getMediaOwnerIds getMediaOwnerIdsMap getMediaOwners getMediaOwnersMap getMediaProductTypes getMediaProductTypesMap getMediaTypes getMediaTypesMap getMediaUrls getMediaUrlsMap getPermalinks getPermalinksMap getShortcodes getShortcodesMap getTimestamps getTimestampsMap getUsernames getUsernamesMap getVideoTitles getVideoTitlesMap

Constructors

constructor

Properties

Protected data

data: MediaData[]

The response data.

Methods

getCaptions

  • 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)[]

getCaptionsMap

  • 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>

getChildren

  • 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)[]

getChildrenMap

  • 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>

getCommentsCount

  • 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)[]

getCommentsCountMap

  • 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>

getCommentsEnabled

  • 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)[]

getCommentsEnabledMap

  • 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>

getData

getIds

getIgIds

  • 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)[]

getIgIdsMap

  • 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>

getLikes

  • 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)[]

getLikesMap

  • 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>

getMediaOwnerIds

  • 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)[]

getMediaOwnerIdsMap

  • 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>

getMediaOwners

  • 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;
    })[]

getMediaOwnersMap

  • 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;
    }>

getMediaProductTypes

  • 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)[]

getMediaProductTypesMap

  • 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>

getMediaTypes

  • 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)[]

getMediaTypesMap

  • 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>

getMediaUrls

  • 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)[]

getMediaUrlsMap

  • 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>

getPermalinks

  • 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)[]

getPermalinksMap

  • 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>

getShortcodes

  • 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)[]

getShortcodesMap

  • 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>

getTimestamps

  • 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)[]

getTimestampsMap

  • 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>

getUsernames

  • 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)[]

getUsernamesMap

  • 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>

getVideoTitles

  • 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)[]

getVideoTitlesMap

  • 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>

Settings

Member Visibility

Theme

Generated using TypeDoc