v1

package
v3.49.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	MlsApi_SendGroupMessages_FullMethodName        = "/xmtp.mls.api.v1.MlsApi/SendGroupMessages"
	MlsApi_SendWelcomeMessages_FullMethodName      = "/xmtp.mls.api.v1.MlsApi/SendWelcomeMessages"
	MlsApi_RegisterInstallation_FullMethodName     = "/xmtp.mls.api.v1.MlsApi/RegisterInstallation"
	MlsApi_UploadKeyPackage_FullMethodName         = "/xmtp.mls.api.v1.MlsApi/UploadKeyPackage"
	MlsApi_FetchKeyPackages_FullMethodName         = "/xmtp.mls.api.v1.MlsApi/FetchKeyPackages"
	MlsApi_RevokeInstallation_FullMethodName       = "/xmtp.mls.api.v1.MlsApi/RevokeInstallation"
	MlsApi_GetIdentityUpdates_FullMethodName       = "/xmtp.mls.api.v1.MlsApi/GetIdentityUpdates"
	MlsApi_QueryGroupMessages_FullMethodName       = "/xmtp.mls.api.v1.MlsApi/QueryGroupMessages"
	MlsApi_QueryWelcomeMessages_FullMethodName     = "/xmtp.mls.api.v1.MlsApi/QueryWelcomeMessages"
	MlsApi_SubscribeGroupMessages_FullMethodName   = "/xmtp.mls.api.v1.MlsApi/SubscribeGroupMessages"
	MlsApi_SubscribeWelcomeMessages_FullMethodName = "/xmtp.mls.api.v1.MlsApi/SubscribeWelcomeMessages"
)

Variables

View Source
var (
	SortDirection_name = map[int32]string{
		0: "SORT_DIRECTION_UNSPECIFIED",
		1: "SORT_DIRECTION_ASCENDING",
		2: "SORT_DIRECTION_DESCENDING",
	}
	SortDirection_value = map[string]int32{
		"SORT_DIRECTION_UNSPECIFIED": 0,
		"SORT_DIRECTION_ASCENDING":   1,
		"SORT_DIRECTION_DESCENDING":  2,
	}
)

Enum value maps for SortDirection.

View Source
var File_mls_api_v1_mls_proto protoreflect.FileDescriptor
View Source
var MlsApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "xmtp.mls.api.v1.MlsApi",
	HandlerType: (*MlsApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SendGroupMessages",
			Handler:    _MlsApi_SendGroupMessages_Handler,
		},
		{
			MethodName: "SendWelcomeMessages",
			Handler:    _MlsApi_SendWelcomeMessages_Handler,
		},
		{
			MethodName: "RegisterInstallation",
			Handler:    _MlsApi_RegisterInstallation_Handler,
		},
		{
			MethodName: "UploadKeyPackage",
			Handler:    _MlsApi_UploadKeyPackage_Handler,
		},
		{
			MethodName: "FetchKeyPackages",
			Handler:    _MlsApi_FetchKeyPackages_Handler,
		},
		{
			MethodName: "RevokeInstallation",
			Handler:    _MlsApi_RevokeInstallation_Handler,
		},
		{
			MethodName: "GetIdentityUpdates",
			Handler:    _MlsApi_GetIdentityUpdates_Handler,
		},
		{
			MethodName: "QueryGroupMessages",
			Handler:    _MlsApi_QueryGroupMessages_Handler,
		},
		{
			MethodName: "QueryWelcomeMessages",
			Handler:    _MlsApi_QueryWelcomeMessages_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "SubscribeGroupMessages",
			Handler:       _MlsApi_SubscribeGroupMessages_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "SubscribeWelcomeMessages",
			Handler:       _MlsApi_SubscribeWelcomeMessages_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "mls/api/v1/mls.proto",
}

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

Functions

func RegisterMlsApiHandler

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

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

func RegisterMlsApiHandlerClient

func RegisterMlsApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MlsApiClient) error

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

func RegisterMlsApiHandlerFromEndpoint

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

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

func RegisterMlsApiHandlerServer

func RegisterMlsApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MlsApiServer) error

RegisterMlsApiHandlerServer registers the http handlers for service MlsApi to "mux". UnaryRPC :call MlsApiServer 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 RegisterMlsApiHandlerFromEndpoint instead.

func RegisterMlsApiServer

func RegisterMlsApiServer(s grpc.ServiceRegistrar, srv MlsApiServer)

Types

type FetchKeyPackagesRequest

type FetchKeyPackagesRequest struct {

	// The caller can provide an array of installation keys, and the API
	// will return one key package for each installation associated with each
	// installation key
	InstallationKeys [][]byte `protobuf:"bytes,1,rep,name=installation_keys,json=installationKeys,proto3" json:"installation_keys,omitempty"`
	// contains filtered or unexported fields
}

Fetch one or more key packages

func (*FetchKeyPackagesRequest) Descriptor deprecated

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

Deprecated: Use FetchKeyPackagesRequest.ProtoReflect.Descriptor instead.

func (*FetchKeyPackagesRequest) GetInstallationKeys added in v3.38.0

func (x *FetchKeyPackagesRequest) GetInstallationKeys() [][]byte

func (*FetchKeyPackagesRequest) ProtoMessage

func (*FetchKeyPackagesRequest) ProtoMessage()

func (*FetchKeyPackagesRequest) ProtoReflect

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

func (*FetchKeyPackagesRequest) Reset

func (x *FetchKeyPackagesRequest) Reset()

func (*FetchKeyPackagesRequest) String

func (x *FetchKeyPackagesRequest) String() string

type FetchKeyPackagesResponse

type FetchKeyPackagesResponse struct {

	// Returns one key package per installation in the original order of the
	// request. If any installations are missing key packages, an empty entry is
	// left in their respective spots in the array.
	KeyPackages []*FetchKeyPackagesResponse_KeyPackage `protobuf:"bytes,1,rep,name=key_packages,json=keyPackages,proto3" json:"key_packages,omitempty"`
	// contains filtered or unexported fields
}

The response to a FetchKeyPackagesRequest

func (*FetchKeyPackagesResponse) Descriptor deprecated

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

Deprecated: Use FetchKeyPackagesResponse.ProtoReflect.Descriptor instead.

func (*FetchKeyPackagesResponse) GetKeyPackages

func (*FetchKeyPackagesResponse) ProtoMessage

func (*FetchKeyPackagesResponse) ProtoMessage()

func (*FetchKeyPackagesResponse) ProtoReflect

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

func (*FetchKeyPackagesResponse) Reset

func (x *FetchKeyPackagesResponse) Reset()

func (*FetchKeyPackagesResponse) String

func (x *FetchKeyPackagesResponse) String() string

type FetchKeyPackagesResponse_KeyPackage

type FetchKeyPackagesResponse_KeyPackage struct {
	KeyPackageTlsSerialized []byte `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

An individual key package

func (*FetchKeyPackagesResponse_KeyPackage) Descriptor deprecated

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

Deprecated: Use FetchKeyPackagesResponse_KeyPackage.ProtoReflect.Descriptor instead.

func (*FetchKeyPackagesResponse_KeyPackage) GetKeyPackageTlsSerialized

func (x *FetchKeyPackagesResponse_KeyPackage) GetKeyPackageTlsSerialized() []byte

func (*FetchKeyPackagesResponse_KeyPackage) ProtoMessage

func (*FetchKeyPackagesResponse_KeyPackage) ProtoMessage()

func (*FetchKeyPackagesResponse_KeyPackage) ProtoReflect

func (*FetchKeyPackagesResponse_KeyPackage) Reset

func (*FetchKeyPackagesResponse_KeyPackage) String

type GetIdentityUpdatesRequest

type GetIdentityUpdatesRequest struct {
	AccountAddresses []string `protobuf:"bytes,1,rep,name=account_addresses,json=accountAddresses,proto3" json:"account_addresses,omitempty"`
	StartTimeNs      uint64   `protobuf:"varint,2,opt,name=start_time_ns,json=startTimeNs,proto3" json:"start_time_ns,omitempty"`
	// contains filtered or unexported fields
}

Get all updates for an identity since the specified time

func (*GetIdentityUpdatesRequest) Descriptor deprecated

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

Deprecated: Use GetIdentityUpdatesRequest.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesRequest) GetAccountAddresses

func (x *GetIdentityUpdatesRequest) GetAccountAddresses() []string

func (*GetIdentityUpdatesRequest) GetStartTimeNs

func (x *GetIdentityUpdatesRequest) GetStartTimeNs() uint64

func (*GetIdentityUpdatesRequest) ProtoMessage

func (*GetIdentityUpdatesRequest) ProtoMessage()

func (*GetIdentityUpdatesRequest) ProtoReflect

func (*GetIdentityUpdatesRequest) Reset

func (x *GetIdentityUpdatesRequest) Reset()

func (*GetIdentityUpdatesRequest) String

func (x *GetIdentityUpdatesRequest) String() string

type GetIdentityUpdatesResponse

type GetIdentityUpdatesResponse struct {

	// A list of updates (or empty objects if no changes) in the original order
	// of the request
	Updates []*GetIdentityUpdatesResponse_WalletUpdates `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"`
	// contains filtered or unexported fields
}

Used to get any new or revoked installations for a list of wallet addresses

func (*GetIdentityUpdatesResponse) Descriptor deprecated

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

Deprecated: Use GetIdentityUpdatesResponse.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesResponse) GetUpdates

func (*GetIdentityUpdatesResponse) ProtoMessage

func (*GetIdentityUpdatesResponse) ProtoMessage()

func (*GetIdentityUpdatesResponse) ProtoReflect

func (*GetIdentityUpdatesResponse) Reset

func (x *GetIdentityUpdatesResponse) Reset()

func (*GetIdentityUpdatesResponse) String

func (x *GetIdentityUpdatesResponse) String() string

type GetIdentityUpdatesResponse_NewInstallationUpdate

type GetIdentityUpdatesResponse_NewInstallationUpdate struct {
	InstallationKey    []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	CredentialIdentity []byte `protobuf:"bytes,2,opt,name=credential_identity,json=credentialIdentity,proto3" json:"credential_identity,omitempty"`
	// contains filtered or unexported fields
}

A new installation key was seen for the first time by the nodes

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Descriptor deprecated

Deprecated: Use GetIdentityUpdatesResponse_NewInstallationUpdate.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) GetCredentialIdentity

func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) GetCredentialIdentity() []byte

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) GetInstallationKey added in v3.38.0

func (x *GetIdentityUpdatesResponse_NewInstallationUpdate) GetInstallationKey() []byte

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoMessage

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) ProtoReflect

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) Reset

func (*GetIdentityUpdatesResponse_NewInstallationUpdate) String

type GetIdentityUpdatesResponse_RevokedInstallationUpdate

type GetIdentityUpdatesResponse_RevokedInstallationUpdate struct {
	InstallationKey []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	// contains filtered or unexported fields
}

An installation was revoked

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Descriptor deprecated

Deprecated: Use GetIdentityUpdatesResponse_RevokedInstallationUpdate.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) GetInstallationKey added in v3.38.0

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoMessage

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) ProtoReflect

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) Reset

func (*GetIdentityUpdatesResponse_RevokedInstallationUpdate) String

type GetIdentityUpdatesResponse_Update

type GetIdentityUpdatesResponse_Update struct {
	TimestampNs uint64 `protobuf:"varint,1,opt,name=timestamp_ns,json=timestampNs,proto3" json:"timestamp_ns,omitempty"`
	// Types that are assignable to Kind:
	//
	//	*GetIdentityUpdatesResponse_Update_NewInstallation
	//	*GetIdentityUpdatesResponse_Update_RevokedInstallation
	Kind isGetIdentityUpdatesResponse_Update_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

A wrapper for any update to the wallet

func (*GetIdentityUpdatesResponse_Update) Descriptor deprecated

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

Deprecated: Use GetIdentityUpdatesResponse_Update.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesResponse_Update) GetKind

func (m *GetIdentityUpdatesResponse_Update) GetKind() isGetIdentityUpdatesResponse_Update_Kind

func (*GetIdentityUpdatesResponse_Update) GetNewInstallation

func (*GetIdentityUpdatesResponse_Update) GetRevokedInstallation

func (*GetIdentityUpdatesResponse_Update) GetTimestampNs

func (x *GetIdentityUpdatesResponse_Update) GetTimestampNs() uint64

func (*GetIdentityUpdatesResponse_Update) ProtoMessage

func (*GetIdentityUpdatesResponse_Update) ProtoMessage()

func (*GetIdentityUpdatesResponse_Update) ProtoReflect

func (*GetIdentityUpdatesResponse_Update) Reset

func (*GetIdentityUpdatesResponse_Update) String

type GetIdentityUpdatesResponse_Update_NewInstallation

type GetIdentityUpdatesResponse_Update_NewInstallation struct {
	NewInstallation *GetIdentityUpdatesResponse_NewInstallationUpdate `protobuf:"bytes,2,opt,name=new_installation,json=newInstallation,proto3,oneof"`
}

type GetIdentityUpdatesResponse_Update_RevokedInstallation

type GetIdentityUpdatesResponse_Update_RevokedInstallation struct {
	RevokedInstallation *GetIdentityUpdatesResponse_RevokedInstallationUpdate `protobuf:"bytes,3,opt,name=revoked_installation,json=revokedInstallation,proto3,oneof"`
}

type GetIdentityUpdatesResponse_WalletUpdates

type GetIdentityUpdatesResponse_WalletUpdates struct {
	Updates []*GetIdentityUpdatesResponse_Update `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"`
	// contains filtered or unexported fields
}

A wrapper for the updates for a single wallet

func (*GetIdentityUpdatesResponse_WalletUpdates) Descriptor deprecated

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

Deprecated: Use GetIdentityUpdatesResponse_WalletUpdates.ProtoReflect.Descriptor instead.

func (*GetIdentityUpdatesResponse_WalletUpdates) GetUpdates

func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoMessage

func (*GetIdentityUpdatesResponse_WalletUpdates) ProtoReflect

func (*GetIdentityUpdatesResponse_WalletUpdates) Reset

func (*GetIdentityUpdatesResponse_WalletUpdates) String

type GroupMessage added in v3.38.0

type GroupMessage struct {

	// Types that are assignable to Version:
	//
	//	*GroupMessage_V1_
	Version isGroupMessage_Version `protobuf_oneof:"version"`
	// contains filtered or unexported fields
}

Full representation of a group message

func (*GroupMessage) Descriptor deprecated added in v3.38.0

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

Deprecated: Use GroupMessage.ProtoReflect.Descriptor instead.

func (*GroupMessage) GetV1 added in v3.38.0

func (x *GroupMessage) GetV1() *GroupMessage_V1

func (*GroupMessage) GetVersion added in v3.38.0

func (m *GroupMessage) GetVersion() isGroupMessage_Version

func (*GroupMessage) ProtoMessage added in v3.38.0

func (*GroupMessage) ProtoMessage()

func (*GroupMessage) ProtoReflect added in v3.38.0

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

func (*GroupMessage) Reset added in v3.38.0

func (x *GroupMessage) Reset()

func (*GroupMessage) String added in v3.38.0

func (x *GroupMessage) String() string

type GroupMessageInput added in v3.38.0

type GroupMessageInput struct {

	// Types that are assignable to Version:
	//
	//	*GroupMessageInput_V1_
	Version isGroupMessageInput_Version `protobuf_oneof:"version"`
	// contains filtered or unexported fields
}

Input type for a group message

func (*GroupMessageInput) Descriptor deprecated added in v3.38.0

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

Deprecated: Use GroupMessageInput.ProtoReflect.Descriptor instead.

func (*GroupMessageInput) GetV1 added in v3.38.0

func (*GroupMessageInput) GetVersion added in v3.38.0

func (m *GroupMessageInput) GetVersion() isGroupMessageInput_Version

func (*GroupMessageInput) ProtoMessage added in v3.38.0

func (*GroupMessageInput) ProtoMessage()

func (*GroupMessageInput) ProtoReflect added in v3.38.0

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

func (*GroupMessageInput) Reset added in v3.38.0

func (x *GroupMessageInput) Reset()

func (*GroupMessageInput) String added in v3.38.0

func (x *GroupMessageInput) String() string

type GroupMessageInput_V1 added in v3.38.0

type GroupMessageInput_V1 struct {
	Data       []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	SenderHmac []byte `protobuf:"bytes,2,opt,name=sender_hmac,json=senderHmac,proto3" json:"sender_hmac,omitempty"`
	// contains filtered or unexported fields
}

Version 1 of the GroupMessageInput payload format

func (*GroupMessageInput_V1) Descriptor deprecated added in v3.38.0

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

Deprecated: Use GroupMessageInput_V1.ProtoReflect.Descriptor instead.

func (*GroupMessageInput_V1) GetData added in v3.38.0

func (x *GroupMessageInput_V1) GetData() []byte

func (*GroupMessageInput_V1) GetSenderHmac added in v3.39.0

func (x *GroupMessageInput_V1) GetSenderHmac() []byte

func (*GroupMessageInput_V1) ProtoMessage added in v3.38.0

func (*GroupMessageInput_V1) ProtoMessage()

func (*GroupMessageInput_V1) ProtoReflect added in v3.38.0

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

func (*GroupMessageInput_V1) Reset added in v3.38.0

func (x *GroupMessageInput_V1) Reset()

func (*GroupMessageInput_V1) String added in v3.38.0

func (x *GroupMessageInput_V1) String() string

type GroupMessageInput_V1_ added in v3.38.0

type GroupMessageInput_V1_ struct {
	V1 *GroupMessageInput_V1 `protobuf:"bytes,1,opt,name=v1,proto3,oneof"`
}

type GroupMessage_V1 added in v3.38.0

type GroupMessage_V1 struct {
	Id         uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	CreatedNs  uint64 `protobuf:"varint,2,opt,name=created_ns,json=createdNs,proto3" json:"created_ns,omitempty"`
	GroupId    []byte `protobuf:"bytes,3,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	Data       []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	SenderHmac []byte `protobuf:"bytes,5,opt,name=sender_hmac,json=senderHmac,proto3" json:"sender_hmac,omitempty"`
	// contains filtered or unexported fields
}

Version 1 of the GroupMessage format

func (*GroupMessage_V1) Descriptor deprecated added in v3.38.0

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

Deprecated: Use GroupMessage_V1.ProtoReflect.Descriptor instead.

func (*GroupMessage_V1) GetCreatedNs added in v3.38.0

func (x *GroupMessage_V1) GetCreatedNs() uint64

func (*GroupMessage_V1) GetData added in v3.38.0

func (x *GroupMessage_V1) GetData() []byte

func (*GroupMessage_V1) GetGroupId added in v3.38.0

func (x *GroupMessage_V1) GetGroupId() []byte

func (*GroupMessage_V1) GetId added in v3.38.0

func (x *GroupMessage_V1) GetId() uint64

func (*GroupMessage_V1) GetSenderHmac added in v3.39.0

func (x *GroupMessage_V1) GetSenderHmac() []byte

func (*GroupMessage_V1) ProtoMessage added in v3.38.0

func (*GroupMessage_V1) ProtoMessage()

func (*GroupMessage_V1) ProtoReflect added in v3.38.0

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

func (*GroupMessage_V1) Reset added in v3.38.0

func (x *GroupMessage_V1) Reset()

func (*GroupMessage_V1) String added in v3.38.0

func (x *GroupMessage_V1) String() string

type GroupMessage_V1_ added in v3.38.0

type GroupMessage_V1_ struct {
	V1 *GroupMessage_V1 `protobuf:"bytes,1,opt,name=v1,proto3,oneof"`
}

type KeyPackageUpload

type KeyPackageUpload struct {

	// The owner's wallet address would be extracted from the identity
	// credential in the key package, and all signatures would be validated.
	KeyPackageTlsSerialized []byte `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

A wrapper around the Key Package bytes

func (*KeyPackageUpload) Descriptor deprecated

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

Deprecated: Use KeyPackageUpload.ProtoReflect.Descriptor instead.

func (*KeyPackageUpload) GetKeyPackageTlsSerialized

func (x *KeyPackageUpload) GetKeyPackageTlsSerialized() []byte

func (*KeyPackageUpload) ProtoMessage

func (*KeyPackageUpload) ProtoMessage()

func (*KeyPackageUpload) ProtoReflect

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

func (*KeyPackageUpload) Reset

func (x *KeyPackageUpload) Reset()

func (*KeyPackageUpload) String

func (x *KeyPackageUpload) String() string

type MlsApiClient

type MlsApiClient interface {
	// Send a MLS payload, that would be validated before being stored to the
	// network
	SendGroupMessages(ctx context.Context, in *SendGroupMessagesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Send a batch of welcome messages
	SendWelcomeMessages(ctx context.Context, in *SendWelcomeMessagesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Register a new installation, which would be validated before storage
	RegisterInstallation(ctx context.Context, in *RegisterInstallationRequest, opts ...grpc.CallOption) (*RegisterInstallationResponse, error)
	// Upload a new KeyPackage, which would be validated before storage
	UploadKeyPackage(ctx context.Context, in *UploadKeyPackageRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get one or more Key Packages by installation_id
	FetchKeyPackages(ctx context.Context, in *FetchKeyPackagesRequest, opts ...grpc.CallOption) (*FetchKeyPackagesResponse, error)
	// Would delete all key packages associated with the installation and mark
	// the installation as having been revoked
	RevokeInstallation(ctx context.Context, in *RevokeInstallationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Used to check for changes related to members of a group.
	// Would return an array of any new installations associated with the wallet
	// address, and any revocations that have happened.
	GetIdentityUpdates(ctx context.Context, in *GetIdentityUpdatesRequest, opts ...grpc.CallOption) (*GetIdentityUpdatesResponse, error)
	// Query stored group messages
	QueryGroupMessages(ctx context.Context, in *QueryGroupMessagesRequest, opts ...grpc.CallOption) (*QueryGroupMessagesResponse, error)
	// Query stored group messages
	QueryWelcomeMessages(ctx context.Context, in *QueryWelcomeMessagesRequest, opts ...grpc.CallOption) (*QueryWelcomeMessagesResponse, error)
	// Subscribe stream of new group messages
	SubscribeGroupMessages(ctx context.Context, in *SubscribeGroupMessagesRequest, opts ...grpc.CallOption) (MlsApi_SubscribeGroupMessagesClient, error)
	// Subscribe stream of new welcome messages
	SubscribeWelcomeMessages(ctx context.Context, in *SubscribeWelcomeMessagesRequest, opts ...grpc.CallOption) (MlsApi_SubscribeWelcomeMessagesClient, error)
}

MlsApiClient is the client API for MlsApi 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 NewMlsApiClient

func NewMlsApiClient(cc grpc.ClientConnInterface) MlsApiClient

type MlsApiServer

type MlsApiServer interface {
	// Send a MLS payload, that would be validated before being stored to the
	// network
	SendGroupMessages(context.Context, *SendGroupMessagesRequest) (*emptypb.Empty, error)
	// Send a batch of welcome messages
	SendWelcomeMessages(context.Context, *SendWelcomeMessagesRequest) (*emptypb.Empty, error)
	// Register a new installation, which would be validated before storage
	RegisterInstallation(context.Context, *RegisterInstallationRequest) (*RegisterInstallationResponse, error)
	// Upload a new KeyPackage, which would be validated before storage
	UploadKeyPackage(context.Context, *UploadKeyPackageRequest) (*emptypb.Empty, error)
	// Get one or more Key Packages by installation_id
	FetchKeyPackages(context.Context, *FetchKeyPackagesRequest) (*FetchKeyPackagesResponse, error)
	// Would delete all key packages associated with the installation and mark
	// the installation as having been revoked
	RevokeInstallation(context.Context, *RevokeInstallationRequest) (*emptypb.Empty, error)
	// Used to check for changes related to members of a group.
	// Would return an array of any new installations associated with the wallet
	// address, and any revocations that have happened.
	GetIdentityUpdates(context.Context, *GetIdentityUpdatesRequest) (*GetIdentityUpdatesResponse, error)
	// Query stored group messages
	QueryGroupMessages(context.Context, *QueryGroupMessagesRequest) (*QueryGroupMessagesResponse, error)
	// Query stored group messages
	QueryWelcomeMessages(context.Context, *QueryWelcomeMessagesRequest) (*QueryWelcomeMessagesResponse, error)
	// Subscribe stream of new group messages
	SubscribeGroupMessages(*SubscribeGroupMessagesRequest, MlsApi_SubscribeGroupMessagesServer) error
	// Subscribe stream of new welcome messages
	SubscribeWelcomeMessages(*SubscribeWelcomeMessagesRequest, MlsApi_SubscribeWelcomeMessagesServer) error
	// contains filtered or unexported methods
}

MlsApiServer is the server API for MlsApi service. All implementations must embed UnimplementedMlsApiServer for forward compatibility

type MlsApi_SubscribeGroupMessagesClient added in v3.38.0

type MlsApi_SubscribeGroupMessagesClient interface {
	Recv() (*GroupMessage, error)
	grpc.ClientStream
}

type MlsApi_SubscribeGroupMessagesServer added in v3.38.0

type MlsApi_SubscribeGroupMessagesServer interface {
	Send(*GroupMessage) error
	grpc.ServerStream
}

type MlsApi_SubscribeWelcomeMessagesClient added in v3.38.0

type MlsApi_SubscribeWelcomeMessagesClient interface {
	Recv() (*WelcomeMessage, error)
	grpc.ClientStream
}

type MlsApi_SubscribeWelcomeMessagesServer added in v3.38.0

type MlsApi_SubscribeWelcomeMessagesServer interface {
	Send(*WelcomeMessage) error
	grpc.ServerStream
}

type PagingInfo added in v3.38.0

type PagingInfo struct {
	Direction SortDirection `protobuf:"varint,1,opt,name=direction,proto3,enum=xmtp.mls.api.v1.SortDirection" json:"direction,omitempty"`
	Limit     uint32        `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	IdCursor  uint64        `protobuf:"varint,3,opt,name=id_cursor,json=idCursor,proto3" json:"id_cursor,omitempty"`
	// contains filtered or unexported fields
}

Pagination config for queries

func (*PagingInfo) Descriptor deprecated added in v3.38.0

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

Deprecated: Use PagingInfo.ProtoReflect.Descriptor instead.

func (*PagingInfo) GetDirection added in v3.38.0

func (x *PagingInfo) GetDirection() SortDirection

func (*PagingInfo) GetIdCursor added in v3.38.0

func (x *PagingInfo) GetIdCursor() uint64

func (*PagingInfo) GetLimit added in v3.38.0

func (x *PagingInfo) GetLimit() uint32

func (*PagingInfo) ProtoMessage added in v3.38.0

func (*PagingInfo) ProtoMessage()

func (*PagingInfo) ProtoReflect added in v3.38.0

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

func (*PagingInfo) Reset added in v3.38.0

func (x *PagingInfo) Reset()

func (*PagingInfo) String added in v3.38.0

func (x *PagingInfo) String() string

type QueryGroupMessagesRequest added in v3.38.0

type QueryGroupMessagesRequest struct {
	GroupId    []byte      `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	PagingInfo *PagingInfo `protobuf:"bytes,2,opt,name=paging_info,json=pagingInfo,proto3" json:"paging_info,omitempty"`
	// contains filtered or unexported fields
}

Request for group message queries

func (*QueryGroupMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use QueryGroupMessagesRequest.ProtoReflect.Descriptor instead.

func (*QueryGroupMessagesRequest) GetGroupId added in v3.38.0

func (x *QueryGroupMessagesRequest) GetGroupId() []byte

func (*QueryGroupMessagesRequest) GetPagingInfo added in v3.38.0

func (x *QueryGroupMessagesRequest) GetPagingInfo() *PagingInfo

func (*QueryGroupMessagesRequest) ProtoMessage added in v3.38.0

func (*QueryGroupMessagesRequest) ProtoMessage()

func (*QueryGroupMessagesRequest) ProtoReflect added in v3.38.0

func (*QueryGroupMessagesRequest) Reset added in v3.38.0

func (x *QueryGroupMessagesRequest) Reset()

func (*QueryGroupMessagesRequest) String added in v3.38.0

func (x *QueryGroupMessagesRequest) String() string

type QueryGroupMessagesResponse added in v3.38.0

type QueryGroupMessagesResponse struct {
	Messages   []*GroupMessage `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	PagingInfo *PagingInfo     `protobuf:"bytes,2,opt,name=paging_info,json=pagingInfo,proto3" json:"paging_info,omitempty"`
	// contains filtered or unexported fields
}

Response for group message queries

func (*QueryGroupMessagesResponse) Descriptor deprecated added in v3.38.0

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

Deprecated: Use QueryGroupMessagesResponse.ProtoReflect.Descriptor instead.

func (*QueryGroupMessagesResponse) GetMessages added in v3.38.0

func (x *QueryGroupMessagesResponse) GetMessages() []*GroupMessage

func (*QueryGroupMessagesResponse) GetPagingInfo added in v3.38.0

func (x *QueryGroupMessagesResponse) GetPagingInfo() *PagingInfo

func (*QueryGroupMessagesResponse) ProtoMessage added in v3.38.0

func (*QueryGroupMessagesResponse) ProtoMessage()

func (*QueryGroupMessagesResponse) ProtoReflect added in v3.38.0

func (*QueryGroupMessagesResponse) Reset added in v3.38.0

func (x *QueryGroupMessagesResponse) Reset()

func (*QueryGroupMessagesResponse) String added in v3.38.0

func (x *QueryGroupMessagesResponse) String() string

type QueryWelcomeMessagesRequest added in v3.38.0

type QueryWelcomeMessagesRequest struct {
	InstallationKey []byte      `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	PagingInfo      *PagingInfo `protobuf:"bytes,2,opt,name=paging_info,json=pagingInfo,proto3" json:"paging_info,omitempty"`
	// contains filtered or unexported fields
}

Request for welcome message queries

func (*QueryWelcomeMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use QueryWelcomeMessagesRequest.ProtoReflect.Descriptor instead.

func (*QueryWelcomeMessagesRequest) GetInstallationKey added in v3.38.0

func (x *QueryWelcomeMessagesRequest) GetInstallationKey() []byte

func (*QueryWelcomeMessagesRequest) GetPagingInfo added in v3.38.0

func (x *QueryWelcomeMessagesRequest) GetPagingInfo() *PagingInfo

func (*QueryWelcomeMessagesRequest) ProtoMessage added in v3.38.0

func (*QueryWelcomeMessagesRequest) ProtoMessage()

func (*QueryWelcomeMessagesRequest) ProtoReflect added in v3.38.0

func (*QueryWelcomeMessagesRequest) Reset added in v3.38.0

func (x *QueryWelcomeMessagesRequest) Reset()

func (*QueryWelcomeMessagesRequest) String added in v3.38.0

func (x *QueryWelcomeMessagesRequest) String() string

type QueryWelcomeMessagesResponse added in v3.38.0

type QueryWelcomeMessagesResponse struct {
	Messages   []*WelcomeMessage `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	PagingInfo *PagingInfo       `protobuf:"bytes,2,opt,name=paging_info,json=pagingInfo,proto3" json:"paging_info,omitempty"`
	// contains filtered or unexported fields
}

Response for welcome message queries

func (*QueryWelcomeMessagesResponse) Descriptor deprecated added in v3.38.0

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

Deprecated: Use QueryWelcomeMessagesResponse.ProtoReflect.Descriptor instead.

func (*QueryWelcomeMessagesResponse) GetMessages added in v3.38.0

func (x *QueryWelcomeMessagesResponse) GetMessages() []*WelcomeMessage

func (*QueryWelcomeMessagesResponse) GetPagingInfo added in v3.38.0

func (x *QueryWelcomeMessagesResponse) GetPagingInfo() *PagingInfo

func (*QueryWelcomeMessagesResponse) ProtoMessage added in v3.38.0

func (*QueryWelcomeMessagesResponse) ProtoMessage()

func (*QueryWelcomeMessagesResponse) ProtoReflect added in v3.38.0

func (*QueryWelcomeMessagesResponse) Reset added in v3.38.0

func (x *QueryWelcomeMessagesResponse) Reset()

func (*QueryWelcomeMessagesResponse) String added in v3.38.0

type RegisterInstallationRequest

type RegisterInstallationRequest struct {

	// The Key Package contains all information needed to register an installation
	KeyPackage *KeyPackageUpload `protobuf:"bytes,1,opt,name=key_package,json=keyPackage,proto3" json:"key_package,omitempty"`
	// contains filtered or unexported fields
}

Register a new installation

func (*RegisterInstallationRequest) Descriptor deprecated

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

Deprecated: Use RegisterInstallationRequest.ProtoReflect.Descriptor instead.

func (*RegisterInstallationRequest) GetKeyPackage

func (x *RegisterInstallationRequest) GetKeyPackage() *KeyPackageUpload

func (*RegisterInstallationRequest) ProtoMessage

func (*RegisterInstallationRequest) ProtoMessage()

func (*RegisterInstallationRequest) ProtoReflect

func (*RegisterInstallationRequest) Reset

func (x *RegisterInstallationRequest) Reset()

func (*RegisterInstallationRequest) String

func (x *RegisterInstallationRequest) String() string

type RegisterInstallationResponse

type RegisterInstallationResponse struct {
	InstallationKey []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	// contains filtered or unexported fields
}

The response to a RegisterInstallationRequest

func (*RegisterInstallationResponse) Descriptor deprecated

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

Deprecated: Use RegisterInstallationResponse.ProtoReflect.Descriptor instead.

func (*RegisterInstallationResponse) GetInstallationKey added in v3.38.0

func (x *RegisterInstallationResponse) GetInstallationKey() []byte

func (*RegisterInstallationResponse) ProtoMessage

func (*RegisterInstallationResponse) ProtoMessage()

func (*RegisterInstallationResponse) ProtoReflect

func (*RegisterInstallationResponse) Reset

func (x *RegisterInstallationResponse) Reset()

func (*RegisterInstallationResponse) String

type RevokeInstallationRequest

type RevokeInstallationRequest struct {
	InstallationKey []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	// All revocations must be validated with a wallet signature over the
	// installation_id being revoked (and some sort of standard prologue)
	WalletSignature *message_contents.Signature `protobuf:"bytes,2,opt,name=wallet_signature,json=walletSignature,proto3" json:"wallet_signature,omitempty"`
	// contains filtered or unexported fields
}

Revoke an installation

func (*RevokeInstallationRequest) Descriptor deprecated

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

Deprecated: Use RevokeInstallationRequest.ProtoReflect.Descriptor instead.

func (*RevokeInstallationRequest) GetInstallationKey added in v3.38.0

func (x *RevokeInstallationRequest) GetInstallationKey() []byte

func (*RevokeInstallationRequest) GetWalletSignature

func (x *RevokeInstallationRequest) GetWalletSignature() *message_contents.Signature

func (*RevokeInstallationRequest) ProtoMessage

func (*RevokeInstallationRequest) ProtoMessage()

func (*RevokeInstallationRequest) ProtoReflect

func (*RevokeInstallationRequest) Reset

func (x *RevokeInstallationRequest) Reset()

func (*RevokeInstallationRequest) String

func (x *RevokeInstallationRequest) String() string

type SendGroupMessagesRequest added in v3.38.0

type SendGroupMessagesRequest struct {
	Messages []*GroupMessageInput `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

Send a batch of MLS messages

func (*SendGroupMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SendGroupMessagesRequest.ProtoReflect.Descriptor instead.

func (*SendGroupMessagesRequest) GetMessages added in v3.38.0

func (x *SendGroupMessagesRequest) GetMessages() []*GroupMessageInput

func (*SendGroupMessagesRequest) ProtoMessage added in v3.38.0

func (*SendGroupMessagesRequest) ProtoMessage()

func (*SendGroupMessagesRequest) ProtoReflect added in v3.38.0

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

func (*SendGroupMessagesRequest) Reset added in v3.38.0

func (x *SendGroupMessagesRequest) Reset()

func (*SendGroupMessagesRequest) String added in v3.38.0

func (x *SendGroupMessagesRequest) String() string

type SendWelcomeMessagesRequest added in v3.38.0

type SendWelcomeMessagesRequest struct {
	Messages []*WelcomeMessageInput `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

Send a batch of welcome messages

func (*SendWelcomeMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SendWelcomeMessagesRequest.ProtoReflect.Descriptor instead.

func (*SendWelcomeMessagesRequest) GetMessages added in v3.38.0

func (x *SendWelcomeMessagesRequest) GetMessages() []*WelcomeMessageInput

func (*SendWelcomeMessagesRequest) ProtoMessage added in v3.38.0

func (*SendWelcomeMessagesRequest) ProtoMessage()

func (*SendWelcomeMessagesRequest) ProtoReflect added in v3.38.0

func (*SendWelcomeMessagesRequest) Reset added in v3.38.0

func (x *SendWelcomeMessagesRequest) Reset()

func (*SendWelcomeMessagesRequest) String added in v3.38.0

func (x *SendWelcomeMessagesRequest) String() string

type SortDirection added in v3.38.0

type SortDirection int32

Sort direction for queries

const (
	SortDirection_SORT_DIRECTION_UNSPECIFIED SortDirection = 0
	SortDirection_SORT_DIRECTION_ASCENDING   SortDirection = 1
	SortDirection_SORT_DIRECTION_DESCENDING  SortDirection = 2
)

func (SortDirection) Descriptor added in v3.38.0

func (SortDirection) Enum added in v3.38.0

func (x SortDirection) Enum() *SortDirection

func (SortDirection) EnumDescriptor deprecated added in v3.38.0

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

Deprecated: Use SortDirection.Descriptor instead.

func (SortDirection) Number added in v3.38.0

func (SortDirection) String added in v3.38.0

func (x SortDirection) String() string

func (SortDirection) Type added in v3.38.0

type SubscribeGroupMessagesRequest added in v3.38.0

type SubscribeGroupMessagesRequest struct {
	Filters []*SubscribeGroupMessagesRequest_Filter `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Request for subscribing to group messages

func (*SubscribeGroupMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SubscribeGroupMessagesRequest.ProtoReflect.Descriptor instead.

func (*SubscribeGroupMessagesRequest) GetFilters added in v3.38.0

func (*SubscribeGroupMessagesRequest) ProtoMessage added in v3.38.0

func (*SubscribeGroupMessagesRequest) ProtoMessage()

func (*SubscribeGroupMessagesRequest) ProtoReflect added in v3.38.0

func (*SubscribeGroupMessagesRequest) Reset added in v3.38.0

func (x *SubscribeGroupMessagesRequest) Reset()

func (*SubscribeGroupMessagesRequest) String added in v3.38.0

type SubscribeGroupMessagesRequest_Filter added in v3.38.0

type SubscribeGroupMessagesRequest_Filter struct {
	GroupId  []byte `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	IdCursor uint64 `protobuf:"varint,2,opt,name=id_cursor,json=idCursor,proto3" json:"id_cursor,omitempty"`
	// contains filtered or unexported fields
}

Subscription filter

func (*SubscribeGroupMessagesRequest_Filter) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SubscribeGroupMessagesRequest_Filter.ProtoReflect.Descriptor instead.

func (*SubscribeGroupMessagesRequest_Filter) GetGroupId added in v3.38.0

func (x *SubscribeGroupMessagesRequest_Filter) GetGroupId() []byte

func (*SubscribeGroupMessagesRequest_Filter) GetIdCursor added in v3.38.0

func (*SubscribeGroupMessagesRequest_Filter) ProtoMessage added in v3.38.0

func (*SubscribeGroupMessagesRequest_Filter) ProtoMessage()

func (*SubscribeGroupMessagesRequest_Filter) ProtoReflect added in v3.38.0

func (*SubscribeGroupMessagesRequest_Filter) Reset added in v3.38.0

func (*SubscribeGroupMessagesRequest_Filter) String added in v3.38.0

type SubscribeWelcomeMessagesRequest added in v3.38.0

type SubscribeWelcomeMessagesRequest struct {
	Filters []*SubscribeWelcomeMessagesRequest_Filter `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Request for subscribing to welcome messages

func (*SubscribeWelcomeMessagesRequest) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SubscribeWelcomeMessagesRequest.ProtoReflect.Descriptor instead.

func (*SubscribeWelcomeMessagesRequest) GetFilters added in v3.38.0

func (*SubscribeWelcomeMessagesRequest) ProtoMessage added in v3.38.0

func (*SubscribeWelcomeMessagesRequest) ProtoMessage()

func (*SubscribeWelcomeMessagesRequest) ProtoReflect added in v3.38.0

func (*SubscribeWelcomeMessagesRequest) Reset added in v3.38.0

func (*SubscribeWelcomeMessagesRequest) String added in v3.38.0

type SubscribeWelcomeMessagesRequest_Filter added in v3.38.0

type SubscribeWelcomeMessagesRequest_Filter struct {
	InstallationKey []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	IdCursor        uint64 `protobuf:"varint,2,opt,name=id_cursor,json=idCursor,proto3" json:"id_cursor,omitempty"`
	// contains filtered or unexported fields
}

Subscription filter

func (*SubscribeWelcomeMessagesRequest_Filter) Descriptor deprecated added in v3.38.0

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

Deprecated: Use SubscribeWelcomeMessagesRequest_Filter.ProtoReflect.Descriptor instead.

func (*SubscribeWelcomeMessagesRequest_Filter) GetIdCursor added in v3.38.0

func (*SubscribeWelcomeMessagesRequest_Filter) GetInstallationKey added in v3.38.0

func (x *SubscribeWelcomeMessagesRequest_Filter) GetInstallationKey() []byte

func (*SubscribeWelcomeMessagesRequest_Filter) ProtoMessage added in v3.38.0

func (*SubscribeWelcomeMessagesRequest_Filter) ProtoReflect added in v3.38.0

func (*SubscribeWelcomeMessagesRequest_Filter) Reset added in v3.38.0

func (*SubscribeWelcomeMessagesRequest_Filter) String added in v3.38.0

type UnimplementedMlsApiServer

type UnimplementedMlsApiServer struct {
}

UnimplementedMlsApiServer must be embedded to have forward compatible implementations.

func (UnimplementedMlsApiServer) FetchKeyPackages

func (UnimplementedMlsApiServer) QueryGroupMessages added in v3.38.0

func (UnimplementedMlsApiServer) QueryWelcomeMessages added in v3.38.0

func (UnimplementedMlsApiServer) RevokeInstallation

func (UnimplementedMlsApiServer) SendGroupMessages added in v3.38.0

func (UnimplementedMlsApiServer) SendWelcomeMessages added in v3.38.0

func (UnimplementedMlsApiServer) SubscribeGroupMessages added in v3.38.0

func (UnimplementedMlsApiServer) SubscribeWelcomeMessages added in v3.38.0

func (UnimplementedMlsApiServer) UploadKeyPackage

type UnsafeMlsApiServer

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

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

type UploadKeyPackageRequest

type UploadKeyPackageRequest struct {

	// An individual key package upload request
	KeyPackage *KeyPackageUpload `protobuf:"bytes,1,opt,name=key_package,json=keyPackage,proto3" json:"key_package,omitempty"`
	// contains filtered or unexported fields
}

Upload a new key packages

func (*UploadKeyPackageRequest) Descriptor deprecated

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

Deprecated: Use UploadKeyPackageRequest.ProtoReflect.Descriptor instead.

func (*UploadKeyPackageRequest) GetKeyPackage

func (x *UploadKeyPackageRequest) GetKeyPackage() *KeyPackageUpload

func (*UploadKeyPackageRequest) ProtoMessage

func (*UploadKeyPackageRequest) ProtoMessage()

func (*UploadKeyPackageRequest) ProtoReflect

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

func (*UploadKeyPackageRequest) Reset

func (x *UploadKeyPackageRequest) Reset()

func (*UploadKeyPackageRequest) String

func (x *UploadKeyPackageRequest) String() string

type WelcomeMessage added in v3.38.0

type WelcomeMessage struct {

	// Types that are assignable to Version:
	//
	//	*WelcomeMessage_V1_
	Version isWelcomeMessage_Version `protobuf_oneof:"version"`
	// contains filtered or unexported fields
}

Full representation of a welcome message

func (*WelcomeMessage) Descriptor deprecated added in v3.38.0

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

Deprecated: Use WelcomeMessage.ProtoReflect.Descriptor instead.

func (*WelcomeMessage) GetV1 added in v3.38.0

func (x *WelcomeMessage) GetV1() *WelcomeMessage_V1

func (*WelcomeMessage) GetVersion added in v3.38.0

func (m *WelcomeMessage) GetVersion() isWelcomeMessage_Version

func (*WelcomeMessage) ProtoMessage added in v3.38.0

func (*WelcomeMessage) ProtoMessage()

func (*WelcomeMessage) ProtoReflect added in v3.38.0

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

func (*WelcomeMessage) Reset added in v3.38.0

func (x *WelcomeMessage) Reset()

func (*WelcomeMessage) String added in v3.38.0

func (x *WelcomeMessage) String() string

type WelcomeMessageInput added in v3.38.0

type WelcomeMessageInput struct {

	// Types that are assignable to Version:
	//
	//	*WelcomeMessageInput_V1_
	Version isWelcomeMessageInput_Version `protobuf_oneof:"version"`
	// contains filtered or unexported fields
}

Input type for a welcome message

func (*WelcomeMessageInput) Descriptor deprecated added in v3.38.0

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

Deprecated: Use WelcomeMessageInput.ProtoReflect.Descriptor instead.

func (*WelcomeMessageInput) GetV1 added in v3.38.0

func (*WelcomeMessageInput) GetVersion added in v3.38.0

func (m *WelcomeMessageInput) GetVersion() isWelcomeMessageInput_Version

func (*WelcomeMessageInput) ProtoMessage added in v3.38.0

func (*WelcomeMessageInput) ProtoMessage()

func (*WelcomeMessageInput) ProtoReflect added in v3.38.0

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

func (*WelcomeMessageInput) Reset added in v3.38.0

func (x *WelcomeMessageInput) Reset()

func (*WelcomeMessageInput) String added in v3.38.0

func (x *WelcomeMessageInput) String() string

type WelcomeMessageInput_V1 added in v3.38.0

type WelcomeMessageInput_V1 struct {
	InstallationKey []byte `protobuf:"bytes,1,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	Data            []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	HpkePublicKey   []byte `protobuf:"bytes,3,opt,name=hpke_public_key,json=hpkePublicKey,proto3" json:"hpke_public_key,omitempty"`
	// contains filtered or unexported fields
}

Version 1 of the WelcomeMessageInput format

func (*WelcomeMessageInput_V1) Descriptor deprecated added in v3.38.0

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

Deprecated: Use WelcomeMessageInput_V1.ProtoReflect.Descriptor instead.

func (*WelcomeMessageInput_V1) GetData added in v3.38.0

func (x *WelcomeMessageInput_V1) GetData() []byte

func (*WelcomeMessageInput_V1) GetHpkePublicKey added in v3.39.0

func (x *WelcomeMessageInput_V1) GetHpkePublicKey() []byte

func (*WelcomeMessageInput_V1) GetInstallationKey added in v3.38.0

func (x *WelcomeMessageInput_V1) GetInstallationKey() []byte

func (*WelcomeMessageInput_V1) ProtoMessage added in v3.38.0

func (*WelcomeMessageInput_V1) ProtoMessage()

func (*WelcomeMessageInput_V1) ProtoReflect added in v3.38.0

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

func (*WelcomeMessageInput_V1) Reset added in v3.38.0

func (x *WelcomeMessageInput_V1) Reset()

func (*WelcomeMessageInput_V1) String added in v3.38.0

func (x *WelcomeMessageInput_V1) String() string

type WelcomeMessageInput_V1_ added in v3.38.0

type WelcomeMessageInput_V1_ struct {
	V1 *WelcomeMessageInput_V1 `protobuf:"bytes,1,opt,name=v1,proto3,oneof"`
}

type WelcomeMessage_V1 added in v3.38.0

type WelcomeMessage_V1 struct {
	Id              uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	CreatedNs       uint64 `protobuf:"varint,2,opt,name=created_ns,json=createdNs,proto3" json:"created_ns,omitempty"`
	InstallationKey []byte `protobuf:"bytes,3,opt,name=installation_key,json=installationKey,proto3" json:"installation_key,omitempty"`
	Data            []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	HpkePublicKey   []byte `protobuf:"bytes,5,opt,name=hpke_public_key,json=hpkePublicKey,proto3" json:"hpke_public_key,omitempty"`
	// contains filtered or unexported fields
}

Version 1 of the WelcomeMessage format

func (*WelcomeMessage_V1) Descriptor deprecated added in v3.38.0

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

Deprecated: Use WelcomeMessage_V1.ProtoReflect.Descriptor instead.

func (*WelcomeMessage_V1) GetCreatedNs added in v3.38.0

func (x *WelcomeMessage_V1) GetCreatedNs() uint64

func (*WelcomeMessage_V1) GetData added in v3.38.0

func (x *WelcomeMessage_V1) GetData() []byte

func (*WelcomeMessage_V1) GetHpkePublicKey added in v3.39.0

func (x *WelcomeMessage_V1) GetHpkePublicKey() []byte

func (*WelcomeMessage_V1) GetId added in v3.38.0

func (x *WelcomeMessage_V1) GetId() uint64

func (*WelcomeMessage_V1) GetInstallationKey added in v3.38.0

func (x *WelcomeMessage_V1) GetInstallationKey() []byte

func (*WelcomeMessage_V1) ProtoMessage added in v3.38.0

func (*WelcomeMessage_V1) ProtoMessage()

func (*WelcomeMessage_V1) ProtoReflect added in v3.38.0

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

func (*WelcomeMessage_V1) Reset added in v3.38.0

func (x *WelcomeMessage_V1) Reset()

func (*WelcomeMessage_V1) String added in v3.38.0

func (x *WelcomeMessage_V1) String() string

type WelcomeMessage_V1_ added in v3.38.0

type WelcomeMessage_V1_ struct {
	V1 *WelcomeMessage_V1 `protobuf:"bytes,1,opt,name=v1,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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