igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface TelemetryChannel

    One telemetry channel as the platform declares it and the sender drives it: its name (the key of its events in the device's queue), when its own rule makes an upload due and the app's reason for it, the moments it sends what it has pending, and the delivery. Closed over the process's services by the platform that installs it; the sender knows no channel by name.

    interface TelemetryChannel {
        deliver: (
            reason: TelemetryFlushReason,
        ) => Effect<TelemetryFlushResult, TelemetryDeliveryError>;
        dueAt: (
            process: { startedAtMs: number },
        ) => Effect<TelemetryDue | undefined>;
        flushesAt: readonly (
            "app-start"
            | "background"
            | "foreground"
            | "close"
            | "explicit"
        )[];
        name: string;
    }
    Index

    Properties

    deliver dueAt flushesAt name

    Properties

    deliver: (
        reason: TelemetryFlushReason,
    ) => Effect<TelemetryFlushResult, TelemetryDeliveryError>

    Sends what the channel has pending; an empty channel makes no request.

    dueAt: (process: { startedAtMs: number }) => Effect<TelemetryDue | undefined>

    The device-clock moment the channel's own rule makes an upload due and the reason, given when the process started; undefined while nothing is due (nothing pending, or a channel that sends only at a moment).

    flushesAt: readonly (
        "app-start"
        | "background"
        | "foreground"
        | "close"
        | "explicit"
    )[]

    The moments at which the channel sends what it has pending: the app's lifecycle moments, and explicit for a channel the caller's own FlushTelemetry sends.

    name: string

    Settings

    Member Visibility

    On This Page

    Properties