pnwkit 3.0 - v4.3.0
    Preparing search index...

    Interface SubscriptionParams

    Optional server-side filters that narrow which events a subscription receives.

    Which keys are meaningful depends on the model (e.g. alliance_id for nations, war_id for war attacks). All values are strings — they are sent as URL query parameters.

    interface SubscriptionParams {
        alliance_id?: string;
        att_alliance_id?: string;
        buy_or_sell?: string;
        def_alliance_id?: string;
        id?: string;
        nation_id?: string;
        offer_resource?: string;
        or_id?: string;
        receiver_id?: string;
        receiver_type?: string;
        sender_id?: string;
        sender_type?: string;
        team_id?: string;
        war_id?: string;
    }
    Index
    alliance_id? att_alliance_id? buy_or_sell? def_alliance_id? id? nation_id? offer_resource? or_id? receiver_id? receiver_type? sender_id? sender_type? team_id? war_id?
    alliance_id?: string
    att_alliance_id?: string
    buy_or_sell?: string
    def_alliance_id?: string
    id?: string
    nation_id?: string
    offer_resource?: string
    or_id?: string

    Match records where the sender or receiver id equals this.

    receiver_id?: string

    Receiver nation/alliance id.

    receiver_type?: string

    Whether the receiver is a nation (1) or alliance (2).

    sender_id?: string

    Sender nation/alliance id (bank records, trades).

    sender_type?: string

    Whether the sender is a nation (1) or alliance (2).

    team_id?: string
    war_id?: string

    Settings
    Member Visibility

    On This Page
    Properties