console

package
v3.21.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2024 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Package console is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Console_Authenticate_FullMethodName              = "/nakama.console.Console/Authenticate"
	Console_AuthenticateLogout_FullMethodName        = "/nakama.console.Console/AuthenticateLogout"
	Console_AddUser_FullMethodName                   = "/nakama.console.Console/AddUser"
	Console_AddGroupUsers_FullMethodName             = "/nakama.console.Console/AddGroupUsers"
	Console_BanAccount_FullMethodName                = "/nakama.console.Console/BanAccount"
	Console_CallApiEndpoint_FullMethodName           = "/nakama.console.Console/CallApiEndpoint"
	Console_CallRpcEndpoint_FullMethodName           = "/nakama.console.Console/CallRpcEndpoint"
	Console_DeleteAllData_FullMethodName             = "/nakama.console.Console/DeleteAllData"
	Console_DeleteAccount_FullMethodName             = "/nakama.console.Console/DeleteAccount"
	Console_DeleteChannelMessages_FullMethodName     = "/nakama.console.Console/DeleteChannelMessages"
	Console_DeleteFriend_FullMethodName              = "/nakama.console.Console/DeleteFriend"
	Console_DeleteGroup_FullMethodName               = "/nakama.console.Console/DeleteGroup"
	Console_DeleteGroupUser_FullMethodName           = "/nakama.console.Console/DeleteGroupUser"
	Console_DeleteStorage_FullMethodName             = "/nakama.console.Console/DeleteStorage"
	Console_DeleteStorageObject_FullMethodName       = "/nakama.console.Console/DeleteStorageObject"
	Console_DeleteAccounts_FullMethodName            = "/nakama.console.Console/DeleteAccounts"
	Console_DeleteLeaderboard_FullMethodName         = "/nakama.console.Console/DeleteLeaderboard"
	Console_DeleteLeaderboardRecord_FullMethodName   = "/nakama.console.Console/DeleteLeaderboardRecord"
	Console_DeleteUser_FullMethodName                = "/nakama.console.Console/DeleteUser"
	Console_DeleteWalletLedger_FullMethodName        = "/nakama.console.Console/DeleteWalletLedger"
	Console_DemoteGroupMember_FullMethodName         = "/nakama.console.Console/DemoteGroupMember"
	Console_ExportAccount_FullMethodName             = "/nakama.console.Console/ExportAccount"
	Console_ExportGroup_FullMethodName               = "/nakama.console.Console/ExportGroup"
	Console_GetAccount_FullMethodName                = "/nakama.console.Console/GetAccount"
	Console_GetConfig_FullMethodName                 = "/nakama.console.Console/GetConfig"
	Console_GetFriends_FullMethodName                = "/nakama.console.Console/GetFriends"
	Console_GetGroup_FullMethodName                  = "/nakama.console.Console/GetGroup"
	Console_GetMembers_FullMethodName                = "/nakama.console.Console/GetMembers"
	Console_GetGroups_FullMethodName                 = "/nakama.console.Console/GetGroups"
	Console_GetLeaderboard_FullMethodName            = "/nakama.console.Console/GetLeaderboard"
	Console_GetMatchState_FullMethodName             = "/nakama.console.Console/GetMatchState"
	Console_GetRuntime_FullMethodName                = "/nakama.console.Console/GetRuntime"
	Console_GetStatus_FullMethodName                 = "/nakama.console.Console/GetStatus"
	Console_GetStorage_FullMethodName                = "/nakama.console.Console/GetStorage"
	Console_GetWalletLedger_FullMethodName           = "/nakama.console.Console/GetWalletLedger"
	Console_ListApiEndpoints_FullMethodName          = "/nakama.console.Console/ListApiEndpoints"
	Console_ListLeaderboardRecords_FullMethodName    = "/nakama.console.Console/ListLeaderboardRecords"
	Console_ListLeaderboards_FullMethodName          = "/nakama.console.Console/ListLeaderboards"
	Console_ListStorage_FullMethodName               = "/nakama.console.Console/ListStorage"
	Console_ListStorageCollections_FullMethodName    = "/nakama.console.Console/ListStorageCollections"
	Console_ListAccounts_FullMethodName              = "/nakama.console.Console/ListAccounts"
	Console_ListChannelMessages_FullMethodName       = "/nakama.console.Console/ListChannelMessages"
	Console_ListGroups_FullMethodName                = "/nakama.console.Console/ListGroups"
	Console_ListMatches_FullMethodName               = "/nakama.console.Console/ListMatches"
	Console_ListPurchases_FullMethodName             = "/nakama.console.Console/ListPurchases"
	Console_ListSubscriptions_FullMethodName         = "/nakama.console.Console/ListSubscriptions"
	Console_ListUsers_FullMethodName                 = "/nakama.console.Console/ListUsers"
	Console_PromoteGroupMember_FullMethodName        = "/nakama.console.Console/PromoteGroupMember"
	Console_UnbanAccount_FullMethodName              = "/nakama.console.Console/UnbanAccount"
	Console_UnlinkCustom_FullMethodName              = "/nakama.console.Console/UnlinkCustom"
	Console_UnlinkDevice_FullMethodName              = "/nakama.console.Console/UnlinkDevice"
	Console_UnlinkEmail_FullMethodName               = "/nakama.console.Console/UnlinkEmail"
	Console_UnlinkApple_FullMethodName               = "/nakama.console.Console/UnlinkApple"
	Console_UnlinkFacebook_FullMethodName            = "/nakama.console.Console/UnlinkFacebook"
	Console_UnlinkFacebookInstantGame_FullMethodName = "/nakama.console.Console/UnlinkFacebookInstantGame"
	Console_UnlinkGameCenter_FullMethodName          = "/nakama.console.Console/UnlinkGameCenter"
	Console_UnlinkGoogle_FullMethodName              = "/nakama.console.Console/UnlinkGoogle"
	Console_UnlinkSteam_FullMethodName               = "/nakama.console.Console/UnlinkSteam"
	Console_UpdateAccount_FullMethodName             = "/nakama.console.Console/UpdateAccount"
	Console_UpdateGroup_FullMethodName               = "/nakama.console.Console/UpdateGroup"
	Console_WriteStorageObject_FullMethodName        = "/nakama.console.Console/WriteStorageObject"
)

Variables

View Source 
var (
	UserRole_name = map[int32]string{
		0: "USER_ROLE_UNKNOWN",
		1: "USER_ROLE_ADMIN",
		2: "USER_ROLE_DEVELOPER",
		3: "USER_ROLE_MAINTAINER",
		4: "USER_ROLE_READONLY",
	}
	UserRole_value = map[string]int32{
		"USER_ROLE_UNKNOWN":    0,
		"USER_ROLE_ADMIN":      1,
		"USER_ROLE_DEVELOPER":  2,
		"USER_ROLE_MAINTAINER": 3,
		"USER_ROLE_READONLY":   4,
	}
)

Enum value maps for UserRole.

View Source 
var (
	StatusHealth_name = map[int32]string{
		0: "STATUS_HEALTH_OK",
		1: "STATUS_HEALTH_ERROR",
		2: "STATUS_HEALTH_CONNECTING",
		3: "STATUS_HEALTH_DISCONNECTING",
	}
	StatusHealth_value = map[string]int32{
		"STATUS_HEALTH_OK":            0,
		"STATUS_HEALTH_ERROR":         1,
		"STATUS_HEALTH_CONNECTING":    2,
		"STATUS_HEALTH_DISCONNECTING": 3,
	}
)

Enum value maps for StatusHealth.

View Source 
var (
	ListChannelMessagesRequest_Type_name = map[int32]string{
		0: "UNKNOWN",
		2: "ROOM",
		3: "GROUP",
		4: "DIRECT",
	}
	ListChannelMessagesRequest_Type_value = map[string]int32{
		"UNKNOWN": 0,
		"ROOM":    2,
		"GROUP":   3,
		"DIRECT":  4,
	}
)

Enum value maps for ListChannelMessagesRequest_Type.

View Source 
var Console_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nakama.console.Console",
	HandlerType: (*ConsoleServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Authenticate",
			Handler:    _Console_Authenticate_Handler,
		},
		{
			MethodName: "AuthenticateLogout",
			Handler:    _Console_AuthenticateLogout_Handler,
		},
		{
			MethodName: "AddUser",
			Handler:    _Console_AddUser_Handler,
		},
		{
			MethodName: "AddGroupUsers",
			Handler:    _Console_AddGroupUsers_Handler,
		},
		{
			MethodName: "BanAccount",
			Handler:    _Console_BanAccount_Handler,
		},
		{
			MethodName: "CallApiEndpoint",
			Handler:    _Console_CallApiEndpoint_Handler,
		},
		{
			MethodName: "CallRpcEndpoint",
			Handler:    _Console_CallRpcEndpoint_Handler,
		},
		{
			MethodName: "DeleteAllData",
			Handler:    _Console_DeleteAllData_Handler,
		},
		{
			MethodName: "DeleteAccount",
			Handler:    _Console_DeleteAccount_Handler,
		},
		{
			MethodName: "DeleteChannelMessages",
			Handler:    _Console_DeleteChannelMessages_Handler,
		},
		{
			MethodName: "DeleteFriend",
			Handler:    _Console_DeleteFriend_Handler,
		},
		{
			MethodName: "DeleteGroup",
			Handler:    _Console_DeleteGroup_Handler,
		},
		{
			MethodName: "DeleteGroupUser",
			Handler:    _Console_DeleteGroupUser_Handler,
		},
		{
			MethodName: "DeleteStorage",
			Handler:    _Console_DeleteStorage_Handler,
		},
		{
			MethodName: "DeleteStorageObject",
			Handler:    _Console_DeleteStorageObject_Handler,
		},
		{
			MethodName: "DeleteAccounts",
			Handler:    _Console_DeleteAccounts_Handler,
		},
		{
			MethodName: "DeleteLeaderboard",
			Handler:    _Console_DeleteLeaderboard_Handler,
		},
		{
			MethodName: "DeleteLeaderboardRecord",
			Handler:    _Console_DeleteLeaderboardRecord_Handler,
		},
		{
			MethodName: "DeleteUser",
			Handler:    _Console_DeleteUser_Handler,
		},
		{
			MethodName: "DeleteWalletLedger",
			Handler:    _Console_DeleteWalletLedger_Handler,
		},
		{
			MethodName: "DemoteGroupMember",
			Handler:    _Console_DemoteGroupMember_Handler,
		},
		{
			MethodName: "ExportAccount",
			Handler:    _Console_ExportAccount_Handler,
		},
		{
			MethodName: "ExportGroup",
			Handler:    _Console_ExportGroup_Handler,
		},
		{
			MethodName: "GetAccount",
			Handler:    _Console_GetAccount_Handler,
		},
		{
			MethodName: "GetConfig",
			Handler:    _Console_GetConfig_Handler,
		},
		{
			MethodName: "GetFriends",
			Handler:    _Console_GetFriends_Handler,
		},
		{
			MethodName: "GetGroup",
			Handler:    _Console_GetGroup_Handler,
		},
		{
			MethodName: "GetMembers",
			Handler:    _Console_GetMembers_Handler,
		},
		{
			MethodName: "GetGroups",
			Handler:    _Console_GetGroups_Handler,
		},
		{
			MethodName: "GetLeaderboard",
			Handler:    _Console_GetLeaderboard_Handler,
		},
		{
			MethodName: "GetMatchState",
			Handler:    _Console_GetMatchState_Handler,
		},
		{
			MethodName: "GetRuntime",
			Handler:    _Console_GetRuntime_Handler,
		},
		{
			MethodName: "GetStatus",
			Handler:    _Console_GetStatus_Handler,
		},
		{
			MethodName: "GetStorage",
			Handler:    _Console_GetStorage_Handler,
		},
		{
			MethodName: "GetWalletLedger",
			Handler:    _Console_GetWalletLedger_Handler,
		},
		{
			MethodName: "ListApiEndpoints",
			Handler:    _Console_ListApiEndpoints_Handler,
		},
		{
			MethodName: "ListLeaderboardRecords",
			Handler:    _Console_ListLeaderboardRecords_Handler,
		},
		{
			MethodName: "ListLeaderboards",
			Handler:    _Console_ListLeaderboards_Handler,
		},
		{
			MethodName: "ListStorage",
			Handler:    _Console_ListStorage_Handler,
		},
		{
			MethodName: "ListStorageCollections",
			Handler:    _Console_ListStorageCollections_Handler,
		},
		{
			MethodName: "ListAccounts",
			Handler:    _Console_ListAccounts_Handler,
		},
		{
			MethodName: "ListChannelMessages",
			Handler:    _Console_ListChannelMessages_Handler,
		},
		{
			MethodName: "ListGroups",
			Handler:    _Console_ListGroups_Handler,
		},
		{
			MethodName: "ListMatches",
			Handler:    _Console_ListMatches_Handler,
		},
		{
			MethodName: "ListPurchases",
			Handler:    _Console_ListPurchases_Handler,
		},
		{
			MethodName: "ListSubscriptions",
			Handler:    _Console_ListSubscriptions_Handler,
		},
		{
			MethodName: "ListUsers",
			Handler:    _Console_ListUsers_Handler,
		},
		{
			MethodName: "PromoteGroupMember",
			Handler:    _Console_PromoteGroupMember_Handler,
		},
		{
			MethodName: "UnbanAccount",
			Handler:    _Console_UnbanAccount_Handler,
		},
		{
			MethodName: "UnlinkCustom",
			Handler:    _Console_UnlinkCustom_Handler,
		},
		{
			MethodName: "UnlinkDevice",
			Handler:    _Console_UnlinkDevice_Handler,
		},
		{
			MethodName: "UnlinkEmail",
			Handler:    _Console_UnlinkEmail_Handler,
		},
		{
			MethodName: "UnlinkApple",
			Handler:    _Console_UnlinkApple_Handler,
		},
		{
			MethodName: "UnlinkFacebook",
			Handler:    _Console_UnlinkFacebook_Handler,
		},
		{
			MethodName: "UnlinkFacebookInstantGame",
			Handler:    _Console_UnlinkFacebookInstantGame_Handler,
		},
		{
			MethodName: "UnlinkGameCenter",
			Handler:    _Console_UnlinkGameCenter_Handler,
		},
		{
			MethodName: "UnlinkGoogle",
			Handler:    _Console_UnlinkGoogle_Handler,
		},
		{
			MethodName: "UnlinkSteam",
			Handler:    _Console_UnlinkSteam_Handler,
		},
		{
			MethodName: "UpdateAccount",
			Handler:    _Console_UpdateAccount_Handler,
		},
		{
			MethodName: "UpdateGroup",
			Handler:    _Console_UpdateGroup_Handler,
		},
		{
			MethodName: "WriteStorageObject",
			Handler:    _Console_WriteStorageObject_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "console.proto",
}

Console_ServiceDesc is the grpc.ServiceDesc for Console service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_console_proto protoreflect.FileDescriptor
View Source 
var UI = http.FileServer(http.FS(UIFS))
View Source 
var UIFS = &uiFS{}

Functions

func RegisterConsoleHandler 

func RegisterConsoleHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterConsoleHandler registers the http handlers for service Console to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterConsoleHandlerClient 

func RegisterConsoleHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ConsoleClient) error

RegisterConsoleHandlerClient registers the http handlers for service Console to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ConsoleClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ConsoleClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ConsoleClient" to call the correct interceptors.

func RegisterConsoleHandlerFromEndpoint 

func RegisterConsoleHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterConsoleHandlerFromEndpoint is same as RegisterConsoleHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterConsoleHandlerServer 

func RegisterConsoleHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ConsoleServer) error

RegisterConsoleHandlerServer registers the http handlers for service Console to "mux". UnaryRPC :call ConsoleServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterConsoleHandlerFromEndpoint instead.

func RegisterConsoleServer 

func RegisterConsoleServer(s grpc.ServiceRegistrar, srv ConsoleServer)

Types

type Account 

type Account struct {

	// The user's account details.
	Account *api.Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// The UNIX time when the account was disabled.
	DisableTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=disable_time,json=disableTime,proto3" json:"disable_time,omitempty"`
	// contains filtered or unexported fields
}

Account information.

func (*Account) Descriptor deprecated 

func (*Account) Descriptor() ([]byte, []int)

Deprecated: Use Account.ProtoReflect.Descriptor instead.

func (*Account) GetAccount 

func (x *Account) GetAccount() *api.Account

func (*Account) GetDisableTime 

func (x *Account) GetDisableTime() *timestamppb.Timestamp

func (*Account) ProtoMessage 

func (*Account) ProtoMessage()

func (*Account) ProtoReflect 

func (x *Account) ProtoReflect() protoreflect.Message

func (*Account) Reset 

func (x *Account) Reset()

func (*Account) String 

func (x *Account) String() string

type AccountDeleteRequest 

type AccountDeleteRequest struct {

	// The unique identifier of the user account.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Record the user deletion - used for GDPR compliance.
	RecordDeletion *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=record_deletion,json=recordDeletion,proto3" json:"record_deletion,omitempty"`
	// contains filtered or unexported fields
}

Delete a user account.

func (*AccountDeleteRequest) Descriptor deprecated 

func (*AccountDeleteRequest) Descriptor() ([]byte, []int)

Deprecated: Use AccountDeleteRequest.ProtoReflect.Descriptor instead.

func (*AccountDeleteRequest) GetId 

func (x *AccountDeleteRequest) GetId() string

func (*AccountDeleteRequest) GetRecordDeletion 

func (x *AccountDeleteRequest) GetRecordDeletion() *wrapperspb.BoolValue

func (*AccountDeleteRequest) ProtoMessage 

func (*AccountDeleteRequest) ProtoMessage()

func (*AccountDeleteRequest) ProtoReflect 

func (x *AccountDeleteRequest) ProtoReflect() protoreflect.Message

func (*AccountDeleteRequest) Reset 

func (x *AccountDeleteRequest) Reset()

func (*AccountDeleteRequest) String 

func (x *AccountDeleteRequest) String() string

type AccountExport 

type AccountExport struct {

	// The user's account details.
	Account *api.Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// The user's storage.
	Objects []*api.StorageObject `protobuf:"bytes,2,rep,name=objects,proto3" json:"objects,omitempty"`
	// The user's friends.
	Friends []*api.Friend `protobuf:"bytes,3,rep,name=friends,proto3" json:"friends,omitempty"`
	// The user's groups.
	Groups []*api.Group `protobuf:"bytes,4,rep,name=groups,proto3" json:"groups,omitempty"`
	// The user's chat messages.
	Messages []*api.ChannelMessage `protobuf:"bytes,5,rep,name=messages,proto3" json:"messages,omitempty"`
	// The user's leaderboard records.
	LeaderboardRecords []*api.LeaderboardRecord `protobuf:"bytes,6,rep,name=leaderboard_records,json=leaderboardRecords,proto3" json:"leaderboard_records,omitempty"`
	// The user's notifications.
	Notifications []*api.Notification `protobuf:"bytes,7,rep,name=notifications,proto3" json:"notifications,omitempty"`
	// The user's wallet ledger items.
	WalletLedgers []*WalletLedger `protobuf:"bytes,8,rep,name=wallet_ledgers,json=walletLedgers,proto3" json:"wallet_ledgers,omitempty"`
	// contains filtered or unexported fields
}

An export of all information stored for a user account.

func (*AccountExport) Descriptor deprecated 

func (*AccountExport) Descriptor() ([]byte, []int)

Deprecated: Use AccountExport.ProtoReflect.Descriptor instead.

func (*AccountExport) GetAccount 

func (x *AccountExport) GetAccount() *api.Account

func (*AccountExport) GetFriends 

func (x *AccountExport) GetFriends() []*api.Friend

func (*AccountExport) GetGroups 

func (x *AccountExport) GetGroups() []*api.Group

func (*AccountExport) GetLeaderboardRecords 

func (x *AccountExport) GetLeaderboardRecords() []*api.LeaderboardRecord

func (*AccountExport) GetMessages 

func (x *AccountExport) GetMessages() []*api.ChannelMessage

func (*AccountExport) GetNotifications 

func (x *AccountExport) GetNotifications() []*api.Notification

func (*AccountExport) GetObjects 

func (x *AccountExport) GetObjects() []*api.StorageObject

func (*AccountExport) GetWalletLedgers 

func (x *AccountExport) GetWalletLedgers() []*WalletLedger

func (*AccountExport) ProtoMessage 

func (*AccountExport) ProtoMessage()

func (*AccountExport) ProtoReflect 

func (x *AccountExport) ProtoReflect() protoreflect.Message

func (*AccountExport) Reset 

func (x *AccountExport) Reset()

func (*AccountExport) String 

func (x *AccountExport) String() string

type AccountId 

type AccountId struct {

	// The unique identifier of the user account.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The identifier for a user account.

func (*AccountId) Descriptor deprecated 

func (*AccountId) Descriptor() ([]byte, []int)

Deprecated: Use AccountId.ProtoReflect.Descriptor instead.

func (*AccountId) GetId 

func (x *AccountId) GetId() string

func (*AccountId) ProtoMessage 

func (*AccountId) ProtoMessage()

func (*AccountId) ProtoReflect 

func (x *AccountId) ProtoReflect() protoreflect.Message

func (*AccountId) Reset 

func (x *AccountId) Reset()

func (*AccountId) String 

func (x *AccountId) String() string

type AccountList 

type AccountList struct {

	// A list of users.
	Users []*api.User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// Approximate total number of users.
	TotalCount int32 `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Next cursor.
	NextCursor string `protobuf:"bytes,3,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// contains filtered or unexported fields
}

A list of users.

func (*AccountList) Descriptor deprecated 

func (*AccountList) Descriptor() ([]byte, []int)

Deprecated: Use AccountList.ProtoReflect.Descriptor instead.

func (*AccountList) GetNextCursor 

func (x *AccountList) GetNextCursor() string

func (*AccountList) GetTotalCount 

func (x *AccountList) GetTotalCount() int32

func (*AccountList) GetUsers 

func (x *AccountList) GetUsers() []*api.User

func (*AccountList) ProtoMessage 

func (*AccountList) ProtoMessage()

func (*AccountList) ProtoReflect 

func (x *AccountList) ProtoReflect() protoreflect.Message

func (*AccountList) Reset 

func (x *AccountList) Reset()

func (*AccountList) String 

func (x *AccountList) String() string

type AddGroupUsersRequest added in v3.15.0 

type AddGroupUsersRequest struct {

	// Users to add/join.
	Ids string `protobuf:"bytes,1,opt,name=ids,proto3" json:"ids,omitempty"`
	// ID of the group to add them to.
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// Whether it is a join request.
	JoinRequest bool `protobuf:"varint,3,opt,name=join_request,json=joinRequest,proto3" json:"join_request,omitempty"`
	// contains filtered or unexported fields
}

Add/join users to a group.

func (*AddGroupUsersRequest) Descriptor deprecated added in v3.15.0 

func (*AddGroupUsersRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddGroupUsersRequest.ProtoReflect.Descriptor instead.

func (*AddGroupUsersRequest) GetGroupId added in v3.15.0 

func (x *AddGroupUsersRequest) GetGroupId() string

func (*AddGroupUsersRequest) GetIds added in v3.15.0 

func (x *AddGroupUsersRequest) GetIds() string

func (*AddGroupUsersRequest) GetJoinRequest added in v3.15.0 

func (x *AddGroupUsersRequest) GetJoinRequest() bool

func (*AddGroupUsersRequest) ProtoMessage added in v3.15.0 

func (*AddGroupUsersRequest) ProtoMessage()

func (*AddGroupUsersRequest) ProtoReflect added in v3.15.0 

func (x *AddGroupUsersRequest) ProtoReflect() protoreflect.Message

func (*AddGroupUsersRequest) Reset added in v3.15.0 

func (x *AddGroupUsersRequest) Reset()

func (*AddGroupUsersRequest) String added in v3.15.0 

func (x *AddGroupUsersRequest) String() string

type AddUserRequest 

type AddUserRequest struct {

	// The username of the user.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// The password of the user.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// Email address of the user.
	Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	// Role of this user;
	Role UserRole `protobuf:"varint,4,opt,name=role,proto3,enum=nakama.console.UserRole" json:"role,omitempty"`
	// Subscribe to newsletters
	NewsletterSubscription bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Add a new console user

func (*AddUserRequest) Descriptor deprecated 

func (*AddUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddUserRequest.ProtoReflect.Descriptor instead.

func (*AddUserRequest) GetEmail 

func (x *AddUserRequest) GetEmail() string

func (*AddUserRequest) GetNewsletterSubscription added in v3.1.2 

func (x *AddUserRequest) GetNewsletterSubscription() bool

func (*AddUserRequest) GetPassword 

func (x *AddUserRequest) GetPassword() string

func (*AddUserRequest) GetRole 

func (x *AddUserRequest) GetRole() UserRole

func (*AddUserRequest) GetUsername 

func (x *AddUserRequest) GetUsername() string

func (*AddUserRequest) ProtoMessage 

func (*AddUserRequest) ProtoMessage()

func (*AddUserRequest) ProtoReflect 

func (x *AddUserRequest) ProtoReflect() protoreflect.Message

func (*AddUserRequest) Reset 

func (x *AddUserRequest) Reset()

func (*AddUserRequest) String 

func (x *AddUserRequest) String() string

type ApiEndpointDescriptor 

type ApiEndpointDescriptor struct {
	Method       string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	BodyTemplate string `protobuf:"bytes,2,opt,name=body_template,json=bodyTemplate,proto3" json:"body_template,omitempty"`
	// contains filtered or unexported fields
}

API Explorer List of Endpoints response message

func (*ApiEndpointDescriptor) Descriptor deprecated 

func (*ApiEndpointDescriptor) Descriptor() ([]byte, []int)

Deprecated: Use ApiEndpointDescriptor.ProtoReflect.Descriptor instead.

func (*ApiEndpointDescriptor) GetBodyTemplate 

func (x *ApiEndpointDescriptor) GetBodyTemplate() string

func (*ApiEndpointDescriptor) GetMethod 

func (x *ApiEndpointDescriptor) GetMethod() string

func (*ApiEndpointDescriptor) ProtoMessage 

func (*ApiEndpointDescriptor) ProtoMessage()

func (*ApiEndpointDescriptor) ProtoReflect 

func (x *ApiEndpointDescriptor) ProtoReflect() protoreflect.Message

func (*ApiEndpointDescriptor) Reset 

func (x *ApiEndpointDescriptor) Reset()

func (*ApiEndpointDescriptor) String 

func (x *ApiEndpointDescriptor) String() string

type ApiEndpointList 

type ApiEndpointList struct {
	Endpoints    []*ApiEndpointDescriptor `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	RpcEndpoints []*ApiEndpointDescriptor `protobuf:"bytes,2,rep,name=rpc_endpoints,json=rpcEndpoints,proto3" json:"rpc_endpoints,omitempty"`
	// contains filtered or unexported fields
}

API Explorer List of Endpoints

func (*ApiEndpointList) Descriptor deprecated 

func (*ApiEndpointList) Descriptor() ([]byte, []int)

Deprecated: Use ApiEndpointList.ProtoReflect.Descriptor instead.

func (*ApiEndpointList) GetEndpoints 

func (x *ApiEndpointList) GetEndpoints() []*ApiEndpointDescriptor

func (*ApiEndpointList) GetRpcEndpoints 

func (x *ApiEndpointList) GetRpcEndpoints() []*ApiEndpointDescriptor

func (*ApiEndpointList) ProtoMessage 

func (*ApiEndpointList) ProtoMessage()

func (*ApiEndpointList) ProtoReflect 

func (x *ApiEndpointList) ProtoReflect() protoreflect.Message

func (*ApiEndpointList) Reset 

func (x *ApiEndpointList) Reset()

func (*ApiEndpointList) String 

func (x *ApiEndpointList) String() string

type AuthenticateLogoutRequest added in v3.13.0 

type AuthenticateLogoutRequest struct {

	// Session token to log out.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

Log out a session and invalidate a session token.

func (*AuthenticateLogoutRequest) Descriptor deprecated added in v3.13.0 

func (*AuthenticateLogoutRequest) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticateLogoutRequest.ProtoReflect.Descriptor instead.

func (*AuthenticateLogoutRequest) GetToken added in v3.13.0 

func (x *AuthenticateLogoutRequest) GetToken() string

func (*AuthenticateLogoutRequest) ProtoMessage added in v3.13.0 

func (*AuthenticateLogoutRequest) ProtoMessage()

func (*AuthenticateLogoutRequest) ProtoReflect added in v3.13.0 

func (x *AuthenticateLogoutRequest) ProtoReflect() protoreflect.Message

func (*AuthenticateLogoutRequest) Reset added in v3.13.0 

func (x *AuthenticateLogoutRequest) Reset()

func (*AuthenticateLogoutRequest) String added in v3.13.0 

func (x *AuthenticateLogoutRequest) String() string

type AuthenticateRequest 

type AuthenticateRequest struct {

	// The username of the user.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// The password of the user.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Authenticate a console user with username and password.

func (*AuthenticateRequest) Descriptor deprecated 

func (*AuthenticateRequest) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticateRequest.ProtoReflect.Descriptor instead.

func (*AuthenticateRequest) GetPassword 

func (x *AuthenticateRequest) GetPassword() string

func (*AuthenticateRequest) GetUsername 

func (x *AuthenticateRequest) GetUsername() string

func (*AuthenticateRequest) ProtoMessage 

func (*AuthenticateRequest) ProtoMessage()

func (*AuthenticateRequest) ProtoReflect 

func (x *AuthenticateRequest) ProtoReflect() protoreflect.Message

func (*AuthenticateRequest) Reset 

func (x *AuthenticateRequest) Reset()

func (*AuthenticateRequest) String 

func (x *AuthenticateRequest) String() string

type CallApiEndpointRequest 

type CallApiEndpointRequest struct {
	Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	Body   string `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
	UserId string `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

API Explorer request definition for CallApiEndpoint

func (*CallApiEndpointRequest) Descriptor deprecated 

func (*CallApiEndpointRequest) Descriptor() ([]byte, []int)

Deprecated: Use CallApiEndpointRequest.ProtoReflect.Descriptor instead.

func (*CallApiEndpointRequest) GetBody 

func (x *CallApiEndpointRequest) GetBody() string

func (*CallApiEndpointRequest) GetMethod 

func (x *CallApiEndpointRequest) GetMethod() string

func (*CallApiEndpointRequest) GetUserId 

func (x *CallApiEndpointRequest) GetUserId() string

func (*CallApiEndpointRequest) ProtoMessage 

func (*CallApiEndpointRequest) ProtoMessage()

func (*CallApiEndpointRequest) ProtoReflect 

func (x *CallApiEndpointRequest) ProtoReflect() protoreflect.Message

func (*CallApiEndpointRequest) Reset 

func (x *CallApiEndpointRequest) Reset()

func (*CallApiEndpointRequest) String 

func (x *CallApiEndpointRequest) String() string

type CallApiEndpointResponse 

type CallApiEndpointResponse struct {
	Body         string `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

API Explorer response definition for CallApiEndpoint

func (*CallApiEndpointResponse) Descriptor deprecated 

func (*CallApiEndpointResponse) Descriptor() ([]byte, []int)

Deprecated: Use CallApiEndpointResponse.ProtoReflect.Descriptor instead.

func (*CallApiEndpointResponse) GetBody 

func (x *CallApiEndpointResponse) GetBody() string

func (*CallApiEndpointResponse) GetErrorMessage 

func (x *CallApiEndpointResponse) GetErrorMessage() string

func (*CallApiEndpointResponse) ProtoMessage 

func (*CallApiEndpointResponse) ProtoMessage()

func (*CallApiEndpointResponse) ProtoReflect 

func (x *CallApiEndpointResponse) ProtoReflect() protoreflect.Message

func (*CallApiEndpointResponse) Reset 

func (x *CallApiEndpointResponse) Reset()

func (*CallApiEndpointResponse) String 

func (x *CallApiEndpointResponse) String() string

type Config 

type Config struct {

	// JSON-encoded active server configuration.
	Config string `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// Any warnings about the current config.
	Warnings []*Config_Warning `protobuf:"bytes,2,rep,name=warnings,proto3" json:"warnings,omitempty"`
	// Server version
	ServerVersion string `protobuf:"bytes,3,opt,name=server_version,json=serverVersion,proto3" json:"server_version,omitempty"`
	// contains filtered or unexported fields
}

The current server configuration and any associated warnings.

func (*Config) Descriptor deprecated 

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetConfig 

func (x *Config) GetConfig() string

func (*Config) GetServerVersion 

func (x *Config) GetServerVersion() string

func (*Config) GetWarnings 

func (x *Config) GetWarnings() []*Config_Warning

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) ProtoReflect 

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) String 

func (x *Config) String() string

type Config_Warning 

type Config_Warning struct {

	// The config field this warning is for in a JSON pointer format.
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Warning message text.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

A warning for a configuration field.

func (*Config_Warning) Descriptor deprecated 

func (*Config_Warning) Descriptor() ([]byte, []int)

Deprecated: Use Config_Warning.ProtoReflect.Descriptor instead.

func (*Config_Warning) GetField 

func (x *Config_Warning) GetField() string

func (*Config_Warning) GetMessage 

func (x *Config_Warning) GetMessage() string

func (*Config_Warning) ProtoMessage 

func (*Config_Warning) ProtoMessage()

func (*Config_Warning) ProtoReflect 

func (x *Config_Warning) ProtoReflect() protoreflect.Message

func (*Config_Warning) Reset 

func (x *Config_Warning) Reset()

func (*Config_Warning) String 

func (x *Config_Warning) String() string

type ConsoleClient 

type ConsoleClient interface {
	// Authenticate a console user with username and password.
	Authenticate(ctx context.Context, in *AuthenticateRequest, opts ...grpc.CallOption) (*ConsoleSession, error)
	// Log out a session and invalidate the session token.
	AuthenticateLogout(ctx context.Context, in *AuthenticateLogoutRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Add a new console user.
	AddUser(ctx context.Context, in *AddUserRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Add/join members to a group.
	AddGroupUsers(ctx context.Context, in *AddGroupUsersRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Ban a user.
	BanAccount(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// API Explorer - call an endpoint
	CallApiEndpoint(ctx context.Context, in *CallApiEndpointRequest, opts ...grpc.CallOption) (*CallApiEndpointResponse, error)
	// API Explorer - call a custom RPC endpoint
	CallRpcEndpoint(ctx context.Context, in *CallApiEndpointRequest, opts ...grpc.CallOption) (*CallApiEndpointResponse, error)
	// Deletes all data
	DeleteAllData(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete all information stored for a user account.
	DeleteAccount(ctx context.Context, in *AccountDeleteRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete messages.
	DeleteChannelMessages(ctx context.Context, in *DeleteChannelMessagesRequest, opts ...grpc.CallOption) (*DeleteChannelMessagesResponse, error)
	// Delete the friend relationship between two users.
	DeleteFriend(ctx context.Context, in *DeleteFriendRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Remove a group.
	DeleteGroup(ctx context.Context, in *DeleteGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Remove a user from a group.
	DeleteGroupUser(ctx context.Context, in *DeleteGroupUserRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete all storage data.
	DeleteStorage(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete a storage object.
	DeleteStorageObject(ctx context.Context, in *DeleteStorageObjectRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete (non-recorded) all user accounts.
	DeleteAccounts(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete leaderboard
	DeleteLeaderboard(ctx context.Context, in *LeaderboardRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete leaderboard record
	DeleteLeaderboardRecord(ctx context.Context, in *DeleteLeaderboardRecordRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete console user.
	DeleteUser(ctx context.Context, in *Username, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete a wallet ledger item.
	DeleteWalletLedger(ctx context.Context, in *DeleteWalletLedgerRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Demote a user from a group.
	DemoteGroupMember(ctx context.Context, in *UpdateGroupUserStateRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Export all information stored about a user account.
	ExportAccount(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*AccountExport, error)
	// Export all information stored about a group.
	ExportGroup(ctx context.Context, in *GroupId, opts ...grpc.CallOption) (*GroupExport, error)
	// Get detailed account information for a single user.
	GetAccount(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*Account, error)
	// Get server config and configuration warnings.
	GetConfig(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*Config, error)
	// Get a user's list of friend relationships.
	GetFriends(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*api.FriendList, error)
	// Get detailed group information.
	GetGroup(ctx context.Context, in *GroupId, opts ...grpc.CallOption) (*api.Group, error)
	// Get a list of members of the group.
	GetMembers(ctx context.Context, in *GroupId, opts ...grpc.CallOption) (*api.GroupUserList, error)
	// Get a list of groups the user is a member of.
	GetGroups(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*api.UserGroupList, error)
	// Get leaderboard.
	GetLeaderboard(ctx context.Context, in *LeaderboardRequest, opts ...grpc.CallOption) (*Leaderboard, error)
	// Get current state of a running match
	GetMatchState(ctx context.Context, in *MatchStateRequest, opts ...grpc.CallOption) (*MatchState, error)
	// Get runtime info
	GetRuntime(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*RuntimeInfo, error)
	// Get current status data for all nodes.
	GetStatus(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*StatusList, error)
	// Get a storage object.
	GetStorage(ctx context.Context, in *api.ReadStorageObjectId, opts ...grpc.CallOption) (*api.StorageObject, error)
	// Get a list of the user's wallet transactions.
	GetWalletLedger(ctx context.Context, in *GetWalletLedgerRequest, opts ...grpc.CallOption) (*WalletLedgerList, error)
	// API Explorer - list all endpoints
	ListApiEndpoints(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ApiEndpointList, error)
	// List leaderboard records.
	ListLeaderboardRecords(ctx context.Context, in *api.ListLeaderboardRecordsRequest, opts ...grpc.CallOption) (*api.LeaderboardRecordList, error)
	// List leaderboards
	ListLeaderboards(ctx context.Context, in *LeaderboardListRequest, opts ...grpc.CallOption) (*LeaderboardList, error)
	// List (and optionally filter) storage data.
	ListStorage(ctx context.Context, in *ListStorageRequest, opts ...grpc.CallOption) (*StorageList, error)
	// List storage collections
	ListStorageCollections(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*StorageCollectionsList, error)
	// List (and optionally filter) accounts.
	ListAccounts(ctx context.Context, in *ListAccountsRequest, opts ...grpc.CallOption) (*AccountList, error)
	// List channel messages with the selected filter
	ListChannelMessages(ctx context.Context, in *ListChannelMessagesRequest, opts ...grpc.CallOption) (*api.ChannelMessageList, error)
	// List (and optionally filter) groups.
	ListGroups(ctx context.Context, in *ListGroupsRequest, opts ...grpc.CallOption) (*GroupList, error)
	// List ongoing matches
	ListMatches(ctx context.Context, in *ListMatchesRequest, opts ...grpc.CallOption) (*MatchList, error)
	// List validated purchases
	ListPurchases(ctx context.Context, in *ListPurchasesRequest, opts ...grpc.CallOption) (*api.PurchaseList, error)
	// List validated subscriptions
	ListSubscriptions(ctx context.Context, in *ListSubscriptionsRequest, opts ...grpc.CallOption) (*api.SubscriptionList, error)
	// List (and optionally filter) users.
	ListUsers(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*UserList, error)
	// Promote a user from a group.
	PromoteGroupMember(ctx context.Context, in *UpdateGroupUserStateRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unban a user.
	UnbanAccount(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the custom ID from a user account.
	UnlinkCustom(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the device ID from a user account.
	UnlinkDevice(ctx context.Context, in *UnlinkDeviceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the email from a user account.
	UnlinkEmail(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Apple ID from a user account.
	UnlinkApple(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Facebook ID from a user account.
	UnlinkFacebook(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Facebook Instant Game ID from a user account.
	UnlinkFacebookInstantGame(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Game Center ID from a user account.
	UnlinkGameCenter(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Google ID from a user account.
	UnlinkGoogle(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Unlink the Steam ID from a user account.
	UnlinkSteam(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Update one or more fields on a user account.
	UpdateAccount(ctx context.Context, in *UpdateAccountRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Update one or more fields on a group.
	UpdateGroup(ctx context.Context, in *UpdateGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Write a new storage object or replace an existing one.
	WriteStorageObject(ctx context.Context, in *WriteStorageObjectRequest, opts ...grpc.CallOption) (*api.StorageObjectAck, error)
}

ConsoleClient is the client API for Console service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConsoleClient 

func NewConsoleClient(cc grpc.ClientConnInterface) ConsoleClient

type ConsoleServer 

type ConsoleServer interface {
	// Authenticate a console user with username and password.
	Authenticate(context.Context, *AuthenticateRequest) (*ConsoleSession, error)
	// Log out a session and invalidate the session token.
	AuthenticateLogout(context.Context, *AuthenticateLogoutRequest) (*emptypb.Empty, error)
	// Add a new console user.
	AddUser(context.Context, *AddUserRequest) (*emptypb.Empty, error)
	// Add/join members to a group.
	AddGroupUsers(context.Context, *AddGroupUsersRequest) (*emptypb.Empty, error)
	// Ban a user.
	BanAccount(context.Context, *AccountId) (*emptypb.Empty, error)
	// API Explorer - call an endpoint
	CallApiEndpoint(context.Context, *CallApiEndpointRequest) (*CallApiEndpointResponse, error)
	// API Explorer - call a custom RPC endpoint
	CallRpcEndpoint(context.Context, *CallApiEndpointRequest) (*CallApiEndpointResponse, error)
	// Deletes all data
	DeleteAllData(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
	// Delete all information stored for a user account.
	DeleteAccount(context.Context, *AccountDeleteRequest) (*emptypb.Empty, error)
	// Delete messages.
	DeleteChannelMessages(context.Context, *DeleteChannelMessagesRequest) (*DeleteChannelMessagesResponse, error)
	// Delete the friend relationship between two users.
	DeleteFriend(context.Context, *DeleteFriendRequest) (*emptypb.Empty, error)
	// Remove a group.
	DeleteGroup(context.Context, *DeleteGroupRequest) (*emptypb.Empty, error)
	// Remove a user from a group.
	DeleteGroupUser(context.Context, *DeleteGroupUserRequest) (*emptypb.Empty, error)
	// Delete all storage data.
	DeleteStorage(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
	// Delete a storage object.
	DeleteStorageObject(context.Context, *DeleteStorageObjectRequest) (*emptypb.Empty, error)
	// Delete (non-recorded) all user accounts.
	DeleteAccounts(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
	// Delete leaderboard
	DeleteLeaderboard(context.Context, *LeaderboardRequest) (*emptypb.Empty, error)
	// Delete leaderboard record
	DeleteLeaderboardRecord(context.Context, *DeleteLeaderboardRecordRequest) (*emptypb.Empty, error)
	// Delete console user.
	DeleteUser(context.Context, *Username) (*emptypb.Empty, error)
	// Delete a wallet ledger item.
	DeleteWalletLedger(context.Context, *DeleteWalletLedgerRequest) (*emptypb.Empty, error)
	// Demote a user from a group.
	DemoteGroupMember(context.Context, *UpdateGroupUserStateRequest) (*emptypb.Empty, error)
	// Export all information stored about a user account.
	ExportAccount(context.Context, *AccountId) (*AccountExport, error)
	// Export all information stored about a group.
	ExportGroup(context.Context, *GroupId) (*GroupExport, error)
	// Get detailed account information for a single user.
	GetAccount(context.Context, *AccountId) (*Account, error)
	// Get server config and configuration warnings.
	GetConfig(context.Context, *emptypb.Empty) (*Config, error)
	// Get a user's list of friend relationships.
	GetFriends(context.Context, *AccountId) (*api.FriendList, error)
	// Get detailed group information.
	GetGroup(context.Context, *GroupId) (*api.Group, error)
	// Get a list of members of the group.
	GetMembers(context.Context, *GroupId) (*api.GroupUserList, error)
	// Get a list of groups the user is a member of.
	GetGroups(context.Context, *AccountId) (*api.UserGroupList, error)
	// Get leaderboard.
	GetLeaderboard(context.Context, *LeaderboardRequest) (*Leaderboard, error)
	// Get current state of a running match
	GetMatchState(context.Context, *MatchStateRequest) (*MatchState, error)
	// Get runtime info
	GetRuntime(context.Context, *emptypb.Empty) (*RuntimeInfo, error)
	// Get current status data for all nodes.
	GetStatus(context.Context, *emptypb.Empty) (*StatusList, error)
	// Get a storage object.
	GetStorage(context.Context, *api.ReadStorageObjectId) (*api.StorageObject, error)
	// Get a list of the user's wallet transactions.
	GetWalletLedger(context.Context, *GetWalletLedgerRequest) (*WalletLedgerList, error)
	// API Explorer - list all endpoints
	ListApiEndpoints(context.Context, *emptypb.Empty) (*ApiEndpointList, error)
	// List leaderboard records.
	ListLeaderboardRecords(context.Context, *api.ListLeaderboardRecordsRequest) (*api.LeaderboardRecordList, error)
	// List leaderboards
	ListLeaderboards(context.Context, *LeaderboardListRequest) (*LeaderboardList, error)
	// List (and optionally filter) storage data.
	ListStorage(context.Context, *ListStorageRequest) (*StorageList, error)
	// List storage collections
	ListStorageCollections(context.Context, *emptypb.Empty) (*StorageCollectionsList, error)
	// List (and optionally filter) accounts.
	ListAccounts(context.Context, *ListAccountsRequest) (*AccountList, error)
	// List channel messages with the selected filter
	ListChannelMessages(context.Context, *ListChannelMessagesRequest) (*api.ChannelMessageList, error)
	// List (and optionally filter) groups.
	ListGroups(context.Context, *ListGroupsRequest) (*GroupList, error)
	// List ongoing matches
	ListMatches(context.Context, *ListMatchesRequest) (*MatchList, error)
	// List validated purchases
	ListPurchases(context.Context, *ListPurchasesRequest) (*api.PurchaseList, error)
	// List validated subscriptions
	ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*api.SubscriptionList, error)
	// List (and optionally filter) users.
	ListUsers(context.Context, *emptypb.Empty) (*UserList, error)
	// Promote a user from a group.
	PromoteGroupMember(context.Context, *UpdateGroupUserStateRequest) (*emptypb.Empty, error)
	// Unban a user.
	UnbanAccount(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the custom ID from a user account.
	UnlinkCustom(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the device ID from a user account.
	UnlinkDevice(context.Context, *UnlinkDeviceRequest) (*emptypb.Empty, error)
	// Unlink the email from a user account.
	UnlinkEmail(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Apple ID from a user account.
	UnlinkApple(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Facebook ID from a user account.
	UnlinkFacebook(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Facebook Instant Game ID from a user account.
	UnlinkFacebookInstantGame(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Game Center ID from a user account.
	UnlinkGameCenter(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Google ID from a user account.
	UnlinkGoogle(context.Context, *AccountId) (*emptypb.Empty, error)
	// Unlink the Steam ID from a user account.
	UnlinkSteam(context.Context, *AccountId) (*emptypb.Empty, error)
	// Update one or more fields on a user account.
	UpdateAccount(context.Context, *UpdateAccountRequest) (*emptypb.Empty, error)
	// Update one or more fields on a group.
	UpdateGroup(context.Context, *UpdateGroupRequest) (*emptypb.Empty, error)
	// Write a new storage object or replace an existing one.
	WriteStorageObject(context.Context, *WriteStorageObjectRequest) (*api.StorageObjectAck, error)
	// contains filtered or unexported methods
}

ConsoleServer is the server API for Console service. All implementations must embed UnimplementedConsoleServer for forward compatibility

type ConsoleSession 

type ConsoleSession struct {

	// A session token (JWT) for the console user.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

A console user session.

func (*ConsoleSession) Descriptor deprecated 

func (*ConsoleSession) Descriptor() ([]byte, []int)

Deprecated: Use ConsoleSession.ProtoReflect.Descriptor instead.

func (*ConsoleSession) GetToken 

func (x *ConsoleSession) GetToken() string

func (*ConsoleSession) ProtoMessage 

func (*ConsoleSession) ProtoMessage()

func (*ConsoleSession) ProtoReflect 

func (x *ConsoleSession) ProtoReflect() protoreflect.Message

func (*ConsoleSession) Reset 

func (x *ConsoleSession) Reset()

func (*ConsoleSession) String 

func (x *ConsoleSession) String() string

type DeleteChannelMessagesRequest added in v3.13.0 

type DeleteChannelMessagesRequest struct {

	// Timestamp before which messages will be deleted.
	Before *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=before,proto3" json:"before,omitempty"`
	// IDs of the messages to delete.
	Ids []string `protobuf:"bytes,2,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

Delete channel messages by timestamp or/and ids.

func (*DeleteChannelMessagesRequest) Descriptor deprecated added in v3.13.0 

func (*DeleteChannelMessagesRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteChannelMessagesRequest.ProtoReflect.Descriptor instead.

func (*DeleteChannelMessagesRequest) GetBefore added in v3.13.0 

func (x *DeleteChannelMessagesRequest) GetBefore() *timestamppb.Timestamp

func (*DeleteChannelMessagesRequest) GetIds added in v3.13.0 

func (x *DeleteChannelMessagesRequest) GetIds() []string

func (*DeleteChannelMessagesRequest) ProtoMessage added in v3.13.0 

func (*DeleteChannelMessagesRequest) ProtoMessage()

func (*DeleteChannelMessagesRequest) ProtoReflect added in v3.13.0 

func (x *DeleteChannelMessagesRequest) ProtoReflect() protoreflect.Message

func (*DeleteChannelMessagesRequest) Reset added in v3.13.0 

func (x *DeleteChannelMessagesRequest) Reset()

func (*DeleteChannelMessagesRequest) String added in v3.13.0 

func (x *DeleteChannelMessagesRequest) String() string

type DeleteChannelMessagesResponse added in v3.13.0 

type DeleteChannelMessagesResponse struct {

	// Total number of messages deleted.
	Total int64 `protobuf:"varint,1,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteChannelMessagesResponse) Descriptor deprecated added in v3.13.0 

func (*DeleteChannelMessagesResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteChannelMessagesResponse.ProtoReflect.Descriptor instead.

func (*DeleteChannelMessagesResponse) GetTotal added in v3.13.0 

func (x *DeleteChannelMessagesResponse) GetTotal() int64

func (*DeleteChannelMessagesResponse) ProtoMessage added in v3.13.0 

func (*DeleteChannelMessagesResponse) ProtoMessage()

func (*DeleteChannelMessagesResponse) ProtoReflect added in v3.13.0 

func (x *DeleteChannelMessagesResponse) ProtoReflect() protoreflect.Message

func (*DeleteChannelMessagesResponse) Reset added in v3.13.0 

func (x *DeleteChannelMessagesResponse) Reset()

func (*DeleteChannelMessagesResponse) String added in v3.13.0 

func (x *DeleteChannelMessagesResponse) String() string

type DeleteFriendRequest 

type DeleteFriendRequest struct {

	// The user do delete for.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// User ID of the friend to remove.
	FriendId string `protobuf:"bytes,2,opt,name=friend_id,json=friendId,proto3" json:"friend_id,omitempty"`
	// contains filtered or unexported fields
}

Delete friend relationship between two users.

func (*DeleteFriendRequest) Descriptor deprecated 

func (*DeleteFriendRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFriendRequest.ProtoReflect.Descriptor instead.

func (*DeleteFriendRequest) GetFriendId 

func (x *DeleteFriendRequest) GetFriendId() string

func (*DeleteFriendRequest) GetId 

func (x *DeleteFriendRequest) GetId() string

func (*DeleteFriendRequest) ProtoMessage 

func (*DeleteFriendRequest) ProtoMessage()

func (*DeleteFriendRequest) ProtoReflect 

func (x *DeleteFriendRequest) ProtoReflect() protoreflect.Message

func (*DeleteFriendRequest) Reset 

func (x *DeleteFriendRequest) Reset()

func (*DeleteFriendRequest) String 

func (x *DeleteFriendRequest) String() string

type DeleteGroupRequest added in v3.11.0 

type DeleteGroupRequest struct {

	// ID of the group to delete.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Delete a group.

func (*DeleteGroupRequest) Descriptor deprecated added in v3.11.0 

func (*DeleteGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteGroupRequest.ProtoReflect.Descriptor instead.

func (*DeleteGroupRequest) GetId added in v3.11.0 

func (x *DeleteGroupRequest) GetId() string

func (*DeleteGroupRequest) ProtoMessage added in v3.11.0 

func (*DeleteGroupRequest) ProtoMessage()

func (*DeleteGroupRequest) ProtoReflect added in v3.11.0 

func (x *DeleteGroupRequest) ProtoReflect() protoreflect.Message

func (*DeleteGroupRequest) Reset added in v3.11.0 

func (x *DeleteGroupRequest) Reset()

func (*DeleteGroupRequest) String added in v3.11.0 

func (x *DeleteGroupRequest) String() string

type DeleteGroupUserRequest 

type DeleteGroupUserRequest struct {

	// User to remove.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the group to remove them from.
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

Remove a user from a group.

func (*DeleteGroupUserRequest) Descriptor deprecated 

func (*DeleteGroupUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteGroupUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteGroupUserRequest) GetGroupId 

func (x *DeleteGroupUserRequest) GetGroupId() string

func (*DeleteGroupUserRequest) GetId 

func (x *DeleteGroupUserRequest) GetId() string

func (*DeleteGroupUserRequest) ProtoMessage 

func (*DeleteGroupUserRequest) ProtoMessage()

func (*DeleteGroupUserRequest) ProtoReflect 

func (x *DeleteGroupUserRequest) ProtoReflect() protoreflect.Message

func (*DeleteGroupUserRequest) Reset 

func (x *DeleteGroupUserRequest) Reset()

func (*DeleteGroupUserRequest) String 

func (x *DeleteGroupUserRequest) String() string

type DeleteLeaderboardRecordRequest 

type DeleteLeaderboardRecordRequest struct {

	// Leaderboard ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Record owner.
	OwnerId string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	// contains filtered or unexported fields
}

Remove a leaderboard record

func (*DeleteLeaderboardRecordRequest) Descriptor deprecated 

func (*DeleteLeaderboardRecordRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteLeaderboardRecordRequest.ProtoReflect.Descriptor instead.

func (*DeleteLeaderboardRecordRequest) GetId 

func (x *DeleteLeaderboardRecordRequest) GetId() string

func (*DeleteLeaderboardRecordRequest) GetOwnerId 

func (x *DeleteLeaderboardRecordRequest) GetOwnerId() string

func (*DeleteLeaderboardRecordRequest) ProtoMessage 

func (*DeleteLeaderboardRecordRequest) ProtoMessage()

func (*DeleteLeaderboardRecordRequest) ProtoReflect 

func (x *DeleteLeaderboardRecordRequest) ProtoReflect() protoreflect.Message

func (*DeleteLeaderboardRecordRequest) Reset 

func (x *DeleteLeaderboardRecordRequest) Reset()

func (*DeleteLeaderboardRecordRequest) String 

func (x *DeleteLeaderboardRecordRequest) String() string

type DeleteStorageObjectRequest 

type DeleteStorageObjectRequest struct {

	// Collection.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Key.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Owner user ID.
	UserId string `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Version for OCC.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Delete an individual storage object.

func (*DeleteStorageObjectRequest) Descriptor deprecated 

func (*DeleteStorageObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteStorageObjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteStorageObjectRequest) GetCollection 

func (x *DeleteStorageObjectRequest) GetCollection() string

func (*DeleteStorageObjectRequest) GetKey 

func (x *DeleteStorageObjectRequest) GetKey() string

func (*DeleteStorageObjectRequest) GetUserId 

func (x *DeleteStorageObjectRequest) GetUserId() string

func (*DeleteStorageObjectRequest) GetVersion 

func (x *DeleteStorageObjectRequest) GetVersion() string

func (*DeleteStorageObjectRequest) ProtoMessage 

func (*DeleteStorageObjectRequest) ProtoMessage()

func (*DeleteStorageObjectRequest) ProtoReflect 

func (x *DeleteStorageObjectRequest) ProtoReflect() protoreflect.Message

func (*DeleteStorageObjectRequest) Reset 

func (x *DeleteStorageObjectRequest) Reset()

func (*DeleteStorageObjectRequest) String 

func (x *DeleteStorageObjectRequest) String() string

type DeleteWalletLedgerRequest 

type DeleteWalletLedgerRequest struct {

	// User ID to remove wallet ledger item from.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the wallet ledger item to remove.
	WalletId string `protobuf:"bytes,2,opt,name=wallet_id,json=walletId,proto3" json:"wallet_id,omitempty"`
	// contains filtered or unexported fields
}

Delete a single wallet ledger item.

func (*DeleteWalletLedgerRequest) Descriptor deprecated 

func (*DeleteWalletLedgerRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteWalletLedgerRequest.ProtoReflect.Descriptor instead.

func (*DeleteWalletLedgerRequest) GetId 

func (x *DeleteWalletLedgerRequest) GetId() string

func (*DeleteWalletLedgerRequest) GetWalletId 

func (x *DeleteWalletLedgerRequest) GetWalletId() string

func (*DeleteWalletLedgerRequest) ProtoMessage 

func (*DeleteWalletLedgerRequest) ProtoMessage()

func (*DeleteWalletLedgerRequest) ProtoReflect 

func (x *DeleteWalletLedgerRequest) ProtoReflect() protoreflect.Message

func (*DeleteWalletLedgerRequest) Reset 

func (x *DeleteWalletLedgerRequest) Reset()

func (*DeleteWalletLedgerRequest) String 

func (x *DeleteWalletLedgerRequest) String() string

type GetWalletLedgerRequest added in v3.9.0 

type GetWalletLedgerRequest struct {

	// The unique identifier of the user account.
	AccountId string `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// Max number of results per page
	Limit uint32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Cursor to retrieve a page of records from
	Cursor string `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWalletLedgerRequest) Descriptor deprecated added in v3.9.0 

func (*GetWalletLedgerRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetWalletLedgerRequest.ProtoReflect.Descriptor instead.

func (*GetWalletLedgerRequest) GetAccountId added in v3.9.0 

func (x *GetWalletLedgerRequest) GetAccountId() string

func (*GetWalletLedgerRequest) GetCursor added in v3.9.0 

func (x *GetWalletLedgerRequest) GetCursor() string

func (*GetWalletLedgerRequest) GetLimit added in v3.9.0 

func (x *GetWalletLedgerRequest) GetLimit() uint32

func (*GetWalletLedgerRequest) ProtoMessage added in v3.9.0 

func (*GetWalletLedgerRequest) ProtoMessage()

func (*GetWalletLedgerRequest) ProtoReflect added in v3.9.0 

func (x *GetWalletLedgerRequest) ProtoReflect() protoreflect.Message

func (*GetWalletLedgerRequest) Reset added in v3.9.0 

func (x *GetWalletLedgerRequest) Reset()

func (*GetWalletLedgerRequest) String added in v3.9.0 

func (x *GetWalletLedgerRequest) String() string

type GroupExport added in v3.11.0 

type GroupExport struct {

	// The group details.
	Group *api.Group `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// The group's list of members.
	Members []*api.GroupUserList_GroupUser `protobuf:"bytes,2,rep,name=members,proto3" json:"members,omitempty"`
	// contains filtered or unexported fields
}

An export of all information stored for a group.

func (*GroupExport) Descriptor deprecated added in v3.11.0 

func (*GroupExport) Descriptor() ([]byte, []int)

Deprecated: Use GroupExport.ProtoReflect.Descriptor instead.

func (*GroupExport) GetGroup added in v3.11.0 

func (x *GroupExport) GetGroup() *api.Group

func (*GroupExport) GetMembers added in v3.11.0 

func (x *GroupExport) GetMembers() []*api.GroupUserList_GroupUser

func (*GroupExport) ProtoMessage added in v3.11.0 

func (*GroupExport) ProtoMessage()

func (*GroupExport) ProtoReflect added in v3.11.0 

func (x *GroupExport) ProtoReflect() protoreflect.Message

func (*GroupExport) Reset added in v3.11.0 

func (x *GroupExport) Reset()

func (*GroupExport) String added in v3.11.0 

func (x *GroupExport) String() string

type GroupId added in v3.11.0 

type GroupId struct {

	// The unique identifier of the group.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The identifier for a group.

func (*GroupId) Descriptor deprecated added in v3.11.0 

func (*GroupId) Descriptor() ([]byte, []int)

Deprecated: Use GroupId.ProtoReflect.Descriptor instead.

func (*GroupId) GetId added in v3.11.0 

func (x *GroupId) GetId() string

func (*GroupId) ProtoMessage added in v3.11.0 

func (*GroupId) ProtoMessage()

func (*GroupId) ProtoReflect added in v3.11.0 

func (x *GroupId) ProtoReflect() protoreflect.Message

func (*GroupId) Reset added in v3.11.0 

func (x *GroupId) Reset()

func (*GroupId) String added in v3.11.0 

func (x *GroupId) String() string

type GroupList added in v3.11.0 

type GroupList struct {

	// A list of groups.
	Groups []*api.Group `protobuf:"bytes,1,rep,name=groups,proto3" json:"groups,omitempty"`
	// Approximate total number of groups.
	TotalCount int32 `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Next cursor.
	NextCursor string `protobuf:"bytes,3,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// contains filtered or unexported fields
}

A list of groups

func (*GroupList) Descriptor deprecated added in v3.11.0 

func (*GroupList) Descriptor() ([]byte, []int)

Deprecated: Use GroupList.ProtoReflect.Descriptor instead.

func (*GroupList) GetGroups added in v3.11.0 

func (x *GroupList) GetGroups() []*api.Group

func (*GroupList) GetNextCursor added in v3.11.0 

func (x *GroupList) GetNextCursor() string

func (*GroupList) GetTotalCount added in v3.11.0 

func (x *GroupList) GetTotalCount() int32

func (*GroupList) ProtoMessage added in v3.11.0 

func (*GroupList) ProtoMessage()

func (*GroupList) ProtoReflect added in v3.11.0 

func (x *GroupList) ProtoReflect() protoreflect.Message

func (*GroupList) Reset added in v3.11.0 

func (x *GroupList) Reset()

func (*GroupList) String added in v3.11.0 

func (x *GroupList) String() string

type Leaderboard 

type Leaderboard struct {

	// The ID of the leaderboard.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The title for the leaderboard.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// The description of the leaderboard. May be blank.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The category of the leaderboard. e.g. "vip" could be category 1.
	Category uint32 `protobuf:"varint,4,opt,name=category,proto3" json:"category,omitempty"`
	// ASC or DESC sort mode of scores in the leaderboard.
	SortOrder uint32 `protobuf:"varint,5,opt,name=sort_order,json=sortOrder,proto3" json:"sort_order,omitempty"`
	// The current number of players in the leaderboard.
	Size uint32 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`
	// The maximum number of players for the leaderboard.
	MaxSize uint32 `protobuf:"varint,7,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// The maximum score updates allowed per player for the current leaderboard.
	MaxNumScore uint32 `protobuf:"varint,8,opt,name=max_num_score,json=maxNumScore,proto3" json:"max_num_score,omitempty"`
	// The operator of the leaderboard
	Operator uint32 `protobuf:"varint,9,opt,name=operator,proto3" json:"operator,omitempty"`
	// The UNIX time when the leaderboard stops being active until next reset. A computed value.
	EndActive uint32 `protobuf:"varint,10,opt,name=end_active,json=endActive,proto3" json:"end_active,omitempty"`
	// Reset cron expression.
	ResetSchedule string `protobuf:"bytes,11,opt,name=reset_schedule,json=resetSchedule,proto3" json:"reset_schedule,omitempty"`
	// Additional information stored as a JSON object.
	Metadata string `protobuf:"bytes,12,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The UNIX time when the leaderboard was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The UNIX time when the leaderboard will start.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The UNIX time when the leaderboard will be stopped.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Duration of the tournament in seconds.
	Duration uint32 `protobuf:"varint,16,opt,name=duration,proto3" json:"duration,omitempty"`
	// The UNIX time when the leaderboard start being active. A computed value.
	StartActive uint32 `protobuf:"varint,17,opt,name=start_active,json=startActive,proto3" json:"start_active,omitempty"`
	// Join required.
	JoinRequired bool `protobuf:"varint,18,opt,name=join_required,json=joinRequired,proto3" json:"join_required,omitempty"`
	// Authoritative.
	Authoritative bool `protobuf:"varint,19,opt,name=authoritative,proto3" json:"authoritative,omitempty"`
	// Tournament.
	Tournament bool `protobuf:"varint,20,opt,name=tournament,proto3" json:"tournament,omitempty"`
	// The UNIX time when the tournament was last reset. A computed value.
	PrevReset uint32 `protobuf:"varint,21,opt,name=prev_reset,json=prevReset,proto3" json:"prev_reset,omitempty"`
	// The UNIX time when the tournament is next playable. A computed value.
	NextReset uint32 `protobuf:"varint,22,opt,name=next_reset,json=nextReset,proto3" json:"next_reset,omitempty"`
	// contains filtered or unexported fields
}

A leaderboard.

func (*Leaderboard) Descriptor deprecated 

func (*Leaderboard) Descriptor() ([]byte, []int)

Deprecated: Use Leaderboard.ProtoReflect.Descriptor instead.

func (*Leaderboard) GetAuthoritative 

func (x *Leaderboard) GetAuthoritative() bool

func (*Leaderboard) GetCategory 

func (x *Leaderboard) GetCategory() uint32

func (*Leaderboard) GetCreateTime 

func (x *Leaderboard) GetCreateTime() *timestamppb.Timestamp

func (*Leaderboard) GetDescription 

func (x *Leaderboard) GetDescription() string

func (*Leaderboard) GetDuration 

func (x *Leaderboard) GetDuration() uint32

func (*Leaderboard) GetEndActive 

func (x *Leaderboard) GetEndActive() uint32

func (*Leaderboard) GetEndTime 

func (x *Leaderboard) GetEndTime() *timestamppb.Timestamp

func (*Leaderboard) GetId 

func (x *Leaderboard) GetId() string

func (*Leaderboard) GetJoinRequired 

func (x *Leaderboard) GetJoinRequired() bool

func (*Leaderboard) GetMaxNumScore 

func (x *Leaderboard) GetMaxNumScore() uint32

func (*Leaderboard) GetMaxSize 

func (x *Leaderboard) GetMaxSize() uint32

func (*Leaderboard) GetMetadata 

func (x *Leaderboard) GetMetadata() string

func (*Leaderboard) GetNextReset added in v3.16.0 

func (x *Leaderboard) GetNextReset() uint32

func (*Leaderboard) GetOperator 

func (x *Leaderboard) GetOperator() uint32

func (*Leaderboard) GetPrevReset added in v3.16.0 

func (x *Leaderboard) GetPrevReset() uint32

func (*Leaderboard) GetResetSchedule 

func (x *Leaderboard) GetResetSchedule() string

func (*Leaderboard) GetSize 

func (x *Leaderboard) GetSize() uint32

func (*Leaderboard) GetSortOrder 

func (x *Leaderboard) GetSortOrder() uint32

func (*Leaderboard) GetStartActive 

func (x *Leaderboard) GetStartActive() uint32

func (*Leaderboard) GetStartTime 

func (x *Leaderboard) GetStartTime() *timestamppb.Timestamp

func (*Leaderboard) GetTitle 

func (x *Leaderboard) GetTitle() string

func (*Leaderboard) GetTournament 

func (x *Leaderboard) GetTournament() bool

func (*Leaderboard) ProtoMessage 

func (*Leaderboard) ProtoMessage()

func (*Leaderboard) ProtoReflect 

func (x *Leaderboard) ProtoReflect() protoreflect.Message

func (*Leaderboard) Reset 

func (x *Leaderboard) Reset()

func (*Leaderboard) String 

func (x *Leaderboard) String() string

type LeaderboardList 

type LeaderboardList struct {

	// The list of leaderboards returned.
	Leaderboards []*Leaderboard `protobuf:"bytes,1,rep,name=leaderboards,proto3" json:"leaderboards,omitempty"`
	// Total count of leaderboards and tournaments.
	Total int32 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
	// A cursor, if any.
	Cursor string `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

A list of leaderboards.

func (*LeaderboardList) Descriptor deprecated 

func (*LeaderboardList) Descriptor() ([]byte, []int)

Deprecated: Use LeaderboardList.ProtoReflect.Descriptor instead.

func (*LeaderboardList) GetCursor added in v3.17.0 

func (x *LeaderboardList) GetCursor() string

func (*LeaderboardList) GetLeaderboards 

func (x *LeaderboardList) GetLeaderboards() []*Leaderboard

func (*LeaderboardList) GetTotal added in v3.17.0 

func (x *LeaderboardList) GetTotal() int32

func (*LeaderboardList) ProtoMessage 

func (*LeaderboardList) ProtoMessage()

func (*LeaderboardList) ProtoReflect 

func (x *LeaderboardList) ProtoReflect() protoreflect.Message

func (*LeaderboardList) Reset 

func (x *LeaderboardList) Reset()

func (*LeaderboardList) String 

func (x *LeaderboardList) String() string

type LeaderboardListRequest added in v3.17.0 

type LeaderboardListRequest struct {

	// An optional cursor to paginate from.
	Cursor string `protobuf:"bytes,1,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List leaderboards.

func (*LeaderboardListRequest) Descriptor deprecated added in v3.17.0 

func (*LeaderboardListRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaderboardListRequest.ProtoReflect.Descriptor instead.

func (*LeaderboardListRequest) GetCursor added in v3.17.0 

func (x *LeaderboardListRequest) GetCursor() string

func (*LeaderboardListRequest) ProtoMessage added in v3.17.0 

func (*LeaderboardListRequest) ProtoMessage()

func (*LeaderboardListRequest) ProtoReflect added in v3.17.0 

func (x *LeaderboardListRequest) ProtoReflect() protoreflect.Message

func (*LeaderboardListRequest) Reset added in v3.17.0 

func (x *LeaderboardListRequest) Reset()

func (*LeaderboardListRequest) String added in v3.17.0 

func (x *LeaderboardListRequest) String() string

type LeaderboardRequest 

type LeaderboardRequest struct {

	// Leaderboard ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Get Leaderboard.

func (*LeaderboardRequest) Descriptor deprecated 

func (*LeaderboardRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaderboardRequest.ProtoReflect.Descriptor instead.

func (*LeaderboardRequest) GetId 

func (x *LeaderboardRequest) GetId() string

func (*LeaderboardRequest) ProtoMessage 

func (*LeaderboardRequest) ProtoMessage()

func (*LeaderboardRequest) ProtoReflect 

func (x *LeaderboardRequest) ProtoReflect() protoreflect.Message

func (*LeaderboardRequest) Reset 

func (x *LeaderboardRequest) Reset()

func (*LeaderboardRequest) String 

func (x *LeaderboardRequest) String() string

type ListAccountsRequest 

type ListAccountsRequest struct {

	// User ID or username filter.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Search only recorded deletes.
	Tombstones bool `protobuf:"varint,2,opt,name=tombstones,proto3" json:"tombstones,omitempty"`
	// Cursor to start from
	Cursor string `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List (and optionally filter) users.

func (*ListAccountsRequest) Descriptor deprecated 

func (*ListAccountsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListAccountsRequest) GetCursor 

func (x *ListAccountsRequest) GetCursor() string

func (*ListAccountsRequest) GetFilter 

func (x *ListAccountsRequest) GetFilter() string

func (*ListAccountsRequest) GetTombstones 

func (x *ListAccountsRequest) GetTombstones() bool

func (*ListAccountsRequest) ProtoMessage 

func (*ListAccountsRequest) ProtoMessage()

func (*ListAccountsRequest) ProtoReflect 

func (x *ListAccountsRequest) ProtoReflect() protoreflect.Message

func (*ListAccountsRequest) Reset 

func (x *ListAccountsRequest) Reset()

func (*ListAccountsRequest) String 

func (x *ListAccountsRequest) String() string

type ListChannelMessagesRequest added in v3.13.0 

type ListChannelMessagesRequest struct {

	// Type of the chat channel
	Type ListChannelMessagesRequest_Type `protobuf:"varint,1,opt,name=type,proto3,enum=nakama.console.ListChannelMessagesRequest_Type" json:"type,omitempty"`
	// Label of the channel, if a standard chat room
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// Group ID of the channel, if a group chat
	GroupId string `protobuf:"bytes,3,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// User IDs, if a direct chat
	UserIdOne string `protobuf:"bytes,4,opt,name=user_id_one,json=userIdOne,proto3" json:"user_id_one,omitempty"`
	UserIdTwo string `protobuf:"bytes,5,opt,name=user_id_two,json=userIdTwo,proto3" json:"user_id_two,omitempty"`
	// Cursor to start from
	Cursor string `protobuf:"bytes,6,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List selected channel messages.

func (*ListChannelMessagesRequest) Descriptor deprecated added in v3.13.0 

func (*ListChannelMessagesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListChannelMessagesRequest.ProtoReflect.Descriptor instead.

func (*ListChannelMessagesRequest) GetCursor added in v3.13.0 

func (x *ListChannelMessagesRequest) GetCursor() string

func (*ListChannelMessagesRequest) GetGroupId added in v3.13.0 

func (x *ListChannelMessagesRequest) GetGroupId() string

func (*ListChannelMessagesRequest) GetLabel added in v3.13.0 

func (x *ListChannelMessagesRequest) GetLabel() string

func (*ListChannelMessagesRequest) GetType added in v3.13.0 

func (x *ListChannelMessagesRequest) GetType() ListChannelMessagesRequest_Type

func (*ListChannelMessagesRequest) GetUserIdOne added in v3.13.0 

func (x *ListChannelMessagesRequest) GetUserIdOne() string

func (*ListChannelMessagesRequest) GetUserIdTwo added in v3.13.0 

func (x *ListChannelMessagesRequest) GetUserIdTwo() string

func (*ListChannelMessagesRequest) ProtoMessage added in v3.13.0 

func (*ListChannelMessagesRequest) ProtoMessage()

func (*ListChannelMessagesRequest) ProtoReflect added in v3.13.0 

func (x *ListChannelMessagesRequest) ProtoReflect() protoreflect.Message

func (*ListChannelMessagesRequest) Reset added in v3.13.0 

func (x *ListChannelMessagesRequest) Reset()

func (*ListChannelMessagesRequest) String added in v3.13.0 

func (x *ListChannelMessagesRequest) String() string

type ListChannelMessagesRequest_Type added in v3.13.0 

type ListChannelMessagesRequest_Type int32
const (
	ListChannelMessagesRequest_UNKNOWN ListChannelMessagesRequest_Type = 0
	ListChannelMessagesRequest_ROOM    ListChannelMessagesRequest_Type = 2
	ListChannelMessagesRequest_GROUP   ListChannelMessagesRequest_Type = 3
	ListChannelMessagesRequest_DIRECT  ListChannelMessagesRequest_Type = 4
)

func (ListChannelMessagesRequest_Type) Descriptor added in v3.13.0 

func (ListChannelMessagesRequest_Type) Descriptor() protoreflect.EnumDescriptor

func (ListChannelMessagesRequest_Type) Enum added in v3.13.0 

func (x ListChannelMessagesRequest_Type) Enum() *ListChannelMessagesRequest_Type

func (ListChannelMessagesRequest_Type) EnumDescriptor deprecated added in v3.13.0 

func (ListChannelMessagesRequest_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use ListChannelMessagesRequest_Type.Descriptor instead.

func (ListChannelMessagesRequest_Type) Number added in v3.13.0 

func (x ListChannelMessagesRequest_Type) Number() protoreflect.EnumNumber

func (ListChannelMessagesRequest_Type) String added in v3.13.0 

func (x ListChannelMessagesRequest_Type) String() string

func (ListChannelMessagesRequest_Type) Type added in v3.13.0 

func (ListChannelMessagesRequest_Type) Type() protoreflect.EnumType

type ListGroupsRequest added in v3.11.0 

type ListGroupsRequest struct {

	// User ID or username filter.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Cursor to start from
	Cursor string `protobuf:"bytes,2,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List (and optionally filter) groups.

func (*ListGroupsRequest) Descriptor deprecated added in v3.11.0 

func (*ListGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListGroupsRequest) GetCursor added in v3.11.0 

func (x *ListGroupsRequest) GetCursor() string

func (*ListGroupsRequest) GetFilter added in v3.11.0 

func (x *ListGroupsRequest) GetFilter() string

func (*ListGroupsRequest) ProtoMessage added in v3.11.0 

func (*ListGroupsRequest) ProtoMessage()

func (*ListGroupsRequest) ProtoReflect added in v3.11.0 

func (x *ListGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListGroupsRequest) Reset added in v3.11.0 

func (x *ListGroupsRequest) Reset()

func (*ListGroupsRequest) String added in v3.11.0 

func (x *ListGroupsRequest) String() string

type ListMatchesRequest added in v3.13.0 

type ListMatchesRequest struct {

	// Limit the number of returned matches.
	Limit *wrapperspb.Int32Value `protobuf:"bytes,1,opt,name=limit,proto3" json:"limit,omitempty"`
	// Authoritative or relayed matches, or null for both.
	Authoritative *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=authoritative,proto3" json:"authoritative,omitempty"`
	// Label filter.
	Label *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// Minimum user count.
	MinSize *wrapperspb.Int32Value `protobuf:"bytes,4,opt,name=min_size,json=minSize,proto3" json:"min_size,omitempty"`
	// Maximum user count.
	MaxSize *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// Match ID.
	MatchId string `protobuf:"bytes,6,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// Arbitrary label query.
	Query *wrapperspb.StringValue `protobuf:"bytes,7,opt,name=query,proto3" json:"query,omitempty"`
	// Node name filter, optional.
	Node *wrapperspb.StringValue `protobuf:"bytes,8,opt,name=node,proto3" json:"node,omitempty"`
	// contains filtered or unexported fields
}

List realtime matches.

func (*ListMatchesRequest) Descriptor deprecated added in v3.13.0 

func (*ListMatchesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMatchesRequest.ProtoReflect.Descriptor instead.

func (*ListMatchesRequest) GetAuthoritative added in v3.13.0 

func (x *ListMatchesRequest) GetAuthoritative() *wrapperspb.BoolValue

func (*ListMatchesRequest) GetLabel added in v3.13.0 

func (x *ListMatchesRequest) GetLabel() *wrapperspb.StringValue

func (*ListMatchesRequest) GetLimit added in v3.13.0 

func (x *ListMatchesRequest) GetLimit() *wrapperspb.Int32Value

func (*ListMatchesRequest) GetMatchId added in v3.13.0 

func (x *ListMatchesRequest) GetMatchId() string

func (*ListMatchesRequest) GetMaxSize added in v3.13.0 

func (x *ListMatchesRequest) GetMaxSize() *wrapperspb.Int32Value

func (*ListMatchesRequest) GetMinSize added in v3.13.0 

func (x *ListMatchesRequest) GetMinSize() *wrapperspb.Int32Value

func (*ListMatchesRequest) GetNode added in v3.13.0 

func (x *ListMatchesRequest) GetNode() *wrapperspb.StringValue

func (*ListMatchesRequest) GetQuery added in v3.13.0 

func (x *ListMatchesRequest) GetQuery() *wrapperspb.StringValue

func (*ListMatchesRequest) ProtoMessage added in v3.13.0 

func (*ListMatchesRequest) ProtoMessage()

func (*ListMatchesRequest) ProtoReflect added in v3.13.0 

func (x *ListMatchesRequest) ProtoReflect() protoreflect.Message

func (*ListMatchesRequest) Reset added in v3.13.0 

func (x *ListMatchesRequest) Reset()

func (*ListMatchesRequest) String added in v3.13.0 

func (x *ListMatchesRequest) String() string

type ListPurchasesRequest added in v3.2.0 

type ListPurchasesRequest struct {

	// User ID to filter purchases for
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Max number of results per page
	Limit uint32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Cursor to retrieve a page of records from
	Cursor string `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List validated purchases.

func (*ListPurchasesRequest) Descriptor deprecated added in v3.2.0 

func (*ListPurchasesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPurchasesRequest.ProtoReflect.Descriptor instead.

func (*ListPurchasesRequest) GetCursor added in v3.2.0 

func (x *ListPurchasesRequest) GetCursor() string

func (*ListPurchasesRequest) GetLimit added in v3.2.0 

func (x *ListPurchasesRequest) GetLimit() uint32

func (*ListPurchasesRequest) GetUserId added in v3.2.0 

func (x *ListPurchasesRequest) GetUserId() string

func (*ListPurchasesRequest) ProtoMessage added in v3.2.0 

func (*ListPurchasesRequest) ProtoMessage()

func (*ListPurchasesRequest) ProtoReflect added in v3.2.0 

func (x *ListPurchasesRequest) ProtoReflect() protoreflect.Message

func (*ListPurchasesRequest) Reset added in v3.2.0 

func (x *ListPurchasesRequest) Reset()

func (*ListPurchasesRequest) String added in v3.2.0 

func (x *ListPurchasesRequest) String() string

type ListStorageRequest 

type ListStorageRequest struct {

	// User ID to filter objects for.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Key to filter objects for
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Collection name to filter objects for
	Collection string `protobuf:"bytes,3,opt,name=collection,proto3" json:"collection,omitempty"`
	// Cursor to retrieve a page of records from
	Cursor string `protobuf:"bytes,4,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List (and optionally filter) storage objects.

func (*ListStorageRequest) Descriptor deprecated 

func (*ListStorageRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListStorageRequest.ProtoReflect.Descriptor instead.

func (*ListStorageRequest) GetCollection 

func (x *ListStorageRequest) GetCollection() string

func (*ListStorageRequest) GetCursor 

func (x *ListStorageRequest) GetCursor() string

func (*ListStorageRequest) GetKey 

func (x *ListStorageRequest) GetKey() string

func (*ListStorageRequest) GetUserId 

func (x *ListStorageRequest) GetUserId() string

func (*ListStorageRequest) ProtoMessage 

func (*ListStorageRequest) ProtoMessage()

func (*ListStorageRequest) ProtoReflect 

func (x *ListStorageRequest) ProtoReflect() protoreflect.Message

func (*ListStorageRequest) Reset 

func (x *ListStorageRequest) Reset()

func (*ListStorageRequest) String 

func (x *ListStorageRequest) String() string

type ListSubscriptionsRequest added in v3.13.0 

type ListSubscriptionsRequest struct {

	// UserID to filter subscriptions for
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Max number of results per page
	Limit uint32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Cursor to retrieve a page of records from
	Cursor string `protobuf:"bytes,3,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

List subscriptions.

func (*ListSubscriptionsRequest) Descriptor deprecated added in v3.13.0 

func (*ListSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListSubscriptionsRequest) GetCursor added in v3.13.0 

func (x *ListSubscriptionsRequest) GetCursor() string

func (*ListSubscriptionsRequest) GetLimit added in v3.13.0 

func (x *ListSubscriptionsRequest) GetLimit() uint32

func (*ListSubscriptionsRequest) GetUserId added in v3.13.0 

func (x *ListSubscriptionsRequest) GetUserId() string

func (*ListSubscriptionsRequest) ProtoMessage added in v3.13.0 

func (*ListSubscriptionsRequest) ProtoMessage()

func (*ListSubscriptionsRequest) ProtoReflect added in v3.13.0 

func (x *ListSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*ListSubscriptionsRequest) Reset added in v3.13.0 

func (x *ListSubscriptionsRequest) Reset()

func (*ListSubscriptionsRequest) String added in v3.13.0 

func (x *ListSubscriptionsRequest) String() string

type MatchList added in v3.13.0 

type MatchList struct {
	Matches []*MatchList_Match `protobuf:"bytes,1,rep,name=matches,proto3" json:"matches,omitempty"`
	// contains filtered or unexported fields
}

A list of realtime matches, with their node names.

func (*MatchList) Descriptor deprecated added in v3.13.0 

func (*MatchList) Descriptor() ([]byte, []int)

Deprecated: Use MatchList.ProtoReflect.Descriptor instead.

func (*MatchList) GetMatches added in v3.13.0 

func (x *MatchList) GetMatches() []*MatchList_Match

func (*MatchList) ProtoMessage added in v3.13.0 

func (*MatchList) ProtoMessage()

func (*MatchList) ProtoReflect added in v3.13.0 

func (x *MatchList) ProtoReflect() protoreflect.Message

func (*MatchList) Reset added in v3.13.0 

func (x *MatchList) Reset()

func (*MatchList) String added in v3.13.0 

func (x *MatchList) String() string

type MatchList_Match added in v3.13.0 

type MatchList_Match struct {

	// The API match
	ApiMatch *api.Match `protobuf:"bytes,1,opt,name=api_match,json=apiMatch,proto3" json:"api_match,omitempty"`
	// The node name
	Node string `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"`
	// contains filtered or unexported fields
}

func (*MatchList_Match) Descriptor deprecated added in v3.13.0 

func (*MatchList_Match) Descriptor() ([]byte, []int)

Deprecated: Use MatchList_Match.ProtoReflect.Descriptor instead.

func (*MatchList_Match) GetApiMatch added in v3.13.0 

func (x *MatchList_Match) GetApiMatch() *api.Match

func (*MatchList_Match) GetNode added in v3.13.0 

func (x *MatchList_Match) GetNode() string

func (*MatchList_Match) ProtoMessage added in v3.13.0 

func (*MatchList_Match) ProtoMessage()

func (*MatchList_Match) ProtoReflect added in v3.13.0 

func (x *MatchList_Match) ProtoReflect() protoreflect.Message

func (*MatchList_Match) Reset added in v3.13.0 

func (x *MatchList_Match) Reset()

func (*MatchList_Match) String added in v3.13.0 

func (x *MatchList_Match) String() string

type MatchState 

type MatchState struct {

	// Presence list.
	Presences []*rtapi.UserPresence `protobuf:"bytes,1,rep,name=presences,proto3" json:"presences,omitempty"`
	// Current tick number.
	Tick int64 `protobuf:"varint,2,opt,name=tick,proto3" json:"tick,omitempty"`
	// State.
	State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Match state

func (*MatchState) Descriptor deprecated 

func (*MatchState) Descriptor() ([]byte, []int)

Deprecated: Use MatchState.ProtoReflect.Descriptor instead.

func (*MatchState) GetPresences 

func (x *MatchState) GetPresences() []*rtapi.UserPresence

func (*MatchState) GetState 

func (x *MatchState) GetState() string

func (*MatchState) GetTick 

func (x *MatchState) GetTick() int64

func (*MatchState) ProtoMessage 

func (*MatchState) ProtoMessage()

func (*MatchState) ProtoReflect 

func (x *MatchState) ProtoReflect() protoreflect.Message

func (*MatchState) Reset 

func (x *MatchState) Reset()

func (*MatchState) String 

func (x *MatchState) String() string

type MatchStateRequest 

type MatchStateRequest struct {

	// Match ID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Get current state of a running match

func (*MatchStateRequest) Descriptor deprecated 

func (*MatchStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use MatchStateRequest.ProtoReflect.Descriptor instead.

func (*MatchStateRequest) GetId 

func (x *MatchStateRequest) GetId() string

func (*MatchStateRequest) ProtoMessage 

func (*MatchStateRequest) ProtoMessage()

func (*MatchStateRequest) ProtoReflect 

func (x *MatchStateRequest) ProtoReflect() protoreflect.Message

func (*MatchStateRequest) Reset 

func (x *MatchStateRequest) Reset()

func (*MatchStateRequest) String 

func (x *MatchStateRequest) String() string

type RuntimeInfo 

type RuntimeInfo struct {

	// Lua registered RPC functions
	LuaRpcFunctions []string `protobuf:"bytes,1,rep,name=lua_rpc_functions,json=luaRpcFunctions,proto3" json:"lua_rpc_functions,omitempty"`
	// Go registered RPC functions
	GoRpcFunctions []string `protobuf:"bytes,2,rep,name=go_rpc_functions,json=goRpcFunctions,proto3" json:"go_rpc_functions,omitempty"`
	// JavaScript registered RPC functions
	JsRpcFunctions []string `protobuf:"bytes,3,rep,name=js_rpc_functions,json=jsRpcFunctions,proto3" json:"js_rpc_functions,omitempty"`
	// Go loaded modules
	GoModules []*RuntimeInfo_ModuleInfo `protobuf:"bytes,4,rep,name=go_modules,json=goModules,proto3" json:"go_modules,omitempty"`
	// Lua loaded modules
	LuaModules []*RuntimeInfo_ModuleInfo `protobuf:"bytes,5,rep,name=lua_modules,json=luaModules,proto3" json:"lua_modules,omitempty"`
	// JavaScript loaded modules
	JsModules []*RuntimeInfo_ModuleInfo `protobuf:"bytes,6,rep,name=js_modules,json=jsModules,proto3" json:"js_modules,omitempty"`
	// contains filtered or unexported fields
}

Runtime information

func (*RuntimeInfo) Descriptor deprecated 

func (*RuntimeInfo) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeInfo.ProtoReflect.Descriptor instead.

func (*RuntimeInfo) GetGoModules 

func (x *RuntimeInfo) GetGoModules() []*RuntimeInfo_ModuleInfo

func (*RuntimeInfo) GetGoRpcFunctions 

func (x *RuntimeInfo) GetGoRpcFunctions() []string

func (*RuntimeInfo) GetJsModules 

func (x *RuntimeInfo) GetJsModules() []*RuntimeInfo_ModuleInfo

func (*RuntimeInfo) GetJsRpcFunctions 

func (x *RuntimeInfo) GetJsRpcFunctions() []string

func (*RuntimeInfo) GetLuaModules 

func (x *RuntimeInfo) GetLuaModules() []*RuntimeInfo_ModuleInfo

func (*RuntimeInfo) GetLuaRpcFunctions 

func (x *RuntimeInfo) GetLuaRpcFunctions() []string

func (*RuntimeInfo) ProtoMessage 

func (*RuntimeInfo) ProtoMessage()

func (*RuntimeInfo) ProtoReflect 

func (x *RuntimeInfo) ProtoReflect() protoreflect.Message

func (*RuntimeInfo) Reset 

func (x *RuntimeInfo) Reset()

func (*RuntimeInfo) String 

func (x *RuntimeInfo) String() string

type RuntimeInfo_ModuleInfo 

type RuntimeInfo_ModuleInfo struct {

	// Module path
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Module last modified date
	ModTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=mod_time,json=modTime,proto3" json:"mod_time,omitempty"`
	// contains filtered or unexported fields
}

Module information

func (*RuntimeInfo_ModuleInfo) Descriptor deprecated 

func (*RuntimeInfo_ModuleInfo) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeInfo_ModuleInfo.ProtoReflect.Descriptor instead.

func (*RuntimeInfo_ModuleInfo) GetModTime 

func (x *RuntimeInfo_ModuleInfo) GetModTime() *timestamppb.Timestamp

func (*RuntimeInfo_ModuleInfo) GetPath 

func (x *RuntimeInfo_ModuleInfo) GetPath() string

func (*RuntimeInfo_ModuleInfo) ProtoMessage 

func (*RuntimeInfo_ModuleInfo) ProtoMessage()

func (*RuntimeInfo_ModuleInfo) ProtoReflect 

func (x *RuntimeInfo_ModuleInfo) ProtoReflect() protoreflect.Message

func (*RuntimeInfo_ModuleInfo) Reset 

func (x *RuntimeInfo_ModuleInfo) Reset()

func (*RuntimeInfo_ModuleInfo) String 

func (x *RuntimeInfo_ModuleInfo) String() string

type StatusHealth added in v3.7.0 

type StatusHealth int32
const (
	StatusHealth_STATUS_HEALTH_OK            StatusHealth = 0
	StatusHealth_STATUS_HEALTH_ERROR         StatusHealth = 1
	StatusHealth_STATUS_HEALTH_CONNECTING    StatusHealth = 2
	StatusHealth_STATUS_HEALTH_DISCONNECTING StatusHealth = 3
)

func (StatusHealth) Descriptor added in v3.7.0 

func (StatusHealth) Descriptor() protoreflect.EnumDescriptor

func (StatusHealth) Enum added in v3.7.0 

func (x StatusHealth) Enum() *StatusHealth

func (StatusHealth) EnumDescriptor deprecated added in v3.7.0 

func (StatusHealth) EnumDescriptor() ([]byte, []int)

Deprecated: Use StatusHealth.Descriptor instead.

func (StatusHealth) Number added in v3.7.0 

func (x StatusHealth) Number() protoreflect.EnumNumber

func (StatusHealth) String added in v3.7.0 

func (x StatusHealth) String() string

func (StatusHealth) Type added in v3.7.0 

func (StatusHealth) Type() protoreflect.EnumType

type StatusList 

type StatusList struct {

	// List of nodes and their stats.
	Nodes []*StatusList_Status `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// Timestamp
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

List of nodes and their stats.

func (*StatusList) Descriptor deprecated 

func (*StatusList) Descriptor() ([]byte, []int)

Deprecated: Use StatusList.ProtoReflect.Descriptor instead.

func (*StatusList) GetNodes 

func (x *StatusList) GetNodes() []*StatusList_Status

func (*StatusList) GetTimestamp 

func (x *StatusList) GetTimestamp() *timestamppb.Timestamp

func (*StatusList) ProtoMessage 

func (*StatusList) ProtoMessage()

func (*StatusList) ProtoReflect 

func (x *StatusList) ProtoReflect() protoreflect.Message

func (*StatusList) Reset 

func (x *StatusList) Reset()

func (*StatusList) String 

func (x *StatusList) String() string

type StatusList_Status 

type StatusList_Status struct {

	// Node name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Health score.
	Health StatusHealth `protobuf:"varint,2,opt,name=health,proto3,enum=nakama.console.StatusHealth" json:"health,omitempty"`
	// Currently connected sessions.
	SessionCount int32 `protobuf:"varint,3,opt,name=session_count,json=sessionCount,proto3" json:"session_count,omitempty"`
	// Currently registered live presences.
	PresenceCount int32 `protobuf:"varint,4,opt,name=presence_count,json=presenceCount,proto3" json:"presence_count,omitempty"`
	// Current number of active authoritative matches.
	MatchCount int32 `protobuf:"varint,5,opt,name=match_count,json=matchCount,proto3" json:"match_count,omitempty"`
	// Current number of running goroutines.
	GoroutineCount int32 `protobuf:"varint,6,opt,name=goroutine_count,json=goroutineCount,proto3" json:"goroutine_count,omitempty"`
	// Average response latency in milliseconds.
	AvgLatencyMs float64 `protobuf:"fixed64,7,opt,name=avg_latency_ms,json=avgLatencyMs,proto3" json:"avg_latency_ms,omitempty"`
	// Average number of requests per second.
	AvgRateSec float64 `protobuf:"fixed64,8,opt,name=avg_rate_sec,json=avgRateSec,proto3" json:"avg_rate_sec,omitempty"`
	// Average input bandwidth usage.
	AvgInputKbs float64 `protobuf:"fixed64,9,opt,name=avg_input_kbs,json=avgInputKbs,proto3" json:"avg_input_kbs,omitempty"`
	// Average output bandwidth usage.
	AvgOutputKbs float64 `protobuf:"fixed64,10,opt,name=avg_output_kbs,json=avgOutputKbs,proto3" json:"avg_output_kbs,omitempty"`
	// contains filtered or unexported fields
}

The status of a Nakama node.

func (*StatusList_Status) Descriptor deprecated 

func (*StatusList_Status) Descriptor() ([]byte, []int)

Deprecated: Use StatusList_Status.ProtoReflect.Descriptor instead.

func (*StatusList_Status) GetAvgInputKbs 

func (x *StatusList_Status) GetAvgInputKbs() float64

func (*StatusList_Status) GetAvgLatencyMs 

func (x *StatusList_Status) GetAvgLatencyMs() float64

func (*StatusList_Status) GetAvgOutputKbs 

func (x *StatusList_Status) GetAvgOutputKbs() float64

func (*StatusList_Status) GetAvgRateSec 

func (x *StatusList_Status) GetAvgRateSec() float64

func (*StatusList_Status) GetGoroutineCount 

func (x *StatusList_Status) GetGoroutineCount() int32

func (*StatusList_Status) GetHealth 

func (x *StatusList_Status) GetHealth() StatusHealth

func (*StatusList_Status) GetMatchCount 

func (x *StatusList_Status) GetMatchCount() int32

func (*StatusList_Status) GetName 

func (x *StatusList_Status) GetName() string

func (*StatusList_Status) GetPresenceCount 

func (x *StatusList_Status) GetPresenceCount() int32

func (*StatusList_Status) GetSessionCount 

func (x *StatusList_Status) GetSessionCount() int32

func (*StatusList_Status) ProtoMessage 

func (*StatusList_Status) ProtoMessage()

func (*StatusList_Status) ProtoReflect 

func (x *StatusList_Status) ProtoReflect() protoreflect.Message

func (*StatusList_Status) Reset 

func (x *StatusList_Status) Reset()

func (*StatusList_Status) String 

func (x *StatusList_Status) String() string

type StorageCollectionsList 

type StorageCollectionsList struct {

	// Available collection names in the whole of the storage
	Collections []string `protobuf:"bytes,3,rep,name=collections,proto3" json:"collections,omitempty"`
	// contains filtered or unexported fields
}

func (*StorageCollectionsList) Descriptor deprecated 

func (*StorageCollectionsList) Descriptor() ([]byte, []int)

Deprecated: Use StorageCollectionsList.ProtoReflect.Descriptor instead.

func (*StorageCollectionsList) GetCollections 

func (x *StorageCollectionsList) GetCollections() []string

func (*StorageCollectionsList) ProtoMessage 

func (*StorageCollectionsList) ProtoMessage()

func (*StorageCollectionsList) ProtoReflect 

func (x *StorageCollectionsList) ProtoReflect() protoreflect.Message

func (*StorageCollectionsList) Reset 

func (x *StorageCollectionsList) Reset()

func (*StorageCollectionsList) String 

func (x *StorageCollectionsList) String() string

type StorageList 

type StorageList struct {

	// List of storage objects matching list/filter operation.
	Objects []*api.StorageObject `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects,omitempty"`
	// Approximate total number of storage objects.
	TotalCount int32 `protobuf:"varint,2,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Next page cursor if any
	NextCursor string `protobuf:"bytes,3,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// contains filtered or unexported fields
}

List of storage objects.

func (*StorageList) Descriptor deprecated 

func (*StorageList) Descriptor() ([]byte, []int)

Deprecated: Use StorageList.ProtoReflect.Descriptor instead.

func (*StorageList) GetNextCursor 

func (x *StorageList) GetNextCursor() string

func (*StorageList) GetObjects 

func (x *StorageList) GetObjects() []*api.StorageObject

func (*StorageList) GetTotalCount 

func (x *StorageList) GetTotalCount() int32

func (*StorageList) ProtoMessage 

func (*StorageList) ProtoMessage()

func (*StorageList) ProtoReflect 

func (x *StorageList) ProtoReflect() protoreflect.Message

func (*StorageList) Reset 

func (x *StorageList) Reset()

func (*StorageList) String 

func (x *StorageList) String() string

type UnimplementedConsoleServer 

type UnimplementedConsoleServer struct {
}

UnimplementedConsoleServer must be embedded to have forward compatible implementations.

func (UnimplementedConsoleServer) AddGroupUsers added in v3.15.0 

func (UnimplementedConsoleServer) AddGroupUsers(context.Context, *AddGroupUsersRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) AddUser 

func (UnimplementedConsoleServer) AddUser(context.Context, *AddUserRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) Authenticate 

func (UnimplementedConsoleServer) Authenticate(context.Context, *AuthenticateRequest) (*ConsoleSession, error)

func (UnimplementedConsoleServer) AuthenticateLogout added in v3.13.0 

func (UnimplementedConsoleServer) AuthenticateLogout(context.Context, *AuthenticateLogoutRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) BanAccount 

func (UnimplementedConsoleServer) BanAccount(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) CallApiEndpoint 

func (UnimplementedConsoleServer) CallApiEndpoint(context.Context, *CallApiEndpointRequest) (*CallApiEndpointResponse, error)

func (UnimplementedConsoleServer) CallRpcEndpoint 

func (UnimplementedConsoleServer) CallRpcEndpoint(context.Context, *CallApiEndpointRequest) (*CallApiEndpointResponse, error)

func (UnimplementedConsoleServer) DeleteAccount 

func (UnimplementedConsoleServer) DeleteAccount(context.Context, *AccountDeleteRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteAccounts 

func (UnimplementedConsoleServer) DeleteAccounts(context.Context, *emptypb.Empty) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteAllData added in v3.11.0 

func (UnimplementedConsoleServer) DeleteAllData(context.Context, *emptypb.Empty) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteChannelMessages added in v3.13.0 

func (UnimplementedConsoleServer) DeleteChannelMessages(context.Context, *DeleteChannelMessagesRequest) (*DeleteChannelMessagesResponse, error)

func (UnimplementedConsoleServer) DeleteFriend 

func (UnimplementedConsoleServer) DeleteFriend(context.Context, *DeleteFriendRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteGroup added in v3.11.0 

func (UnimplementedConsoleServer) DeleteGroup(context.Context, *DeleteGroupRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteGroupUser 

func (UnimplementedConsoleServer) DeleteGroupUser(context.Context, *DeleteGroupUserRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteLeaderboard 

func (UnimplementedConsoleServer) DeleteLeaderboard(context.Context, *LeaderboardRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteLeaderboardRecord 

func (UnimplementedConsoleServer) DeleteLeaderboardRecord(context.Context, *DeleteLeaderboardRecordRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteStorage 

func (UnimplementedConsoleServer) DeleteStorage(context.Context, *emptypb.Empty) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteStorageObject 

func (UnimplementedConsoleServer) DeleteStorageObject(context.Context, *DeleteStorageObjectRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteUser 

func (UnimplementedConsoleServer) DeleteUser(context.Context, *Username) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DeleteWalletLedger 

func (UnimplementedConsoleServer) DeleteWalletLedger(context.Context, *DeleteWalletLedgerRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) DemoteGroupMember added in v3.11.0 

func (UnimplementedConsoleServer) DemoteGroupMember(context.Context, *UpdateGroupUserStateRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) ExportAccount 

func (UnimplementedConsoleServer) ExportAccount(context.Context, *AccountId) (*AccountExport, error)

func (UnimplementedConsoleServer) ExportGroup added in v3.11.0 

func (UnimplementedConsoleServer) ExportGroup(context.Context, *GroupId) (*GroupExport, error)

func (UnimplementedConsoleServer) GetAccount 

func (UnimplementedConsoleServer) GetAccount(context.Context, *AccountId) (*Account, error)

func (UnimplementedConsoleServer) GetConfig 

func (UnimplementedConsoleServer) GetConfig(context.Context, *emptypb.Empty) (*Config, error)

func (UnimplementedConsoleServer) GetFriends 

func (UnimplementedConsoleServer) GetFriends(context.Context, *AccountId) (*api.FriendList, error)

func (UnimplementedConsoleServer) GetGroup added in v3.11.0 

func (UnimplementedConsoleServer) GetGroup(context.Context, *GroupId) (*api.Group, error)

func (UnimplementedConsoleServer) GetGroups 

func (UnimplementedConsoleServer) GetGroups(context.Context, *AccountId) (*api.UserGroupList, error)

func (UnimplementedConsoleServer) GetLeaderboard 

func (UnimplementedConsoleServer) GetLeaderboard(context.Context, *LeaderboardRequest) (*Leaderboard, error)

func (UnimplementedConsoleServer) GetMatchState 

func (UnimplementedConsoleServer) GetMatchState(context.Context, *MatchStateRequest) (*MatchState, error)

func (UnimplementedConsoleServer) GetMembers added in v3.11.0 

func (UnimplementedConsoleServer) GetMembers(context.Context, *GroupId) (*api.GroupUserList, error)

func (UnimplementedConsoleServer) GetRuntime 

func (UnimplementedConsoleServer) GetRuntime(context.Context, *emptypb.Empty) (*RuntimeInfo, error)

func (UnimplementedConsoleServer) GetStatus 

func (UnimplementedConsoleServer) GetStatus(context.Context, *emptypb.Empty) (*StatusList, error)

func (UnimplementedConsoleServer) GetStorage 

func (UnimplementedConsoleServer) GetStorage(context.Context, *api.ReadStorageObjectId) (*api.StorageObject, error)

func (UnimplementedConsoleServer) GetWalletLedger 

func (UnimplementedConsoleServer) GetWalletLedger(context.Context, *GetWalletLedgerRequest) (*WalletLedgerList, error)

func (UnimplementedConsoleServer) ListAccounts 

func (UnimplementedConsoleServer) ListAccounts(context.Context, *ListAccountsRequest) (*AccountList, error)

func (UnimplementedConsoleServer) ListApiEndpoints 

func (UnimplementedConsoleServer) ListApiEndpoints(context.Context, *emptypb.Empty) (*ApiEndpointList, error)

func (UnimplementedConsoleServer) ListChannelMessages added in v3.13.0 

func (UnimplementedConsoleServer) ListChannelMessages(context.Context, *ListChannelMessagesRequest) (*api.ChannelMessageList, error)

func (UnimplementedConsoleServer) ListGroups added in v3.11.0 

func (UnimplementedConsoleServer) ListGroups(context.Context, *ListGroupsRequest) (*GroupList, error)

func (UnimplementedConsoleServer) ListLeaderboardRecords 

func (UnimplementedConsoleServer) ListLeaderboardRecords(context.Context, *api.ListLeaderboardRecordsRequest) (*api.LeaderboardRecordList, error)

func (UnimplementedConsoleServer) ListLeaderboards 

func (UnimplementedConsoleServer) ListLeaderboards(context.Context, *LeaderboardListRequest) (*LeaderboardList, error)

func (UnimplementedConsoleServer) ListMatches 

func (UnimplementedConsoleServer) ListMatches(context.Context, *ListMatchesRequest) (*MatchList, error)

func (UnimplementedConsoleServer) ListPurchases added in v3.2.0 

func (UnimplementedConsoleServer) ListPurchases(context.Context, *ListPurchasesRequest) (*api.PurchaseList, error)

func (UnimplementedConsoleServer) ListStorage 

func (UnimplementedConsoleServer) ListStorage(context.Context, *ListStorageRequest) (*StorageList, error)

func (UnimplementedConsoleServer) ListStorageCollections 

func (UnimplementedConsoleServer) ListStorageCollections(context.Context, *emptypb.Empty) (*StorageCollectionsList, error)

func (UnimplementedConsoleServer) ListSubscriptions added in v3.13.0 

func (UnimplementedConsoleServer) ListSubscriptions(context.Context, *ListSubscriptionsRequest) (*api.SubscriptionList, error)

func (UnimplementedConsoleServer) ListUsers 

func (UnimplementedConsoleServer) ListUsers(context.Context, *emptypb.Empty) (*UserList, error)

func (UnimplementedConsoleServer) PromoteGroupMember added in v3.11.0 

func (UnimplementedConsoleServer) PromoteGroupMember(context.Context, *UpdateGroupUserStateRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnbanAccount 

func (UnimplementedConsoleServer) UnbanAccount(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkApple 

func (UnimplementedConsoleServer) UnlinkApple(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkCustom 

func (UnimplementedConsoleServer) UnlinkCustom(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkDevice 

func (UnimplementedConsoleServer) UnlinkDevice(context.Context, *UnlinkDeviceRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkEmail 

func (UnimplementedConsoleServer) UnlinkEmail(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkFacebook 

func (UnimplementedConsoleServer) UnlinkFacebook(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkFacebookInstantGame 

func (UnimplementedConsoleServer) UnlinkFacebookInstantGame(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkGameCenter 

func (UnimplementedConsoleServer) UnlinkGameCenter(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkGoogle 

func (UnimplementedConsoleServer) UnlinkGoogle(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UnlinkSteam 

func (UnimplementedConsoleServer) UnlinkSteam(context.Context, *AccountId) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UpdateAccount 

func (UnimplementedConsoleServer) UpdateAccount(context.Context, *UpdateAccountRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) UpdateGroup added in v3.11.0 

func (UnimplementedConsoleServer) UpdateGroup(context.Context, *UpdateGroupRequest) (*emptypb.Empty, error)

func (UnimplementedConsoleServer) WriteStorageObject 

func (UnimplementedConsoleServer) WriteStorageObject(context.Context, *WriteStorageObjectRequest) (*api.StorageObjectAck, error)

type UnlinkDeviceRequest 

type UnlinkDeviceRequest struct {

	// User ID to unlink from.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Device ID to unlink.
	DeviceId string `protobuf:"bytes,2,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// contains filtered or unexported fields
}

Unlink a particular device ID from a user's account.

func (*UnlinkDeviceRequest) Descriptor deprecated 

func (*UnlinkDeviceRequest) Descriptor() ([]byte, []int)

Deprecated: Use UnlinkDeviceRequest.ProtoReflect.Descriptor instead.

func (*UnlinkDeviceRequest) GetDeviceId 

func (x *UnlinkDeviceRequest) GetDeviceId() string

func (*UnlinkDeviceRequest) GetId 

func (x *UnlinkDeviceRequest) GetId() string

func (*UnlinkDeviceRequest) ProtoMessage 

func (*UnlinkDeviceRequest) ProtoMessage()

func (*UnlinkDeviceRequest) ProtoReflect 

func (x *UnlinkDeviceRequest) ProtoReflect() protoreflect.Message

func (*UnlinkDeviceRequest) Reset 

func (x *UnlinkDeviceRequest) Reset()

func (*UnlinkDeviceRequest) String 

func (x *UnlinkDeviceRequest) String() string

type UnsafeConsoleServer 

type UnsafeConsoleServer interface {
	// contains filtered or unexported methods
}

UnsafeConsoleServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConsoleServer will result in compilation errors.

type UpdateAccountRequest 

type UpdateAccountRequest struct {

	// User ID to update.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Username.
	Username *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// Display name.
	DisplayName *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Metadata.
	Metadata *wrapperspb.StringValue `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Avatar URL.
	AvatarUrl *wrapperspb.StringValue `protobuf:"bytes,5,opt,name=avatar_url,json=avatarUrl,proto3" json:"avatar_url,omitempty"`
	// Langtag.
	LangTag *wrapperspb.StringValue `protobuf:"bytes,6,opt,name=lang_tag,json=langTag,proto3" json:"lang_tag,omitempty"`
	// Location.
	Location *wrapperspb.StringValue `protobuf:"bytes,7,opt,name=location,proto3" json:"location,omitempty"`
	// Timezone.
	Timezone *wrapperspb.StringValue `protobuf:"bytes,8,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// Custom ID.
	CustomId *wrapperspb.StringValue `protobuf:"bytes,9,opt,name=custom_id,json=customId,proto3" json:"custom_id,omitempty"`
	// Email.
	Email *wrapperspb.StringValue `protobuf:"bytes,10,opt,name=email,proto3" json:"email,omitempty"`
	// Password.
	Password *wrapperspb.StringValue `protobuf:"bytes,11,opt,name=password,proto3" json:"password,omitempty"`
	// Device ID modifications.
	DeviceIds map[string]string `` /* 177-byte string literal not displayed */
	// Wallet.
	Wallet *wrapperspb.StringValue `protobuf:"bytes,13,opt,name=wallet,proto3" json:"wallet,omitempty"`
	// contains filtered or unexported fields
}

Update user account information.

func (*UpdateAccountRequest) Descriptor deprecated 

func (*UpdateAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateAccountRequest.ProtoReflect.Descriptor instead.

func (*UpdateAccountRequest) GetAvatarUrl 

func (x *UpdateAccountRequest) GetAvatarUrl() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetCustomId 

func (x *UpdateAccountRequest) GetCustomId() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetDeviceIds 

func (x *UpdateAccountRequest) GetDeviceIds() map[string]string

func (*UpdateAccountRequest) GetDisplayName 

func (x *UpdateAccountRequest) GetDisplayName() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetEmail 

func (x *UpdateAccountRequest) GetEmail() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetId 

func (x *UpdateAccountRequest) GetId() string

func (*UpdateAccountRequest) GetLangTag 

func (x *UpdateAccountRequest) GetLangTag() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetLocation 

func (x *UpdateAccountRequest) GetLocation() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetMetadata 

func (x *UpdateAccountRequest) GetMetadata() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetPassword 

func (x *UpdateAccountRequest) GetPassword() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetTimezone 

func (x *UpdateAccountRequest) GetTimezone() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetUsername 

func (x *UpdateAccountRequest) GetUsername() *wrapperspb.StringValue

func (*UpdateAccountRequest) GetWallet 

func (x *UpdateAccountRequest) GetWallet() *wrapperspb.StringValue

func (*UpdateAccountRequest) ProtoMessage 

func (*UpdateAccountRequest) ProtoMessage()

func (*UpdateAccountRequest) ProtoReflect 

func (x *UpdateAccountRequest) ProtoReflect() protoreflect.Message

func (*UpdateAccountRequest) Reset 

func (x *UpdateAccountRequest) Reset()

func (*UpdateAccountRequest) String 

func (x *UpdateAccountRequest) String() string

type UpdateGroupRequest added in v3.11.0 

type UpdateGroupRequest struct {

	// Group ID to update.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name.
	Name *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description.
	Description *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Langtag.
	LangTag *wrapperspb.StringValue `protobuf:"bytes,4,opt,name=lang_tag,json=langTag,proto3" json:"lang_tag,omitempty"`
	// Metadata.
	Metadata *wrapperspb.StringValue `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Avatar URL.
	AvatarUrl *wrapperspb.StringValue `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3" json:"avatar_url,omitempty"`
	// Anyone can join open groups, otherwise only admins can accept members.
	Open *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=open,proto3" json:"open,omitempty"`
	// The maximum number of members allowed.
	MaxCount *wrapperspb.Int32Value `protobuf:"bytes,8,opt,name=max_count,json=maxCount,proto3" json:"max_count,omitempty"`
	// contains filtered or unexported fields
}

Update group information.

func (*UpdateGroupRequest) Descriptor deprecated added in v3.11.0 

func (*UpdateGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateGroupRequest.ProtoReflect.Descriptor instead.

func (*UpdateGroupRequest) GetAvatarUrl added in v3.11.0 

func (x *UpdateGroupRequest) GetAvatarUrl() *wrapperspb.StringValue

func (*UpdateGroupRequest) GetDescription added in v3.11.0 

func (x *UpdateGroupRequest) GetDescription() *wrapperspb.StringValue

func (*UpdateGroupRequest) GetId added in v3.11.0 

func (x *UpdateGroupRequest) GetId() string

func (*UpdateGroupRequest) GetLangTag added in v3.11.0 

func (x *UpdateGroupRequest) GetLangTag() *wrapperspb.StringValue

func (*UpdateGroupRequest) GetMaxCount added in v3.11.0 

func (x *UpdateGroupRequest) GetMaxCount() *wrapperspb.Int32Value

func (*UpdateGroupRequest) GetMetadata added in v3.11.0 

func (x *UpdateGroupRequest) GetMetadata() *wrapperspb.StringValue

func (*UpdateGroupRequest) GetName added in v3.11.0 

func (x *UpdateGroupRequest) GetName() *wrapperspb.StringValue

func (*UpdateGroupRequest) GetOpen added in v3.11.0 

func (x *UpdateGroupRequest) GetOpen() *wrapperspb.BoolValue

func (*UpdateGroupRequest) ProtoMessage added in v3.11.0 

func (*UpdateGroupRequest) ProtoMessage()

func (*UpdateGroupRequest) ProtoReflect added in v3.11.0 

func (x *UpdateGroupRequest) ProtoReflect() protoreflect.Message

func (*UpdateGroupRequest) Reset added in v3.11.0 

func (x *UpdateGroupRequest) Reset()

func (*UpdateGroupRequest) String added in v3.11.0 

func (x *UpdateGroupRequest) String() string

type UpdateGroupUserStateRequest added in v3.11.0 

type UpdateGroupUserStateRequest struct {

	// User to change state.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the group.
	GroupId string `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

Promote/demote a user in a group.

func (*UpdateGroupUserStateRequest) Descriptor deprecated added in v3.11.0 

func (*UpdateGroupUserStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateGroupUserStateRequest.ProtoReflect.Descriptor instead.

func (*UpdateGroupUserStateRequest) GetGroupId added in v3.11.0 

func (x *UpdateGroupUserStateRequest) GetGroupId() string

func (*UpdateGroupUserStateRequest) GetId added in v3.11.0 

func (x *UpdateGroupUserStateRequest) GetId() string

func (*UpdateGroupUserStateRequest) ProtoMessage added in v3.11.0 

func (*UpdateGroupUserStateRequest) ProtoMessage()

func (*UpdateGroupUserStateRequest) ProtoReflect added in v3.11.0 

func (x *UpdateGroupUserStateRequest) ProtoReflect() protoreflect.Message

func (*UpdateGroupUserStateRequest) Reset added in v3.11.0 

func (x *UpdateGroupUserStateRequest) Reset()

func (*UpdateGroupUserStateRequest) String added in v3.11.0 

func (x *UpdateGroupUserStateRequest) String() string

type UserList 

type UserList struct {

	// A list of users.
	Users []*UserList_User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// contains filtered or unexported fields
}

A list of console users.

func (*UserList) Descriptor deprecated 

func (*UserList) Descriptor() ([]byte, []int)

Deprecated: Use UserList.ProtoReflect.Descriptor instead.

func (*UserList) GetUsers 

func (x *UserList) GetUsers() []*UserList_User

func (*UserList) ProtoMessage 

func (*UserList) ProtoMessage()

func (*UserList) ProtoReflect 

func (x *UserList) ProtoReflect() protoreflect.Message

func (*UserList) Reset 

func (x *UserList) Reset()

func (*UserList) String 

func (x *UserList) String() string

type UserList_User 

type UserList_User struct {

	// Username of the user
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// Email of the user
	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// Role of the user;
	Role UserRole `protobuf:"varint,3,opt,name=role,proto3,enum=nakama.console.UserRole" json:"role,omitempty"`
	// contains filtered or unexported fields
}

A console user

func (*UserList_User) Descriptor deprecated 

func (*UserList_User) Descriptor() ([]byte, []int)

Deprecated: Use UserList_User.ProtoReflect.Descriptor instead.

func (*UserList_User) GetEmail 

func (x *UserList_User) GetEmail() string

func (*UserList_User) GetRole 

func (x *UserList_User) GetRole() UserRole

func (*UserList_User) GetUsername 

func (x *UserList_User) GetUsername() string

func (*UserList_User) ProtoMessage 

func (*UserList_User) ProtoMessage()

func (*UserList_User) ProtoReflect 

func (x *UserList_User) ProtoReflect() protoreflect.Message

func (*UserList_User) Reset 

func (x *UserList_User) Reset()

func (*UserList_User) String 

func (x *UserList_User) String() string

type UserRole 

type UserRole int32
const (
	UserRole_USER_ROLE_UNKNOWN    UserRole = 0
	UserRole_USER_ROLE_ADMIN      UserRole = 1 // All access
	UserRole_USER_ROLE_DEVELOPER  UserRole = 2 // Best for developers, also enables APIs and API explorer
	UserRole_USER_ROLE_MAINTAINER UserRole = 3 // Best for users who regularly update player information.
	UserRole_USER_ROLE_READONLY   UserRole = 4 // Read-only role for those only need to view data
)

func (UserRole) Descriptor 

func (UserRole) Descriptor() protoreflect.EnumDescriptor

func (UserRole) Enum 

func (x UserRole) Enum() *UserRole

func (UserRole) EnumDescriptor deprecated 

func (UserRole) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserRole.Descriptor instead.

func (UserRole) Number 

func (x UserRole) Number() protoreflect.EnumNumber

func (UserRole) String 

func (x UserRole) String() string

func (UserRole) Type 

func (UserRole) Type() protoreflect.EnumType

type Username 

type Username struct {

	// The unique username of the user account.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// contains filtered or unexported fields
}

The identifier for a user account.

func (*Username) Descriptor deprecated 

func (*Username) Descriptor() ([]byte, []int)

Deprecated: Use Username.ProtoReflect.Descriptor instead.

func (*Username) GetUsername 

func (x *Username) GetUsername() string

func (*Username) ProtoMessage 

func (*Username) ProtoMessage()

func (*Username) ProtoReflect 

func (x *Username) ProtoReflect() protoreflect.Message

func (*Username) Reset 

func (x *Username) Reset()

func (*Username) String 

func (x *Username) String() string

type WalletLedger 

type WalletLedger struct {

	// The identifier of this wallet change.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The user ID this wallet ledger item belongs to.
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The changeset.
	Changeset string `protobuf:"bytes,3,opt,name=changeset,proto3" json:"changeset,omitempty"`
	// Any associated metadata.
	Metadata string `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The UNIX time when the wallet ledger item was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The UNIX time when the wallet ledger item was updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

An individual update to a user's wallet.

func (*WalletLedger) Descriptor deprecated 

func (*WalletLedger) Descriptor() ([]byte, []int)

Deprecated: Use WalletLedger.ProtoReflect.Descriptor instead.

func (*WalletLedger) GetChangeset 

func (x *WalletLedger) GetChangeset() string

func (*WalletLedger) GetCreateTime 

func (x *WalletLedger) GetCreateTime() *timestamppb.Timestamp

func (*WalletLedger) GetId 

func (x *WalletLedger) GetId() string

func (*WalletLedger) GetMetadata 

func (x *WalletLedger) GetMetadata() string

func (*WalletLedger) GetUpdateTime 

func (x *WalletLedger) GetUpdateTime() *timestamppb.Timestamp

func (*WalletLedger) GetUserId 

func (x *WalletLedger) GetUserId() string

func (*WalletLedger) ProtoMessage 

func (*WalletLedger) ProtoMessage()

func (*WalletLedger) ProtoReflect 

func (x *WalletLedger) ProtoReflect() protoreflect.Message

func (*WalletLedger) Reset 

func (x *WalletLedger) Reset()

func (*WalletLedger) String 

func (x *WalletLedger) String() string

type WalletLedgerList 

type WalletLedgerList struct {

	// A list of wallet ledger items.
	Items []*WalletLedger `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// The cursor to send when retrieving the next older page, if any.
	NextCursor string `protobuf:"bytes,2,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// The cursor to send when retrieving the previous page newer, if any.
	PrevCursor string `protobuf:"bytes,3,opt,name=prev_cursor,json=prevCursor,proto3" json:"prev_cursor,omitempty"`
	// contains filtered or unexported fields
}

List of wallet ledger items for a particular user.

func (*WalletLedgerList) Descriptor deprecated 

func (*WalletLedgerList) Descriptor() ([]byte, []int)

Deprecated: Use WalletLedgerList.ProtoReflect.Descriptor instead.

func (*WalletLedgerList) GetItems 

func (x *WalletLedgerList) GetItems() []*WalletLedger

func (*WalletLedgerList) GetNextCursor added in v3.9.0 

func (x *WalletLedgerList) GetNextCursor() string

func (*WalletLedgerList) GetPrevCursor added in v3.9.0 

func (x *WalletLedgerList) GetPrevCursor() string

func (*WalletLedgerList) ProtoMessage 

func (*WalletLedgerList) ProtoMessage()

func (*WalletLedgerList) ProtoReflect 

func (x *WalletLedgerList) ProtoReflect() protoreflect.Message

func (*WalletLedgerList) Reset 

func (x *WalletLedgerList) Reset()

func (*WalletLedgerList) String 

func (x *WalletLedgerList) String() string

type WriteStorageObjectRequest 

type WriteStorageObjectRequest struct {

	// Collection.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Key.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Owner user ID.
	UserId string `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Value.
	Value string `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// Version for OCC.
	Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	// Read permission value.
	PermissionRead *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=permission_read,json=permissionRead,proto3" json:"permission_read,omitempty"`
	// Write permission value.
	PermissionWrite *wrapperspb.Int32Value `protobuf:"bytes,7,opt,name=permission_write,json=permissionWrite,proto3" json:"permission_write,omitempty"`
	// contains filtered or unexported fields
}

Write a new storage object or update an existing one.

func (*WriteStorageObjectRequest) Descriptor deprecated 

func (*WriteStorageObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteStorageObjectRequest.ProtoReflect.Descriptor instead.

func (*WriteStorageObjectRequest) GetCollection 

func (x *WriteStorageObjectRequest) GetCollection() string

func (*WriteStorageObjectRequest) GetKey 

func (x *WriteStorageObjectRequest) GetKey() string

func (*WriteStorageObjectRequest) GetPermissionRead 

func (x *WriteStorageObjectRequest) GetPermissionRead() *wrapperspb.Int32Value

func (*WriteStorageObjectRequest) GetPermissionWrite 

func (x *WriteStorageObjectRequest) GetPermissionWrite() *wrapperspb.Int32Value

func (*WriteStorageObjectRequest) GetUserId 

func (x *WriteStorageObjectRequest) GetUserId() string

func (*WriteStorageObjectRequest) GetValue 

func (x *WriteStorageObjectRequest) GetValue() string

func (*WriteStorageObjectRequest) GetVersion 

func (x *WriteStorageObjectRequest) GetVersion() string

func (*WriteStorageObjectRequest) ProtoMessage 

func (*WriteStorageObjectRequest) ProtoMessage()

func (*WriteStorageObjectRequest) ProtoReflect 

func (x *WriteStorageObjectRequest) ProtoReflect() protoreflect.Message

func (*WriteStorageObjectRequest) Reset 

func (x *WriteStorageObjectRequest) Reset()

func (*WriteStorageObjectRequest) String 

func (x *WriteStorageObjectRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.