Inneholder ytterligere metoder for samhandling med gjenstander i Steam Workshop.

Se ISteamRemoteStorage for hovedgrensesnittet, og ICloudService.

MERK: Dette er et tjenestegrensesnitt. Metoder i dette grensesnittet bør kalles med parameteren input_json.

Gå til Oversikt over nett-API for mer informasjon om nett-API-et til Steamworks.

Delete

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Brukernøkkel for nett-API-et til Steamworks.
publishedfileid	uint64	✔	Gjenstand som skal slettes.
appid	uint32	✔	Applikasjonen som gjenstanden hører til.

Sletter en gjenstand.

MERK: Dette kallet krever en API-utgivernøkkel for å bruke denne metoden. Derfor MÅ dette API-et kalles fra en sikker tjener og kan aldri brukes direkte av klienter!

QueryFiles

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Brukernøkkel for nett-API-et til Steamworks.
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType
page	uint32	✔	Gjeldende side. For øyeblikket er det en maksgrense på 1000.
cursor	string	✔	Markør for å dele resultatene i sider (angi som * i den første forespørselen). Bør brukes fremfor å bruke sideparameteren, da det lar deg få tilgang til flere sider. Hvis dette brukes, ignoreres sideparameteren. Bruk verdien «next_cursor», som returneres i svaret, til å sette opp den neste spørringen for å få det neste resultatsettet.
numperpage	uint32		(Valgfritt) Antall resultater per side som skal returneres.
creator_appid	uint32	✔	Applikasjonen som opprettet filene.
appid	uint32	✔	Applikasjonen som bruker filene.
requiredtags	string	✔	Merkelapper som skal samsvares med. Se parameteren match_all_tags nedenfor.
excludedtags	string	✔	(Valgfritt) Merkelapper som IKKE kan være til stede på en publisert fil for å samsvare med spørringen.
match_all_tags	bool		Hvis sann må gjenstander ha alle angitte merkelapper – ellers må de ha minst én merkelapp.
required_flags	string	✔	Nødvendige flagg som må være angitt på returnerte gjenstander.
omitted_flags	string	✔	Flagg som ikke kan være angitt på returnerte gjenstander.
search_text	string	✔	Tekst som skal samsvare med gjenstandens navn eller beskrivelse.
filetype	uint32	✔	IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileid	uint64	✔	Finn alle gjenstander med referanse til den angitte gjenstanden.
days	uint32	✔	Hvis query_type er k_PublishedFileQueryType_RankedByTrend, er dette antall dager å hente stemmer for [1,7].
include_recent_votes_only	bool	✔	Hvis query_type er k_PublishedFileQueryType_RankedByTrend, begrenses resultatsettet til gjenstander som har stemmer innenfor angitt tidsramme.
cache_max_age_seconds	uint32		La foreldet data returneres i angitt antall sekunder.
language	int32		Språk å søke på, og også det som returneres. Engelsk er standard.
required_kv_tags	{message}	✔	Nødvendige nøkkel-verdi-par å samsvare med.
totalonly	bool	✔	(Valgfritt) Hvis sann returneres kun totalt antall filer som samsvarer med spørringen.
ids_only	bool	✔	(Valgfritt) Hvis sann returneres kun publiserte fil-ID-er for filer som samsvarer med spørringen.
return_vote_data	bool	✔	Returner avstemningsdata.
return_tags	bool	✔	Returner merkelapper i fildetaljene.
return_kv_tags	bool	✔	Returner nøkkel-verdi-merkelapper i fildetaljene.
return_previews	bool	✔	Returner informasjon om forhåndsvisningsbilde og -video i fildetaljene.
return_children	bool	✔	Returner ID-er til underordnede gjenstander i fildetaljene.
return_short_description	bool	✔	Fyll ut feltet short_description istedenfor file_description.
return_for_sale_data	bool	✔	Returner prisinformasjon hvis aktuelt.
return_metadata	bool		Fyll ut metadata.
return_playtime_stats	uint32	✔	Returner spilletidsstatistikk for angitt antall dager før i dag.

Utfører en spørring etter publiserte filer.

SetDeveloperMetadata

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Utgivernøkkel for nett-API-et til Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
metadata	string	✔

Angir metadata for utvikleren på den publiserte filen.

MERK: Dette kallet krever en utgiver-API-nøkkel for å bruke denne metoden. Dette API-et MÅ kalles fra en sikker tjener, og kan aldri brukes direkte av klienten!

UpdateAppUGCBan

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Utgivernøkkel for nett-API-et til Steamworks.
steamid	uint64	✔	Steam-ID-en til brukeren.
appid	uint32	✔
expiration_time	uint32	✔	Unix-tidsstempel når utestengelsen utløper – 0 for å fjerne.
reason	string		Grunnen til at brukeren ble utestengt. Vises til brukeren.

Legger til, oppdaterer eller fjerner en brukers utestengelse fra brukerskapt innhold i applikasjonen. Angi expiration_time som 0 for å fjerne utestengelsen.

MERK: Dette kallet krever en API-utgivernøkkel for å bruke denne metoden. Derfor MÅ dette API-et kalles fra en sikker tjener og kan aldri brukes direkte av klienter!

UpdateBanStatus

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Utgivernøkkel for nett-API-et til Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	Grunnen til at gjenstanden ble utestengt. Kun synlig for administratorer.

Oppdaterer utestengelsesstatusen på den publiserte filen.

MERK: Dette kallet krever en API-utgivernøkkel for å bruke denne metoden. Derfor MÅ dette API-et kalles fra en sikker tjener og kan aldri brukes direkte av klienter!

UpdateIncompatibleStatus

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Utgivernøkkel for nett-API-et til Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

Oppdaterer inkompatibilitetsstatusen på den publiserte filen. «Inkompatible» gjenstander skjules fra samfunnssentraler og brukerprofiler, men man har fremdeles tilgang med en direkte lenke.

MERK: Dette kallet krever en API-utgivernøkkel for å bruke denne metoden. Derfor MÅ dette API-et kalles fra en sikker tjener og kan aldri brukes direkte av klienter!

UpdateTags

Navn	Type	Påkrevd	Beskrivelse
key	string	✔	Utgivernøkkel for nett-API-et til Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	string		Merkelapper å legge til.
remove_tags	string		Merkelapper å fjerne.

Oppdaterer merkelapper på den publiserte filen. Eksisterende merkelapper fjernes ikke med mindre de angis i parameteren remove_tags.

MERK: Dette kallet krever en API-utgivernøkkel for å bruke denne metoden. Derfor MÅ dette API-et kalles fra en sikker tjener og kan aldri brukes direkte av klienter!

Oppramsinger (enum)

Dette er oppramsinger som defineres for bruk med ISteamRemoteStorage.

EPublishedFileQueryType

Måter man kan spørre etter brukerskapte gjenstander.

Navn	Verdi
k_PublishedFileQueryType_RankedByVote	0
k_PublishedFileQueryType_RankedByPublicationDate	1
k_PublishedFileQueryType_AcceptedForGameRankedByAcceptanceDate	2
k_PublishedFileQueryType_RankedByTrend	3
k_PublishedFileQueryType_FavoritedByFriendsRankedByPublicationDate	4
k_PublishedFileQueryType_CreatedByFriendsRankedByPublicationDate	5
k_PublishedFileQueryType_RankedByNumTimesReported	6
k_PublishedFileQueryType_CreatedByFollowedUsersRankedByPublicationDate	7
k_PublishedFileQueryType_NotYetRated	8
k_PublishedFileQueryType_RankedByTotalUniqueSubscriptions	9
k_PublishedFileQueryType_RankedByTotalVotesAsc	10
k_PublishedFileQueryType_RankedByVotesUp	11
k_PublishedFileQueryType_RankedByTextSearch	12
k_PublishedFileQueryType_RankedByPlaytimeTrend	13
k_PublishedFileQueryType_RankedByTotalPlaytime	14
k_PublishedFileQueryType_RankedByAveragePlaytimeTrend	15
k_PublishedFileQueryType_RankedByLifetimeAveragePlaytime	16
k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend	17
k_PublishedFileQueryType_RankedByLifetimePlaytimeSessions	18
k_PublishedFileQueryType_RankedByInappropriateContentRating	19
k_PublishedFileQueryType_RankedByBanContentCheck	20
k_PublishedFileQueryType_RankedByLastUpdatedDate	21

EPublishedFileInfoMatchingFileType

Måten en delt fil kan spørres med QueryFile.

Navn	Verdi	Beskrivelse
k_PFI_MatchingFileType_Items	0	Gjenstander.
k_PFI_MatchingFileType_Collections	1	En samling med workshopgjenstander.
k_PFI_MatchingFileType_Art	2	Kunstverk.
k_PFI_MatchingFileType_Videos	3	Videoer.
k_PFI_MatchingFileType_Screenshots	4	Skjermbilder.
k_PFI_MatchingFileType_CollectionEligible	5	Gjenstander som kan legges i en samling.
k_PFI_MatchingFileType_Games	6	Ikke i bruk.
k_PFI_MatchingFileType_Software	7	Ikke i bruk.
k_PFI_MatchingFileType_Concepts	8	Ikke i bruk.
k_PFI_MatchingFileType_GreenlightItems	9	Ikke i bruk.
k_PFI_MatchingFileType_AllGuides	10	Veiledninger.
k_PFI_MatchingFileType_WebGuides	11	Nettveiledning på Steam.
k_PFI_MatchingFileType_IntegratedGuides	12	Integrert veiledning i applikasjonen.
k_PFI_MatchingFileType_UsableInGame	13
k_PFI_MatchingFileType_Merch	14	Workshopvarer som kan stemmes på, med mål om å selges.
k_PFI_MatchingFileType_ControllerBindings	15	Kontrollerbindinger på Steam.
k_PFI_MatchingFileType_SteamworksAccessInvites	16	Brukes internt.
k_PFI_MatchingFileType_Items_Mtx	17	Workshopgjenstander som kan selges i spillet.
k_PFI_MatchingFileType_Items_ReadyToUse	18	Workshopgjenstander som kan brukes med en gang av brukeren.
k_PFI_MatchingFileType_WorkshopShowcase	19
k_PFI_MatchingFileType_GameManagedItems	20	Behandles fullstendig av spillet – ikke brukeren – og vises ikke på nett.