commonpb

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2025 License: MIT Imports: 17 Imported by: 28

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Platform_name = map[int32]string{
		0: "UNKNOWN",
		1: "APPLE",
		2: "GOOGLE",
	}
	Platform_value = map[string]int32{
		"UNKNOWN": 0,
		"APPLE":   1,
		"GOOGLE":  2,
	}
)

Enum value maps for Platform.

View Source
var File_common_v1_common_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AppInstallId

type AppInstallId struct {
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

AppInstallId is a unque ID tied to a client app installation. It does not identify a device. Value should remain private and not be shared across installs.

func (*AppInstallId) Descriptor deprecated

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

Deprecated: Use AppInstallId.ProtoReflect.Descriptor instead.

func (*AppInstallId) GetValue

func (x *AppInstallId) GetValue() string

func (*AppInstallId) ProtoMessage

func (*AppInstallId) ProtoMessage()

func (*AppInstallId) ProtoReflect

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

func (*AppInstallId) Reset

func (x *AppInstallId) Reset()

func (*AppInstallId) String

func (x *AppInstallId) String() string

func (*AppInstallId) Validate

func (m *AppInstallId) Validate() error

Validate checks the field values on AppInstallId with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*AppInstallId) ValidateAll

func (m *AppInstallId) ValidateAll() error

ValidateAll checks the field values on AppInstallId with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AppInstallIdMultiError, or nil if none found.

type AppInstallIdMultiError

type AppInstallIdMultiError []error

AppInstallIdMultiError is an error wrapping multiple validation errors returned by AppInstallId.ValidateAll() if the designated constraints aren't met.

func (AppInstallIdMultiError) AllErrors

func (m AppInstallIdMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AppInstallIdMultiError) Error

func (m AppInstallIdMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AppInstallIdValidationError

type AppInstallIdValidationError struct {
	// contains filtered or unexported fields
}

AppInstallIdValidationError is the validation error returned by AppInstallId.Validate if the designated constraints aren't met.

func (AppInstallIdValidationError) Cause

Cause function returns cause value.

func (AppInstallIdValidationError) Error

Error satisfies the builtin error interface

func (AppInstallIdValidationError) ErrorName

func (e AppInstallIdValidationError) ErrorName() string

ErrorName returns error name.

func (AppInstallIdValidationError) Field

Field function returns field value.

func (AppInstallIdValidationError) Key

Key function returns key value.

func (AppInstallIdValidationError) Reason

Reason function returns reason value.

type Auth

type Auth struct {

	// Types that are assignable to Kind:
	//
	//	*Auth_KeyPair_
	Kind isAuth_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

Auth provides an authentication information for RPCs/messages.

Currently, only a single form is supported, but it may be useful in the future to rely on session tokens instead.

func (*Auth) Descriptor deprecated

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

Deprecated: Use Auth.ProtoReflect.Descriptor instead.

func (*Auth) GetKeyPair

func (x *Auth) GetKeyPair() *Auth_KeyPair

func (*Auth) GetKind

func (m *Auth) GetKind() isAuth_Kind

func (*Auth) ProtoMessage

func (*Auth) ProtoMessage()

func (*Auth) ProtoReflect

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

func (*Auth) Reset

func (x *Auth) Reset()

func (*Auth) String

func (x *Auth) String() string

func (*Auth) Validate

func (m *Auth) Validate() error

Validate checks the field values on Auth with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Auth) ValidateAll

func (m *Auth) ValidateAll() error

ValidateAll checks the field values on Auth with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AuthMultiError, or nil if none found.

type AuthMultiError

type AuthMultiError []error

AuthMultiError is an error wrapping multiple validation errors returned by Auth.ValidateAll() if the designated constraints aren't met.

func (AuthMultiError) AllErrors

func (m AuthMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AuthMultiError) Error

func (m AuthMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AuthValidationError

type AuthValidationError struct {
	// contains filtered or unexported fields
}

AuthValidationError is the validation error returned by Auth.Validate if the designated constraints aren't met.

func (AuthValidationError) Cause

func (e AuthValidationError) Cause() error

Cause function returns cause value.

func (AuthValidationError) Error

func (e AuthValidationError) Error() string

Error satisfies the builtin error interface

func (AuthValidationError) ErrorName

func (e AuthValidationError) ErrorName() string

ErrorName returns error name.

func (AuthValidationError) Field

func (e AuthValidationError) Field() string

Field function returns field value.

func (AuthValidationError) Key

func (e AuthValidationError) Key() bool

Key function returns key value.

func (AuthValidationError) Reason

func (e AuthValidationError) Reason() string

Reason function returns reason value.

type Auth_KeyPair

type Auth_KeyPair struct {
	PubKey    *PublicKey `protobuf:"bytes,1,opt,name=pub_key,json=pubKey,proto3" json:"pub_key,omitempty"`
	Signature *Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

KeyPair uses a keypair to verify a message.

The signature should be of the encapsulating proto message, _without_ the Auth section being set.

func (*Auth_KeyPair) Descriptor deprecated

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

Deprecated: Use Auth_KeyPair.ProtoReflect.Descriptor instead.

func (*Auth_KeyPair) GetPubKey

func (x *Auth_KeyPair) GetPubKey() *PublicKey

func (*Auth_KeyPair) GetSignature

func (x *Auth_KeyPair) GetSignature() *Signature

func (*Auth_KeyPair) ProtoMessage

func (*Auth_KeyPair) ProtoMessage()

func (*Auth_KeyPair) ProtoReflect

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

func (*Auth_KeyPair) Reset

func (x *Auth_KeyPair) Reset()

func (*Auth_KeyPair) String

func (x *Auth_KeyPair) String() string

func (*Auth_KeyPair) Validate

func (m *Auth_KeyPair) Validate() error

Validate checks the field values on Auth_KeyPair with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Auth_KeyPair) ValidateAll

func (m *Auth_KeyPair) ValidateAll() error

ValidateAll checks the field values on Auth_KeyPair with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in Auth_KeyPairMultiError, or nil if none found.

type Auth_KeyPairMultiError

type Auth_KeyPairMultiError []error

Auth_KeyPairMultiError is an error wrapping multiple validation errors returned by Auth_KeyPair.ValidateAll() if the designated constraints aren't met.

func (Auth_KeyPairMultiError) AllErrors

func (m Auth_KeyPairMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (Auth_KeyPairMultiError) Error

func (m Auth_KeyPairMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type Auth_KeyPairValidationError

type Auth_KeyPairValidationError struct {
	// contains filtered or unexported fields
}

Auth_KeyPairValidationError is the validation error returned by Auth_KeyPair.Validate if the designated constraints aren't met.

func (Auth_KeyPairValidationError) Cause

Cause function returns cause value.

func (Auth_KeyPairValidationError) Error

Error satisfies the builtin error interface

func (Auth_KeyPairValidationError) ErrorName

func (e Auth_KeyPairValidationError) ErrorName() string

ErrorName returns error name.

func (Auth_KeyPairValidationError) Field

Field function returns field value.

func (Auth_KeyPairValidationError) Key

Key function returns key value.

func (Auth_KeyPairValidationError) Reason

Reason function returns reason value.

type Auth_KeyPair_

type Auth_KeyPair_ struct {
	// KeyPair uses pub key cryptography to verify.
	KeyPair *Auth_KeyPair `protobuf:"bytes,1,opt,name=key_pair,json=keyPair,proto3,oneof"`
}

type Platform

type Platform int32
const (
	Platform_UNKNOWN Platform = 0
	Platform_APPLE   Platform = 1
	Platform_GOOGLE  Platform = 2
)

func (Platform) Descriptor

func (Platform) Descriptor() protoreflect.EnumDescriptor

func (Platform) Enum

func (x Platform) Enum() *Platform

func (Platform) EnumDescriptor deprecated

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

Deprecated: Use Platform.Descriptor instead.

func (Platform) Number

func (x Platform) Number() protoreflect.EnumNumber

func (Platform) String

func (x Platform) String() string

func (Platform) Type

type PublicKey

type PublicKey struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*PublicKey) Descriptor deprecated

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

Deprecated: Use PublicKey.ProtoReflect.Descriptor instead.

func (*PublicKey) GetValue

func (x *PublicKey) GetValue() []byte

func (*PublicKey) ProtoMessage

func (*PublicKey) ProtoMessage()

func (*PublicKey) ProtoReflect

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

func (*PublicKey) Reset

func (x *PublicKey) Reset()

func (*PublicKey) String

func (x *PublicKey) String() string

func (*PublicKey) Validate

func (m *PublicKey) Validate() error

Validate checks the field values on PublicKey with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PublicKey) ValidateAll

func (m *PublicKey) ValidateAll() error

ValidateAll checks the field values on PublicKey with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PublicKeyMultiError, or nil if none found.

type PublicKeyMultiError

type PublicKeyMultiError []error

PublicKeyMultiError is an error wrapping multiple validation errors returned by PublicKey.ValidateAll() if the designated constraints aren't met.

func (PublicKeyMultiError) AllErrors

func (m PublicKeyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PublicKeyMultiError) Error

func (m PublicKeyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PublicKeyValidationError

type PublicKeyValidationError struct {
	// contains filtered or unexported fields
}

PublicKeyValidationError is the validation error returned by PublicKey.Validate if the designated constraints aren't met.

func (PublicKeyValidationError) Cause

func (e PublicKeyValidationError) Cause() error

Cause function returns cause value.

func (PublicKeyValidationError) Error

func (e PublicKeyValidationError) Error() string

Error satisfies the builtin error interface

func (PublicKeyValidationError) ErrorName

func (e PublicKeyValidationError) ErrorName() string

ErrorName returns error name.

func (PublicKeyValidationError) Field

func (e PublicKeyValidationError) Field() string

Field function returns field value.

func (PublicKeyValidationError) Key

Key function returns key value.

func (PublicKeyValidationError) Reason

func (e PublicKeyValidationError) Reason() string

Reason function returns reason value.

type Signature

type Signature struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Signature) Descriptor deprecated

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

Deprecated: Use Signature.ProtoReflect.Descriptor instead.

func (*Signature) GetValue

func (x *Signature) GetValue() []byte

func (*Signature) ProtoMessage

func (*Signature) ProtoMessage()

func (*Signature) ProtoReflect

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

func (*Signature) Reset

func (x *Signature) Reset()

func (*Signature) String

func (x *Signature) String() string

func (*Signature) Validate

func (m *Signature) Validate() error

Validate checks the field values on Signature with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Signature) ValidateAll

func (m *Signature) ValidateAll() error

ValidateAll checks the field values on Signature with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SignatureMultiError, or nil if none found.

type SignatureMultiError

type SignatureMultiError []error

SignatureMultiError is an error wrapping multiple validation errors returned by Signature.ValidateAll() if the designated constraints aren't met.

func (SignatureMultiError) AllErrors

func (m SignatureMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SignatureMultiError) Error

func (m SignatureMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SignatureValidationError

type SignatureValidationError struct {
	// contains filtered or unexported fields
}

SignatureValidationError is the validation error returned by Signature.Validate if the designated constraints aren't met.

func (SignatureValidationError) Cause

func (e SignatureValidationError) Cause() error

Cause function returns cause value.

func (SignatureValidationError) Error

func (e SignatureValidationError) Error() string

Error satisfies the builtin error interface

func (SignatureValidationError) ErrorName

func (e SignatureValidationError) ErrorName() string

ErrorName returns error name.

func (SignatureValidationError) Field

func (e SignatureValidationError) Field() string

Field function returns field value.

func (SignatureValidationError) Key

Key function returns key value.

func (SignatureValidationError) Reason

func (e SignatureValidationError) Reason() string

Reason function returns reason value.

type UserId

type UserId struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*UserId) Descriptor deprecated

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

Deprecated: Use UserId.ProtoReflect.Descriptor instead.

func (*UserId) GetValue

func (x *UserId) GetValue() []byte

func (*UserId) ProtoMessage

func (*UserId) ProtoMessage()

func (*UserId) ProtoReflect

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

func (*UserId) Reset

func (x *UserId) Reset()

func (*UserId) String

func (x *UserId) String() string

func (*UserId) Validate

func (m *UserId) Validate() error

Validate checks the field values on UserId with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*UserId) ValidateAll

func (m *UserId) ValidateAll() error

ValidateAll checks the field values on UserId with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in UserIdMultiError, or nil if none found.

type UserIdMultiError

type UserIdMultiError []error

UserIdMultiError is an error wrapping multiple validation errors returned by UserId.ValidateAll() if the designated constraints aren't met.

func (UserIdMultiError) AllErrors

func (m UserIdMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (UserIdMultiError) Error

func (m UserIdMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type UserIdValidationError

type UserIdValidationError struct {
	// contains filtered or unexported fields
}

UserIdValidationError is the validation error returned by UserId.Validate if the designated constraints aren't met.

func (UserIdValidationError) Cause

func (e UserIdValidationError) Cause() error

Cause function returns cause value.

func (UserIdValidationError) Error

func (e UserIdValidationError) Error() string

Error satisfies the builtin error interface

func (UserIdValidationError) ErrorName

func (e UserIdValidationError) ErrorName() string

ErrorName returns error name.

func (UserIdValidationError) Field

func (e UserIdValidationError) Field() string

Field function returns field value.

func (UserIdValidationError) Key

func (e UserIdValidationError) Key() bool

Key function returns key value.

func (UserIdValidationError) Reason

func (e UserIdValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL