console

package
v2.5.1 Latest Latest
Warning

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

 Go to latest Published: May 3, 2019 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package console is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Handler added in v2.1.0 

func Handler() http.Handler

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 RegisterConsoleServer 

func RegisterConsoleServer(s *grpc.Server, srv ConsoleServer)

Types

type Account added in v2.5.0 

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          *timestamp.Timestamp `protobuf:"bytes,2,opt,name=disable_time,json=disableTime,proto3" json:"disable_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

Account information.

func (*Account) Descriptor added in v2.5.0 

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

func (*Account) GetAccount added in v2.5.0 

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

func (*Account) GetDisableTime added in v2.5.0 

func (m *Account) GetDisableTime() *timestamp.Timestamp

func (*Account) ProtoMessage added in v2.5.0 

func (*Account) ProtoMessage()

func (*Account) Reset added in v2.5.0 

func (m *Account) Reset()

func (*Account) String added in v2.5.0 

func (m *Account) String() string

func (*Account) XXX_DiscardUnknown added in v2.5.0 

func (m *Account) XXX_DiscardUnknown()

func (*Account) XXX_Marshal added in v2.5.0 

func (m *Account) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Account) XXX_Merge added in v2.5.0 

func (m *Account) XXX_Merge(src proto.Message)

func (*Account) XXX_Size added in v2.5.0 

func (m *Account) XXX_Size() int

func (*Account) XXX_Unmarshal added in v2.5.0 

func (m *Account) XXX_Unmarshal(b []byte) error

type AccountDeleteRequest added in v2.0.3 

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       *wrappers.BoolValue `protobuf:"bytes,2,opt,name=record_deletion,json=recordDeletion,proto3" json:"record_deletion,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

Delete a user account.

func (*AccountDeleteRequest) Descriptor added in v2.0.3 

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

func (*AccountDeleteRequest) GetId added in v2.0.3 

func (m *AccountDeleteRequest) GetId() string

func (*AccountDeleteRequest) GetRecordDeletion added in v2.0.3 

func (m *AccountDeleteRequest) GetRecordDeletion() *wrappers.BoolValue

func (*AccountDeleteRequest) ProtoMessage added in v2.0.3 

func (*AccountDeleteRequest) ProtoMessage()

func (*AccountDeleteRequest) Reset added in v2.0.3 

func (m *AccountDeleteRequest) Reset()

func (*AccountDeleteRequest) String added in v2.0.3 

func (m *AccountDeleteRequest) String() string

func (*AccountDeleteRequest) XXX_DiscardUnknown added in v2.0.3 

func (m *AccountDeleteRequest) XXX_DiscardUnknown()

func (*AccountDeleteRequest) XXX_Marshal added in v2.0.3 

func (m *AccountDeleteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccountDeleteRequest) XXX_Merge added in v2.0.3 

func (m *AccountDeleteRequest) XXX_Merge(src proto.Message)

func (*AccountDeleteRequest) XXX_Size added in v2.0.3 

func (m *AccountDeleteRequest) XXX_Size() int

func (*AccountDeleteRequest) XXX_Unmarshal added in v2.0.3 

func (m *AccountDeleteRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

An export of all information stored for a user account.

func (*AccountExport) Descriptor 

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

func (*AccountExport) GetAccount 

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

func (*AccountExport) GetFriends 

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

func (*AccountExport) GetGroups 

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

func (*AccountExport) GetLeaderboardRecords 

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

func (*AccountExport) GetMessages 

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

func (*AccountExport) GetNotifications 

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

func (*AccountExport) GetObjects 

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

func (*AccountExport) GetWalletLedgers 

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

func (*AccountExport) ProtoMessage 

func (*AccountExport) ProtoMessage()

func (*AccountExport) Reset 

func (m *AccountExport) Reset()

func (*AccountExport) String 

func (m *AccountExport) String() string

func (*AccountExport) XXX_DiscardUnknown added in v2.0.3 

func (m *AccountExport) XXX_DiscardUnknown()

func (*AccountExport) XXX_Marshal added in v2.0.3 

func (m *AccountExport) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccountExport) XXX_Merge added in v2.0.3 

func (m *AccountExport) XXX_Merge(src proto.Message)

func (*AccountExport) XXX_Size added in v2.0.3 

func (m *AccountExport) XXX_Size() int

func (*AccountExport) XXX_Unmarshal added in v2.0.3 

func (m *AccountExport) XXX_Unmarshal(b []byte) error

type AccountId added in v2.4.2 

type AccountId struct {
	// The unique identifier of the user account.
	Id                   string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The identifier for a user account.

func (*AccountId) Descriptor added in v2.4.2 

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

func (*AccountId) GetId added in v2.4.2 

func (m *AccountId) GetId() string

func (*AccountId) ProtoMessage added in v2.4.2 

func (*AccountId) ProtoMessage()

func (*AccountId) Reset added in v2.4.2 

func (m *AccountId) Reset()

func (*AccountId) String added in v2.4.2 

func (m *AccountId) String() string

func (*AccountId) XXX_DiscardUnknown added in v2.4.2 

func (m *AccountId) XXX_DiscardUnknown()

func (*AccountId) XXX_Marshal added in v2.4.2 

func (m *AccountId) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccountId) XXX_Merge added in v2.4.2 

func (m *AccountId) XXX_Merge(src proto.Message)

func (*AccountId) XXX_Size added in v2.4.2 

func (m *AccountId) XXX_Size() int

func (*AccountId) XXX_Unmarshal added in v2.4.2 

func (m *AccountId) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Authenticate a console user with username and password.

func (*AuthenticateRequest) Descriptor 

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

func (*AuthenticateRequest) GetPassword 

func (m *AuthenticateRequest) GetPassword() string

func (*AuthenticateRequest) GetUsername 

func (m *AuthenticateRequest) GetUsername() string

func (*AuthenticateRequest) ProtoMessage 

func (*AuthenticateRequest) ProtoMessage()

func (*AuthenticateRequest) Reset 

func (m *AuthenticateRequest) Reset()

func (*AuthenticateRequest) String 

func (m *AuthenticateRequest) String() string

func (*AuthenticateRequest) XXX_DiscardUnknown added in v2.0.3 

func (m *AuthenticateRequest) XXX_DiscardUnknown()

func (*AuthenticateRequest) XXX_Marshal added in v2.0.3 

func (m *AuthenticateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AuthenticateRequest) XXX_Merge added in v2.0.3 

func (m *AuthenticateRequest) XXX_Merge(src proto.Message)

func (*AuthenticateRequest) XXX_Size added in v2.0.3 

func (m *AuthenticateRequest) XXX_Size() int

func (*AuthenticateRequest) XXX_Unmarshal added in v2.0.3 

func (m *AuthenticateRequest) XXX_Unmarshal(b []byte) error

type Config added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The current server configuration and any associated warnings.

func (*Config) Descriptor added in v2.4.2 

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

func (*Config) GetConfig added in v2.4.2 

func (m *Config) GetConfig() string

func (*Config) GetServerVersion added in v2.5.0 

func (m *Config) GetServerVersion() string

func (*Config) GetWarnings added in v2.4.2 

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

func (*Config) ProtoMessage added in v2.4.2 

func (*Config) ProtoMessage()

func (*Config) Reset added in v2.4.2 

func (m *Config) Reset()

func (*Config) String added in v2.4.2 

func (m *Config) String() string

func (*Config) XXX_DiscardUnknown added in v2.4.2 

func (m *Config) XXX_DiscardUnknown()

func (*Config) XXX_Marshal added in v2.4.2 

func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Config) XXX_Merge added in v2.4.2 

func (m *Config) XXX_Merge(src proto.Message)

func (*Config) XXX_Size added in v2.4.2 

func (m *Config) XXX_Size() int

func (*Config) XXX_Unmarshal added in v2.4.2 

func (m *Config) XXX_Unmarshal(b []byte) error

type Config_Warning added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A warning for a configuration field.

func (*Config_Warning) Descriptor added in v2.4.2 

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

func (*Config_Warning) GetField added in v2.4.2 

func (m *Config_Warning) GetField() string

func (*Config_Warning) GetMessage added in v2.4.2 

func (m *Config_Warning) GetMessage() string

func (*Config_Warning) ProtoMessage added in v2.4.2 

func (*Config_Warning) ProtoMessage()

func (*Config_Warning) Reset added in v2.4.2 

func (m *Config_Warning) Reset()

func (*Config_Warning) String added in v2.4.2 

func (m *Config_Warning) String() string

func (*Config_Warning) XXX_DiscardUnknown added in v2.4.2 

func (m *Config_Warning) XXX_DiscardUnknown()

func (*Config_Warning) XXX_Marshal added in v2.4.2 

func (m *Config_Warning) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Config_Warning) XXX_Merge added in v2.4.2 

func (m *Config_Warning) XXX_Merge(src proto.Message)

func (*Config_Warning) XXX_Size added in v2.4.2 

func (m *Config_Warning) XXX_Size() int

func (*Config_Warning) XXX_Unmarshal added in v2.4.2 

func (m *Config_Warning) XXX_Unmarshal(b []byte) error

type ConsoleClient 

type ConsoleClient interface {
	// Authenticate a console user with username and password.
	Authenticate(ctx context.Context, in *AuthenticateRequest, opts ...grpc.CallOption) (*ConsoleSession, error)
	// Ban a user.
	BanUser(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete all information stored for a user account.
	DeleteAccount(ctx context.Context, in *AccountDeleteRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete the friend relationship between two users.
	DeleteFriend(ctx context.Context, in *DeleteFriendRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Remove a user from a group.
	DeleteGroupUser(ctx context.Context, in *DeleteGroupUserRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete all storage data.
	DeleteStorage(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete a storage object.
	DeleteStorageObject(ctx context.Context, in *DeleteStorageObjectRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete (non-recorded) all user accounts.
	DeleteUsers(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*empty.Empty, error)
	// Delete a wallet ledger item.
	DeleteWalletLedger(ctx context.Context, in *DeleteWalletLedgerRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Export all information stored about a user account.
	ExportAccount(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*AccountExport, 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 *empty.Empty, opts ...grpc.CallOption) (*Config, error)
	// Get a user's list of friend relationships.
	GetFriends(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*api.Friends, 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 current status data for all nodes.
	GetStatus(ctx context.Context, in *empty.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 *AccountId, opts ...grpc.CallOption) (*WalletLedgerList, error)
	// List (and optionally filter) storage data.
	ListStorage(ctx context.Context, in *ListStorageRequest, opts ...grpc.CallOption) (*StorageList, error)
	// List (and optionally filter) users.
	ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*UserList, error)
	// Unban a user.
	UnbanUser(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the custom ID from a user account.
	UnlinkCustom(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the device ID from a user account.
	UnlinkDevice(ctx context.Context, in *UnlinkDeviceRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the email from a user account.
	UnlinkEmail(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the Facebook ID from a user account.
	UnlinkFacebook(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the Game Center ID from a user account.
	UnlinkGameCenter(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the Google ID from a user account.
	UnlinkGoogle(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Unlink the Steam ID from a user account.
	UnlinkSteam(ctx context.Context, in *AccountId, opts ...grpc.CallOption) (*empty.Empty, error)
	// Update one or more fields on a user account.
	UpdateAccount(ctx context.Context, in *UpdateAccountRequest, opts ...grpc.CallOption) (*empty.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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewConsoleClient 

func NewConsoleClient(cc *grpc.ClientConn) ConsoleClient

type ConsoleServer 

type ConsoleServer interface {
	// Authenticate a console user with username and password.
	Authenticate(context.Context, *AuthenticateRequest) (*ConsoleSession, error)
	// Ban a user.
	BanUser(context.Context, *AccountId) (*empty.Empty, error)
	// Delete all information stored for a user account.
	DeleteAccount(context.Context, *AccountDeleteRequest) (*empty.Empty, error)
	// Delete the friend relationship between two users.
	DeleteFriend(context.Context, *DeleteFriendRequest) (*empty.Empty, error)
	// Remove a user from a group.
	DeleteGroupUser(context.Context, *DeleteGroupUserRequest) (*empty.Empty, error)
	// Delete all storage data.
	DeleteStorage(context.Context, *empty.Empty) (*empty.Empty, error)
	// Delete a storage object.
	DeleteStorageObject(context.Context, *DeleteStorageObjectRequest) (*empty.Empty, error)
	// Delete (non-recorded) all user accounts.
	DeleteUsers(context.Context, *empty.Empty) (*empty.Empty, error)
	// Delete a wallet ledger item.
	DeleteWalletLedger(context.Context, *DeleteWalletLedgerRequest) (*empty.Empty, error)
	// Export all information stored about a user account.
	ExportAccount(context.Context, *AccountId) (*AccountExport, error)
	// Get detailed account information for a single user.
	GetAccount(context.Context, *AccountId) (*Account, error)
	// Get server config and configuration warnings.
	GetConfig(context.Context, *empty.Empty) (*Config, error)
	// Get a user's list of friend relationships.
	GetFriends(context.Context, *AccountId) (*api.Friends, error)
	// Get a list of groups the user is a member of.
	GetGroups(context.Context, *AccountId) (*api.UserGroupList, error)
	// Get current status data for all nodes.
	GetStatus(context.Context, *empty.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, *AccountId) (*WalletLedgerList, error)
	// List (and optionally filter) storage data.
	ListStorage(context.Context, *ListStorageRequest) (*StorageList, error)
	// List (and optionally filter) users.
	ListUsers(context.Context, *ListUsersRequest) (*UserList, error)
	// Unban a user.
	UnbanUser(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the custom ID from a user account.
	UnlinkCustom(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the device ID from a user account.
	UnlinkDevice(context.Context, *UnlinkDeviceRequest) (*empty.Empty, error)
	// Unlink the email from a user account.
	UnlinkEmail(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the Facebook ID from a user account.
	UnlinkFacebook(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the Game Center ID from a user account.
	UnlinkGameCenter(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the Google ID from a user account.
	UnlinkGoogle(context.Context, *AccountId) (*empty.Empty, error)
	// Unlink the Steam ID from a user account.
	UnlinkSteam(context.Context, *AccountId) (*empty.Empty, error)
	// Update one or more fields on a user account.
	UpdateAccount(context.Context, *UpdateAccountRequest) (*empty.Empty, error)
	// Write a new storage object or replace an existing one.
	WriteStorageObject(context.Context, *WriteStorageObjectRequest) (*api.StorageObjectAck, error)
}

ConsoleServer is the server API for Console service.

type ConsoleSession added in v2.4.2 

type ConsoleSession struct {
	// A session token (JWT) for the console user.
	Token                string   `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A console user session.

func (*ConsoleSession) Descriptor added in v2.4.2 

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

func (*ConsoleSession) GetToken added in v2.4.2 

func (m *ConsoleSession) GetToken() string

func (*ConsoleSession) ProtoMessage added in v2.4.2 

func (*ConsoleSession) ProtoMessage()

func (*ConsoleSession) Reset added in v2.4.2 

func (m *ConsoleSession) Reset()

func (*ConsoleSession) String added in v2.4.2 

func (m *ConsoleSession) String() string

func (*ConsoleSession) XXX_DiscardUnknown added in v2.4.2 

func (m *ConsoleSession) XXX_DiscardUnknown()

func (*ConsoleSession) XXX_Marshal added in v2.4.2 

func (m *ConsoleSession) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConsoleSession) XXX_Merge added in v2.4.2 

func (m *ConsoleSession) XXX_Merge(src proto.Message)

func (*ConsoleSession) XXX_Size added in v2.4.2 

func (m *ConsoleSession) XXX_Size() int

func (*ConsoleSession) XXX_Unmarshal added in v2.4.2 

func (m *ConsoleSession) XXX_Unmarshal(b []byte) error

type DeleteFriendRequest added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Delete friend relationship between two users.

func (*DeleteFriendRequest) Descriptor added in v2.4.2 

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

func (*DeleteFriendRequest) GetFriendId added in v2.4.2 

func (m *DeleteFriendRequest) GetFriendId() string

func (*DeleteFriendRequest) GetId added in v2.4.2 

func (m *DeleteFriendRequest) GetId() string

func (*DeleteFriendRequest) ProtoMessage added in v2.4.2 

func (*DeleteFriendRequest) ProtoMessage()

func (*DeleteFriendRequest) Reset added in v2.4.2 

func (m *DeleteFriendRequest) Reset()

func (*DeleteFriendRequest) String added in v2.4.2 

func (m *DeleteFriendRequest) String() string

func (*DeleteFriendRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *DeleteFriendRequest) XXX_DiscardUnknown()

func (*DeleteFriendRequest) XXX_Marshal added in v2.4.2 

func (m *DeleteFriendRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteFriendRequest) XXX_Merge added in v2.4.2 

func (m *DeleteFriendRequest) XXX_Merge(src proto.Message)

func (*DeleteFriendRequest) XXX_Size added in v2.4.2 

func (m *DeleteFriendRequest) XXX_Size() int

func (*DeleteFriendRequest) XXX_Unmarshal added in v2.4.2 

func (m *DeleteFriendRequest) XXX_Unmarshal(b []byte) error

type DeleteGroupUserRequest added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Remove a user from a group.

func (*DeleteGroupUserRequest) Descriptor added in v2.4.2 

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

func (*DeleteGroupUserRequest) GetGroupId added in v2.4.2 

func (m *DeleteGroupUserRequest) GetGroupId() string

func (*DeleteGroupUserRequest) GetId added in v2.4.2 

func (m *DeleteGroupUserRequest) GetId() string

func (*DeleteGroupUserRequest) ProtoMessage added in v2.4.2 

func (*DeleteGroupUserRequest) ProtoMessage()

func (*DeleteGroupUserRequest) Reset added in v2.4.2 

func (m *DeleteGroupUserRequest) Reset()

func (*DeleteGroupUserRequest) String added in v2.4.2 

func (m *DeleteGroupUserRequest) String() string

func (*DeleteGroupUserRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *DeleteGroupUserRequest) XXX_DiscardUnknown()

func (*DeleteGroupUserRequest) XXX_Marshal added in v2.4.2 

func (m *DeleteGroupUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteGroupUserRequest) XXX_Merge added in v2.4.2 

func (m *DeleteGroupUserRequest) XXX_Merge(src proto.Message)

func (*DeleteGroupUserRequest) XXX_Size added in v2.4.2 

func (m *DeleteGroupUserRequest) XXX_Size() int

func (*DeleteGroupUserRequest) XXX_Unmarshal added in v2.4.2 

func (m *DeleteGroupUserRequest) XXX_Unmarshal(b []byte) error

type DeleteStorageObjectRequest added in v2.0.3 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Delete an individual storage object.

func (*DeleteStorageObjectRequest) Descriptor added in v2.0.3 

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

func (*DeleteStorageObjectRequest) GetCollection added in v2.0.3 

func (m *DeleteStorageObjectRequest) GetCollection() string

func (*DeleteStorageObjectRequest) GetKey added in v2.0.3 

func (m *DeleteStorageObjectRequest) GetKey() string

func (*DeleteStorageObjectRequest) GetUserId added in v2.0.3 

func (m *DeleteStorageObjectRequest) GetUserId() string

func (*DeleteStorageObjectRequest) GetVersion added in v2.4.2 

func (m *DeleteStorageObjectRequest) GetVersion() string

func (*DeleteStorageObjectRequest) ProtoMessage added in v2.0.3 

func (*DeleteStorageObjectRequest) ProtoMessage()

func (*DeleteStorageObjectRequest) Reset added in v2.0.3 

func (m *DeleteStorageObjectRequest) Reset()

func (*DeleteStorageObjectRequest) String added in v2.0.3 

func (m *DeleteStorageObjectRequest) String() string

func (*DeleteStorageObjectRequest) XXX_DiscardUnknown added in v2.0.3 

func (m *DeleteStorageObjectRequest) XXX_DiscardUnknown()

func (*DeleteStorageObjectRequest) XXX_Marshal added in v2.0.3 

func (m *DeleteStorageObjectRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteStorageObjectRequest) XXX_Merge added in v2.0.3 

func (m *DeleteStorageObjectRequest) XXX_Merge(src proto.Message)

func (*DeleteStorageObjectRequest) XXX_Size added in v2.0.3 

func (m *DeleteStorageObjectRequest) XXX_Size() int

func (*DeleteStorageObjectRequest) XXX_Unmarshal added in v2.0.3 

func (m *DeleteStorageObjectRequest) XXX_Unmarshal(b []byte) error

type DeleteWalletLedgerRequest added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Delete a single wallet ledger item.

func (*DeleteWalletLedgerRequest) Descriptor added in v2.4.2 

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

func (*DeleteWalletLedgerRequest) GetId added in v2.4.2 

func (m *DeleteWalletLedgerRequest) GetId() string

func (*DeleteWalletLedgerRequest) GetWalletId added in v2.4.2 

func (m *DeleteWalletLedgerRequest) GetWalletId() string

func (*DeleteWalletLedgerRequest) ProtoMessage added in v2.4.2 

func (*DeleteWalletLedgerRequest) ProtoMessage()

func (*DeleteWalletLedgerRequest) Reset added in v2.4.2 

func (m *DeleteWalletLedgerRequest) Reset()

func (*DeleteWalletLedgerRequest) String added in v2.4.2 

func (m *DeleteWalletLedgerRequest) String() string

func (*DeleteWalletLedgerRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *DeleteWalletLedgerRequest) XXX_DiscardUnknown()

func (*DeleteWalletLedgerRequest) XXX_Marshal added in v2.4.2 

func (m *DeleteWalletLedgerRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteWalletLedgerRequest) XXX_Merge added in v2.4.2 

func (m *DeleteWalletLedgerRequest) XXX_Merge(src proto.Message)

func (*DeleteWalletLedgerRequest) XXX_Size added in v2.4.2 

func (m *DeleteWalletLedgerRequest) XXX_Size() int

func (*DeleteWalletLedgerRequest) XXX_Unmarshal added in v2.4.2 

func (m *DeleteWalletLedgerRequest) XXX_Unmarshal(b []byte) error

type ListStorageRequest added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

List (and optionally filter) storage objects.

func (*ListStorageRequest) Descriptor added in v2.4.2 

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

func (*ListStorageRequest) GetUserId added in v2.4.2 

func (m *ListStorageRequest) GetUserId() string

func (*ListStorageRequest) ProtoMessage added in v2.4.2 

func (*ListStorageRequest) ProtoMessage()

func (*ListStorageRequest) Reset added in v2.4.2 

func (m *ListStorageRequest) Reset()

func (*ListStorageRequest) String added in v2.4.2 

func (m *ListStorageRequest) String() string

func (*ListStorageRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *ListStorageRequest) XXX_DiscardUnknown()

func (*ListStorageRequest) XXX_Marshal added in v2.4.2 

func (m *ListStorageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListStorageRequest) XXX_Merge added in v2.4.2 

func (m *ListStorageRequest) XXX_Merge(src proto.Message)

func (*ListStorageRequest) XXX_Size added in v2.4.2 

func (m *ListStorageRequest) XXX_Size() int

func (*ListStorageRequest) XXX_Unmarshal added in v2.4.2 

func (m *ListStorageRequest) XXX_Unmarshal(b []byte) error

type ListUsersRequest added in v2.4.2 

type ListUsersRequest struct {
	// User ID or username filter.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Search only banned users.
	Banned bool `protobuf:"varint,2,opt,name=banned,proto3" json:"banned,omitempty"`
	// Search only recorded deletes.
	Tombstones           bool     `protobuf:"varint,3,opt,name=tombstones,proto3" json:"tombstones,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

List (and optionally filter) users.

func (*ListUsersRequest) Descriptor added in v2.4.2 

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

func (*ListUsersRequest) GetBanned added in v2.4.2 

func (m *ListUsersRequest) GetBanned() bool

func (*ListUsersRequest) GetFilter added in v2.4.2 

func (m *ListUsersRequest) GetFilter() string

func (*ListUsersRequest) GetTombstones added in v2.4.2 

func (m *ListUsersRequest) GetTombstones() bool

func (*ListUsersRequest) ProtoMessage added in v2.4.2 

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) Reset added in v2.4.2 

func (m *ListUsersRequest) Reset()

func (*ListUsersRequest) String added in v2.4.2 

func (m *ListUsersRequest) String() string

func (*ListUsersRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *ListUsersRequest) XXX_DiscardUnknown()

func (*ListUsersRequest) XXX_Marshal added in v2.4.2 

func (m *ListUsersRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListUsersRequest) XXX_Merge added in v2.4.2 

func (m *ListUsersRequest) XXX_Merge(src proto.Message)

func (*ListUsersRequest) XXX_Size added in v2.4.2 

func (m *ListUsersRequest) XXX_Size() int

func (*ListUsersRequest) XXX_Unmarshal added in v2.4.2 

func (m *ListUsersRequest) XXX_Unmarshal(b []byte) error

type StatusList added in v2.4.2 

type StatusList struct {
	// List of nodes and their stats.
	Nodes                []*StatusList_Status `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

List of nodes and their stats.

func (*StatusList) Descriptor added in v2.4.2 

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

func (*StatusList) GetNodes added in v2.4.2 

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

func (*StatusList) ProtoMessage added in v2.4.2 

func (*StatusList) ProtoMessage()

func (*StatusList) Reset added in v2.4.2 

func (m *StatusList) Reset()

func (*StatusList) String added in v2.4.2 

func (m *StatusList) String() string

func (*StatusList) XXX_DiscardUnknown added in v2.4.2 

func (m *StatusList) XXX_DiscardUnknown()

func (*StatusList) XXX_Marshal added in v2.4.2 

func (m *StatusList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatusList) XXX_Merge added in v2.4.2 

func (m *StatusList) XXX_Merge(src proto.Message)

func (*StatusList) XXX_Size added in v2.4.2 

func (m *StatusList) XXX_Size() int

func (*StatusList) XXX_Unmarshal added in v2.4.2 

func (m *StatusList) XXX_Unmarshal(b []byte) error

type StatusList_Status added in v2.4.2 

type StatusList_Status struct {
	// Node name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Health score.
	Health int32 `protobuf:"varint,2,opt,name=health,proto3" 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The status of a Nakama node.

func (*StatusList_Status) Descriptor added in v2.4.2 

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

func (*StatusList_Status) GetAvgInputKbs added in v2.4.2 

func (m *StatusList_Status) GetAvgInputKbs() float64

func (*StatusList_Status) GetAvgLatencyMs added in v2.4.2 

func (m *StatusList_Status) GetAvgLatencyMs() float64

func (*StatusList_Status) GetAvgOutputKbs added in v2.4.2 

func (m *StatusList_Status) GetAvgOutputKbs() float64

func (*StatusList_Status) GetAvgRateSec added in v2.4.2 

func (m *StatusList_Status) GetAvgRateSec() float64

func (*StatusList_Status) GetGoroutineCount added in v2.4.2 

func (m *StatusList_Status) GetGoroutineCount() int32

func (*StatusList_Status) GetHealth added in v2.4.2 

func (m *StatusList_Status) GetHealth() int32

func (*StatusList_Status) GetMatchCount added in v2.4.2 

func (m *StatusList_Status) GetMatchCount() int32

func (*StatusList_Status) GetName added in v2.4.2 

func (m *StatusList_Status) GetName() string

func (*StatusList_Status) GetPresenceCount added in v2.4.2 

func (m *StatusList_Status) GetPresenceCount() int32

func (*StatusList_Status) GetSessionCount added in v2.4.2 

func (m *StatusList_Status) GetSessionCount() int32

func (*StatusList_Status) ProtoMessage added in v2.4.2 

func (*StatusList_Status) ProtoMessage()

func (*StatusList_Status) Reset added in v2.4.2 

func (m *StatusList_Status) Reset()

func (*StatusList_Status) String added in v2.4.2 

func (m *StatusList_Status) String() string

func (*StatusList_Status) XXX_DiscardUnknown added in v2.4.2 

func (m *StatusList_Status) XXX_DiscardUnknown()

func (*StatusList_Status) XXX_Marshal added in v2.4.2 

func (m *StatusList_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatusList_Status) XXX_Merge added in v2.4.2 

func (m *StatusList_Status) XXX_Merge(src proto.Message)

func (*StatusList_Status) XXX_Size added in v2.4.2 

func (m *StatusList_Status) XXX_Size() int

func (*StatusList_Status) XXX_Unmarshal added in v2.4.2 

func (m *StatusList_Status) XXX_Unmarshal(b []byte) error

type StorageList added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

List of storage objects.

func (*StorageList) Descriptor added in v2.4.2 

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

func (*StorageList) GetObjects added in v2.4.2 

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

func (*StorageList) GetTotalCount added in v2.4.2 

func (m *StorageList) GetTotalCount() int32

func (*StorageList) ProtoMessage added in v2.4.2 

func (*StorageList) ProtoMessage()

func (*StorageList) Reset added in v2.4.2 

func (m *StorageList) Reset()

func (*StorageList) String added in v2.4.2 

func (m *StorageList) String() string

func (*StorageList) XXX_DiscardUnknown added in v2.4.2 

func (m *StorageList) XXX_DiscardUnknown()

func (*StorageList) XXX_Marshal added in v2.4.2 

func (m *StorageList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StorageList) XXX_Merge added in v2.4.2 

func (m *StorageList) XXX_Merge(src proto.Message)

func (*StorageList) XXX_Size added in v2.4.2 

func (m *StorageList) XXX_Size() int

func (*StorageList) XXX_Unmarshal added in v2.4.2 

func (m *StorageList) XXX_Unmarshal(b []byte) error

type UnlinkDeviceRequest added in v2.4.2 

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*UnlinkDeviceRequest) Descriptor added in v2.4.2 

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

func (*UnlinkDeviceRequest) GetDeviceId added in v2.4.2 

func (m *UnlinkDeviceRequest) GetDeviceId() string

func (*UnlinkDeviceRequest) GetId added in v2.4.2 

func (m *UnlinkDeviceRequest) GetId() string

func (*UnlinkDeviceRequest) ProtoMessage added in v2.4.2 

func (*UnlinkDeviceRequest) ProtoMessage()

func (*UnlinkDeviceRequest) Reset added in v2.4.2 

func (m *UnlinkDeviceRequest) Reset()

func (*UnlinkDeviceRequest) String added in v2.4.2 

func (m *UnlinkDeviceRequest) String() string

func (*UnlinkDeviceRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *UnlinkDeviceRequest) XXX_DiscardUnknown()

func (*UnlinkDeviceRequest) XXX_Marshal added in v2.4.2 

func (m *UnlinkDeviceRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UnlinkDeviceRequest) XXX_Merge added in v2.4.2 

func (m *UnlinkDeviceRequest) XXX_Merge(src proto.Message)

func (*UnlinkDeviceRequest) XXX_Size added in v2.4.2 

func (m *UnlinkDeviceRequest) XXX_Size() int

func (*UnlinkDeviceRequest) XXX_Unmarshal added in v2.4.2 

func (m *UnlinkDeviceRequest) XXX_Unmarshal(b []byte) error

type UpdateAccountRequest added in v2.4.2 

type UpdateAccountRequest struct {
	// User ID to update.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Username.
	Username *wrappers.StringValue `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// Display name.
	DisplayName *wrappers.StringValue `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Metadata.
	Metadata *wrappers.StringValue `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Avatar URL.
	AvatarUrl *wrappers.StringValue `protobuf:"bytes,5,opt,name=avatar_url,json=avatarUrl,proto3" json:"avatar_url,omitempty"`
	// Langtag.
	LangTag *wrappers.StringValue `protobuf:"bytes,6,opt,name=lang_tag,json=langTag,proto3" json:"lang_tag,omitempty"`
	// Location.
	Location *wrappers.StringValue `protobuf:"bytes,7,opt,name=location,proto3" json:"location,omitempty"`
	// Timezone.
	Timezone *wrappers.StringValue `protobuf:"bytes,8,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// Custom ID.
	CustomId *wrappers.StringValue `protobuf:"bytes,9,opt,name=custom_id,json=customId,proto3" json:"custom_id,omitempty"`
	// Email.
	Email *wrappers.StringValue `protobuf:"bytes,10,opt,name=email,proto3" json:"email,omitempty"`
	// Device ID modifications.
	DeviceIds map[string]string `` /* 177-byte string literal not displayed */
	// Wallet.
	Wallet               *wrappers.StringValue `protobuf:"bytes,12,opt,name=wallet,proto3" json:"wallet,omitempty"`
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

Update user account information.

func (*UpdateAccountRequest) Descriptor added in v2.4.2 

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

func (*UpdateAccountRequest) GetAvatarUrl added in v2.4.2 

func (m *UpdateAccountRequest) GetAvatarUrl() *wrappers.StringValue

func (*UpdateAccountRequest) GetCustomId added in v2.4.2 

func (m *UpdateAccountRequest) GetCustomId() *wrappers.StringValue

func (*UpdateAccountRequest) GetDeviceIds added in v2.4.2 

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

func (*UpdateAccountRequest) GetDisplayName added in v2.4.2 

func (m *UpdateAccountRequest) GetDisplayName() *wrappers.StringValue

func (*UpdateAccountRequest) GetEmail added in v2.4.2 

func (m *UpdateAccountRequest) GetEmail() *wrappers.StringValue

func (*UpdateAccountRequest) GetId added in v2.4.2 

func (m *UpdateAccountRequest) GetId() string

func (*UpdateAccountRequest) GetLangTag added in v2.4.2 

func (m *UpdateAccountRequest) GetLangTag() *wrappers.StringValue

func (*UpdateAccountRequest) GetLocation added in v2.4.2 

func (m *UpdateAccountRequest) GetLocation() *wrappers.StringValue

func (*UpdateAccountRequest) GetMetadata added in v2.4.2 

func (m *UpdateAccountRequest) GetMetadata() *wrappers.StringValue

func (*UpdateAccountRequest) GetTimezone added in v2.4.2 

func (m *UpdateAccountRequest) GetTimezone() *wrappers.StringValue

func (*UpdateAccountRequest) GetUsername added in v2.4.2 

func (m *UpdateAccountRequest) GetUsername() *wrappers.StringValue

func (*UpdateAccountRequest) GetWallet added in v2.4.2 

func (m *UpdateAccountRequest) GetWallet() *wrappers.StringValue

func (*UpdateAccountRequest) ProtoMessage added in v2.4.2 

func (*UpdateAccountRequest) ProtoMessage()

func (*UpdateAccountRequest) Reset added in v2.4.2 

func (m *UpdateAccountRequest) Reset()

func (*UpdateAccountRequest) String added in v2.4.2 

func (m *UpdateAccountRequest) String() string

func (*UpdateAccountRequest) XXX_DiscardUnknown added in v2.4.2 

func (m *UpdateAccountRequest) XXX_DiscardUnknown()

func (*UpdateAccountRequest) XXX_Marshal added in v2.4.2 

func (m *UpdateAccountRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateAccountRequest) XXX_Merge added in v2.4.2 

func (m *UpdateAccountRequest) XXX_Merge(src proto.Message)

func (*UpdateAccountRequest) XXX_Size added in v2.4.2 

func (m *UpdateAccountRequest) XXX_Size() int

func (*UpdateAccountRequest) XXX_Unmarshal added in v2.4.2 

func (m *UpdateAccountRequest) XXX_Unmarshal(b []byte) error

type UserList added in v2.4.2 

type UserList 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A list of users.

func (*UserList) Descriptor added in v2.4.2 

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

func (*UserList) GetTotalCount added in v2.4.2 

func (m *UserList) GetTotalCount() int32

func (*UserList) GetUsers added in v2.4.2 

func (m *UserList) GetUsers() []*api.User

func (*UserList) ProtoMessage added in v2.4.2 

func (*UserList) ProtoMessage()

func (*UserList) Reset added in v2.4.2 

func (m *UserList) Reset()

func (*UserList) String added in v2.4.2 

func (m *UserList) String() string

func (*UserList) XXX_DiscardUnknown added in v2.4.2 

func (m *UserList) XXX_DiscardUnknown()

func (*UserList) XXX_Marshal added in v2.4.2 

func (m *UserList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserList) XXX_Merge added in v2.4.2 

func (m *UserList) XXX_Merge(src proto.Message)

func (*UserList) XXX_Size added in v2.4.2 

func (m *UserList) XXX_Size() int

func (*UserList) XXX_Unmarshal added in v2.4.2 

func (m *UserList) XXX_Unmarshal(b []byte) error

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 *timestamp.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           *timestamp.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

An individual update to a user's wallet.

func (*WalletLedger) Descriptor 

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

func (*WalletLedger) GetChangeset 

func (m *WalletLedger) GetChangeset() string

func (*WalletLedger) GetCreateTime 

func (m *WalletLedger) GetCreateTime() *timestamp.Timestamp

func (*WalletLedger) GetId 

func (m *WalletLedger) GetId() string

func (*WalletLedger) GetMetadata 

func (m *WalletLedger) GetMetadata() string

func (*WalletLedger) GetUpdateTime 

func (m *WalletLedger) GetUpdateTime() *timestamp.Timestamp

func (*WalletLedger) GetUserId 

func (m *WalletLedger) GetUserId() string

func (*WalletLedger) ProtoMessage 

func (*WalletLedger) ProtoMessage()

func (*WalletLedger) Reset 

func (m *WalletLedger) Reset()

func (*WalletLedger) String 

func (m *WalletLedger) String() string

func (*WalletLedger) XXX_DiscardUnknown added in v2.0.3 

func (m *WalletLedger) XXX_DiscardUnknown()

func (*WalletLedger) XXX_Marshal added in v2.0.3 

func (m *WalletLedger) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WalletLedger) XXX_Merge added in v2.0.3 

func (m *WalletLedger) XXX_Merge(src proto.Message)

func (*WalletLedger) XXX_Size added in v2.0.3 

func (m *WalletLedger) XXX_Size() int

func (*WalletLedger) XXX_Unmarshal added in v2.0.3 

func (m *WalletLedger) XXX_Unmarshal(b []byte) error

type WalletLedgerList added in v2.4.2 

type WalletLedgerList struct {
	// A list of wallet ledger items.
	Items                []*WalletLedger `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

List of wallet ledger items for a particular user.

func (*WalletLedgerList) Descriptor added in v2.4.2 

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

func (*WalletLedgerList) GetItems added in v2.4.2 

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

func (*WalletLedgerList) ProtoMessage added in v2.4.2 

func (*WalletLedgerList) ProtoMessage()

func (*WalletLedgerList) Reset added in v2.4.2 

func (m *WalletLedgerList) Reset()

func (*WalletLedgerList) String added in v2.4.2 

func (m *WalletLedgerList) String() string

func (*WalletLedgerList) XXX_DiscardUnknown added in v2.4.2 

func (m *WalletLedgerList) XXX_DiscardUnknown()

func (*WalletLedgerList) XXX_Marshal added in v2.4.2 

func (m *WalletLedgerList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WalletLedgerList) XXX_Merge added in v2.4.2 

func (m *WalletLedgerList) XXX_Merge(src proto.Message)

func (*WalletLedgerList) XXX_Size added in v2.4.2 

func (m *WalletLedgerList) XXX_Size() int

func (*WalletLedgerList) XXX_Unmarshal added in v2.4.2 

func (m *WalletLedgerList) XXX_Unmarshal(b []byte) error

type WriteStorageObjectRequest added in v2.0.3 

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 *wrappers.Int32Value `protobuf:"bytes,6,opt,name=permission_read,json=permissionRead,proto3" json:"permission_read,omitempty"`
	// Write permission value.
	PermissionWrite      *wrappers.Int32Value `protobuf:"bytes,7,opt,name=permission_write,json=permissionWrite,proto3" json:"permission_write,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

Write a new storage object or update an existing one.

func (*WriteStorageObjectRequest) Descriptor added in v2.0.3 

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

func (*WriteStorageObjectRequest) GetCollection added in v2.4.2 

func (m *WriteStorageObjectRequest) GetCollection() string

func (*WriteStorageObjectRequest) GetKey added in v2.4.2 

func (m *WriteStorageObjectRequest) GetKey() string

func (*WriteStorageObjectRequest) GetPermissionRead added in v2.4.2 

func (m *WriteStorageObjectRequest) GetPermissionRead() *wrappers.Int32Value

func (*WriteStorageObjectRequest) GetPermissionWrite added in v2.4.2 

func (m *WriteStorageObjectRequest) GetPermissionWrite() *wrappers.Int32Value

func (*WriteStorageObjectRequest) GetUserId added in v2.4.2 

func (m *WriteStorageObjectRequest) GetUserId() string

func (*WriteStorageObjectRequest) GetValue added in v2.4.2 

func (m *WriteStorageObjectRequest) GetValue() string

func (*WriteStorageObjectRequest) GetVersion added in v2.4.2 

func (m *WriteStorageObjectRequest) GetVersion() string

func (*WriteStorageObjectRequest) ProtoMessage added in v2.0.3 

func (*WriteStorageObjectRequest) ProtoMessage()

func (*WriteStorageObjectRequest) Reset added in v2.0.3 

func (m *WriteStorageObjectRequest) Reset()

func (*WriteStorageObjectRequest) String added in v2.0.3 

func (m *WriteStorageObjectRequest) String() string

func (*WriteStorageObjectRequest) XXX_DiscardUnknown added in v2.0.3 

func (m *WriteStorageObjectRequest) XXX_DiscardUnknown()

func (*WriteStorageObjectRequest) XXX_Marshal added in v2.0.3 

func (m *WriteStorageObjectRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteStorageObjectRequest) XXX_Merge added in v2.0.3 

func (m *WriteStorageObjectRequest) XXX_Merge(src proto.Message)

func (*WriteStorageObjectRequest) XXX_Size added in v2.0.3 

func (m *WriteStorageObjectRequest) XXX_Size() int

func (*WriteStorageObjectRequest) XXX_Unmarshal added in v2.0.3 

func (m *WriteStorageObjectRequest) XXX_Unmarshal(b []byte) error

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.