Open Play SDK API başvurusu
    Preparing search index...

    Interface PluginQueryDefinition<Input, Output>

    Generated query descriptor'ının generic tür taşıyıcısı.

    interface PluginQueryDefinition<Input, Output> {
        access?: "player" | "server" | "public";
        codec?: PluginCodec;
        deprecated?: PluginDeprecation;
        idempotencyRequired: boolean;
        inputType?: Input;
        journal: "reference" | "none" | "full";
        kind: "query";
        method: "GET" | "POST" | "PATCH";
        name: string;
        outputType?: Output;
        path: string;
        pluginId?: string;
        receiptRetentionSeconds?: number;
        requestMessageType: string;
        requestSchema: string;
        resource?: string;
        responseMessageType: string;
        responseSchema: string;
        resultPath?: string;
        retry: "read" | "never" | "same-key-command";
        schemaVersion: number;
        success?: number;
    }

    Type Parameters

    • Input
    • Output

    Hierarchy (View Summary)

    Index

    Properties

    access? codec? deprecated? idempotencyRequired inputType? journal kind method name outputType? path pluginId? receiptRetentionSeconds? requestMessageType requestSchema resource? responseMessageType responseSchema resultPath? retry schemaVersion success?

    Properties

    access?: "player" | "server" | "public"

    Operasyonun anonymous, player veya trusted developer-server erişim sınıfı. Eski artifact'larda alan yoksa runtime bunu player kabul eder.

    codec?: PluginCodec

    Generated binding'in schema-aware codec'i; artifact JSON'ında bulunmaz.

    deprecated?: PluginDeprecation

    Operasyon kullanımdan kalkıyorsa işaret; yoksa alan yoktur (SPEC-0225 K8).

    idempotencyRequired: boolean

    Durable command için aynı logical key ile replay zorunluluğu.

    inputType?: Input

    Compile-time input markası; runtime'da veri tutmaz.

    journal: "reference" | "none" | "full"

    Send-before-persist journal policy.

    kind: "query"

    Bu descriptor query olduğundan yalnız read retry alabilir.

    method: "GET" | "POST" | "PATCH"

    Plugin HTTP methodu.

    name: string

    Generated map anahtarı; URL segmenti değildir.

    outputType?: Output

    Compile-time output markası; runtime'da veri tutmaz.

    path: string

    Yalnız allowlisted relative path; absolute URL kabul edilmez.

    pluginId?: string

    Generated binding üzerinde taşınan plugin namespace'i; artifact girdisinde yoktur.

    receiptRetentionSeconds?: number

    Server'ın command receipt'i en az kaç saniye tutacağını belirtir.

    requestMessageType: string

    Rust manifestindeki istek mesaj kimliği.

    requestSchema: string

    İstek schema bileşeni.

    resource?: string

    Activity/aggregate fence etiketi; serbest global lock değildir.

    responseMessageType: string

    Rust manifestindeki yanıt mesaj kimliği.

    responseSchema: string

    Yanıt schema bileşeni.

    resultPath?: string

    B3 result lookup için aynı key'i alan scoped relative path.

    retry: "read" | "never" | "same-key-command"

    Retry sınıfı; command yalnız aynı key ile tekrar edilebilir.

    schemaVersion: number

    Plugin contract schema version.

    success?: number

    Başarılı HTTP yanıt kodu; verilmezse 200 kabul edilir.

    Settings

    Member Visibility

    On This Page

    Properties