Skip to content

User Storage Protocol

Yannik Marchand edited this page Jan 27, 2021 · 1 revision

NEX Protocols > User Storage (53)

Method ID Method Name
1 SearchContents
2 SearchContentsWithTotal
3 DeleteContent
4 SaveMetaData
5 SaveContentDB
6 SaveContentAndGetUploadInfo
7 UploadEnd
8 GetContentDB
9 GetContentURL
10 GetSlotCount
11 GetMetaData
12 Like
13 Unlike
14 IsLiked
15 GetFavourites
16 MakeFavourite
17 RemoveFromFavourites
18 ReportInappropriate
19 IncrementPlayCount
20 UpdateCustomStat
21 GetOwnContents
22 GetMostPopularTags
23 GetTags
24 TagContent
25 SearchContentsByPlayers
26 SearchContentsByPlayersWithTotal

(1) SearchContents

Request

Type Name
UserStorageQuery query

Response

Type Name
List<UserContent> searchResults

(2) SearchContentsWithTotal

Request

Type Name
UserStorageQuery query

Response

Type Name
List<UserContent> searchResults
Uint32 totalResults

(3) DeleteContent

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(4) SaveMetaData

Request

Type Name
List<ContentProperty> properties

Response

Type Name
UserContentKey contentKey

(5) SaveContentDB

Request

Type Name
List<ContentProperty> properties
Buffer data

Response

Type Name
UserContentKey contentKey

(6) SaveContentAndGetUploadInfo

Request

Type Name
List<ContentProperty> properties
Uint32 size
UserContentKey contentKey

Response

Type Name
UserContentURL uploadInfo
Uint64 pendingID
List<String> headers

(7) UploadEnd

Request

Type Name
Uint64 pendingID
Bool result

Response

Type Name
UserContentKey contentKey

(8) GetContentDB

Request

Type Name
UserContentKey contentKey

Response

Type Name
Buffer data

(9) GetContentURL

Request

Type Name
UserContentKey contentKey

Response

Type Name
UserContentURL downloadInfo

(10) GetSlotCount

Request

Type Name
Uint32 typeID

Response

Type Name
UserSlotCount slotCount

(11) GetMetaData

Request

Type Name
UserContentKey contentKey

Response

Type Name
UserContent content

(12) Like

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(13) Unlike

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(14) IsLiked

Request

Type Name
UserContentKey contentKey

Response

Type Name
Bool liked

(15) GetFavourites

Request

Type Name
List<Uint32> contentTypes

Response

Type Name
List<UserContent> favourites

(16) MakeFavourite

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(17) RemoveFromFavourites

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(18) ReportInappropriate

Request

Type Name
UserContentKey contentKey
String reason

Response

This method does not return anything.

(19) IncrementPlayCount

Request

Type Name
UserContentKey contentKey

Response

This method does not return anything.

(20) UpdateCustomStat

Request

Type Name
UserContentKey contentKey
Uint16 statID
Sint64 incValue

Response

This method does not return anything.

(21) GetOwnContents

Request

Type Name
Uint32 typeID

Response

Type Name
List<UserContent> results

(22) GetMostPopularTags

Request

Type Name
UserContentKey contentKey

Response

Type Name
List<WeightedTag> tags
Uint32 totalNumberOfTaggings

(23) GetTags

Request

Type Name
UserContentKey contentKey

Response

Type Name
List<Uint32> tagIds

(24) TagContent

Request

Type Name
UserContentKey contentKey
List<Uint32> newTagIds

Response

This method does not return anything.

(25) SearchContentsByPlayers

Request

Type Name
List<Uint32> pids
UserStorageQuery query

Response

Type Name
List<UserContent> searchResults

(26) SearchContentsByPlayersWithTotal

Request

Type Name
List<Uint32> pids
UserStorageQuery query

Response

Type Name
List<UserContent> searchResults
Uint32 totalResults

Types

ContentProperty (Structure)

Type Name
Uint32 m_ID
Variant m_value

UserContentKey (Structure)

Type Name
Uint32 m_typeID
Uint64 m_contentID

UserContent (Structure)

Type Name
UserContentKey m_key
Uint32 m_pid
List<ContentProperty> m_properties

UserStorageQuery (Structure)

Type Name
Uint32 m_typeID
Uint32 m_queryID
ResultRange m_resultRange
List<ContentProperty> m_parameters

UserSlotCount (Structure)

Type Name
Uint32 m_pid
Uint32 m_typeID
Uint32 m_usedSlots
Uint32 m_totalSlots

UserContentURL (Structure)

Type Name
String m_protocol
String m_host
String m_path

WeightedTag (Structure)

Type Name
Uint32 m_id
Uint32 m_numberOfOccurences
Clone this wiki locally