v2

package
v0.20.0 Latest Latest
Warning

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

Go to latest
Published: Feb 24, 2024 License: MIT Imports: 48 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DefaultPageSize  = 10
	MaxContentLength = 8 * 1024
	ChunkSize        = 64 * 1024 // 64 KiB
)
View Source
const (
	WorkspaceSettingNamePrefix = "settings/"
	UserNamePrefix             = "users/"
	InboxNamePrefix            = "inboxes/"
)

Variables

View Source
var ListMemosFilterCELAttributes = []cel.EnvOption{
	cel.Variable("content_search", cel.ListType(cel.StringType)),
	cel.Variable("visibilities", cel.ListType(cel.StringType)),
	cel.Variable("order_by_pinned", cel.BoolType),
	cel.Variable("display_time_before", cel.IntType),
	cel.Variable("display_time_after", cel.IntType),
	cel.Variable("creator", cel.StringType),
	cel.Variable("row_status", cel.StringType),
}

ListMemosFilterCELAttributes are the CEL attributes for ListMemosFilter.

Functions

func ExtractInboxIDFromName added in v0.17.1

func ExtractInboxIDFromName(name string) (int32, error)

ExtractInboxIDFromName returns the inbox ID from a resource name.

func ExtractUsernameFromName added in v0.17.1

func ExtractUsernameFromName(name string) (string, error)

ExtractUsernameFromName returns the username from a resource name.

func ExtractWorkspaceSettingKeyFromName added in v0.20.0

func ExtractWorkspaceSettingKeyFromName(name string) (string, error)

func GetNameParentTokens added in v0.17.0

func GetNameParentTokens(name string, tokenPrefixes ...string) ([]string, error)

GetNameParentTokens returns the tokens from a resource name.

Types

type APIV2Service

func NewAPIV2Service

func NewAPIV2Service(secret string, profile *profile.Profile, store *store.Store, grpcServerPort int) *APIV2Service

func (*APIV2Service) BatchUpsertTag added in v0.19.1

func (*APIV2Service) CreateMemo added in v0.17.0

func (*APIV2Service) CreateMemoComment added in v0.17.0

func (*APIV2Service) CreateResource added in v0.18.2

func (*APIV2Service) CreateUser added in v0.17.0

func (*APIV2Service) CreateUserAccessToken added in v0.17.0

func (*APIV2Service) CreateWebhook added in v0.18.0

func (*APIV2Service) DeleteInbox added in v0.17.0

func (*APIV2Service) DeleteMemo added in v0.18.2

func (*APIV2Service) DeleteMemoReaction added in v0.20.0

func (*APIV2Service) DeleteResource added in v0.17.0

func (*APIV2Service) DeleteTag added in v0.17.0

func (*APIV2Service) DeleteUser added in v0.18.0

func (*APIV2Service) DeleteUserAccessToken added in v0.17.0

func (*APIV2Service) DeleteWebhook added in v0.18.0

func (*APIV2Service) DispatchMemoCreatedWebhook added in v0.18.2

func (s *APIV2Service) DispatchMemoCreatedWebhook(ctx context.Context, memo *apiv2pb.Memo) error

DispatchMemoCreatedWebhook dispatches webhook when memo is created.

func (*APIV2Service) DispatchMemoDeletedWebhook added in v0.19.0

func (s *APIV2Service) DispatchMemoDeletedWebhook(ctx context.Context, memo *apiv2pb.Memo) error

DispatchMemoDeletedWebhook dispatches webhook when memo is deleted.

func (*APIV2Service) DispatchMemoUpdatedWebhook added in v0.18.2

func (s *APIV2Service) DispatchMemoUpdatedWebhook(ctx context.Context, memo *apiv2pb.Memo) error

DispatchMemoUpdatedWebhook dispatches webhook when memo is updated.

func (*APIV2Service) ExportMemos added in v0.19.1

func (*APIV2Service) GetActivity added in v0.17.0

func (*APIV2Service) GetAuthStatus added in v0.18.0

func (*APIV2Service) GetGRPCServer

func (s *APIV2Service) GetGRPCServer() *grpc.Server

func (*APIV2Service) GetMemo added in v0.17.0

func (*APIV2Service) GetMemoByName added in v0.19.0

func (*APIV2Service) GetResource added in v0.19.0

func (*APIV2Service) GetResourceByName added in v0.19.0

func (*APIV2Service) GetTagSuggestions added in v0.18.0

func (*APIV2Service) GetUser added in v0.17.0

func (*APIV2Service) GetUserMemosStats added in v0.18.2

func (*APIV2Service) GetUserSetting added in v0.18.0

func (*APIV2Service) GetWebhook added in v0.18.0

func (*APIV2Service) GetWorkspaceProfile added in v0.19.0

func (*APIV2Service) GetWorkspaceSetting added in v0.20.0

func (*APIV2Service) ListInboxes added in v0.17.0

func (*APIV2Service) ListMemoComments added in v0.17.0

func (*APIV2Service) ListMemoReactions added in v0.20.0

func (*APIV2Service) ListMemoRelations added in v0.18.2

func (*APIV2Service) ListMemoResources added in v0.18.2

func (*APIV2Service) ListMemos added in v0.17.0

func (*APIV2Service) ListResources added in v0.17.0

func (*APIV2Service) ListTags added in v0.17.0

func (*APIV2Service) ListUserAccessTokens added in v0.17.0

func (*APIV2Service) ListUsers added in v0.18.2

func (*APIV2Service) ListWebhooks added in v0.18.0

func (*APIV2Service) RegisterGateway

func (s *APIV2Service) RegisterGateway(ctx context.Context, e *echo.Echo) error

RegisterGateway registers the gRPC-Gateway with the given Echo instance.

func (*APIV2Service) RenameTag added in v0.19.0

func (*APIV2Service) SetMemoRelations added in v0.18.2

func (*APIV2Service) SetMemoResources added in v0.18.2

func (*APIV2Service) SetWorkspaceSetting added in v0.20.0

func (*APIV2Service) SignIn added in v0.19.1

func (*APIV2Service) SignInWithSSO added in v0.19.1

func (*APIV2Service) SignOut added in v0.19.1

func (*APIV2Service) SignUp added in v0.19.1

func (*APIV2Service) UpdateInbox added in v0.17.0

func (*APIV2Service) UpdateMemo added in v0.18.2

func (*APIV2Service) UpdateResource added in v0.17.0

func (*APIV2Service) UpdateUser added in v0.17.0

func (*APIV2Service) UpdateUserSetting added in v0.18.0

func (*APIV2Service) UpdateWebhook added in v0.18.0

func (*APIV2Service) UpsertAccessTokenToStore added in v0.17.0

func (s *APIV2Service) UpsertAccessTokenToStore(ctx context.Context, user *store.User, accessToken, description string) error

func (*APIV2Service) UpsertMemoReaction added in v0.20.0

func (*APIV2Service) UpsertTag added in v0.17.0

type ContextKey

type ContextKey int

ContextKey is the key type of context value.

type GRPCAuthInterceptor

type GRPCAuthInterceptor struct {
	Store *store.Store
	// contains filtered or unexported fields
}

GRPCAuthInterceptor is the auth interceptor for gRPC server.

func NewGRPCAuthInterceptor

func NewGRPCAuthInterceptor(store *store.Store, secret string) *GRPCAuthInterceptor

NewGRPCAuthInterceptor returns a new API auth interceptor.

func (*GRPCAuthInterceptor) AuthenticationInterceptor

func (in *GRPCAuthInterceptor) AuthenticationInterceptor(ctx context.Context, request any, serverInfo *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error)

AuthenticationInterceptor is the unary interceptor for gRPC API.

type ListMemosFilter added in v0.15.0

type ListMemosFilter struct {
	ContentSearch     []string
	Visibilities      []store.Visibility
	OrderByPinned     bool
	DisplayTimeBefore *int64
	DisplayTimeAfter  *int64
	Creator           *string
	RowStatus         *store.RowStatus
}

Jump to

Keyboard shortcuts

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