invitev1beta1

package
v0.0.0-...-3ad35d1 Latest Latest
Warning

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

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 12 Imported by: 18

Documentation

Index

Constants

View Source 
const (
	InviteAPI_GenerateInviteToken_FullMethodName = "/cs3.ocm.invite.v1beta1.InviteAPI/GenerateInviteToken"
	InviteAPI_ListInviteTokens_FullMethodName    = "/cs3.ocm.invite.v1beta1.InviteAPI/ListInviteTokens"
	InviteAPI_ForwardInvite_FullMethodName       = "/cs3.ocm.invite.v1beta1.InviteAPI/ForwardInvite"
	InviteAPI_AcceptInvite_FullMethodName        = "/cs3.ocm.invite.v1beta1.InviteAPI/AcceptInvite"
	InviteAPI_GetAcceptedUser_FullMethodName     = "/cs3.ocm.invite.v1beta1.InviteAPI/GetAcceptedUser"
	InviteAPI_FindAcceptedUsers_FullMethodName   = "/cs3.ocm.invite.v1beta1.InviteAPI/FindAcceptedUsers"
	InviteAPI_DeleteAcceptedUser_FullMethodName  = "/cs3.ocm.invite.v1beta1.InviteAPI/DeleteAcceptedUser"
)

Variables

View Source 
var File_cs3_ocm_invite_v1beta1_invite_api_proto protoreflect.FileDescriptor
View Source 
var File_cs3_ocm_invite_v1beta1_resources_proto protoreflect.FileDescriptor
View Source 
var InviteAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.ocm.invite.v1beta1.InviteAPI",
	HandlerType: (*InviteAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GenerateInviteToken",
			Handler:    _InviteAPI_GenerateInviteToken_Handler,
		},
		{
			MethodName: "ListInviteTokens",
			Handler:    _InviteAPI_ListInviteTokens_Handler,
		},
		{
			MethodName: "ForwardInvite",
			Handler:    _InviteAPI_ForwardInvite_Handler,
		},
		{
			MethodName: "AcceptInvite",
			Handler:    _InviteAPI_AcceptInvite_Handler,
		},
		{
			MethodName: "GetAcceptedUser",
			Handler:    _InviteAPI_GetAcceptedUser_Handler,
		},
		{
			MethodName: "FindAcceptedUsers",
			Handler:    _InviteAPI_FindAcceptedUsers_Handler,
		},
		{
			MethodName: "DeleteAcceptedUser",
			Handler:    _InviteAPI_DeleteAcceptedUser_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/ocm/invite/v1beta1/invite_api.proto",
}

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

Functions

func RegisterInviteAPIServer 

func RegisterInviteAPIServer(s grpc.ServiceRegistrar, srv InviteAPIServer)

Types

type AcceptInviteRequest 

type AcceptInviteRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The token to authenticate with.
	InviteToken *InviteToken `protobuf:"bytes,2,opt,name=invite_token,json=inviteToken,proto3" json:"invite_token,omitempty"`
	// REQUIRED.
	// The user who accepted the invite.
	RemoteUser *v1beta13.User `protobuf:"bytes,3,opt,name=remote_user,json=remoteUser,proto3" json:"remote_user,omitempty"`
	// contains filtered or unexported fields
}

func (*AcceptInviteRequest) Descriptor deprecated 

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

Deprecated: Use AcceptInviteRequest.ProtoReflect.Descriptor instead.

func (*AcceptInviteRequest) GetInviteToken 

func (x *AcceptInviteRequest) GetInviteToken() *InviteToken

func (*AcceptInviteRequest) GetOpaque 

func (x *AcceptInviteRequest) GetOpaque() *v1beta1.Opaque

func (*AcceptInviteRequest) GetRemoteUser 

func (x *AcceptInviteRequest) GetRemoteUser() *v1beta13.User

func (*AcceptInviteRequest) ProtoMessage 

func (*AcceptInviteRequest) ProtoMessage()

func (*AcceptInviteRequest) ProtoReflect 

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

func (*AcceptInviteRequest) Reset 

func (x *AcceptInviteRequest) Reset()

func (*AcceptInviteRequest) String 

func (x *AcceptInviteRequest) String() string

type AcceptInviteResponse 

type AcceptInviteResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The initiator's user id of the workflow.
	UserId *v1beta13.UserId `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// REQUIRED.
	// The initiator's email of the workflow.
	Email string `protobuf:"bytes,4,opt,name=email,proto3" json:"email,omitempty"`
	// REQUIRED.
	// The initiator's display name of the workflow.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

func (*AcceptInviteResponse) Descriptor deprecated 

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

Deprecated: Use AcceptInviteResponse.ProtoReflect.Descriptor instead.

func (*AcceptInviteResponse) GetDisplayName 

func (x *AcceptInviteResponse) GetDisplayName() string

func (*AcceptInviteResponse) GetEmail 

func (x *AcceptInviteResponse) GetEmail() string

func (*AcceptInviteResponse) GetOpaque 

func (x *AcceptInviteResponse) GetOpaque() *v1beta1.Opaque

func (*AcceptInviteResponse) GetStatus 

func (x *AcceptInviteResponse) GetStatus() *v1beta11.Status

func (*AcceptInviteResponse) GetUserId 

func (x *AcceptInviteResponse) GetUserId() *v1beta13.UserId

func (*AcceptInviteResponse) ProtoMessage 

func (*AcceptInviteResponse) ProtoMessage()

func (*AcceptInviteResponse) ProtoReflect 

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

func (*AcceptInviteResponse) Reset 

func (x *AcceptInviteResponse) Reset()

func (*AcceptInviteResponse) String 

func (x *AcceptInviteResponse) String() string

type DeleteAcceptedUserRequest 

type DeleteAcceptedUserRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the user.
	RemoteUserId *v1beta13.UserId `protobuf:"bytes,2,opt,name=remote_user_id,json=remoteUserId,proto3" json:"remote_user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteAcceptedUserRequest) Descriptor deprecated 

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

Deprecated: Use DeleteAcceptedUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteAcceptedUserRequest) GetOpaque 

func (x *DeleteAcceptedUserRequest) GetOpaque() *v1beta1.Opaque

func (*DeleteAcceptedUserRequest) GetRemoteUserId 

func (x *DeleteAcceptedUserRequest) GetRemoteUserId() *v1beta13.UserId

func (*DeleteAcceptedUserRequest) ProtoMessage 

func (*DeleteAcceptedUserRequest) ProtoMessage()

func (*DeleteAcceptedUserRequest) ProtoReflect 

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

func (*DeleteAcceptedUserRequest) Reset 

func (x *DeleteAcceptedUserRequest) Reset()

func (*DeleteAcceptedUserRequest) String 

func (x *DeleteAcceptedUserRequest) String() string

type DeleteAcceptedUserResponse 

type DeleteAcceptedUserResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteAcceptedUserResponse) Descriptor deprecated 

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

Deprecated: Use DeleteAcceptedUserResponse.ProtoReflect.Descriptor instead.

func (*DeleteAcceptedUserResponse) GetOpaque 

func (x *DeleteAcceptedUserResponse) GetOpaque() *v1beta1.Opaque

func (*DeleteAcceptedUserResponse) GetStatus 

func (x *DeleteAcceptedUserResponse) GetStatus() *v1beta11.Status

func (*DeleteAcceptedUserResponse) ProtoMessage 

func (*DeleteAcceptedUserResponse) ProtoMessage()

func (*DeleteAcceptedUserResponse) ProtoReflect 

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

func (*DeleteAcceptedUserResponse) Reset 

func (x *DeleteAcceptedUserResponse) Reset()

func (*DeleteAcceptedUserResponse) String 

func (x *DeleteAcceptedUserResponse) String() string

type FindAcceptedUsersRequest 

type FindAcceptedUsersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The filter to apply.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*FindAcceptedUsersRequest) Descriptor deprecated 

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

Deprecated: Use FindAcceptedUsersRequest.ProtoReflect.Descriptor instead.

func (*FindAcceptedUsersRequest) GetFilter 

func (x *FindAcceptedUsersRequest) GetFilter() string

func (*FindAcceptedUsersRequest) GetOpaque 

func (x *FindAcceptedUsersRequest) GetOpaque() *v1beta1.Opaque

func (*FindAcceptedUsersRequest) ProtoMessage 

func (*FindAcceptedUsersRequest) ProtoMessage()

func (*FindAcceptedUsersRequest) ProtoReflect 

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

func (*FindAcceptedUsersRequest) Reset 

func (x *FindAcceptedUsersRequest) Reset()

func (*FindAcceptedUsersRequest) String 

func (x *FindAcceptedUsersRequest) String() string

type FindAcceptedUsersResponse 

type FindAcceptedUsersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The accepted users matching the specified filter.
	AcceptedUsers []*v1beta13.User `protobuf:"bytes,3,rep,name=accepted_users,json=acceptedUsers,proto3" json:"accepted_users,omitempty"`
	// contains filtered or unexported fields
}

func (*FindAcceptedUsersResponse) Descriptor deprecated 

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

Deprecated: Use FindAcceptedUsersResponse.ProtoReflect.Descriptor instead.

func (*FindAcceptedUsersResponse) GetAcceptedUsers 

func (x *FindAcceptedUsersResponse) GetAcceptedUsers() []*v1beta13.User

func (*FindAcceptedUsersResponse) GetOpaque 

func (x *FindAcceptedUsersResponse) GetOpaque() *v1beta1.Opaque

func (*FindAcceptedUsersResponse) GetStatus 

func (x *FindAcceptedUsersResponse) GetStatus() *v1beta11.Status

func (*FindAcceptedUsersResponse) ProtoMessage 

func (*FindAcceptedUsersResponse) ProtoMessage()

func (*FindAcceptedUsersResponse) ProtoReflect 

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

func (*FindAcceptedUsersResponse) Reset 

func (x *FindAcceptedUsersResponse) Reset()

func (*FindAcceptedUsersResponse) String 

func (x *FindAcceptedUsersResponse) String() string

type ForwardInviteRequest 

type ForwardInviteRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The token to authenticate with.
	InviteToken *InviteToken `protobuf:"bytes,2,opt,name=invite_token,json=inviteToken,proto3" json:"invite_token,omitempty"`
	// REQUIRED.
	// The details of the sync'n'share system provider of the user who sent the invite.
	OriginSystemProvider *v1beta12.ProviderInfo `protobuf:"bytes,3,opt,name=origin_system_provider,json=originSystemProvider,proto3" json:"origin_system_provider,omitempty"`
	// contains filtered or unexported fields
}

func (*ForwardInviteRequest) Descriptor deprecated 

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

Deprecated: Use ForwardInviteRequest.ProtoReflect.Descriptor instead.

func (*ForwardInviteRequest) GetInviteToken 

func (x *ForwardInviteRequest) GetInviteToken() *InviteToken

func (*ForwardInviteRequest) GetOpaque 

func (x *ForwardInviteRequest) GetOpaque() *v1beta1.Opaque

func (*ForwardInviteRequest) GetOriginSystemProvider 

func (x *ForwardInviteRequest) GetOriginSystemProvider() *v1beta12.ProviderInfo

func (*ForwardInviteRequest) ProtoMessage 

func (*ForwardInviteRequest) ProtoMessage()

func (*ForwardInviteRequest) ProtoReflect 

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

func (*ForwardInviteRequest) Reset 

func (x *ForwardInviteRequest) Reset()

func (*ForwardInviteRequest) String 

func (x *ForwardInviteRequest) String() string

type ForwardInviteResponse 

type ForwardInviteResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The initiator's user id of the workflow.
	UserId *v1beta13.UserId `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// REQUIRED.
	// The initiator's email of the workflow.
	Email string `protobuf:"bytes,4,opt,name=email,proto3" json:"email,omitempty"`
	// REQUIRED.
	// The initiator's display name of the workflow.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

func (*ForwardInviteResponse) Descriptor deprecated 

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

Deprecated: Use ForwardInviteResponse.ProtoReflect.Descriptor instead.

func (*ForwardInviteResponse) GetDisplayName 

func (x *ForwardInviteResponse) GetDisplayName() string

func (*ForwardInviteResponse) GetEmail 

func (x *ForwardInviteResponse) GetEmail() string

func (*ForwardInviteResponse) GetOpaque 

func (x *ForwardInviteResponse) GetOpaque() *v1beta1.Opaque

func (*ForwardInviteResponse) GetStatus 

func (x *ForwardInviteResponse) GetStatus() *v1beta11.Status

func (*ForwardInviteResponse) GetUserId 

func (x *ForwardInviteResponse) GetUserId() *v1beta13.UserId

func (*ForwardInviteResponse) ProtoMessage 

func (*ForwardInviteResponse) ProtoMessage()

func (*ForwardInviteResponse) ProtoReflect 

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

func (*ForwardInviteResponse) Reset 

func (x *ForwardInviteResponse) Reset()

func (*ForwardInviteResponse) String 

func (x *ForwardInviteResponse) String() string

type GenerateInviteTokenRequest 

type GenerateInviteTokenRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// OPTIONAL.
	// The description of the token.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateInviteTokenRequest) Descriptor deprecated 

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

Deprecated: Use GenerateInviteTokenRequest.ProtoReflect.Descriptor instead.

func (*GenerateInviteTokenRequest) GetDescription 

func (x *GenerateInviteTokenRequest) GetDescription() string

func (*GenerateInviteTokenRequest) GetOpaque 

func (x *GenerateInviteTokenRequest) GetOpaque() *v1beta1.Opaque

func (*GenerateInviteTokenRequest) ProtoMessage 

func (*GenerateInviteTokenRequest) ProtoMessage()

func (*GenerateInviteTokenRequest) ProtoReflect 

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

func (*GenerateInviteTokenRequest) Reset 

func (x *GenerateInviteTokenRequest) Reset()

func (*GenerateInviteTokenRequest) String 

func (x *GenerateInviteTokenRequest) String() string

type GenerateInviteTokenResponse 

type GenerateInviteTokenResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The generated token.
	InviteToken *InviteToken `protobuf:"bytes,3,opt,name=invite_token,json=inviteToken,proto3" json:"invite_token,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateInviteTokenResponse) Descriptor deprecated 

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

Deprecated: Use GenerateInviteTokenResponse.ProtoReflect.Descriptor instead.

func (*GenerateInviteTokenResponse) GetInviteToken 

func (x *GenerateInviteTokenResponse) GetInviteToken() *InviteToken

func (*GenerateInviteTokenResponse) GetOpaque 

func (x *GenerateInviteTokenResponse) GetOpaque() *v1beta1.Opaque

func (*GenerateInviteTokenResponse) GetStatus 

func (x *GenerateInviteTokenResponse) GetStatus() *v1beta11.Status

func (*GenerateInviteTokenResponse) ProtoMessage 

func (*GenerateInviteTokenResponse) ProtoMessage()

func (*GenerateInviteTokenResponse) ProtoReflect 

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

func (*GenerateInviteTokenResponse) Reset 

func (x *GenerateInviteTokenResponse) Reset()

func (*GenerateInviteTokenResponse) String 

func (x *GenerateInviteTokenResponse) String() string

type GetAcceptedUserRequest 

type GetAcceptedUserRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the user.
	RemoteUserId *v1beta13.UserId `protobuf:"bytes,2,opt,name=remote_user_id,json=remoteUserId,proto3" json:"remote_user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAcceptedUserRequest) Descriptor deprecated 

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

Deprecated: Use GetAcceptedUserRequest.ProtoReflect.Descriptor instead.

func (*GetAcceptedUserRequest) GetOpaque 

func (x *GetAcceptedUserRequest) GetOpaque() *v1beta1.Opaque

func (*GetAcceptedUserRequest) GetRemoteUserId 

func (x *GetAcceptedUserRequest) GetRemoteUserId() *v1beta13.UserId

func (*GetAcceptedUserRequest) ProtoMessage 

func (*GetAcceptedUserRequest) ProtoMessage()

func (*GetAcceptedUserRequest) ProtoReflect 

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

func (*GetAcceptedUserRequest) Reset 

func (x *GetAcceptedUserRequest) Reset()

func (*GetAcceptedUserRequest) String 

func (x *GetAcceptedUserRequest) String() string

type GetAcceptedUserResponse 

type GetAcceptedUserResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The user information.
	RemoteUser *v1beta13.User `protobuf:"bytes,3,opt,name=remote_user,json=remoteUser,proto3" json:"remote_user,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAcceptedUserResponse) Descriptor deprecated 

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

Deprecated: Use GetAcceptedUserResponse.ProtoReflect.Descriptor instead.

func (*GetAcceptedUserResponse) GetOpaque 

func (x *GetAcceptedUserResponse) GetOpaque() *v1beta1.Opaque

func (*GetAcceptedUserResponse) GetRemoteUser 

func (x *GetAcceptedUserResponse) GetRemoteUser() *v1beta13.User

func (*GetAcceptedUserResponse) GetStatus 

func (x *GetAcceptedUserResponse) GetStatus() *v1beta11.Status

func (*GetAcceptedUserResponse) ProtoMessage 

func (*GetAcceptedUserResponse) ProtoMessage()

func (*GetAcceptedUserResponse) ProtoReflect 

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

func (*GetAcceptedUserResponse) Reset 

func (x *GetAcceptedUserResponse) Reset()

func (*GetAcceptedUserResponse) String 

func (x *GetAcceptedUserResponse) String() string

type InviteAPIClient 

type InviteAPIClient interface {
	// Generates a new token for the user with a validity of 24 hours.
	GenerateInviteToken(ctx context.Context, in *GenerateInviteTokenRequest, opts ...grpc.CallOption) (*GenerateInviteTokenResponse, error)
	// Lists the valid tokens generated by the user.
	ListInviteTokens(ctx context.Context, in *ListInviteTokensRequest, opts ...grpc.CallOption) (*ListInviteTokensResponse, error)
	// Forwards a received invite to the remote sync'n'share system provider. The remote
	// system SHALL get an `invite-accepted` call as follows:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1invite-accepted/post
	// MUST return CODE_NOT_FOUND if the token does not exist.
	// MUST return CODE_INVALID_ARGUMENT if the token expired.
	// MUST return CODE_ALREADY_EXISTS if the user already accepted an invite.
	// MUST return CODE_PERMISSION_DENIED if the remote service is not trusted to accept invitations.
	ForwardInvite(ctx context.Context, in *ForwardInviteRequest, opts ...grpc.CallOption) (*ForwardInviteResponse, error)
	// Completes an invitation acceptance.
	// MUST return CODE_NOT_FOUND if the token does not exist.
	// MUST return CODE_INVALID_ARGUMENT if the token expired.
	// MUST return CODE_ALREADY_EXISTS if the user already accepted an invite.
	AcceptInvite(ctx context.Context, in *AcceptInviteRequest, opts ...grpc.CallOption) (*AcceptInviteResponse, error)
	// Retrieves details about a remote user who has accepted an invite to share.
	// MUST return CODE_NOT_FOUND if the user does not exist.
	GetAcceptedUser(ctx context.Context, in *GetAcceptedUserRequest, opts ...grpc.CallOption) (*GetAcceptedUserResponse, error)
	// Finds users who accepted invite tokens by their attributes.
	FindAcceptedUsers(ctx context.Context, in *FindAcceptedUsersRequest, opts ...grpc.CallOption) (*FindAcceptedUsersResponse, error)
	// Delete a previously accepted remote user, that is unfriend that user.
	// MUST return CODE_NOT_FOUND if the user does not exist.
	DeleteAcceptedUser(ctx context.Context, in *DeleteAcceptedUserRequest, opts ...grpc.CallOption) (*DeleteAcceptedUserResponse, error)
}

InviteAPIClient is the client API for InviteAPI 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 NewInviteAPIClient 

func NewInviteAPIClient(cc grpc.ClientConnInterface) InviteAPIClient

type InviteAPIServer 

type InviteAPIServer interface {
	// Generates a new token for the user with a validity of 24 hours.
	GenerateInviteToken(context.Context, *GenerateInviteTokenRequest) (*GenerateInviteTokenResponse, error)
	// Lists the valid tokens generated by the user.
	ListInviteTokens(context.Context, *ListInviteTokensRequest) (*ListInviteTokensResponse, error)
	// Forwards a received invite to the remote sync'n'share system provider. The remote
	// system SHALL get an `invite-accepted` call as follows:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1invite-accepted/post
	// MUST return CODE_NOT_FOUND if the token does not exist.
	// MUST return CODE_INVALID_ARGUMENT if the token expired.
	// MUST return CODE_ALREADY_EXISTS if the user already accepted an invite.
	// MUST return CODE_PERMISSION_DENIED if the remote service is not trusted to accept invitations.
	ForwardInvite(context.Context, *ForwardInviteRequest) (*ForwardInviteResponse, error)
	// Completes an invitation acceptance.
	// MUST return CODE_NOT_FOUND if the token does not exist.
	// MUST return CODE_INVALID_ARGUMENT if the token expired.
	// MUST return CODE_ALREADY_EXISTS if the user already accepted an invite.
	AcceptInvite(context.Context, *AcceptInviteRequest) (*AcceptInviteResponse, error)
	// Retrieves details about a remote user who has accepted an invite to share.
	// MUST return CODE_NOT_FOUND if the user does not exist.
	GetAcceptedUser(context.Context, *GetAcceptedUserRequest) (*GetAcceptedUserResponse, error)
	// Finds users who accepted invite tokens by their attributes.
	FindAcceptedUsers(context.Context, *FindAcceptedUsersRequest) (*FindAcceptedUsersResponse, error)
	// Delete a previously accepted remote user, that is unfriend that user.
	// MUST return CODE_NOT_FOUND if the user does not exist.
	DeleteAcceptedUser(context.Context, *DeleteAcceptedUserRequest) (*DeleteAcceptedUserResponse, error)
}

InviteAPIServer is the server API for InviteAPI service. All implementations should embed UnimplementedInviteAPIServer for forward compatibility

type InviteToken 

type InviteToken struct {

	// REQUIRED.
	// Unique ID associated with an InviteToken.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// REQUIRED.
	// The user who created the token.
	UserId *v1beta1.UserId `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// OPTIONAL.
	// The time when the token will expire.
	Expiration *v1beta11.Timestamp `protobuf:"bytes,3,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// OPTIONAL.
	// User-defined description to be forwarded to the invitees.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

InviteToken is used to invite users and groups from other sync'n'share systems to collaborate on resources.

func (*InviteToken) Descriptor deprecated 

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

Deprecated: Use InviteToken.ProtoReflect.Descriptor instead.

func (*InviteToken) GetDescription 

func (x *InviteToken) GetDescription() string

func (*InviteToken) GetExpiration 

func (x *InviteToken) GetExpiration() *v1beta11.Timestamp

func (*InviteToken) GetToken 

func (x *InviteToken) GetToken() string

func (*InviteToken) GetUserId 

func (x *InviteToken) GetUserId() *v1beta1.UserId

func (*InviteToken) ProtoMessage 

func (*InviteToken) ProtoMessage()

func (*InviteToken) ProtoReflect 

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

func (*InviteToken) Reset 

func (x *InviteToken) Reset()

func (*InviteToken) String 

func (x *InviteToken) String() string

type ListInviteTokensRequest 

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

func (*ListInviteTokensRequest) Descriptor deprecated 

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

Deprecated: Use ListInviteTokensRequest.ProtoReflect.Descriptor instead.

func (*ListInviteTokensRequest) ProtoMessage 

func (*ListInviteTokensRequest) ProtoMessage()

func (*ListInviteTokensRequest) ProtoReflect 

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

func (*ListInviteTokensRequest) Reset 

func (x *ListInviteTokensRequest) Reset()

func (*ListInviteTokensRequest) String 

func (x *ListInviteTokensRequest) String() string

type ListInviteTokensResponse 

type ListInviteTokensResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// The list of valid tokens.
	InviteTokens []*InviteToken `protobuf:"bytes,2,rep,name=invite_tokens,json=inviteTokens,proto3" json:"invite_tokens,omitempty"`
	// contains filtered or unexported fields
}

func (*ListInviteTokensResponse) Descriptor deprecated 

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

Deprecated: Use ListInviteTokensResponse.ProtoReflect.Descriptor instead.

func (*ListInviteTokensResponse) GetInviteTokens 

func (x *ListInviteTokensResponse) GetInviteTokens() []*InviteToken

func (*ListInviteTokensResponse) GetStatus 

func (x *ListInviteTokensResponse) GetStatus() *v1beta11.Status

func (*ListInviteTokensResponse) ProtoMessage 

func (*ListInviteTokensResponse) ProtoMessage()

func (*ListInviteTokensResponse) ProtoReflect 

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

func (*ListInviteTokensResponse) Reset 

func (x *ListInviteTokensResponse) Reset()

func (*ListInviteTokensResponse) String 

func (x *ListInviteTokensResponse) String() string

type UnimplementedInviteAPIServer 

type UnimplementedInviteAPIServer struct {
}

UnimplementedInviteAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedInviteAPIServer) AcceptInvite 

func (UnimplementedInviteAPIServer) AcceptInvite(context.Context, *AcceptInviteRequest) (*AcceptInviteResponse, error)

func (UnimplementedInviteAPIServer) DeleteAcceptedUser 

func (UnimplementedInviteAPIServer) DeleteAcceptedUser(context.Context, *DeleteAcceptedUserRequest) (*DeleteAcceptedUserResponse, error)

func (UnimplementedInviteAPIServer) FindAcceptedUsers 

func (UnimplementedInviteAPIServer) FindAcceptedUsers(context.Context, *FindAcceptedUsersRequest) (*FindAcceptedUsersResponse, error)

func (UnimplementedInviteAPIServer) ForwardInvite 

func (UnimplementedInviteAPIServer) ForwardInvite(context.Context, *ForwardInviteRequest) (*ForwardInviteResponse, error)

func (UnimplementedInviteAPIServer) GenerateInviteToken 

func (UnimplementedInviteAPIServer) GenerateInviteToken(context.Context, *GenerateInviteTokenRequest) (*GenerateInviteTokenResponse, error)

func (UnimplementedInviteAPIServer) GetAcceptedUser 

func (UnimplementedInviteAPIServer) GetAcceptedUser(context.Context, *GetAcceptedUserRequest) (*GetAcceptedUserResponse, error)

func (UnimplementedInviteAPIServer) ListInviteTokens 

func (UnimplementedInviteAPIServer) ListInviteTokens(context.Context, *ListInviteTokensRequest) (*ListInviteTokensResponse, error)

type UnsafeInviteAPIServer 

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

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

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.