IGPAPI

https://docs.igpapi.com/
Admin
IGPAPI is a comprehensive Instagram Private API TypeScript SDK for Node.js runtime, providing...
Tokens:1,019,376
Snippets:5,318
Trust Score:4.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://docs.igpapi.com/_igpapi/android/LiveFacade

Starts a live broadcast.

```APIDOC
## start

### Description
Starts a live broadcast.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **broadcastId** (string) - Required - The ID of the broadcast.
- **sendNotifications** (boolean) - Optional - Whether to send notifications when starting.
```

--------------------------------

### NewsLogInput pk Example

Source: https://docs.igpapi.com/_igpapi/android/NewsLogInput

Provides an example of a valid pk string for the NewsLogInput interface. This value can be found in the news/inbox item object.

```string
z8PtgT9Je8xZdGJpIf/3BYQIwk0=
```

--------------------------------

### start

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Starts a live broadcast. Requires broadcastId and an optional sendNotifications flag, returning a promise that resolves to LiveStartBroadcastResponse.

```APIDOC
## start

### Description
Initiates a live broadcast.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
#### Input Parameters
- **broadcastId** (string) - Required - The ID of the broadcast to start.
- **sendNotifications** (boolean) - Optional - Whether to send notifications to followers upon starting the broadcast.

### Response
#### Success Response
- **LiveStartBroadcastResponse** - The response object confirming the broadcast has started.

### Response Example
```json
// Response structure depends on LiveStartBroadcastResponse definition
```
```

--------------------------------

### Multiple User IDs Example

Source: https://docs.igpapi.com/_igpapi/ios/RecoveryNonceLoginInput

Example of multiple user IDs, assumed to be comma-separated, for the userIds property.

```text
111111111,222222222
```

--------------------------------

### Example Web URI for Story Post

Source: https://docs.igpapi.com/_igpapi/android/StoryPostInput

Provides an example of a web URI that can be attached to a story post. Note that igtvId and webUri cannot be used simultaneously.

```plaintext
https://gitlab.com/igpapi/igpapi
```

--------------------------------

### preLiveTools

Source: https://docs.igpapi.com/_igpapi/android/LiveFacade

Accesses tools or settings available before a live broadcast starts.

```APIDOC
## preLiveTools

### Description
Accesses tools available before the live broadcast starts.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None
```

--------------------------------

### DirectFacade.message.guide

Source: https://docs.igpapi.com/_igpapi/android/DirectFacade

Sends a guide message within a direct thread.

```APIDOC
## message.guide

### Description
Sends a guide message within a direct thread.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **input** (DirectBroadcastGuideMessageInput) - Required - Input object for sending a guide message.

### Request Example
```json
{
  "input": { ... DirectBroadcastGuideMessageInput ... }
}
```

### Response
#### Success Response (200)
- **DirectBroadcastMessage** - The response object for the sent guide message.
```

--------------------------------

### url Method

Source: https://docs.igpapi.com/_igpapi/android/TrayStoryConfiguration

Gets the URL for the story tray configuration.

```APIDOC
## url

### Description
Retrieves the URL associated with the story tray configuration.

### Returns
* **string** - The URL for the story tray configuration.
```

--------------------------------

### Example Reaction Type String

Source: https://docs.igpapi.com/_igpapi/ios/DirectBroadcastReactionMessageInput

Demonstrates a valid string value for the reactionType property.

```typescript
"like"
```

--------------------------------

### DirectBroadcastGuideMessageInput Interface

Source: https://docs.igpapi.com/_igpapi/android/DirectBroadcastGuideMessageInput

The DirectBroadcastGuideMessageInput interface defines the structure for providing guide information.

```APIDOC
## Interface DirectBroadcastGuideMessageInput

This interface is used to structure the input for broadcast guide messages.

### Properties

*   **guideId** (string) - Required - The unique identifier for the guide.
```

--------------------------------

### Install @igpapi/ios

Source: https://docs.igpapi.com/_igpapi/ios

Install the @igpapi/ios package using yarn.

```bash
yarn add @igpapi/ios
```

--------------------------------

### videoShouldStart Function

Source: https://docs.igpapi.com/_igpapi/pigeon-nest/videoShouldStart

The videoShouldStart function is used to initiate video playback. It takes the video item, context, and optional settings as arguments.

```APIDOC
## Function videoShouldStart
  * videoShouldStart(
item: FeedVideoItem,
ctx: FeedContext,
opts: {
seqNum?: number;
sessionValidationToken: string;
viewerSessionId: string;
},
): Effect<PigeonEvent, never, MobileSession>

#### Parameters
    * item: FeedVideoItem
    * ctx: FeedContext
    * opts: { seqNum?: number; sessionValidationToken: string; viewerSessionId: string }

#### Returns Effect<PigeonEvent, never, MobileSession>
```

--------------------------------

### Install @igpapi/pigeon-nest

Source: https://docs.igpapi.com/_igpapi/pigeon-nest

Install the pigeon-nest package using yarn.

```bash
yarn add @igpapi/pigeon-nest
```

--------------------------------

### build Method

Source: https://docs.igpapi.com/_igpapi/android/TrayStoryConfiguration

Builds the configuration for the story tray.

```APIDOC
## build

### Description
Builds the configuration object for the story tray.

### Returns
* **{ audience: string; configure_mode: string }** - An object containing the audience and configure_mode.
```

--------------------------------

### Install @igpapi/android

Source: https://docs.igpapi.com/_igpapi/android

Install the @igpapi/android package using yarn.

```bash
yarn add @igpapi/android
```

--------------------------------

### Upload Start Segmented Video

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Starts the upload process for a segmented video.

```APIDOC
## upload.startSegmentedVideo

### Description
Starts the upload process for a segmented video.

### Method
Not specified (likely a function call within an SDK)

### Endpoint
Not specified

### Parameters
#### Arguments
- **input** ({ ruploadParams: Record<string, string | undefined> }) - Required - Input parameters for starting the segmented video upload.
  - **ruploadParams** (Record<string, string | undefined>) - Required - Upload parameters.
```

--------------------------------

### NavigationDeltaLoginReviewScreen Constructor

Source: https://docs.igpapi.com/_igpapi/ios/NavigationDeltaLoginReviewScreen

Initializes a new instance of the NavigationDeltaLoginReviewScreen class.

```APIDOC
## new NavigationDeltaLoginReviewScreen

### Description
Initializes a new instance of the NavigationDeltaLoginReviewScreen class.

### Parameters
* `args` (object) - Required. An object containing the initial state and submit function.
  * `state` (NavigationDeltaLoginReviewFullState) - Readonly. The initial state of the login review.
  * `submit` (function) - Readonly. A function to submit a choice ('0' or '1'). Returns a Promise.

### Returns
NavigationDeltaLoginReviewScreen - A new instance of the class.
```

--------------------------------

### Single User ID Example

Source: https://docs.igpapi.com/_igpapi/ios/RecoveryNonceLoginInput

Example of a single user ID for the userIds property.

```text
111111111
```

--------------------------------

### create

Source: https://docs.igpapi.com/_igpapi/android/LiveFacade

Creates a new live broadcast.

```APIDOC
## create

### Description
Creates a new live broadcast.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **input** (LiveCreateInput) - Required - Input object for creating a live broadcast.
```

--------------------------------

### WebViewHttp Constructor

Source: https://docs.igpapi.com/_igpapi/core/mobile/WebViewHttp

Initializes a new instance of the WebViewHttp class.

```APIDOC
## constructor
  * new WebViewHttp(_: never): WebViewHttp
#### Parameters
    * _: never
#### Returns WebViewHttp
```

--------------------------------

### PostingCollabAcceptInput Media ID Example

Source: https://docs.igpapi.com/_igpapi/android/PostingCollabAcceptInput

An example of a media ID string used with PostingCollabAcceptInput.

```plaintext
1111111111111111111_22222222222
```

--------------------------------

### NavigationDeltaLoginReviewScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/NavigationDeltaLoginReviewScreen

Initializes a new instance of the NavigationDeltaLoginReviewScreen class. It requires the current state and a submit function.

```APIDOC
## constructor
  * new NavigationDeltaLoginReviewScreen(
args: {
state: NavigationDeltaLoginReviewFullState;
submit: (choice: "0" | "1") => Promise<unknown>;
},
): NavigationDeltaLoginReviewScreen
#### Parameters
    * args: {
state: NavigationDeltaLoginReviewFullState;
submit: (choice: "0" | "1") => Promise<unknown>;
}
      * ##### `Readonly`state: NavigationDeltaLoginReviewFullState
      * ##### `Readonly`submit: (choice: "0" | "1") => Promise<unknown>
```

--------------------------------

### LogoutSessionInput sessionId Example

Source: https://docs.igpapi.com/_igpapi/android/LogoutSessionInput

Example of a sessionId string value used for the LogoutSessionInput interface.

```json
"4:1654109414"
```

--------------------------------

### Start Segmented Video Upload

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Starts the upload process for a segmented video. Requires ruploadParams.

```APIDOC
## upload.startSegmentedVideo

### Description
Starts the upload process for a segmented video. Requires ruploadParams.

### Method
Not specified (likely a function call within a SDK)

### Endpoint
Not specified

### Parameters
#### Input
- **input** ({ ruploadParams: Record<string, string | undefined> }): Input object for starting segmented video upload.
  - **ruploadParams** (Record<string, string | undefined>): Parameters for the upload.

### Request Example
```json
{
  "example": "Not specified"
}
```

### Response
#### Success Response
- **UploadStartSegmentedVideoResponse**: The response object for starting a segmented video upload.

#### Response Example
```json
{
  "example": "Not specified"
}
```
```

--------------------------------

### initVideo

Source: https://docs.igpapi.com/_igpapi/ios/UploadFacade

Initializes a video upload. This method prepares the system for a new video upload and returns an offset for subsequent operations.

```APIDOC
## initVideo

### Description
Initializes a video upload. This method prepares the system for a new video upload and returns an offset for subsequent operations.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **input** (UploadInitVideoInput) - Required - Input object for initializing video upload.

### Request Example
```json
{
  "input": {
    "ruploadParams": {
      "param1": "value1"
    },
    "videoSize": 1000000,
    "mimeType": "video/mp4"
  }
}
```

### Response
#### Success Response (200)
- **offset** (number) - The offset for the next operation.

#### Response Example
```json
{
  "offset": 0
}
```
```

--------------------------------

### UfacBotCaptchaRecaptchaScreen Constructor

Source: https://docs.igpapi.com/_igpapi/ios/UfacBotCaptchaRecaptchaScreen

Initializes a new instance of the UfacBotCaptchaRecaptchaScreen class. This constructor requires a configuration object containing controller, siteKey, submit function, and url.

```APIDOC
## new UfacBotCaptchaRecaptchaScreen

### Description
Initializes a new instance of the UfacBotCaptchaRecaptchaScreen class.

### Parameters
#### Arguments
- **args** (object) - Required - Configuration object for the screen.
  - **controller** (UfacPayload) - Required - The controller for the Ufac payload.
  - **siteKey** (string) - Required - The reCAPTCHA site key.
  - **submit** (function) - Required - A function that takes a captcha string and returns a Promise resolving to Bloks.BloksResponse.
  - **url** (string) - Required - The URL associated with the reCAPTCHA.

### Returns
- UfacBotCaptchaRecaptchaScreen - A new instance of the UfacBotCaptchaRecaptchaScreen.
```

--------------------------------

### RecoveryCodeVerifyInput Example Phone Number

Source: https://docs.igpapi.com/_igpapi/ios/RecoveryCodeVerifyInput

Provides an example of a phone number format for the phoneNumber property of the RecoveryCodeVerifyInput interface.

```text
+79999999999
```

--------------------------------

### MobileApplication Constructor

Source: https://docs.igpapi.com/_igpapi/core/mobile/MobileApplication

Initializes a new instance of the MobileApplication class.

```APIDOC
## constructor
  * new MobileApplication(_: never): MobileApplication
#### Parameters
    * _ (never) - Description of the parameter
#### Returns MobileApplication
```

--------------------------------

### UfacBotCaptchaRecaptchaScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/UfacBotCaptchaRecaptchaScreen

Initializes a new instance of the UfacBotCaptchaRecaptchaScreen class with the necessary parameters.

```APIDOC
## Constructor

### new UfacBotCaptchaRecaptchaScreen(args)

Initializes a new instance of the `UfacBotCaptchaRecaptchaScreen` class.

#### Parameters

*   **args** (object) - Required - An object containing the following properties:
    *   **controller** (UfacPayload) - Required - The controller payload.
    *   **siteKey** (string) - Required - The reCAPTCHA site key.
    *   **submit** (function) - Required - A function that submits the captcha token and returns a Promise resolving to `Bloks.BloksResponse`.
    *   **url** (string) - Required - The URL associated with the reCAPTCHA challenge.

#### Returns

*   `UfacBotCaptchaRecaptchaScreen` - A new instance of the class.
```

--------------------------------

### IgConfigureVideoError Constructor

Source: https://docs.igpapi.com/_igpapi/core/index/IgConfigureVideoError

Initializes a new instance of the IgConfigureVideoError class.

```APIDOC
## Constructor

### constructor
  * new IgConfigureVideoError(  
args: { body: unknown; videoInfo?: unknown },  
): IgConfigureVideoError
#### Parameters
    * args: { body: unknown; videoInfo?: unknown }
#### Returns IgConfigureVideoError
```

--------------------------------

### NewsLogInput tuuid Example

Source: https://docs.igpapi.com/_igpapi/android/NewsLogInput

Provides an example of a valid tuuid string for the NewsLogInput interface. This value can be found in the news/inbox item object's arguments.

```string
06d63a32-7bbc-11eb-8080-808080808080
```

--------------------------------

### Start Video Selfie

Source: https://docs.igpapi.com/_igpapi/android/UfacAuthenticityWizardScreen

Initiates the video selfie process by firing the IXT authenticity-wizard trigger, typically invoked when a user taps a 'Start video selfie' button.

```APIDOC
## startVideoSelfie

### Description
Fire the IXT authenticity-wizard trigger observed when the user taps "Start video selfie".

### Method
N/A (SDK method)

### Parameters
None

### Response
#### Success Response (Bloks.BloksResponse)
- **response** (Bloks.BloksResponse) - The response after initiating the video selfie process.
```

--------------------------------

### Example IGTV ID for Story Post

Source: https://docs.igpapi.com/_igpapi/android/StoryPostInput

Provides an example of a valid IGTV video ID that can be attached to a story post. Note that igtvId and webUri cannot be used simultaneously.

```plaintext
2308255451735650132
```

--------------------------------

### NavigationSelectVerifyMethodScreen Constructor

Source: https://docs.igpapi.com/_igpapi/ios/NavigationSelectVerifyMethodScreen

Initializes a new instance of the NavigationSelectVerifyMethodScreen class. It takes an object containing the current state and a submit function as arguments.

```APIDOC
## constructor
  * new NavigationSelectVerifyMethodScreen<S = unknown>(
args: { state: S; submit: (choice: string) => Promise<unknown> },
): NavigationSelectVerifyMethodScreen<S>
#### Type Parameters
    * S = unknown
#### Parameters
    * args: { state: S; submit: (choice: string) => Promise<unknown> }
      * ##### `Readonly`state: S
      * ##### `Readonly`submit: (choice: string) => Promise<unknown>
#### Returns NavigationSelectVerifyMethodScreen<S>
```

--------------------------------

### NavigationSubmitPhoneScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/NavigationSubmitPhoneScreen

Initializes a new instance of the NavigationSubmitPhoneScreen class. It requires state information including bloks_action, challenge_context, cni, flow_render_type, step_name, and a submit function.

```APIDOC
## constructor
  * new NavigationSubmitPhoneScreen(
args: {
state: {
bloks_action: string;
challenge_context: string;
cni: string | number;
flow_render_type: 3;
step_name: "submit_phone";
};
submit: (phoneNumber: string) => Promise<unknown>;
},
): NavigationSubmitPhoneScreen
#### Parameters
    * args: {
state: {
bloks_action: string;
challenge_context: string;
cni: string | number;
flow_render_type: 3;
step_name: "submit_phone";
};
submit: (phoneNumber: string) => Promise<unknown>;
}
#### Returns NavigationSubmitPhoneScreen
```

--------------------------------

### NavigationScrapingWarningScreen Methods

Source: https://docs.igpapi.com/_igpapi/ios/NavigationScrapingWarningScreen

Provides access to the `get` and `submit` methods for interacting with the scraping warning screen. The `get` method retrieves the current state, and the `submit` method allows for submitting actions.

```APIDOC
## Properties
get: () => Promise<unknown>;
state: {
bloks_action: string;
challenge_context: string;
cni: string | number;
flow_render_type: 3;
step_name: "scraping_warning";
};
submit: () => Promise<unknown>;

## Methods
### get
Retrieves the current state of the scraping warning.

### submit
Submits an action related to the scraping warning.
```

--------------------------------

### UfacUnimplementedScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/UfacUnimplementedScreen

Initializes a new instance of the UfacUnimplementedScreen class.

```APIDOC
## constructor
  * new UfacUnimplementedScreen(
args: { controller: UfacPayload },
): UfacUnimplementedScreen
#### Parameters
    * args: { controller: UfacPayload }
#### Returns UfacUnimplementedScreen
```

--------------------------------

### url Method

Source: https://docs.igpapi.com/_igpapi/ios/TrayStoryConfiguration

Gets the URL for the story configuration.

```APIDOC
## url

### Description
Gets the URL for the story configuration.

### Signature
`url(): string`

### Returns
The URL string for the story configuration.
```

--------------------------------

### Reel Settings - Get

Source: https://docs.igpapi.com/_igpapi/android/SettingsFacade

Retrieves current reel settings.

```typescript
get: (...args: []) => Promise<ReelSettingsGetResponse>;
```

--------------------------------

### NavigationSelectVerifyMethodScreen Methods

Source: https://docs.igpapi.com/_igpapi/ios/NavigationSelectVerifyMethodScreen

Provides methods for interacting with the screen, including functional composition with 'pipe'.

```APIDOC
## Methods
### pipe
  * pipe<A>(this: A): A
#### Type Parameters
    * A
#### Parameters
    * this: A
#### Returns A
  * pipe<A, B = never>(this: A, ab: (_: A) => B): B
#### Type Parameters
    * A
    * B = never
#### Parameters
    * this: A
    * ab: (_: A) => B
#### Returns B
  * pipe<A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C
#### Type Parameters
    * A
    * B = never
    * C = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
#### Returns C
  * pipe<A, B = never, C = never, D = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
): D
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
#### Returns D
  * pipe<A, B = never, C = never, D = never, E = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
): E
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
#### Returns E
  * pipe<A, B = never, C = never, D = never, E = never, F = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
 ef: (_: E) => F,
): F
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
#### Returns F
  * pipe<A, B = never, C = never, D = never, E = never, F = never, G = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
 ef: (_: E) => F,
 fg: (_: F) => G,
): G
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
#### Returns G
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
 ef: (_: E) => F,
 fg: (_: F) => G,
 gh: (_: G) => H,
): H
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
    * gh: (_: G) => H
#### Returns H
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
I = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
 ef: (_: E) => F,
 fg: (_: F) => G,
 gh: (_: G) => H,
 hi: (_: H) => I,
): I
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
    * I = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
    * gh: (_: G) => H
    * hi: (_: H) => I
#### Returns I
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
I = never,
J = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
 ef: (_: E) => F,
 fg: (_: F) => G,
 gh: (_: G) => H,
 hi: (_: H) => I,
 ij: (_: I) => J,
): J
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
    * I = never
    * J = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
    * gh: (_: G) => H
    * hi: (_: H) => I
    * ij: (_: I) => J
#### Returns J
```

--------------------------------

### WebUnimplementedScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/WebUnimplementedScreen

Initializes a new instance of the WebUnimplementedScreen class.

```APIDOC
## constructor
  * new WebUnimplementedScreen(args: { state: unknown }): WebUnimplementedScreen
#### Parameters
    * args: { state: unknown }
#### Returns WebUnimplementedScreen
```

--------------------------------

### Get Live Settings

Source: https://docs.igpapi.com/_igpapi/ios/createMobileRuntime

Retrieves current live notification settings.

```typescript
settings: {
live: {
get: (...args: []) => Promise<LiveSettingsGetResponse>;

```

--------------------------------

### IgChallengeUnknownResponseError Constructor

Source: https://docs.igpapi.com/_igpapi/ios/IgChallengeUnknownResponseError

Initializes a new instance of the IgChallengeUnknownResponseError class.

```APIDOC
## constructor
  * new IgChallengeUnknownResponseError(
args: { response: unknown },
): IgChallengeUnknownResponseError
#### Parameters
    * args: { response: unknown }
#### Returns IgChallengeUnknownResponseError
```

--------------------------------

### WebViewHeaders Constructor

Source: https://docs.igpapi.com/_igpapi/core/mobile/WebViewHeaders

Initializes a new instance of the WebViewHeaders class.

```APIDOC
## constructor
  * new WebViewHeaders(_: never): WebViewHeaders
#### Parameters
    * _: never
#### Returns WebViewHeaders
```

--------------------------------

### Get Live Settings

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Retrieves the current live streaming settings.

```APIDOC
## GET /api/v1/settings/live

### Description
Retrieves live settings.

### Method
GET

### Endpoint
/api/v1/settings/live

### Response
#### Success Response (200)
- **settings** (LiveSettingsGetResponse) - The current live settings.

#### Response Example
```json
{
  "settings": {
    "enabled": true
  }
}
```
```

--------------------------------

### RedirectScrapingWarningScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/RedirectScrapingWarningScreen

Initializes a new instance of the RedirectScrapingWarningScreen class.

```APIDOC
## constructor
  * new RedirectScrapingWarningScreen(
args: {
get: () => Promise<unknown>;
resolved: RedirectResolveResult;
submit: () => Promise<unknown>;
},
): RedirectScrapingWarningScreen
#### Parameters
    * args: {
get: () => Promise<unknown>;
resolved: RedirectResolveResult;
submit: () => Promise<unknown>;
}
#### Returns RedirectScrapingWarningScreen
```

--------------------------------

### Get Live Settings

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Retrieves the current live notification settings.

```APIDOC
## Get Live Settings

### Description
Retrieves the current live notification settings.

### Method Signature
`settings.live.get()`

### Returns
A Promise resolving to LiveSettingsGetResponse.
```

--------------------------------

### Get Recent Searches

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Retrieves a list of recent search queries.

```APIDOC
## Get Recent Searches

### Description
Retrieves a list of recent search queries.

### Method Signature
`search.recentSearches()`

### Returns
A Promise resolving to RecentSearchesResponse.
```

--------------------------------

### preLiveTools

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Accesses pre-live tools for a broadcast. This method does not take arguments and returns a promise that resolves to unknown.

```APIDOC
## preLiveTools

### Description
Provides access to tools and settings available before a live broadcast starts.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
This method does not accept any parameters.

### Response
#### Success Response
- The response type is unknown as specified in the source.

### Response Example
```json
// Response structure is unknown
```
```

--------------------------------

### Privacy Settings - Get Messages

Source: https://docs.igpapi.com/_igpapi/android/SettingsFacade

Retrieves privacy messages settings.

```typescript
get: (...args: []) => Promise<SettingsPrivacyMessagesGetResponse>;
```

--------------------------------

### UfacAwaitingReviewScreen Constructor

Source: https://docs.igpapi.com/_igpapi/ios/UfacAwaitingReviewScreen

Initializes a new instance of the UfacAwaitingReviewScreen class.

```APIDOC
## new UfacAwaitingReviewScreen(args)

### Description
Initializes a new instance of the UfacAwaitingReviewScreen class.

### Parameters
#### args
- **controller** (UfacPayload) - Required - The controller object.
- **poll** (() => Promise<Bloks.BloksResponse>) - Required - A function to perform a single poll tick.
- **pollUntilDone** ((opts?: { intervalMs?: number; maxAttempts?: number }) => Promise<Bloks.BloksResponse>) - Required - A function to poll until the review is done, with optional interval and attempt limits.
```

--------------------------------

### NavigationReviewContactPointChangeScreen Constructor

Source: https://docs.igpapi.com/_igpapi/android/NavigationReviewContactPointChangeScreen

Initializes a new instance of the NavigationReviewContactPointChangeScreen class. It requires a state object and a submit function.

```APIDOC
## new NavigationReviewContactPointChangeScreen(args)

### Description
Initializes a new instance of the NavigationReviewContactPointChangeScreen class.

### Parameters
* `args` (object) - Required. An object containing the initial state and submit function.
  * `state` (NavigationReviewContactPointChangeFullState) - Readonly. The initial state for the navigation review.
  * `submit` (function) - Readonly. A function to submit a choice ('0' or '1') which returns a Promise.

### Returns
* `NavigationReviewContactPointChangeScreen` - A new instance of the class.
```

--------------------------------

### Fundraisers By Others Notifications

Source: https://docs.igpapi.com/_igpapi/ios/createMobileRuntime

Toggles notification settings for fundraisers started by others.

```APIDOC
## Fundraisers By Others Notifications

### Description
Enables or disables notifications for fundraisers initiated by other users.

### Method
Not applicable (SDK function)

### Parameters
#### Args
- **value** (NotificationSettingsOnOff) - Required - The desired state (on/off) for fundraisers by others notifications.

### Returns
- **Promise<ChangeNotificationSettingsResponse<"fundraiser_supporter"> >** - A promise that resolves to the updated notification settings response.
```

--------------------------------

### build Method

Source: https://docs.igpapi.com/_igpapi/android/UserDirectTargetConfiguration

Builds the configuration for sending a direct message.

```APIDOC
## build
  * build(): Record<string, string>

### Returns Record<string, string>
```

--------------------------------

### DirectThreadAddUserResponseBoldItem Interface

Source: https://docs.igpapi.com/_igpapi/ios/DirectThreadAddUserResponseBoldItem

Defines the structure for DirectThreadAddUserResponseBoldItem, including start and end properties.

```APIDOC
## Interface DirectThreadAddUserResponseBoldItem

### Description
Represents an item with start and end properties, likely used for range or interval definitions.

### Properties

- **end** (number) - The end value of the item.
- **start** (number) - The start value of the item.

### Example
```json
{
  "end": 100,
  "start": 0
}
```
```

--------------------------------

### IgConfigureVideoError Methods

Source: https://docs.igpapi.com/_igpapi/core/index/IgConfigureVideoError

Provides methods for interacting with the IgConfigureVideoError instance.

```APIDOC
## Methods

### [iterator]
  * "[iterator]"(): EffectIterator<IgConfigureVideoError>
#### Returns EffectIterator<IgConfigureVideoError>

### asEffect
  * asEffect(): Effect<never, IgConfigureVideoError, never>
#### Returns Effect<never, IgConfigureVideoError, never>

### pipe
  * pipe<A>(this: A): A
#### Type Parameters
    * A
#### Parameters
    * this: A
#### Returns A
  * pipe<A, B = never>(this: A, ab: (_: A) => B): B
#### Type Parameters
    * A
    * B = never
#### Parameters
    * this: A
    * ab: (_: A) => B
#### Returns B
  * pipe<A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C
#### Type Parameters
    * A
    * B = never
    * C = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
#### Returns C
  * pipe<A, B = never, C = never, D = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
): D
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
#### Returns D
  * pipe<A, B = never, C = never, D = never, E = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
): E
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
#### Returns E
  * pipe<A, B = never, C = never, D = never, E = never, F = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
    ef: (_: E) => F,
): F
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
#### Returns F
  * pipe<A, B = never, C = never, D = never, E = never, F = never, G = never>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
): G
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
#### Returns G
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
): H
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
    * gh: (_: G) => H
#### Returns H
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
I = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
): I
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
    * I = never
#### Parameters
    * this: A
    * ab: (_: A) => B
    * bc: (_: B) => C
    * cd: (_: C) => D
    * de: (_: D) => E
    * ef: (_: E) => F
    * fg: (_: F) => G
    * gh: (_: G) => H
    * hi: (_: H) => I
#### Returns I
  * pipe<  
A,
B = never,
C = never,
D = never,
E = never,
F = never,
G = never,
H = never,
I = never,
J = never,
>(
this: A,
ab: (_: A) => B,
bc: (_: B) => C,
cd: (_: C) => D,
de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
): J
#### Type Parameters
    * A
    * B = never
    * C = never
    * D = never
    * E = never
    * F = never
    * G = never
    * H = never
    * I = never
    * J = never

```

--------------------------------

### Notification Settings

Source: https://docs.igpapi.com/_igpapi/ios/createMobileRuntime

Provides methods to change and get various notification settings.

```APIDOC
## Notification Settings

This section details the methods for managing notification preferences.

### Methods

- **messages**: Configure direct share activity notifications.
- **muteAll**: Mute all notifications for a specified period.
- **newFollower**: Enable or disable new follower notifications.
- **reminders**: Configure notification reminders.
- **rooms**: Manage notifications for rooms.
- **supportRequests**: Handle notifications for support requests.
- **taggedInBio**: Configure notifications when tagged in a bio.
- **unrecognizedLogins**: Enable or disable notifications for unrecognized logins.
- **userTagged**: Configure notifications when tagged by a user.
- **videoCall**: Manage video call notifications.
- **videoUploads**: Configure notifications for video uploads.
- **videoViewCounts**: Enable or disable video view count notifications.
- **yourFundraisers**: Manage notifications for your fundraisers.

### Get Notification Settings

- **_**: Get notification settings for a specific content type.
- **emailAndSms**: Retrieve email and SMS notification settings.
- **followingAndFollowers**: Get notification settings for following and followers.
- **fromInstagram**: Retrieve Instagram-specific notification settings.
- **fundraisers**: Get fundraiser notification settings.
- **instagramDirect**: Retrieve Instagram Direct notification settings.
- **postAndComments**: Get notification settings for posts and comments.
- **root**: Retrieve the root notification settings.
- **shopping**: Get shopping-related notification settings.
- **storyLiveAndVideo**: Retrieve notification settings for stories, live, and videos.
```

--------------------------------

### Get Suggested Searches

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Retrieves suggested search queries based on input.

```APIDOC
## Get Suggested Searches

### Description
Retrieves suggested search queries.

### Method Signature
`search.suggestedSearches(input: SuggestedSearchesInput)`

### Returns
A Promise resolving to SuggestedSearchesResponse.
```

--------------------------------

### Configure First Posts and Stories Notifications

Source: https://docs.igpapi.com/_igpapi/android/SettingsFacade

Configures notifications for first posts and stories. Use NotificationSettingsOptions for detailed settings.

```typescript
settingsFacade.notifications.change.firstPostsAndStories(value)
```

--------------------------------

### DirectStoryConfiguration Constructor

Source: https://docs.igpapi.com/_igpapi/android/DirectStoryConfiguration

Initializes a new instance of the DirectStoryConfiguration class.

```APIDOC
## constructor
  * new DirectStoryConfiguration(
directConfiguration: DirectTargetConfiguration, 
viewMode: DirectStoryViewMode,
): DirectStoryConfiguration
#### Parameters
    * directConfiguration: DirectTargetConfiguration
    * viewMode: DirectStoryViewMode
```

--------------------------------

### Get Likers

Source: https://docs.igpapi.com/_igpapi/android/createMobileRuntime

Retrieves a list of users who liked a specific media item.

```APIDOC
## likers

### Description
Retrieves a list of users who liked a specific media item.

### Method
`likers(id: string)`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the media item.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
/media/{id}/likers
```

### Response
#### Success Response (200)
- **mediaLikers** (MediaLikersResponse) - The response object containing likers information.

#### Response Example
```json
{
  "mediaLikers": {
    "...MediaLikersResponse": "..."
  }
}
```
```

--------------------------------

### HighlightsFacade.tray

Source: https://docs.igpapi.com/_igpapi/ios/HighlightsFacade

Fetches the highlight tray.

```APIDOC
## tray

### Description
Fetches the highlight tray.

### Method
`tray`

### Parameters
#### Input
- `input` (HighlightsTrayInput) - Required - The input object for fetching the tray.

### Response
#### Success Response
- `HighlightsTrayResponse` - The response object containing the highlight tray.
```

--------------------------------

### Get Notification Settings from Instagram

Source: https://docs.igpapi.com/_igpapi/android/SettingsFacade

Retrieves notification settings that originate from Instagram.

```typescript
settingsFacade.notifications.get.fromInstagram()
```
Tokens:
Raw