Class MediaRepository

constructor

• new MediaRepository(http: AndroidHttp, state: AndroidState, facade: IgpapiFacade): MediaRepository

• Parameters

  • http: AndroidHttp

  • state: AndroidState

  • facade: IgpapiFacade

  Returns MediaRepository

addMentionedUser

edit

impression

info

updateLikeAndViewCountsVisibility

blocked

• blocked(): Promise<string[]>

• Returns Promise<string[]>

checkOffensiveComment

• checkOffensiveComment(commentText: string, mediaId?: string): Promise<MediaRepositoryCheckOffensiveCommentResponseRootObject>

• Normally, this is requested before each comment is sent to ensure it isn't spam or hateful

  Parameters

  • commentText: string

  • Optional mediaId: string

    The mediaId of the post

  Returns Promise<MediaRepositoryCheckOffensiveCommentResponseRootObject>

comment

• comment(__namedParameters: {
      mediaId: string;
      module?: string;
      replyToCommentId?: string;
      text: string;
  }): Promise<MediaRepositoryCommentResponseComment>

• Parameters

  • __namedParameters: {
        mediaId: string;
        module?: string;
        replyToCommentId?: string;
        text: string;
    }

    • mediaId: string

    • Optional module?: string

    • Optional replyToCommentId?: string

    • text: string

  Returns Promise<MediaRepositoryCommentResponseComment>

commentLike

• commentLike(options: MediaCommentLikeOptions): Promise<StatusResponse>

• Parameters

  • options: MediaCommentLikeOptions

  Returns Promise<StatusResponse>

commentUnlike

• commentUnlike(options: MediaCommentLikeOptions): Promise<StatusResponse>

• Parameters

  • options: MediaCommentLikeOptions

  Returns Promise<StatusResponse>

commentsBulkDelete

• commentsBulkDelete(mediaId: string, commentIds: string[]): Promise<StatusResponse>

• Parameters

  • mediaId: string

  • commentIds: string[]

  Returns Promise<StatusResponse>

commentsDisable

• commentsDisable(mediaId: string | number): Promise<unknown>

• Parameters

  • mediaId: string | number

  Returns Promise<unknown>

commentsEnable

• commentsEnable(mediaId: string | number): Promise<unknown>

• Parameters

  • mediaId: string | number

  Returns Promise<unknown>

configure

• configure(options: MediaConfigureTimelineOptions): Promise<MediaRepositoryConfigureResponseRootObject>

• Configures an upload (indicated by upload_id input option) for the timeline

  Parameters

  • options: MediaConfigureTimelineOptions

    configuration-options

  Returns Promise<MediaRepositoryConfigureResponseRootObject>

configureToIgtv

• configureToIgtv(options: MediaConfigureToIgtvOptions): Promise<unknown>

• Parameters

  • options: MediaConfigureToIgtvOptions

  Returns Promise<unknown>

configureVideo

• configureVideo(options: MediaConfigureTimelineVideoOptions): Promise<MediaRepositoryConfigureResponseRootObject>

• Parameters

  • options: MediaConfigureTimelineVideoOptions

  Returns Promise<MediaRepositoryConfigureResponseRootObject>

delete

• delete(__namedParameters: {
      mediaId: string;
      mediaType?: "PHOTO" | "VIDEO" | "CAROUSEL";
  }): Promise<unknown>

• Deletes a media. Though it is counter-intuitive, this method is also responsible for deleting story from tray

  Parameters

  • __namedParameters: {
        mediaId: string;
        mediaType?: "PHOTO" | "VIDEO" | "CAROUSEL";
    }

    • mediaId: string

    • Optional mediaType?: "PHOTO" | "VIDEO" | "CAROUSEL"

  Returns Promise<unknown>

editMedia

• editMedia(__namedParameters: {
      captionText: string;
      mediaId: string;
  }): Promise<MediaEditResponseRootObject>

• Deprecated

  use igpapi.media.edit({...}) instead

  Parameters

  • __namedParameters: {
        captionText: string;
        mediaId: string;
    }

    • captionText: string

    • mediaId: string

  Returns Promise<MediaEditResponseRootObject>

like

• like(options: LikeRequestOptions): Promise<unknown>

• Deprecated

  use igpapi.impression(...) instead

  Parameters

  • options: LikeRequestOptions

  Returns Promise<unknown>

likers

• likers(id: string): Promise<MediaRepositoryLikersResponseRootObject>

• Parameters

  • id: string

  Returns Promise<MediaRepositoryLikersResponseRootObject>

onlyMe

• onlyMe(mediaId: string): Promise<StatusResponse>

• Parameters

  • mediaId: string

  Returns Promise<StatusResponse>

save

• save(userOptions: string | MediaSaveOptions): Promise<unknown>

• Last update: 5. Apr. 2020

  Parameters

  • userOptions: string | MediaSaveOptions

    or id

  Returns Promise<unknown>

seen

• seen(reels: {
      [item: string]: [string];
  }, module?: AndroidNavModule): Promise<StatusResponse>

• Parameters

  • reels: {
        [item: string]: [string];
    }

    • [item: string]: [string]

  • module: AndroidNavModule = 'feed_timeline'

  Returns Promise<StatusResponse>

storyPollVote

• storyPollVote(mediaId: string, pollId: string | number, vote: "0" | "1"): Promise<MediaUpdatedMediaResponseRootObject>

• Parameters

  • mediaId: string

  • pollId: string | number

  • vote: "0" | "1"

  Returns Promise<MediaUpdatedMediaResponseRootObject>

storyQuestionResponse

• storyQuestionResponse(mediaId: string, questionId: string | number, options: StoryTextQuestionResponse | StoryMusicQuestionResponse): Promise<StatusResponse>

• Parameters

  • mediaId: string

  • questionId: string | number

  • options: StoryTextQuestionResponse | StoryMusicQuestionResponse

  Returns Promise<StatusResponse>

storyQuizAnswer

• storyQuizAnswer(mediaId: string, quizId: string | number, answer: string): Promise<MediaUpdatedMediaResponseRootObject>

• Answers a story quiz

  Parameters

  • mediaId: string

    storyId

  • quizId: string | number

    id of the quiz

  • answer: string

    index (string is only for compatibility)

  Returns Promise<MediaUpdatedMediaResponseRootObject>

storySliderVote

• storySliderVote(mediaId: string, sliderId: string | number, vote: number): Promise<MediaUpdatedMediaResponseRootObject>

• Parameters

  • mediaId: string

  • sliderId: string | number

  • vote: number

  Returns Promise<MediaUpdatedMediaResponseRootObject>

undoOnlyMe

• undoOnlyMe(mediaId: string): Promise<StatusResponse>

• Parameters

  • mediaId: string

  Returns Promise<StatusResponse>

unlike

• unlike(options: UnlikeRequestOptions): Promise<unknown>

• Deprecated

  use igpapi.impression(...) instead

  Parameters

  • options: UnlikeRequestOptions

  Returns Promise<unknown>

unsave

• unsave(mediaId: string): Promise<unknown>

• Parameters

  • mediaId: string

  Returns Promise<unknown>

uploadFinish

• uploadFinish(options: {
      source_type: string;
      upload_id: string;
      video?: {
          audio_muted?: boolean;
          clips?: {
              length: number;
              source_type: string;
          }[];
          length: number;
          poster_frame_index?: number;
      };
  }): Promise<unknown>

• Parameters

  • options: {
        source_type: string;
        upload_id: string;
        video?: {
            audio_muted?: boolean;
            clips?: {
                length: number;
                source_type: string;
            }[];
            length: number;
            poster_frame_index?: number;
        };
    }

    • source_type: string

    • upload_id: string

    • Optional video?: {
          audio_muted?: boolean;
          clips?: {
              length: number;
              source_type: string;
          }[];
          length: number;
          poster_frame_index?: number;
      }

      • Optional audio_muted?: boolean

      • Optional clips?: {
            length: number;
            source_type: string;
        }[]

      • length: number

      • Optional poster_frame_index?: number

  Returns Promise<unknown>