instagram-graph-api
Version:
A library to help perform requests to the Instagram Graph API.
151 lines (150 loc) • 6.28 kB
TypeScript
import { AbstractResponse } from '../../AbstractResponse';
import { Children } from '../../data/Common';
import { HashtagMediaData } from '../../data/HashtagMediaData';
import { Paging, PagingData } from '../../data/Paging';
/**
* Class that represents a response from a Get Hashtag Media request.
*
* @author Tiago Grosso <tiagogrosso99@gmail.com>
* @since 0.5.0
*/
export declare class GetHashtagMediaResponse extends AbstractResponse<HashtagMediaData[]> {
/**
* The paging of the response.
*/
private paging;
/**
* The constructor.
*
* @param body the body of the response.
* @param paging the paging of the response.
*/
constructor(body: {
data: HashtagMediaData[];
paging: PagingData;
});
/**
* Gets the paging of the response.
*
* @returns the paging of the response.
*/
getPaging(): Paging;
/**
* Gets an array with the ids of all the media objects.
*
* @returns an array with the ids of all the media objects.
*/
getIds(): string[];
/**
* 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.
*/
getChildren(): (Children | undefined)[];
/**
* 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'.
*/
getChildrenMap(): Map<string, Children | undefined>;
/**
* 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.
*/
getCaptions(): (string | undefined)[];
/**
* 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'.
*/
getCaptionsMap(): Map<string, string | undefined>;
/**
* 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.
*/
getCommentsCount(): (number | undefined)[];
/**
* 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'.
*/
getCommentsCountMap(): Map<string, number | undefined>;
/**
* 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.
*/
getLikes(): (number | undefined)[];
/**
* 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'.
*/
getLikesMap(): Map<string, number | undefined>;
/**
* 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.
*/
getMediaTypes(): (string | undefined)[];
/**
* 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'.
*/
getMediaTypesMap(): Map<string, string | undefined>;
/**
* 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.
*/
getMediaUrls(): (string | undefined)[];
/**
* 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'.
*/
getMediaUrlsMap(): Map<string, string | undefined>;
/**
* Gets an array with the media owner of the all the permalinks.
* 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.
*/
getPermalinks(): (string | undefined)[];
/**
* 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'.
*/
getPermalinksMap(): Map<string, string | undefined>;
/**
* Gets an array with the media owner of the all the timestamps.
* 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.
*/
getTimestamps(): (Date | undefined)[];
/**
* 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'.
*/
getTimestampsMap(): Map<string, Date | undefined>;
}