Documentation
¶
Index ¶
- type AddBlackListRequest
- type CommentRequest
- type ContactHandlers
- func (ctrl *ContactHandlers) Black() gin.HandlerFunc
- func (ctrl *ContactHandlers) BlackList() gin.HandlerFunc
- func (ctrl *ContactHandlers) Comment() gin.HandlerFunc
- func (ctrl *ContactHandlers) Follow() gin.HandlerFunc
- func (ctrl *ContactHandlers) Followers() gin.HandlerFunc
- func (ctrl *ContactHandlers) List() gin.HandlerFunc
- func (ctrl *ContactHandlers) Remove() gin.HandlerFunc
- type FlollowRequest
- type ListBlackListRequest
- type ListMyFollowersRequest
- type RemoveContactRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddBlackListRequest ¶
type AddBlackListRequest struct {
// 联系人记录ID
//
// required: true
// min: 3
FriendUID int `json:"friendUID"`
// 联系人记录ID
//
// required: false
// min: 3
ContactID int `json:"contactID"`
}
AddBlackListRequest model swagger:model AddBlackListRequest
type CommentRequest ¶
type CommentRequest struct {
// 联系人记录ID
//
// required: true
// min: 3
ContactID int `json:"contactID"`
// 联系人备注
//
// required: true
// min: 6
Comment string `json:"Comment"`
}
CommentRequest model swagger:model CommentRequest
type ContactHandlers ¶
type ContactHandlers struct {
*basichandlers.Basic
}
ContactHandlers defined for captcha APIs
func (*ContactHandlers) Black ¶
func (ctrl *ContactHandlers) Black() gin.HandlerFunc
Black friend @Summary 拉黑联系人 @Tags 联系人 @Description 拉黑联系人 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param AddBlackListRequest body contacthandlers.AddBlackListRequest true "拉黑联系人" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/remove [post]
func (*ContactHandlers) BlackList ¶
func (ctrl *ContactHandlers) BlackList() gin.HandlerFunc
BlackList users @Summary 黑名单列表 @Tags 联系人 @Description 黑名单列表 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param ListBlackListRequest body contacthandlers.ListBlackListRequest true "黑名单列表" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/blacklist [post]
func (*ContactHandlers) Comment ¶
func (ctrl *ContactHandlers) Comment() gin.HandlerFunc
Comment friend @Summary 备注 @Tags 联系人 @Description 为联系人添加备注信息 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param CommentRequest body contacthandlers.CommentRequest true "关注" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/comment [post]
func (*ContactHandlers) Follow ¶
func (ctrl *ContactHandlers) Follow() gin.HandlerFunc
Follow someone @Summary 关注 @Tags 联系人 @Description 关注某个用户 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param FlollowRequest body contacthandlers.FlollowRequest true "关注" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/follow [post]
func (*ContactHandlers) Followers ¶
func (ctrl *ContactHandlers) Followers() gin.HandlerFunc
Followers api @Summary 粉丝列表 @Tags 联系人 @Description 获取关注我用户们 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param ListMyFollowersRequest body contacthandlers.ListMyFollowersRequest true "查询粉丝列表" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/followers [post]
func (*ContactHandlers) List ¶
func (ctrl *ContactHandlers) List() gin.HandlerFunc
List defined to get user contact List todo: cache contact list for 30 minutes @Summary 获取联系人列表 @Tags 联系人 @Description 获取当前登录用户的联系人信息 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/list [get]
func (*ContactHandlers) Remove ¶
func (ctrl *ContactHandlers) Remove() gin.HandlerFunc
Remove friend @Summary 删除联系人 @Tags 联系人 @Description 删除联系人 @Accept json @Produce json @Accept application/x-json-stream @Param Authorization header string true "Authentication header" @Param RemoveCommentRequest body RemoveCommentRequest true "关注" @Success 200 "{"code":200,"data":{},"message":"操作成功"}" @Router /contacts/remove [post]
type FlollowRequest ¶
type FlollowRequest struct {
// 联系人记录ID
//
// required: true
// min: 3
FriendUID int `json:"friendUID"`
// 联系人备注
//
// required: true
// min: 6
Comment string `json:"Comment"`
}
FlollowRequest model swagger:model FlollowRequest
type ListBlackListRequest ¶
type ListBlackListRequest struct {
*basichandlers.PaginationRequest
}
ListBlackListRequest model swagger:model ListBlackListRequest
type ListMyFollowersRequest ¶
type ListMyFollowersRequest struct {
*basichandlers.PaginationRequest
}
ListMyFollowersRequest model swagger:model ListMyFollowersRequest
type RemoveContactRequest ¶
type RemoveContactRequest struct {
// 关注用户UID
//
// required: true
// min: 3
ContactID int `json:"contactID"`
}
RemoveContactRequest model swagger:model RemoveContactRequest
Source Files