Unverified Commit 6821d622 authored by Gabriel's avatar Gabriel Committed by GitHub
Browse files

Update cursor definitions (#887)

parent a6988ecc

server/runtime_go_nakama.go

+23 −23
Original line number Diff line number Diff line
@@ -1799,7 +1799,7 @@ func (n *RuntimeGoNakamaModule) WalletLedgerUpdate(ctx context.Context, itemID s 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param userId(type=string) The ID of the user to list wallet updates for.

// @param limit(type=int, optional=true, default=100) Limit number of results.

// @param cursor(type=string) Pagination cursor from previous result. If none available set to nil or "" (empty string).

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return runtimeItems([]runtime.WalletLedgerItem) A Go slice containing wallet entries with Id, UserId, CreateTime, UpdateTime, Changeset, Metadata parameters.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) WalletLedgerList(ctx context.Context, userID string, limit int, cursor string) ([]runtime.WalletLedgerItem, string, error) {
@@ -1830,9 +1830,9 @@ func (n *RuntimeGoNakamaModule) WalletLedgerList(ctx context.Context, userID str 
// @param userId(type=string) User ID to list records for or "" (empty string) for public records.

// @param collection(type=string) Collection to list data from.

// @param limit(type=int, optional=true, default=100) Limit number of records retrieved.

// @param cursor(type=string) Pagination cursor from previous result. If none available set to nil or "" (empty string).

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return objects([]*api.StorageObject) A list of storage objects.

// @return cursor(string) Pagination cursor.

// @return cursor(string) Pagination cursor. Will be set to "" or nil when fetching last available page.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) StorageList(ctx context.Context, userID, collection string, limit int, cursor string) ([]*api.StorageObject, string, error) {

	var uid *uuid.UUID
@@ -2206,8 +2206,8 @@ func (n *RuntimeGoNakamaModule) LeaderboardDelete(ctx context.Context, id string 
// @param categoryStart(type=int) Filter leaderboards with categories greater or equal than this value.

// @param categoryEnd(type=int) Filter leaderboards with categories equal or less than this value.

// @param limit(type=int) Return only the required number of leaderboards denoted by this limit value.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there are no further results.

// @return leaderboardList(*api.LeaderboardList) A list of leaderboard results and possibly a cursor.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return leaderboardList(*api.LeaderboardList) A list of leaderboard results and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) LeaderboardList(categoryStart, categoryEnd, limit int, cursor string) (*api.LeaderboardList, error) {

	if categoryStart < 0 || categoryStart >= 128 {
@@ -2242,7 +2242,7 @@ func (n *RuntimeGoNakamaModule) LeaderboardList(categoryStart, categoryEnd, limi 
// @param id(type=string) The unique identifier for the leaderboard to list.

// @param owners(type=[]string, optional=true) Array of owners to filter to.

// @param limit(type=int) The maximum number of records to return (Max 10,000).

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there are no further results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return records(*api.LeaderboardRecord) A page of leaderboard records.

// @return ownerRecords(*api.LeaderboardRecord) A list of owner leaderboard records (empty if the owners input parameter is not set).

// @return nextCursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any).
@@ -2351,9 +2351,9 @@ func (n *RuntimeGoNakamaModule) LeaderboardRecordDelete(ctx context.Context, id, 
// @param id(type=string) The ID of the leaderboard to list records for.

// @param ownerId(type=string) The owner ID around which to show records.

// @param limit(type=int) Return only the required number of leaderboard records denoted by this limit value. Between 1-100.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there are no further results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @param expiry(type=int64) Time since epoch in seconds. Must be greater than 0.

// @return leaderboardRecordsHaystack(*api.LeaderboardRecordList) A list of leaderboard records.

// @return leaderboardRecordsHaystack(*api.LeaderboardRecordList) A list of leaderboard records and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) LeaderboardRecordsHaystack(ctx context.Context, id, ownerID string, limit int, cursor string, expiry int64) (*api.LeaderboardRecordList, error) {

	if id == "" {
@@ -2558,8 +2558,8 @@ func (n *RuntimeGoNakamaModule) TournamentsGetId(ctx context.Context, tournament 
// @param startTime(type=int) Filter tournament with that start after this time.

// @param endTime(type=int) Filter tournament with that end before this time.

// @param limit(type=int, optional=true, default=10) Return only the required number of tournament denoted by this limit value.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there is no further results.

// @return tournamentList([]*api.TournamentList) A list of tournament results and possibly a cursor.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return tournamentList([]*api.TournamentList) A list of tournament results and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) TournamentList(ctx context.Context, categoryStart, categoryEnd, startTime, endTime, limit int, cursor string) (*api.TournamentList, error) {

	if categoryStart < 0 || categoryStart >= 128 {
@@ -2603,7 +2603,7 @@ func (n *RuntimeGoNakamaModule) TournamentList(ctx context.Context, categoryStar 
// @param tournamentId(type=string) The ID of the tournament to list records for.

// @param ownerIds(type=[]string, optional=true) Array of owner IDs to filter results by.

// @param limit(type=int) Return only the required number of tournament records denoted by this limit value. Max is 10000.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there are no further results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @param overrideExpiry(type=int64) Records with expiry in the past are not returned unless within this defined limit. Must be equal or greater than 0.

// @return records(*api.LeaderboardRecord) A page of tournament records.

// @return ownerRecords(*api.LeaderboardRecord) A list of owner tournament records (empty if the owners input parameter is not set).
@@ -2687,9 +2687,9 @@ func (n *RuntimeGoNakamaModule) TournamentRecordWrite(ctx context.Context, id, o 
// @param id(type=string) The ID of the tournament to list records for.

// @param ownerId(type=string) The owner ID around which to show records.

// @param limit(type=int) Return only the required number of tournament records denoted by this limit value. Between 1-100.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there are no further results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @param expiry(type=int64) Time since epoch in seconds. Must be greater than 0.

// @return tournamentRecordsHaystack(*api.LeaderboardRecordList) A list of tournament records.

// @return tournamentRecordsHaystack(*api.LeaderboardRecordList) A list of tournament records and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) TournamentRecordsHaystack(ctx context.Context, id, ownerID string, limit int, cursor string, expiry int64) (*api.TournamentRecordList, error) {

	if id == "" {
@@ -2839,8 +2839,8 @@ func (n *RuntimeGoNakamaModule) PurchaseValidateHuawei(ctx context.Context, user 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param userId(type=string) Filter by user ID. Can be an empty string to list purchases for all users.

// @param limit(type=int) Limit number of records retrieved. Defaults to 100.

// @param cursor(type=string) Pagination cursor from previous result. If none available set to nil or "" (empty string).

// @return listPurchases(*api.PurchaseList) A page of stored validated purchases.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return listPurchases(*api.PurchaseList) A page of stored validated purchases and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) PurchasesList(ctx context.Context, userID string, limit int, cursor string) (*api.PurchaseList, error) {

	if userID != "" {
@@ -2961,8 +2961,8 @@ func (n *RuntimeGoNakamaModule) SubscriptionValidateGoogle(ctx context.Context, 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param userId(type=string) Filter by user ID. Can be an empty string to list purchases for all users.

// @param limit(type=int) Limit number of records retrieved. Defaults to 100.

// @param cursor(type=string) Pagination cursor from previous result. If none available set to nil or "" (empty string).

// @return listSubscriptions(*api.SubscriptionList) A page of stored validated subscriptions.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return listSubscriptions(*api.SubscriptionList) A page of stored validated subscriptions and possibly a cursor. If cursor is empty/nil there are no further results.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) SubscriptionsList(ctx context.Context, userID string, limit int, cursor string) (*api.SubscriptionList, error) {

	if userID != "" {
@@ -3434,9 +3434,9 @@ func (n *RuntimeGoNakamaModule) GroupUsersList(ctx context.Context, id string, l 
// @param members(type=int, optional=true) Search by number of group members.

// @param open(type=bool, optional=true) Filter based on whether groups are Open or Closed.

// @param limit(type=int) Return only the required number of groups denoted by this limit value.

// @param cursor(type=string) Cursor to paginate to the next result set. If this is empty/null there is no further results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return groups([]*api.Group) A list of groups.

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any).

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any). Will be set to "" or nil when fetching last available page.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) GroupsList(ctx context.Context, name, langTag string, members *int, open *bool, limit int, cursor string) ([]*api.Group, string, error) {

	if name != "" && (langTag != "" || members != nil || open != nil) {
@@ -3465,7 +3465,7 @@ func (n *RuntimeGoNakamaModule) GroupsList(ctx context.Context, name, langTag st 
// @param ctx(type=context.Context) The context object represents information about the server and requester.

// @param userId(type=string) The ID of the user to list groups for.

// @return userGroups([]*api.UserGroupList_UserGroup) A table of groups with their fields.

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any).

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any). Will be set to "" or nil when fetching last available page.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) UserGroupsList(ctx context.Context, userID string, limit int, state *int, cursor string) ([]*api.UserGroupList_UserGroup, string, error) {

	uid, err := uuid.FromString(userID)
@@ -3550,9 +3550,9 @@ func (n *RuntimeGoNakamaModule) MetricsTimerRecord(name string, tags map[string] 
// @param userId(type=string) The ID of the user whose friends, invites, invited, and blocked you want to list.

// @param limit(type=int) The number of friends to retrieve in this page of results. No more than 100 limit allowed per result.

// @param state(type=int, optional=true) The state of the friendship with the user. If unspecified this returns friends in all states for the user.

// @param cursor(type=string) The cursor returned from a previous listing request. Used to obtain the next page of results.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return friends([]*api.Friend) The user information for users that are friends of the current user.

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any).

// @return cursor(string) An optional next page cursor that can be used to retrieve the next page of records (if any). Will be set to "" or nil when fetching last available page.

// @return error(error) An optional error value if an error occurred.

func (n *RuntimeGoNakamaModule) FriendsList(ctx context.Context, userID string, limit int, state *int, cursor string) ([]*api.Friend, string, error) {

	uid, err := uuid.FromString(userID)
@@ -3824,7 +3824,7 @@ func (n *RuntimeGoNakamaModule) ChannelMessageUpdate(ctx context.Context, channe 
// @param channelId(type=string) The ID of the channel to list messages from.

// @param limit(type=int) The number of messages to return per page.

// @param forward(type=bool) Whether to list messages from oldest to newest, or newest to oldest.

// @param cursor(type=string, optional=true) A pagination cursor to use for retrieving a next page of messages.

// @param cursor(type=string, optional=true, default="") Pagination cursor from previous result. Don't set to start fetching from the beginning.

// @return channelMessageList([]*rtapi.ChannelMessage) Messages from the specified channel.

// @return nextCursor(string) Cursor for the next page of messages, if any.

// @return prevCursor(string) Cursor for the previous page of messages, if any.

server/runtime_javascript_nakama.go

+26 −26

File changed.

Preview size limit exceeded, changes collapsed.

server/runtime_lua_nakama.go

+28 −29

File changed.

Preview size limit exceeded, changes collapsed.