newsroom

package
v1.7.75 Latest Latest
Warning

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

Go to latest
Published: May 1, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	NewsroomAPI_CreateNewsArticle_FullMethodName        = "/api.v1alpha1.newsroom.NewsroomAPI/CreateNewsArticle"
	NewsroomAPI_ListNewsArticles_FullMethodName         = "/api.v1alpha1.newsroom.NewsroomAPI/ListNewsArticles"
	NewsroomAPI_GetNewsArticleById_FullMethodName       = "/api.v1alpha1.newsroom.NewsroomAPI/GetNewsArticleById"
	NewsroomAPI_UpdateNewsArticle_FullMethodName        = "/api.v1alpha1.newsroom.NewsroomAPI/UpdateNewsArticle"
	NewsroomAPI_CreatePublishedArticle_FullMethodName   = "/api.v1alpha1.newsroom.NewsroomAPI/CreatePublishedArticle"
	NewsroomAPI_ListPublishedArticles_FullMethodName    = "/api.v1alpha1.newsroom.NewsroomAPI/ListPublishedArticles"
	NewsroomAPI_GetPublishedArticleById_FullMethodName  = "/api.v1alpha1.newsroom.NewsroomAPI/GetPublishedArticleById"
	NewsroomAPI_UserActivity_FullMethodName             = "/api.v1alpha1.newsroom.NewsroomAPI/UserActivity"
	NewsroomAPI_GetNewsForUser_FullMethodName           = "/api.v1alpha1.newsroom.NewsroomAPI/GetNewsForUser"
	NewsroomAPI_StoreNewsArticleImage_FullMethodName    = "/api.v1alpha1.newsroom.NewsroomAPI/StoreNewsArticleImage"
	NewsroomAPI_ListImagesForNewsArticle_FullMethodName = "/api.v1alpha1.newsroom.NewsroomAPI/ListImagesForNewsArticle"
)

Variables

View Source
var File_api_v1alpha1_newsroom_entities_proto protoreflect.FileDescriptor
View Source
var File_api_v1alpha1_newsroom_service_proto protoreflect.FileDescriptor
View Source
var NewsroomAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1alpha1.newsroom.NewsroomAPI",
	HandlerType: (*NewsroomAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateNewsArticle",
			Handler:    _NewsroomAPI_CreateNewsArticle_Handler,
		},
		{
			MethodName: "ListNewsArticles",
			Handler:    _NewsroomAPI_ListNewsArticles_Handler,
		},
		{
			MethodName: "GetNewsArticleById",
			Handler:    _NewsroomAPI_GetNewsArticleById_Handler,
		},
		{
			MethodName: "UpdateNewsArticle",
			Handler:    _NewsroomAPI_UpdateNewsArticle_Handler,
		},
		{
			MethodName: "CreatePublishedArticle",
			Handler:    _NewsroomAPI_CreatePublishedArticle_Handler,
		},
		{
			MethodName: "ListPublishedArticles",
			Handler:    _NewsroomAPI_ListPublishedArticles_Handler,
		},
		{
			MethodName: "GetPublishedArticleById",
			Handler:    _NewsroomAPI_GetPublishedArticleById_Handler,
		},
		{
			MethodName: "UserActivity",
			Handler:    _NewsroomAPI_UserActivity_Handler,
		},
		{
			MethodName: "GetNewsForUser",
			Handler:    _NewsroomAPI_GetNewsForUser_Handler,
		},
		{
			MethodName: "StoreNewsArticleImage",
			Handler:    _NewsroomAPI_StoreNewsArticleImage_Handler,
		},
		{
			MethodName: "ListImagesForNewsArticle",
			Handler:    _NewsroomAPI_ListImagesForNewsArticle_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/v1alpha1/newsroom/service.proto",
}

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

Functions

func RegisterNewsroomAPIServer

func RegisterNewsroomAPIServer(s grpc.ServiceRegistrar, srv NewsroomAPIServer)

Types

type CreateNewsArticleRequest

type CreateNewsArticleRequest struct {

	// news article title
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// markdown content
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// article author
	Author string `protobuf:"bytes,3,opt,name=author,proto3" json:"author,omitempty"`
	// image reference id
	ImageReferenceId string `protobuf:"bytes,4,opt,name=image_reference_id,json=imageReferenceId,proto3" json:"image_reference_id,omitempty"`
	// contains filtered or unexported fields
}

Request to create news article

func (*CreateNewsArticleRequest) Descriptor deprecated

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

Deprecated: Use CreateNewsArticleRequest.ProtoReflect.Descriptor instead.

func (*CreateNewsArticleRequest) GetAuthor added in v1.7.39

func (x *CreateNewsArticleRequest) GetAuthor() string

func (*CreateNewsArticleRequest) GetContent

func (x *CreateNewsArticleRequest) GetContent() string

func (*CreateNewsArticleRequest) GetImageReferenceId added in v1.7.39

func (x *CreateNewsArticleRequest) GetImageReferenceId() string

func (*CreateNewsArticleRequest) GetTitle

func (x *CreateNewsArticleRequest) GetTitle() string

func (*CreateNewsArticleRequest) ProtoMessage

func (*CreateNewsArticleRequest) ProtoMessage()

func (*CreateNewsArticleRequest) ProtoReflect

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

func (*CreateNewsArticleRequest) Reset

func (x *CreateNewsArticleRequest) Reset()

func (*CreateNewsArticleRequest) String

func (x *CreateNewsArticleRequest) String() string

type CreateNewsArticleResponse

type CreateNewsArticleResponse struct {

	// news article details
	ArticleDetails *NewsArticleDetails `protobuf:"bytes,1,opt,name=article_details,json=articleDetails,proto3" json:"article_details,omitempty"`
	// contains filtered or unexported fields
}

Response to create news article

func (*CreateNewsArticleResponse) Descriptor deprecated

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

Deprecated: Use CreateNewsArticleResponse.ProtoReflect.Descriptor instead.

func (*CreateNewsArticleResponse) GetArticleDetails

func (x *CreateNewsArticleResponse) GetArticleDetails() *NewsArticleDetails

func (*CreateNewsArticleResponse) ProtoMessage

func (*CreateNewsArticleResponse) ProtoMessage()

func (*CreateNewsArticleResponse) ProtoReflect

func (*CreateNewsArticleResponse) Reset

func (x *CreateNewsArticleResponse) Reset()

func (*CreateNewsArticleResponse) String

func (x *CreateNewsArticleResponse) String() string

type CreatePublishedArticleRequest added in v1.7.35

type CreatePublishedArticleRequest struct {

	// news article identifier
	NewArticleSid int64 `protobuf:"varint,1,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// determines if we show to user
	DisplayToUser bool `protobuf:"varint,2,opt,name=display_to_user,json=displayToUser,proto3" json:"display_to_user,omitempty"`
	// link to the published article
	ArticleLink string `protobuf:"bytes,3,opt,name=article_link,json=articleLink,proto3" json:"article_link,omitempty"`
	// contains filtered or unexported fields
}

Request to create published article

func (*CreatePublishedArticleRequest) Descriptor deprecated added in v1.7.35

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

Deprecated: Use CreatePublishedArticleRequest.ProtoReflect.Descriptor instead.

func (x *CreatePublishedArticleRequest) GetArticleLink() string

func (*CreatePublishedArticleRequest) GetDisplayToUser added in v1.7.35

func (x *CreatePublishedArticleRequest) GetDisplayToUser() bool

func (*CreatePublishedArticleRequest) GetNewArticleSid added in v1.7.35

func (x *CreatePublishedArticleRequest) GetNewArticleSid() int64

func (*CreatePublishedArticleRequest) ProtoMessage added in v1.7.35

func (*CreatePublishedArticleRequest) ProtoMessage()

func (*CreatePublishedArticleRequest) ProtoReflect added in v1.7.35

func (*CreatePublishedArticleRequest) Reset added in v1.7.35

func (x *CreatePublishedArticleRequest) Reset()

func (*CreatePublishedArticleRequest) String added in v1.7.35

type CreatePublishedArticleResponse added in v1.7.35

type CreatePublishedArticleResponse struct {

	// news article details
	PublishedArticleDetails *PublishedArticleDetails `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to create published article

func (*CreatePublishedArticleResponse) Descriptor deprecated added in v1.7.35

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

Deprecated: Use CreatePublishedArticleResponse.ProtoReflect.Descriptor instead.

func (*CreatePublishedArticleResponse) GetPublishedArticleDetails added in v1.7.35

func (x *CreatePublishedArticleResponse) GetPublishedArticleDetails() *PublishedArticleDetails

func (*CreatePublishedArticleResponse) ProtoMessage added in v1.7.35

func (*CreatePublishedArticleResponse) ProtoMessage()

func (*CreatePublishedArticleResponse) ProtoReflect added in v1.7.35

func (*CreatePublishedArticleResponse) Reset added in v1.7.35

func (x *CreatePublishedArticleResponse) Reset()

func (*CreatePublishedArticleResponse) String added in v1.7.35

type GetNewsArticleByIdRequest

type GetNewsArticleByIdRequest struct {

	// the unique news article identifier
	NewArticleSid int64 `protobuf:"varint,1,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// contains filtered or unexported fields
}

Request to get news article by id

func (*GetNewsArticleByIdRequest) Descriptor deprecated

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

Deprecated: Use GetNewsArticleByIdRequest.ProtoReflect.Descriptor instead.

func (*GetNewsArticleByIdRequest) GetNewArticleSid

func (x *GetNewsArticleByIdRequest) GetNewArticleSid() int64

func (*GetNewsArticleByIdRequest) ProtoMessage

func (*GetNewsArticleByIdRequest) ProtoMessage()

func (*GetNewsArticleByIdRequest) ProtoReflect

func (*GetNewsArticleByIdRequest) Reset

func (x *GetNewsArticleByIdRequest) Reset()

func (*GetNewsArticleByIdRequest) String

func (x *GetNewsArticleByIdRequest) String() string

type GetNewsArticleByIdResponse

type GetNewsArticleByIdResponse struct {

	// news article details
	ArticleDetails *NewsArticleDetails `protobuf:"bytes,1,opt,name=article_details,json=articleDetails,proto3" json:"article_details,omitempty"`
	// contains filtered or unexported fields
}

Response to get news article

func (*GetNewsArticleByIdResponse) Descriptor deprecated

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

Deprecated: Use GetNewsArticleByIdResponse.ProtoReflect.Descriptor instead.

func (*GetNewsArticleByIdResponse) GetArticleDetails

func (x *GetNewsArticleByIdResponse) GetArticleDetails() *NewsArticleDetails

func (*GetNewsArticleByIdResponse) ProtoMessage

func (*GetNewsArticleByIdResponse) ProtoMessage()

func (*GetNewsArticleByIdResponse) ProtoReflect

func (*GetNewsArticleByIdResponse) Reset

func (x *GetNewsArticleByIdResponse) Reset()

func (*GetNewsArticleByIdResponse) String

func (x *GetNewsArticleByIdResponse) String() string

type GetNewsForUserRequest added in v1.7.36

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

Request to get unseen news articles for the user

func (*GetNewsForUserRequest) Descriptor deprecated added in v1.7.36

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

Deprecated: Use GetNewsForUserRequest.ProtoReflect.Descriptor instead.

func (*GetNewsForUserRequest) ProtoMessage added in v1.7.36

func (*GetNewsForUserRequest) ProtoMessage()

func (*GetNewsForUserRequest) ProtoReflect added in v1.7.36

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

func (*GetNewsForUserRequest) Reset added in v1.7.36

func (x *GetNewsForUserRequest) Reset()

func (*GetNewsForUserRequest) String added in v1.7.36

func (x *GetNewsForUserRequest) String() string

type GetNewsForUserResponse added in v1.7.36

type GetNewsForUserResponse struct {

	// published article details
	PublishedArticleDetails []*PublishedArticleDetails `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to unseen news articles for the user

func (*GetNewsForUserResponse) Descriptor deprecated added in v1.7.36

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

Deprecated: Use GetNewsForUserResponse.ProtoReflect.Descriptor instead.

func (*GetNewsForUserResponse) GetPublishedArticleDetails added in v1.7.36

func (x *GetNewsForUserResponse) GetPublishedArticleDetails() []*PublishedArticleDetails

func (*GetNewsForUserResponse) ProtoMessage added in v1.7.36

func (*GetNewsForUserResponse) ProtoMessage()

func (*GetNewsForUserResponse) ProtoReflect added in v1.7.36

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

func (*GetNewsForUserResponse) Reset added in v1.7.36

func (x *GetNewsForUserResponse) Reset()

func (*GetNewsForUserResponse) String added in v1.7.36

func (x *GetNewsForUserResponse) String() string

type GetPublishedArticleByIdRequest added in v1.7.35

type GetPublishedArticleByIdRequest struct {

	// deprecated
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/newsroom/entities.proto.
	NewArticleSid int64 `protobuf:"varint,1,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// the unique published article sid
	PublishedArticleSid int64 `protobuf:"varint,2,opt,name=published_article_sid,json=publishedArticleSid,proto3" json:"published_article_sid,omitempty"`
	// contains filtered or unexported fields
}

Request to get published article by id

func (*GetPublishedArticleByIdRequest) Descriptor deprecated added in v1.7.35

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

Deprecated: Use GetPublishedArticleByIdRequest.ProtoReflect.Descriptor instead.

func (*GetPublishedArticleByIdRequest) GetNewArticleSid deprecated added in v1.7.35

func (x *GetPublishedArticleByIdRequest) GetNewArticleSid() int64

Deprecated: Marked as deprecated in api/v1alpha1/newsroom/entities.proto.

func (*GetPublishedArticleByIdRequest) GetPublishedArticleSid added in v1.7.36

func (x *GetPublishedArticleByIdRequest) GetPublishedArticleSid() int64

func (*GetPublishedArticleByIdRequest) ProtoMessage added in v1.7.35

func (*GetPublishedArticleByIdRequest) ProtoMessage()

func (*GetPublishedArticleByIdRequest) ProtoReflect added in v1.7.35

func (*GetPublishedArticleByIdRequest) Reset added in v1.7.35

func (x *GetPublishedArticleByIdRequest) Reset()

func (*GetPublishedArticleByIdRequest) String added in v1.7.35

type GetPublishedArticleByIdResponse added in v1.7.35

type GetPublishedArticleByIdResponse struct {

	// published article details
	PublishedArticleDetails *PublishedArticleDetails `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to get published article

func (*GetPublishedArticleByIdResponse) Descriptor deprecated added in v1.7.35

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

Deprecated: Use GetPublishedArticleByIdResponse.ProtoReflect.Descriptor instead.

func (*GetPublishedArticleByIdResponse) GetPublishedArticleDetails added in v1.7.35

func (x *GetPublishedArticleByIdResponse) GetPublishedArticleDetails() *PublishedArticleDetails

func (*GetPublishedArticleByIdResponse) ProtoMessage added in v1.7.35

func (*GetPublishedArticleByIdResponse) ProtoMessage()

func (*GetPublishedArticleByIdResponse) ProtoReflect added in v1.7.35

func (*GetPublishedArticleByIdResponse) Reset added in v1.7.35

func (*GetPublishedArticleByIdResponse) String added in v1.7.35

type ListImagesForNewsArticleRequest added in v1.7.38

type ListImagesForNewsArticleRequest struct {

	// images for the new article sid
	NewArticleSid int64 `protobuf:"varint,1,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// contains filtered or unexported fields
}

request to list all images news article

func (*ListImagesForNewsArticleRequest) Descriptor deprecated added in v1.7.38

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

Deprecated: Use ListImagesForNewsArticleRequest.ProtoReflect.Descriptor instead.

func (*ListImagesForNewsArticleRequest) GetNewArticleSid added in v1.7.38

func (x *ListImagesForNewsArticleRequest) GetNewArticleSid() int64

func (*ListImagesForNewsArticleRequest) ProtoMessage added in v1.7.38

func (*ListImagesForNewsArticleRequest) ProtoMessage()

func (*ListImagesForNewsArticleRequest) ProtoReflect added in v1.7.38

func (*ListImagesForNewsArticleRequest) Reset added in v1.7.38

func (*ListImagesForNewsArticleRequest) String added in v1.7.38

type ListImagesForNewsArticleResponse added in v1.7.38

type ListImagesForNewsArticleResponse struct {

	// images for the news article
	NewsArticleImages []*NewsArticleImage `protobuf:"bytes,1,rep,name=news_article_images,json=newsArticleImages,proto3" json:"news_article_images,omitempty"`
	// contains filtered or unexported fields
}

response to list all images for the news article

func (*ListImagesForNewsArticleResponse) Descriptor deprecated added in v1.7.38

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

Deprecated: Use ListImagesForNewsArticleResponse.ProtoReflect.Descriptor instead.

func (*ListImagesForNewsArticleResponse) GetNewsArticleImages added in v1.7.38

func (x *ListImagesForNewsArticleResponse) GetNewsArticleImages() []*NewsArticleImage

func (*ListImagesForNewsArticleResponse) ProtoMessage added in v1.7.38

func (*ListImagesForNewsArticleResponse) ProtoMessage()

func (*ListImagesForNewsArticleResponse) ProtoReflect added in v1.7.38

func (*ListImagesForNewsArticleResponse) Reset added in v1.7.38

func (*ListImagesForNewsArticleResponse) String added in v1.7.38

type ListNewsArticlesRequest

type ListNewsArticlesRequest struct {

	// the statuses to select by when listing articles (if empty, selects all)
	Statuses []commons.ArticleStatus `protobuf:"varint,1,rep,packed,name=statuses,proto3,enum=api.commons.ArticleStatus" json:"statuses,omitempty"`
	// list of article details to be Requested
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,100,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to list of news articles

func (*ListNewsArticlesRequest) Descriptor deprecated

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

Deprecated: Use ListNewsArticlesRequest.ProtoReflect.Descriptor instead.

func (*ListNewsArticlesRequest) GetFieldMask

func (x *ListNewsArticlesRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*ListNewsArticlesRequest) GetStatuses

func (x *ListNewsArticlesRequest) GetStatuses() []commons.ArticleStatus

func (*ListNewsArticlesRequest) ProtoMessage

func (*ListNewsArticlesRequest) ProtoMessage()

func (*ListNewsArticlesRequest) ProtoReflect

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

func (*ListNewsArticlesRequest) Reset

func (x *ListNewsArticlesRequest) Reset()

func (*ListNewsArticlesRequest) String

func (x *ListNewsArticlesRequest) String() string

type ListNewsArticlesResponse

type ListNewsArticlesResponse struct {

	// article details
	ArticleDetails []*NewsArticleDetails `protobuf:"bytes,1,rep,name=article_details,json=articleDetails,proto3" json:"article_details,omitempty"`
	// contains filtered or unexported fields
}

Responseponse to list of news articles

func (*ListNewsArticlesResponse) Descriptor deprecated

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

Deprecated: Use ListNewsArticlesResponse.ProtoReflect.Descriptor instead.

func (*ListNewsArticlesResponse) GetArticleDetails

func (x *ListNewsArticlesResponse) GetArticleDetails() []*NewsArticleDetails

func (*ListNewsArticlesResponse) ProtoMessage

func (*ListNewsArticlesResponse) ProtoMessage()

func (*ListNewsArticlesResponse) ProtoReflect

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

func (*ListNewsArticlesResponse) Reset

func (x *ListNewsArticlesResponse) Reset()

func (*ListNewsArticlesResponse) String

func (x *ListNewsArticlesResponse) String() string

type ListPublishedArticlesRequest added in v1.7.35

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

Request to list of published articles

func (*ListPublishedArticlesRequest) Descriptor deprecated added in v1.7.35

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

Deprecated: Use ListPublishedArticlesRequest.ProtoReflect.Descriptor instead.

func (*ListPublishedArticlesRequest) ProtoMessage added in v1.7.35

func (*ListPublishedArticlesRequest) ProtoMessage()

func (*ListPublishedArticlesRequest) ProtoReflect added in v1.7.35

func (*ListPublishedArticlesRequest) Reset added in v1.7.35

func (x *ListPublishedArticlesRequest) Reset()

func (*ListPublishedArticlesRequest) String added in v1.7.35

type ListPublishedArticlesResponse added in v1.7.35

type ListPublishedArticlesResponse struct {

	// published article details
	PublishedArticleDetails []*PublishedArticleDetails `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to list of published articles

func (*ListPublishedArticlesResponse) Descriptor deprecated added in v1.7.35

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

Deprecated: Use ListPublishedArticlesResponse.ProtoReflect.Descriptor instead.

func (*ListPublishedArticlesResponse) GetPublishedArticleDetails added in v1.7.35

func (x *ListPublishedArticlesResponse) GetPublishedArticleDetails() []*PublishedArticleDetails

func (*ListPublishedArticlesResponse) ProtoMessage added in v1.7.35

func (*ListPublishedArticlesResponse) ProtoMessage()

func (*ListPublishedArticlesResponse) ProtoReflect added in v1.7.35

func (*ListPublishedArticlesResponse) Reset added in v1.7.35

func (x *ListPublishedArticlesResponse) Reset()

func (*ListPublishedArticlesResponse) String added in v1.7.35

type NewsArticleDetails

type NewsArticleDetails struct {

	// the unique news article identifier
	NewArticleSid int64 `protobuf:"varint,1,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// news article title
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// markdown content
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// article status
	Status commons.ArticleStatus `protobuf:"varint,4,opt,name=status,proto3,enum=api.commons.ArticleStatus" json:"status,omitempty"`
	// news article creation date
	DateCreated *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=date_created,json=dateCreated,proto3" json:"date_created,omitempty"`
	// news article last updated date
	LastEdited *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=last_edited,json=lastEdited,proto3" json:"last_edited,omitempty"`
	// article author
	Author string `protobuf:"bytes,7,opt,name=author,proto3" json:"author,omitempty"`
	// image reference id
	ImageReferenceId string `protobuf:"bytes,8,opt,name=image_reference_id,json=imageReferenceId,proto3" json:"image_reference_id,omitempty"`
	// contains filtered or unexported fields
}

news article details

func (*NewsArticleDetails) Descriptor deprecated

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

Deprecated: Use NewsArticleDetails.ProtoReflect.Descriptor instead.

func (*NewsArticleDetails) GetAuthor added in v1.7.39

func (x *NewsArticleDetails) GetAuthor() string

func (*NewsArticleDetails) GetContent

func (x *NewsArticleDetails) GetContent() string

func (*NewsArticleDetails) GetDateCreated

func (x *NewsArticleDetails) GetDateCreated() *timestamppb.Timestamp

func (*NewsArticleDetails) GetImageReferenceId added in v1.7.39

func (x *NewsArticleDetails) GetImageReferenceId() string

func (*NewsArticleDetails) GetLastEdited

func (x *NewsArticleDetails) GetLastEdited() *timestamppb.Timestamp

func (*NewsArticleDetails) GetNewArticleSid

func (x *NewsArticleDetails) GetNewArticleSid() int64

func (*NewsArticleDetails) GetStatus

func (x *NewsArticleDetails) GetStatus() commons.ArticleStatus

func (*NewsArticleDetails) GetTitle

func (x *NewsArticleDetails) GetTitle() string

func (*NewsArticleDetails) ProtoMessage

func (*NewsArticleDetails) ProtoMessage()

func (*NewsArticleDetails) ProtoReflect

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

func (*NewsArticleDetails) Reset

func (x *NewsArticleDetails) Reset()

func (*NewsArticleDetails) String

func (x *NewsArticleDetails) String() string

type NewsArticleImage added in v1.7.38

type NewsArticleImage struct {

	// unique name of the image
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// image for the new article
	NewArticleSid int64 `protobuf:"varint,2,opt,name=new_article_sid,json=newArticleSid,proto3" json:"new_article_sid,omitempty"`
	// image content
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// download image url
	DownloadUrl string `protobuf:"bytes,4,opt,name=download_url,json=downloadUrl,proto3" json:"download_url,omitempty"`
	// image reference id
	ImageReferenceId string `protobuf:"bytes,5,opt,name=image_reference_id,json=imageReferenceId,proto3" json:"image_reference_id,omitempty"`
	// image type
	ImageType string `protobuf:"bytes,6,opt,name=image_type,json=imageType,proto3" json:"image_type,omitempty"`
	// contains filtered or unexported fields
}

image for the news article details

func (*NewsArticleImage) Descriptor deprecated added in v1.7.38

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

Deprecated: Use NewsArticleImage.ProtoReflect.Descriptor instead.

func (*NewsArticleImage) GetContent added in v1.7.38

func (x *NewsArticleImage) GetContent() string

func (*NewsArticleImage) GetDownloadUrl added in v1.7.38

func (x *NewsArticleImage) GetDownloadUrl() string

func (*NewsArticleImage) GetImageReferenceId added in v1.7.39

func (x *NewsArticleImage) GetImageReferenceId() string

func (*NewsArticleImage) GetImageType added in v1.7.39

func (x *NewsArticleImage) GetImageType() string

func (*NewsArticleImage) GetNewArticleSid added in v1.7.38

func (x *NewsArticleImage) GetNewArticleSid() int64

func (*NewsArticleImage) GetUuid added in v1.7.38

func (x *NewsArticleImage) GetUuid() string

func (*NewsArticleImage) ProtoMessage added in v1.7.38

func (*NewsArticleImage) ProtoMessage()

func (*NewsArticleImage) ProtoReflect added in v1.7.38

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

func (*NewsArticleImage) Reset added in v1.7.38

func (x *NewsArticleImage) Reset()

func (*NewsArticleImage) String added in v1.7.38

func (x *NewsArticleImage) String() string

type NewsroomAPIClient

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

NewsroomAPIClient is the client API for NewsroomAPI 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.

type NewsroomAPIServer

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

NewsroomAPIServer is the server API for NewsroomAPI service. All implementations must embed UnimplementedNewsroomAPIServer for forward compatibility

type PublishedArticleDetails added in v1.7.35

type PublishedArticleDetails struct {

	// the unique published article identifier
	PublishedArticleSid int64 `protobuf:"varint,1,opt,name=published_article_sid,json=publishedArticleSid,proto3" json:"published_article_sid,omitempty"`
	// news article details
	NewsArticleDetails *NewsArticleDetails `protobuf:"bytes,2,opt,name=news_article_details,json=newsArticleDetails,proto3" json:"news_article_details,omitempty"`
	// news article published date
	DatePublished *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=date_published,json=datePublished,proto3" json:"date_published,omitempty"`
	// this flag determines if we show to user or not
	DisplayToUser bool `protobuf:"varint,4,opt,name=display_to_user,json=displayToUser,proto3" json:"display_to_user,omitempty"`
	// contains filtered or unexported fields
}

published article details

func (*PublishedArticleDetails) Descriptor deprecated added in v1.7.35

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

Deprecated: Use PublishedArticleDetails.ProtoReflect.Descriptor instead.

func (*PublishedArticleDetails) GetDatePublished added in v1.7.35

func (x *PublishedArticleDetails) GetDatePublished() *timestamppb.Timestamp

func (*PublishedArticleDetails) GetDisplayToUser added in v1.7.35

func (x *PublishedArticleDetails) GetDisplayToUser() bool

func (*PublishedArticleDetails) GetNewsArticleDetails added in v1.7.35

func (x *PublishedArticleDetails) GetNewsArticleDetails() *NewsArticleDetails

func (*PublishedArticleDetails) GetPublishedArticleSid added in v1.7.35

func (x *PublishedArticleDetails) GetPublishedArticleSid() int64

func (*PublishedArticleDetails) ProtoMessage added in v1.7.35

func (*PublishedArticleDetails) ProtoMessage()

func (*PublishedArticleDetails) ProtoReflect added in v1.7.35

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

func (*PublishedArticleDetails) Reset added in v1.7.35

func (x *PublishedArticleDetails) Reset()

func (*PublishedArticleDetails) String added in v1.7.35

func (x *PublishedArticleDetails) String() string

type StoreNewsArticleImageRequest added in v1.7.38

type StoreNewsArticleImageRequest struct {

	// NewsArticleImage
	Image *NewsArticleImage `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

request to upload image for the news article

func (*StoreNewsArticleImageRequest) Descriptor deprecated added in v1.7.38

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

Deprecated: Use StoreNewsArticleImageRequest.ProtoReflect.Descriptor instead.

func (*StoreNewsArticleImageRequest) GetImage added in v1.7.38

func (*StoreNewsArticleImageRequest) ProtoMessage added in v1.7.38

func (*StoreNewsArticleImageRequest) ProtoMessage()

func (*StoreNewsArticleImageRequest) ProtoReflect added in v1.7.38

func (*StoreNewsArticleImageRequest) Reset added in v1.7.38

func (x *StoreNewsArticleImageRequest) Reset()

func (*StoreNewsArticleImageRequest) String added in v1.7.38

type StoreNewsArticleImageResponse added in v1.7.38

type StoreNewsArticleImageResponse struct {

	// stored image details
	Image *NewsArticleImage `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

response to uploaded image

func (*StoreNewsArticleImageResponse) Descriptor deprecated added in v1.7.38

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

Deprecated: Use StoreNewsArticleImageResponse.ProtoReflect.Descriptor instead.

func (*StoreNewsArticleImageResponse) GetImage added in v1.7.38

func (*StoreNewsArticleImageResponse) ProtoMessage added in v1.7.38

func (*StoreNewsArticleImageResponse) ProtoMessage()

func (*StoreNewsArticleImageResponse) ProtoReflect added in v1.7.38

func (*StoreNewsArticleImageResponse) Reset added in v1.7.38

func (x *StoreNewsArticleImageResponse) Reset()

func (*StoreNewsArticleImageResponse) String added in v1.7.38

type UnimplementedNewsroomAPIServer

type UnimplementedNewsroomAPIServer struct {
}

UnimplementedNewsroomAPIServer must be embedded to have forward compatible implementations.

func (UnimplementedNewsroomAPIServer) CreateNewsArticle

func (UnimplementedNewsroomAPIServer) CreatePublishedArticle added in v1.7.35

func (UnimplementedNewsroomAPIServer) GetNewsArticleById

func (UnimplementedNewsroomAPIServer) GetNewsForUser added in v1.7.36

func (UnimplementedNewsroomAPIServer) GetPublishedArticleById added in v1.7.35

func (UnimplementedNewsroomAPIServer) ListImagesForNewsArticle added in v1.7.38

func (UnimplementedNewsroomAPIServer) ListNewsArticles

func (UnimplementedNewsroomAPIServer) ListPublishedArticles added in v1.7.35

func (UnimplementedNewsroomAPIServer) StoreNewsArticleImage added in v1.7.38

func (UnimplementedNewsroomAPIServer) UpdateNewsArticle

func (UnimplementedNewsroomAPIServer) UserActivity added in v1.7.36

type UnsafeNewsroomAPIServer

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

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

type UpdateNewsArticleRequest

type UpdateNewsArticleRequest struct {

	// the news article fields specified to be updated
	ArticleDetails *NewsArticleDetails `protobuf:"bytes,1,opt,name=article_details,json=articleDetails,proto3" json:"article_details,omitempty"`
	// list of fields Requested to be updated
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,100,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update news article

func (*UpdateNewsArticleRequest) Descriptor deprecated

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

Deprecated: Use UpdateNewsArticleRequest.ProtoReflect.Descriptor instead.

func (*UpdateNewsArticleRequest) GetArticleDetails

func (x *UpdateNewsArticleRequest) GetArticleDetails() *NewsArticleDetails

func (*UpdateNewsArticleRequest) GetFieldMask

func (x *UpdateNewsArticleRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*UpdateNewsArticleRequest) ProtoMessage

func (*UpdateNewsArticleRequest) ProtoMessage()

func (*UpdateNewsArticleRequest) ProtoReflect

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

func (*UpdateNewsArticleRequest) Reset

func (x *UpdateNewsArticleRequest) Reset()

func (*UpdateNewsArticleRequest) String

func (x *UpdateNewsArticleRequest) String() string

type UpdateNewsArticleResponse

type UpdateNewsArticleResponse struct {

	// updated news article
	ArticleDetails *NewsArticleDetails `protobuf:"bytes,1,opt,name=article_details,json=articleDetails,proto3" json:"article_details,omitempty"`
	// contains filtered or unexported fields
}

Response to update news article

func (*UpdateNewsArticleResponse) Descriptor deprecated

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

Deprecated: Use UpdateNewsArticleResponse.ProtoReflect.Descriptor instead.

func (*UpdateNewsArticleResponse) GetArticleDetails

func (x *UpdateNewsArticleResponse) GetArticleDetails() *NewsArticleDetails

func (*UpdateNewsArticleResponse) ProtoMessage

func (*UpdateNewsArticleResponse) ProtoMessage()

func (*UpdateNewsArticleResponse) ProtoReflect

func (*UpdateNewsArticleResponse) Reset

func (x *UpdateNewsArticleResponse) Reset()

func (*UpdateNewsArticleResponse) String

func (x *UpdateNewsArticleResponse) String() string

type UserActivity added in v1.7.36

type UserActivity struct {

	// the unique user activity log identifier
	UserActivityLogSid int64 `protobuf:"varint,1,opt,name=user_activity_log_sid,json=userActivityLogSid,proto3" json:"user_activity_log_sid,omitempty"`
	// user activity created date
	DateCreated *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=date_created,json=dateCreated,proto3" json:"date_created,omitempty"`
	// user activity details
	UserActivityDetails *UserActivity_UserActivityDetails `protobuf:"bytes,3,opt,name=user_activity_details,json=userActivityDetails,proto3" json:"user_activity_details,omitempty"`
	// contains filtered or unexported fields
}

user activity details

func (*UserActivity) Descriptor deprecated added in v1.7.36

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

Deprecated: Use UserActivity.ProtoReflect.Descriptor instead.

func (*UserActivity) GetDateCreated added in v1.7.36

func (x *UserActivity) GetDateCreated() *timestamppb.Timestamp

func (*UserActivity) GetUserActivityDetails added in v1.7.36

func (x *UserActivity) GetUserActivityDetails() *UserActivity_UserActivityDetails

func (*UserActivity) GetUserActivityLogSid added in v1.7.36

func (x *UserActivity) GetUserActivityLogSid() int64

func (*UserActivity) ProtoMessage added in v1.7.36

func (*UserActivity) ProtoMessage()

func (*UserActivity) ProtoReflect added in v1.7.36

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

func (*UserActivity) Reset added in v1.7.36

func (x *UserActivity) Reset()

func (*UserActivity) String added in v1.7.36

func (x *UserActivity) String() string

type UserActivityRequest added in v1.7.36

type UserActivityRequest struct {

	// the unique published article identifier
	PublishedArticleSid int64 `protobuf:"varint,1,opt,name=published_article_sid,json=publishedArticleSid,proto3" json:"published_article_sid,omitempty"`
	// contains filtered or unexported fields
}

Request to update user activity

func (*UserActivityRequest) Descriptor deprecated added in v1.7.36

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

Deprecated: Use UserActivityRequest.ProtoReflect.Descriptor instead.

func (*UserActivityRequest) GetPublishedArticleSid added in v1.7.36

func (x *UserActivityRequest) GetPublishedArticleSid() int64

func (*UserActivityRequest) ProtoMessage added in v1.7.36

func (*UserActivityRequest) ProtoMessage()

func (*UserActivityRequest) ProtoReflect added in v1.7.36

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

func (*UserActivityRequest) Reset added in v1.7.36

func (x *UserActivityRequest) Reset()

func (*UserActivityRequest) String added in v1.7.36

func (x *UserActivityRequest) String() string

type UserActivityResponse added in v1.7.36

type UserActivityResponse struct {

	// user activity details
	UserActivity *UserActivity `protobuf:"bytes,1,opt,name=user_activity,json=userActivity,proto3" json:"user_activity,omitempty"`
	// contains filtered or unexported fields
}

Response to user activity updates

func (*UserActivityResponse) Descriptor deprecated added in v1.7.36

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

Deprecated: Use UserActivityResponse.ProtoReflect.Descriptor instead.

func (*UserActivityResponse) GetUserActivity added in v1.7.36

func (x *UserActivityResponse) GetUserActivity() *UserActivity

func (*UserActivityResponse) ProtoMessage added in v1.7.36

func (*UserActivityResponse) ProtoMessage()

func (*UserActivityResponse) ProtoReflect added in v1.7.36

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

func (*UserActivityResponse) Reset added in v1.7.36

func (x *UserActivityResponse) Reset()

func (*UserActivityResponse) String added in v1.7.36

func (x *UserActivityResponse) String() string

type UserActivity_UserActivityDetails added in v1.7.36

type UserActivity_UserActivityDetails struct {

	// the unique published article identifier
	PublishedArticleSid int64 `protobuf:"varint,1,opt,name=published_article_sid,json=publishedArticleSid,proto3" json:"published_article_sid,omitempty"`
	// contains filtered or unexported fields
}

user activity details

func (*UserActivity_UserActivityDetails) Descriptor deprecated added in v1.7.36

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

Deprecated: Use UserActivity_UserActivityDetails.ProtoReflect.Descriptor instead.

func (*UserActivity_UserActivityDetails) GetPublishedArticleSid added in v1.7.36

func (x *UserActivity_UserActivityDetails) GetPublishedArticleSid() int64

func (*UserActivity_UserActivityDetails) ProtoMessage added in v1.7.36

func (*UserActivity_UserActivityDetails) ProtoMessage()

func (*UserActivity_UserActivityDetails) ProtoReflect added in v1.7.36

func (*UserActivity_UserActivityDetails) Reset added in v1.7.36

func (*UserActivity_UserActivityDetails) String added in v1.7.36

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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