newsroomconnect

package
v1.8.0 Latest Latest
Warning

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

 Go to latest Published: Jun 11, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// NewsroomAPICreateNewsArticleProcedure is the fully-qualified name of the NewsroomAPI's
	// CreateNewsArticle RPC.
	NewsroomAPICreateNewsArticleProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/CreateNewsArticle"
	// NewsroomAPIListNewsArticlesProcedure is the fully-qualified name of the NewsroomAPI's
	// ListNewsArticles RPC.
	NewsroomAPIListNewsArticlesProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/ListNewsArticles"
	// NewsroomAPIGetNewsArticleByIdProcedure is the fully-qualified name of the NewsroomAPI's
	// GetNewsArticleById RPC.
	NewsroomAPIGetNewsArticleByIdProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/GetNewsArticleById"
	// NewsroomAPIUpdateNewsArticleProcedure is the fully-qualified name of the NewsroomAPI's
	// UpdateNewsArticle RPC.
	NewsroomAPIUpdateNewsArticleProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/UpdateNewsArticle"
	// NewsroomAPICreatePublishedArticleProcedure is the fully-qualified name of the NewsroomAPI's
	// CreatePublishedArticle RPC.
	NewsroomAPICreatePublishedArticleProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/CreatePublishedArticle"
	// NewsroomAPIListPublishedArticlesProcedure is the fully-qualified name of the NewsroomAPI's
	// ListPublishedArticles RPC.
	NewsroomAPIListPublishedArticlesProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/ListPublishedArticles"
	// NewsroomAPIGetPublishedArticleByIdProcedure is the fully-qualified name of the NewsroomAPI's
	// GetPublishedArticleById RPC.
	NewsroomAPIGetPublishedArticleByIdProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/GetPublishedArticleById"
	// NewsroomAPIUserActivityProcedure is the fully-qualified name of the NewsroomAPI's UserActivity
	// RPC.
	NewsroomAPIUserActivityProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/UserActivity"
	// NewsroomAPIGetNewsForUserProcedure is the fully-qualified name of the NewsroomAPI's
	// GetNewsForUser RPC.
	NewsroomAPIGetNewsForUserProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/GetNewsForUser"
	// NewsroomAPIStoreNewsArticleImageProcedure is the fully-qualified name of the NewsroomAPI's
	// StoreNewsArticleImage RPC.
	NewsroomAPIStoreNewsArticleImageProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/StoreNewsArticleImage"
	// NewsroomAPIListImagesForNewsArticleProcedure is the fully-qualified name of the NewsroomAPI's
	// ListImagesForNewsArticle RPC.
	NewsroomAPIListImagesForNewsArticleProcedure = "/api.v1alpha1.newsroom.NewsroomAPI/ListImagesForNewsArticle"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source 
const (
	// NewsroomAPIName is the fully-qualified name of the NewsroomAPI service.
	NewsroomAPIName = "api.v1alpha1.newsroom.NewsroomAPI"
)

Variables

This section is empty.

Functions

func NewNewsroomAPIHandler 

func NewNewsroomAPIHandler(svc NewsroomAPIHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewNewsroomAPIHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type NewsroomAPIClient 

type NewsroomAPIClient interface {
	// create news article
	CreateNewsArticle(context.Context, *connect_go.Request[newsroom.CreateNewsArticleRequest]) (*connect_go.Response[newsroom.CreateNewsArticleResponse], error)
	// list news articles
	ListNewsArticles(context.Context, *connect_go.Request[newsroom.ListNewsArticlesRequest]) (*connect_go.Response[newsroom.ListNewsArticlesResponse], error)
	// get news article details by the id
	GetNewsArticleById(context.Context, *connect_go.Request[newsroom.GetNewsArticleByIdRequest]) (*connect_go.Response[newsroom.GetNewsArticleByIdResponse], error)
	// update news article
	UpdateNewsArticle(context.Context, *connect_go.Request[newsroom.UpdateNewsArticleRequest]) (*connect_go.Response[newsroom.UpdateNewsArticleResponse], error)
	// create published article
	CreatePublishedArticle(context.Context, *connect_go.Request[newsroom.CreatePublishedArticleRequest]) (*connect_go.Response[newsroom.CreatePublishedArticleResponse], error)
	// list published articles
	ListPublishedArticles(context.Context, *connect_go.Request[newsroom.ListPublishedArticlesRequest]) (*connect_go.Response[newsroom.ListPublishedArticlesResponse], error)
	// get published article details by the id
	GetPublishedArticleById(context.Context, *connect_go.Request[newsroom.GetPublishedArticleByIdRequest]) (*connect_go.Response[newsroom.GetPublishedArticleByIdResponse], error)
	// user activity updates
	UserActivity(context.Context, *connect_go.Request[newsroom.UserActivityRequest]) (*connect_go.Response[newsroom.UserActivityResponse], error)
	// fetch the unseen articles for the user
	GetNewsForUser(context.Context, *connect_go.Request[newsroom.GetNewsForUserRequest]) (*connect_go.Response[newsroom.GetNewsForUserResponse], error)
	// upload newsroom image for the news article
	StoreNewsArticleImage(context.Context, *connect_go.Request[newsroom.StoreNewsArticleImageRequest]) (*connect_go.Response[newsroom.StoreNewsArticleImageResponse], error)
	// list newsroom images
	ListImagesForNewsArticle(context.Context, *connect_go.Request[newsroom.ListImagesForNewsArticleRequest]) (*connect_go.Response[newsroom.ListImagesForNewsArticleResponse], error)
}

NewsroomAPIClient is a client for the api.v1alpha1.newsroom.NewsroomAPI service.

func NewNewsroomAPIClient 

func NewNewsroomAPIClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) NewsroomAPIClient

NewNewsroomAPIClient constructs a client for the api.v1alpha1.newsroom.NewsroomAPI service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type NewsroomAPIHandler 

type NewsroomAPIHandler interface {
	// create news article
	CreateNewsArticle(context.Context, *connect_go.Request[newsroom.CreateNewsArticleRequest]) (*connect_go.Response[newsroom.CreateNewsArticleResponse], error)
	// list news articles
	ListNewsArticles(context.Context, *connect_go.Request[newsroom.ListNewsArticlesRequest]) (*connect_go.Response[newsroom.ListNewsArticlesResponse], error)
	// get news article details by the id
	GetNewsArticleById(context.Context, *connect_go.Request[newsroom.GetNewsArticleByIdRequest]) (*connect_go.Response[newsroom.GetNewsArticleByIdResponse], error)
	// update news article
	UpdateNewsArticle(context.Context, *connect_go.Request[newsroom.UpdateNewsArticleRequest]) (*connect_go.Response[newsroom.UpdateNewsArticleResponse], error)
	// create published article
	CreatePublishedArticle(context.Context, *connect_go.Request[newsroom.CreatePublishedArticleRequest]) (*connect_go.Response[newsroom.CreatePublishedArticleResponse], error)
	// list published articles
	ListPublishedArticles(context.Context, *connect_go.Request[newsroom.ListPublishedArticlesRequest]) (*connect_go.Response[newsroom.ListPublishedArticlesResponse], error)
	// get published article details by the id
	GetPublishedArticleById(context.Context, *connect_go.Request[newsroom.GetPublishedArticleByIdRequest]) (*connect_go.Response[newsroom.GetPublishedArticleByIdResponse], error)
	// user activity updates
	UserActivity(context.Context, *connect_go.Request[newsroom.UserActivityRequest]) (*connect_go.Response[newsroom.UserActivityResponse], error)
	// fetch the unseen articles for the user
	GetNewsForUser(context.Context, *connect_go.Request[newsroom.GetNewsForUserRequest]) (*connect_go.Response[newsroom.GetNewsForUserResponse], error)
	// upload newsroom image for the news article
	StoreNewsArticleImage(context.Context, *connect_go.Request[newsroom.StoreNewsArticleImageRequest]) (*connect_go.Response[newsroom.StoreNewsArticleImageResponse], error)
	// list newsroom images
	ListImagesForNewsArticle(context.Context, *connect_go.Request[newsroom.ListImagesForNewsArticleRequest]) (*connect_go.Response[newsroom.ListImagesForNewsArticleResponse], error)
}

NewsroomAPIHandler is an implementation of the api.v1alpha1.newsroom.NewsroomAPI service.

type UnimplementedNewsroomAPIHandler 

type UnimplementedNewsroomAPIHandler struct{}

UnimplementedNewsroomAPIHandler returns CodeUnimplemented from all methods.

func (UnimplementedNewsroomAPIHandler) CreateNewsArticle 

func (UnimplementedNewsroomAPIHandler) CreateNewsArticle(context.Context, *connect_go.Request[newsroom.CreateNewsArticleRequest]) (*connect_go.Response[newsroom.CreateNewsArticleResponse], error)

func (UnimplementedNewsroomAPIHandler) CreatePublishedArticle added in v1.7.35 

func (UnimplementedNewsroomAPIHandler) CreatePublishedArticle(context.Context, *connect_go.Request[newsroom.CreatePublishedArticleRequest]) (*connect_go.Response[newsroom.CreatePublishedArticleResponse], error)

func (UnimplementedNewsroomAPIHandler) GetNewsArticleById 

func (UnimplementedNewsroomAPIHandler) GetNewsArticleById(context.Context, *connect_go.Request[newsroom.GetNewsArticleByIdRequest]) (*connect_go.Response[newsroom.GetNewsArticleByIdResponse], error)

func (UnimplementedNewsroomAPIHandler) GetNewsForUser added in v1.7.36 

func (UnimplementedNewsroomAPIHandler) GetNewsForUser(context.Context, *connect_go.Request[newsroom.GetNewsForUserRequest]) (*connect_go.Response[newsroom.GetNewsForUserResponse], error)

func (UnimplementedNewsroomAPIHandler) GetPublishedArticleById added in v1.7.35 

func (UnimplementedNewsroomAPIHandler) GetPublishedArticleById(context.Context, *connect_go.Request[newsroom.GetPublishedArticleByIdRequest]) (*connect_go.Response[newsroom.GetPublishedArticleByIdResponse], error)

func (UnimplementedNewsroomAPIHandler) ListImagesForNewsArticle added in v1.7.38 

func (UnimplementedNewsroomAPIHandler) ListImagesForNewsArticle(context.Context, *connect_go.Request[newsroom.ListImagesForNewsArticleRequest]) (*connect_go.Response[newsroom.ListImagesForNewsArticleResponse], error)

func (UnimplementedNewsroomAPIHandler) ListNewsArticles 

func (UnimplementedNewsroomAPIHandler) ListNewsArticles(context.Context, *connect_go.Request[newsroom.ListNewsArticlesRequest]) (*connect_go.Response[newsroom.ListNewsArticlesResponse], error)

func (UnimplementedNewsroomAPIHandler) ListPublishedArticles added in v1.7.35 

func (UnimplementedNewsroomAPIHandler) ListPublishedArticles(context.Context, *connect_go.Request[newsroom.ListPublishedArticlesRequest]) (*connect_go.Response[newsroom.ListPublishedArticlesResponse], error)

func (UnimplementedNewsroomAPIHandler) StoreNewsArticleImage added in v1.7.38 

func (UnimplementedNewsroomAPIHandler) StoreNewsArticleImage(context.Context, *connect_go.Request[newsroom.StoreNewsArticleImageRequest]) (*connect_go.Response[newsroom.StoreNewsArticleImageResponse], error)

func (UnimplementedNewsroomAPIHandler) UpdateNewsArticle 

func (UnimplementedNewsroomAPIHandler) UpdateNewsArticle(context.Context, *connect_go.Request[newsroom.UpdateNewsArticleRequest]) (*connect_go.Response[newsroom.UpdateNewsArticleResponse], error)

func (UnimplementedNewsroomAPIHandler) UserActivity added in v1.7.36 

func (UnimplementedNewsroomAPIHandler) UserActivity(context.Context, *connect_go.Request[newsroom.UserActivityRequest]) (*connect_go.Response[newsroom.UserActivityResponse], error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.