pm

Documentation

Index

• Variables
• type FolderType
• type IDFilter
• type PrivateMessage
• type PrivateMessageListItem
• type PrivateMessageTypeCounts
• type Repo
  • func NewMysqlRepo(q *query.Query, log *zap.Logger) (Repo, error)

Variables

var ErrPmDeleted = errors.New("private message deleted")

var ErrPmInvalidOperation = errors.New("invalid operation")

var ErrPmNotOwned = errors.New("not sent or received this private message")

var ErrPmRelatedNotExists = errors.New("related private message not exists")

var ErrPmUserIrrelevant = errors.New("has user irrelevant message")

Types

type FolderType

type FolderType string

const (
	FolderTypeInbox  FolderType = "inbox"
	FolderTypeOutbox FolderType = "outbox"
)

type IDFilter

type IDFilter struct {
	Type null.Null[model.PrivateMessageID]
}

type PrivateMessage

type PrivateMessage struct {
	CreatedTime       time.Time
	Title             string
	Content           string
	Folder            FolderType
	SenderID          model.UserID
	ReceiverID        model.UserID
	ID                model.PrivateMessageID
	MainMessageID     model.PrivateMessageID // 如果当前是首条私信，则为当前私信的id，否则为0
	RelatedMessageID  model.PrivateMessageID // 首条私信的id
	New               bool
	DeletedBySender   bool
	DeletedByReceiver bool
}

type PrivateMessageListItem

type PrivateMessageListItem struct {
	Main PrivateMessage
	Self PrivateMessage
}

type PrivateMessageTypeCounts

type PrivateMessageTypeCounts struct {
	Unread int64
	Inbox  int64
	Outbox int64
}

type Repo

type Repo interface {
	List(
		ctx context.Context,
		userID model.UserID,
		folder FolderType,
		offset int,
		limit int,
	) ([]PrivateMessageListItem, error)

	CountByFolder(
		ctx context.Context,
		userID model.UserID,
		folder FolderType,
	) (int64, error)

	ListRelated(
		ctx context.Context,
		userID model.UserID,
		id model.PrivateMessageID,
	) ([]PrivateMessage, error)

	CountTypes(ctx context.Context, userID model.UserID) (PrivateMessageTypeCounts, error)

	MarkRead(ctx context.Context, userID model.UserID, relatedID model.PrivateMessageID) error

	ListRecentContact(ctx context.Context, userID model.UserID) ([]model.UserID, error)

	Create(
		ctx context.Context,
		senderID model.UserID,
		receiverIDs []model.UserID,
		relatedIDFilter IDFilter,
		title string,
		content string,
	) ([]PrivateMessage, error)

	Delete(
		ctx context.Context,
		userID model.UserID,
		ids []model.PrivateMessageID,
	) error
}

func NewMysqlRepo

func NewMysqlRepo(q *query.Query, log *zap.Logger) (Repo, error)