Pretendo Developer Documentation

PretendoNetwork/nex-protocols-go

--

datastoredatastore.Protocol

Fields

PatchesPatchedMethodsPrepareGetObjectV1PreparePostObjectV1CompletePostObjectV1DeleteObjectDeleteObjectsChangeMetaV1ChangeMetasV1GetMetaGetMetasPrepareUpdateObjectCompleteUpdateObjectSearchObjectGetNotificationURLGetNewArrivedNotificationsV1RateObjectGetRatingGetRatingsResetRatingResetRatingsGetSpecificMetaV1PostMetaBinaryTouchObjectGetRatingWithLogPreparePostObjectPrepareGetObjectCompletePostObjectGetNewArrivedNotificationsGetSpecificMetaGetPersistenceInfoGetPersistenceInfosPerpetuateObjectUnperpetuateObjectPrepareGetObjectOrMetaBinaryGetPasswordInfoGetPasswordInfosGetMetasMultipleParamCompletePostObjectsChangeMetaChangeMetasRateObjectsPostMetaBinaryWithDataIDPostMetaBinariesWithDataIDRateObjectWithPostingRateObjectsWithPostingGetObjectInfosSearchObjectLight

Methods

EndpointSetEndpointSetHandlerPrepareGetObjectV1SetHandlerPreparePostObjectV1SetHandlerCompletePostObjectV1SetHandlerDeleteObjectSetHandlerDeleteObjectsSetHandlerChangeMetaV1SetHandlerChangeMetasV1SetHandlerGetMetaSetHandlerGetMetasSetHandlerPrepareUpdateObjectSetHandlerCompleteUpdateObjectSetHandlerSearchObjectSetHandlerGetNotificationURLSetHandlerGetNewArrivedNotificationsV1SetHandlerRateObjectSetHandlerGetRatingSetHandlerGetRatingsSetHandlerResetRatingSetHandlerResetRatingsSetHandlerGetSpecificMetaV1SetHandlerPostMetaBinarySetHandlerTouchObjectSetHandlerGetRatingWithLogSetHandlerPreparePostObjectSetHandlerPrepareGetObjectSetHandlerCompletePostObjectSetHandlerGetNewArrivedNotificationsSetHandlerGetSpecificMetaSetHandlerGetPersistenceInfoSetHandlerGetPersistenceInfosSetHandlerPerpetuateObjectSetHandlerUnperpetuateObjectSetHandlerPrepareGetObjectOrMetaBinarySetHandlerGetPasswordInfoSetHandlerGetPasswordInfosSetHandlerGetMetasMultipleParamSetHandlerCompletePostObjectsSetHandlerChangeMetaSetHandlerChangeMetasSetHandlerRateObjectsSetHandlerPostMetaBinaryWithDataIDSetHandlerPostMetaBinariesWithDataIDSetHandlerRateObjectWithPostingSetHandlerRateObjectsWithPostingSetHandlerGetObjectInfosSetHandlerSearchObjectLight

Protocol.RateObjectsWithPosting#

Type#

func(
	err error,
	packet nex.PacketInterface,
	callID uint32,
	targets *types.List[*datastore_types.DataStoreRatingTarget],
	rateParams *types.List[*datastore_types.DataStoreRateObjectParam],
	postParams *types.List[*datastore_types.DataStorePreparePostParam],
	transactional *types.PrimitiveBool,
	fetchRatings *types.PrimitiveBool
) (*nex.RMCMessage, *nex.Error)

Description#

Callback handler for the DataStore::RateObjectsWithPosting RMC method.

Rate multiple objects at once. If a target object does not exist, initialize and rate it using the data from postParams. targets, rateParams, and postParams must all be the same length.

Parameters#

NameDescription
errAn error which occured during RMC decoding. Nil if no error occured
packetThe source packet
callIDThe RMC call ID
targetsList of DataStore objects to rate. Nil if an error occured during RMC decoding
rateParamsRatings to apply to objects. Nil if an error occured during RMC decoding
postParamsObject initialization data. Nil if an error occured during RMC decoding
transactionalIf true only commit database changes if all operations succeed. Nil if an error occured during RMC decoding
fetchRatingsIf true populate pRatings. Nil if an error occured during RMC decoding

Return#

TypeDescription
*nex.RMCMessageAn RMC message of type response. Nil if an error occured during request processing
*nex.ErrorAn error which occured during the request processing. Nil if no error occured

RMC return parameters#

NameTypeDescription
pRatings*types.List[*datastore_types.DataStoreRatingInfo]New rating values for the requested objects. Only populated if fetchRatings is true
pResults*types.List[*types.Result]The result of each operation. Only populated if transactional is false
Copyright © 2024 — Powered by Guider

Type

Description

Parameters

Return

RMC return parameters