docs(SteamClient): update interfaces to Steam Version 1702515219

Steam Version: 1702515219 Steam Client Build Date: Thu, Dec 14 00:36 UTC -08:00
SteamDeckHomebrew · Dec 14, 2023 · 5680855 · 5680855
1 parent 77052b8
commit 5680855
Showing 1 changed file with 76 additions and 13 deletions.
diff --git a/src/deck-components/SteamClient.ts b/src/deck-components/SteamClient.ts
@@ -280,6 +280,15 @@ export interface Apps {
     // [...appStore.m_mapStoreTagLocalization.keys()]
     GetStoreTagLocalization(tags: number[]): Promise<StoreTagLocalization[]>;
 
+    /**
+     * Retrieves a list of subscribed workshop item details for a specific application.
+     * @param {number} appId - The ID of the application to retrieve subscribed workshop item details for.
+     * @param {string[]} itemIds - Workshop item IDs to retrieve details for.
+     * @returns {Promise<WorkshopItemDetails[] | OperationResponse>} - A Promise that resolves to an array of subscribed workshop item details for the specified application.
+     * @throws Throws if the query failed.
+     */
+    GetSubscribedWorkshopItemDetails(appId: number, itemIds: string[]): Promise<WorkshopItemDetails[] | OperationResponse>;
+
     /**
      * Retrieves a list of subscribed workshop items for a specific application.
      * @param {number} appId - The ID of the application to retrieve subscribed workshop items for.
@@ -298,6 +307,16 @@ export interface Apps {
     MarkEulaAccepted: any;
     MarkEulaRejected: any;
 
+    /**
+     * Move specified workshop item load order.
+     * @param appId - The ID of the application.
+     * @param oldOrder - The item to move, referenced by its position number.
+     * @param newOrder - The position number to move the item to.
+     * @returns {void}
+     * @remarks Orders are zero-indexed.
+     */
+    MoveWorkshopItemLoadOrder(appId: number, oldOrder: number, newOrder: number): void;
+
     /**
      * Opens the settings dialog for a specific application.
      * @param {number} appId - The ID of the application for which to open the settings dialog.
@@ -624,6 +643,24 @@ export interface Apps {
 
     SetThirdPartyControllerConfiguration: any;
 
+    /**
+     * Sets the workshop items disabled state.
+     * @param {number} appId - The ID of the application.
+     * @param {string[]} itemIds - Workshop item IDs to change the state for.
+     * @param {boolean} value - `true` to disable, `false` otherwise.
+     * @returns {void}
+     */
+    SetWorkshopItemsDisabledLocally(appId: number, itemIds: string[], value: boolean): void;
+
+    /**
+     * Sets the workshop items load order for a specified application.
+     * @param {number} appId - The ID of the application.
+     * @param {string[]} itemIds - Workshop item IDs.
+     * @returns {void}
+     * @remarks `itemIds` has to be the full list of subscribed items, otherwise the specified items get moved to the last position.
+     */
+    SetWorkshopItemsLoadOrder(appId: number, itemIds: string[]): void;
+
     /**
      * Opens the controller configurator for a specific application.
      * @param {number} appId - The ID of the application for which to open the controller configurator.
@@ -997,6 +1034,8 @@ export interface FamilySharing {
      */
     DeauthorizeLocalDevice(): Promise<number>;
 
+    GetFamilyGroupInfo(): Promise<string>;
+
     RegisterForKickedBorrower: any;
 
     RequestLocalDeviceAuthorization(steam64Id: string): Promise<number>;
@@ -1132,18 +1171,6 @@ export interface GameSessions {
  * Represents functions related to input and controllers in Steam.
  */
 export interface Input {
-    /**
-     * Checks if the specified controller is a Steam Controller.
-     * @param {function} callback - The callback function to receive the result.
-     */
-    BIsSteamController(callback: (steamController: boolean) => void): void;
-
-    /**
-     * Checks if the specified controller supports LED color.
-     * @param {function} callback - The callback function to receive the result.
-     */
-    BSupportsControllerLEDColor(callback: (supportControllerLEDColor: boolean) => void): void;
-
     CalibrateControllerIMU(param0: any): any; // param0 - m_controllerStateDeviceIdx
     CalibrateControllerJoystick(param0: any): any; // param0 - m_controllerStateDeviceIdx
     CalibrateControllerTrackpads(param0: any): any; // param0 - m_controllerStateDeviceIdx
@@ -1697,8 +1724,8 @@ export interface Notifications {
 
 export interface VRDevice {
     BIsConnected: any;
-    BVRDeviceSeenRecently: any;
     RegisterForDeviceConnectivityChange: Unregisterable | any;
+    RegisterForVRDeviceSeenRecently: Unregisterable | any;
 }
 
 export interface DeviceProperties {
@@ -4031,6 +4058,42 @@ export interface AuthRefreshInfo {
     login_id_token: string;
 }
 
+export interface WorkshopItemDetails {
+    /**
+     * Required items' IDs.
+     */
+    children: string[];
+    eresult: Result;
+    /**
+     * Item size, in byts.
+     */
+    file_size: string;
+    /**
+     * @todo enum?
+     */
+    file_type: number;
+    /**
+     * Item preview image URL.
+     */
+    preview_url: string;
+    /**
+     * Item ID.
+     */
+    publishedfileid: string;
+    /**
+     * Item description.
+     */
+    short_description: string;
+    /**
+     * Item tags.
+     */
+    tags: string[];
+    /**
+     * Item title.
+     */
+    title: string;
+}
+
 export interface WorkshopItem {
     unAppID: number;
     ulPublishedFileID: string;