instagram-graph-api
Version:
A library to help perform requests to the Instagram Graph API.
44 lines (43 loc) • 1.48 kB
TypeScript
import { UserTag } from '../../Params';
import { MediaType } from './AbstractPostPageMediaRequest';
import { AbstractPostPageTimelineMediaRequest } from './AbstractPostTimelineMediaRequest';
/**
* A request that creates a new Photo Media container.
*
* @author Tiago Grosso <tiagogrosso99@gmail.com>
* @since 1.1.0
*/
export declare class PostPagePhotoMediaRequest extends AbstractPostPageTimelineMediaRequest {
/**
* The constructor
*
* @param accessToken the access token.
* @param pageId the page id.
* @param imageUrl the image URL.
* @param caption the caption.
* @param locationId the location id.
* @param userTags the user_tags.
* @param isCarousel whether the media is a carousel.
*/
constructor(accessToken: string, pageId: string, imageUrl: string, caption?: string, locationId?: string, userTags?: UserTag[], isCarousel?: boolean);
/**
* Sets the user_tags in the request.
*
* @param userTags the user_tags.
*
* @returns this object, for chained invocation.
*/
withUserTags(userTags: UserTag[]): PostPagePhotoMediaRequest;
/**
* Sets the is_carousel param in the request.
*
* @param isCarousel whether the media is a carousel.
*
* @returns this object, for chained invocation.
*/
withIsCarousel(isCarousel: boolean): PostPagePhotoMediaRequest;
/**
* @inheritdoc
*/
protected mediaType(): MediaType | undefined;
}