Class UgcClient

Index

Constructors

Methods

downloadItem getDownloadInfo getInstallInfo getItem getItemState getItemStates getSubscriptions itemStateToString queryUser subscribeToItem unsubscribeToItem

Constructors

constructor

new UgcClient(): UgcClient
Returns UgcClient

Methods

downloadItem

downloadItem(itemId: number, highPriority: boolean): boolean
Parameters
- itemId: number
- highPriority: boolean
Returns boolean
- Defined in index.d.ts:187

getDownloadInfo

getDownloadInfo(itemId: number): DownloadInfo
Parameters
- itemId: number
Returns DownloadInfo
- Defined in index.d.ts:186

getInstallInfo

getInstallInfo(itemId: number): WorkshopItemInstallInfo
Parameters
- itemId: number
Returns WorkshopItemInstallInfo
- Defined in index.d.ts:185

getItem

getItem(itemId: number): Promise<WorkshopItemDetails>
Parameters
- itemId: number
Returns Promise<WorkshopItemDetails>
- Defined in index.d.ts:181

getItemState

getItemState(itemId: number): number
Parameters
- itemId: number
Returns number
- Defined in index.d.ts:188

getItemStates

getItemStates(itemId: number): WorkshopItemStateEnum[]
Parameters
- itemId: number
Returns WorkshopItemStateEnum[]
- Defined in index.d.ts:189

getSubscriptions

getSubscriptions(): number[]
Returns number[]
- Defined in index.d.ts:184

itemStateToString

itemStateToString(state: WorkshopItemStateEnum): string
Parameters
- state: WorkshopItemStateEnum
Returns string
- Defined in index.d.ts:179

queryUser

queryUser(
    appId: number,
    account: number,
    listType: WorkshopUserListType,
    itemType: WorkshopUGCType,
    sortOrder: WorkshopUserListOrder,
    page: number,
): Promise<WorkshopItemDetails[]>
Parameters
- appId: number
- account: number
- listType: WorkshopUserListType
- itemType: WorkshopUGCType
- sortOrder: WorkshopUserListOrder
- page: number
Returns Promise<WorkshopItemDetails[]>
- Defined in index.d.ts:180

subscribeToItem

subscribeToItem(itemId: number): Promise<void>
Parameters
- itemId: number
Returns Promise<void>
- Defined in index.d.ts:182

unsubscribeToItem

unsubscribeToItem(itemId: number): Promise<void>
Parameters
- itemId: number
Returns Promise<void>
- Defined in index.d.ts:183