storage

Documentation

Overview

Package storage provides the interface containing methods that access the database and return values for groups and other socials.

Index

• type Storage

Types

type Storage

type Storage interface {
	// GetCreatedGroupsByUserId returns all the groups the user created
	GetCreatedGroupsByUserId(ctx context.Context, id models.UserId) ([]models.GroupConfig, error)

	// GetGroupsByUserId returns all the groups the user pertains to
	GetGroupsByUserId(ctx context.Context, id models.UserId) ([]models.GroupConfig, error)

	// GetUsersByGroupId returns all users pertaining to the group
	GetUsersByGroupId(ctx context.Context, id models.GroupId) (models.Members, error)

	// GetGroupByGroupId returns the group with the given id
	GetGroupByGroupId(ctx context.Context, id models.GroupId) (models.GroupConfig, error)

	// TODO
	GetDecksByGroupId(ctx context.Context, id models.GroupId) ([]cardmodels.DeckConfig, error)

	// GetInvitesByGroupId returns invites from the given group
	GetInvitesByGroupId(ctx context.Context, id models.GroupId) (map[models.UserId]models.InviteInfo, error)

	// GetInvitesByUserId returns invites to the given user
	GetInvitesByUserId(ctx context.Context, id models.UserId) (map[models.GroupId]models.InviteInfo, error)

	// Creates new group with id being the owner
	CreateGroup(ctx context.Context, id models.UserId, name string) (models.GroupId, error)

	// Deletes the group where id belongs to its creator
	DeleteGroup(ctx context.Context, id models.UserId, groupId models.GroupId) error

	// QuitGroup deletes user [id] from the group. The creator can't quit.
	QuitGroup(ctx context.Context, id models.UserId, groupId models.GroupId) error

	// User accepts an invite to a group and becomes a member of the group
	AcceptInvite(ctx context.Context, id models.UserId, group_id models.GroupId) error

	// Sends invite to group to the user
	SendInvite(ctx context.Context, creator_id models.UserId, invitee models.UserId, group_id models.GroupId) error

	DeepCopyDeck(ctx context.Context, copier models.UserId, deckId models.DeckId) (models.DeckId, error)

	GetFollowersByUserId(ctx context.Context, id models.UserId) ([]usermodels.UserInfo, error)

	GetFollowingsByUserId(ctx context.Context, id models.UserId) ([]usermodels.UserInfo, error)

	Follow(ctx context.Context, follower models.UserId, author models.UserId) error

	Unfollow(ctx context.Context, follower models.UserId, author models.UserId) error

	ShareDeckGroup(ctx context.Context, owner models.UserId, groupId models.GroupId, deckId models.DeckId) error

	DeleteDeckFromGroup(ctx context.Context, owner models.UserId, groupId models.GroupId, deckId models.DeckId) error

	GetGroupsByName(ctx context.Context, name string) ([]models.GroupConfig, error)

	ChangeGroupName(ctx context.Context, creatorId models.UserId, groupId models.GroupId, name string) error

	GetUsersByName(ctx context.Context, name string) ([]usermodels.UserInfo, error)

	Feed(ctx context.Context, userId models.UserId, page int) ([]models.Post, error)

	CheckIfSharedFollowers(ctx context.Context, userId models.UserId, deckId models.DeckId) (bool, error)

	ShareWithFollowers(ctx context.Context, userId models.UserId, deckId models.DeckId) error

	GetParticipantsByGroupId(ctx context.Context, id models.GroupId) ([]models.UserInfo, error)

	GetGroupsDeckShared(ctx context.Context, userId cardmodels.UserId, deckId models.DeckId) ([]models.GroupsShared, error)

	GetFollowersNotJoinedGroup(ctx context.Context, userId models.UserId, groupId models.GroupId) ([]models.GroupsFollowed, error)
}

Storage is an interface for accessing a database.