@xmobitea/gn-server/dist/GN-common/constant/Commands.d.ts

GearN Server by XmobiTea (Pro)

/**
 * Centralizes HTTP header names, content-type values, socket frame commands,
 * and multipart field names used by the SDK transport layer.
 */
export declare class Commands {
    /**
     * HTTP header used to identify the SDK client variant and version.
     */
    static readonly USER_AGENT: string;
    /**
     * HTTP header that declares the request body content type.
     */
    static readonly CONTENT_TYPE: string;
    /**
     * HTTP header that declares which response content types the client accepts.
     */
    static readonly ACCEPT: string;
    /**
     * HTTP header that carries the serialized request body size in bytes when required.
     */
    static readonly CONTENT_LENGTH: string;
    /**
     * MIME type used for JSON request and response payloads.
     */
    static readonly APPLICATION_JSON: string;
    /**
     * MIME type used for MessagePack request and response payloads.
     */
    static readonly APPLICATION_MSGPACK: string;
    /**
     * Transport header used to send the current auth token with HTTP requests.
     */
    static readonly RequestAuthTokenCmd: string;
    /**
     * Transport header used to send the selected route secret key with HTTP requests.
     */
    static readonly RequestSecretCmd: string;
    /**
     * Transport header used to send the current game id when the backend requires it.
     */
    static readonly RequestGameIdCmd: string;
    /**
     * Socket command name for MessagePack operation requests.
     */
    static readonly RequestCmd_MsgPack: string;
    /**
     * Socket command name for MessagePack operation responses.
     */
    static readonly ResponseCmd_MsgPack: string;
    /**
     * Socket command name for MessagePack pushed events.
     */
    static readonly EventCmd_MsgPack: string;
    /**
     * Socket command name for JSON operation requests.
     */
    static readonly RequestCmd_Json: string;
    /**
     * Socket command name for JSON operation responses.
     */
    static readonly ResponseCmd_Json: string;
    /**
     * Socket command name for JSON pushed events.
     */
    static readonly EventCmd_Json: string;
    /**
     * Multipart field name used for non-file payload data.
     */
    static readonly Data: string;
    /**
     * Multipart field name used for uploaded file content.
     */
    static readonly File: string;
    /**
     * Reverse-proxy helper header that carries the original base URL when needed.
     */
    static readonly BaseUrl: string;
}