openapi: 拉取表情表态用户列表 (merge request !46)

Squash merge branch 'feature_20220411_getreactions_story_873145169' into 'master'
- 新增拉取表情表态用户列表

TAPD: --story=873145169

Author: kamichen-tencent

dto/message.go

@@ -62,3 +62,10 @@ type EmbedField struct {
 type MessageAttachment struct {
 	URL string `json:"url"`
 }
+
+// MessageReactionUsers 消息表情表态用户列表
+type MessageReactionUsers struct {
+	Users  []*User `json:"users,omitempty"`
+	Cookie string  `json:"cookie,omitempty"`
+	IsEnd  bool    `json:"is_end,omitempty"`
+}

dto/pager.go

@@ -66,6 +66,24 @@ func (m *MessagesPager) QueryParams() map[string]string {
 	return query
 }
 
+// MessageReactionPager 分页器
+type MessageReactionPager struct {
+	Cookie string `json:"cookie"` // 分页游标
+	Limit  string `json:"limit"`  // 分页大小，1-1000，默认是20
+}
+
+// QueryParams 转换为 query 参数
+func (g *MessageReactionPager) QueryParams() map[string]string {
+	query := make(map[string]string)
+	if g.Limit != "" {
+		query["limit"] = g.Limit
+	}
+	if g.Cookie != "" {
+		query["cookie"] = g.Cookie
+	}
+	return query
+}
+
 // MessagePagerType 消息翻页拉取方式
 type MessagePagerType string
 

examples/apitest/message_reaction_test.go

@@ -25,4 +25,26 @@ func TestMessageReaction(t *testing.T) {
 			t.Logf("err:%+v", err)
 		},
 	)
+	t.Run(
+		"Get Reaction Users", func(t *testing.T) {
+			users, err := api.GetMessageReactions(ctx, testChannelID, testMessageID, dto.Emoji{Type: 1, ID: "43"},
+				&dto.MessageReactionPager{
+					Limit: "20",
+				})
+			if err != nil {
+				t.Error(err)
+			}
+			t.Logf("err:%+v", err)
+
+			_, err = api.GetMessageReactions(ctx, testChannelID, testMessageID, dto.Emoji{Type: 1, ID: "43"},
+				&dto.MessageReactionPager{
+					Cookie: users.Cookie,
+					Limit:  "20",
+				})
+			if err != nil {
+				t.Error(err)
+			}
+			t.Logf("err:%+v", err)
+		},
+	)
 }

openapi/iface.go

@@ -216,6 +216,9 @@ type MessageReactionAPI interface {
 	CreateMessageReaction(ctx context.Context, channelID, messageID string, emoji dto.Emoji) error
 	// DeleteOwnMessageReaction 删除自己的消息表情表态
 	DeleteOwnMessageReaction(ctx context.Context, channelID, messageID string, emoji dto.Emoji) error
+	// GetMessageReactions 获取消息表情表态用户列表
+	GetMessageReactions(ctx context.Context, channelID, messageID string, emoji dto.Emoji,
+		pager *dto.MessageReactionPager) (*dto.MessageReactionUsers, error)
 }
 
 // InteractionAPI 互动接口

openapi/v1/message_reaction.go

@@ -2,9 +2,11 @@ package v1
 
 import (
 	"context"
+	"encoding/json"
 	"strconv"
 
 	"github.com/tencent-connect/botgo/dto"
+	"github.com/tencent-connect/botgo/errs"
 )
 
 // CreateMessageReaction 对消息发表表情表态
@@ -36,3 +38,28 @@ func (o *openAPI) DeleteOwnMessageReaction(ctx context.Context,
 	}
 	return nil
 }
+
+// GetMessageReactionUsers 获取消息表情表态用户列表
+func (o *openAPI) GetMessageReactionUsers(ctx context.Context, channelID, messageID string, emoji dto.Emoji,
+	pager *dto.MessageReactionPager) (*dto.MessageReactionUsers, error) {
+	if pager == nil {
+		return nil, errs.ErrPagerIsNil
+	}
+	resp, err := o.request(ctx).
+		SetPathParam("channel_id", channelID).
+		SetPathParam("message_id", messageID).
+		SetPathParam("emoji_type", strconv.FormatUint(uint64(emoji.Type), 10)).
+		SetPathParam("emoji_id", emoji.ID).
+		SetQueryParams(pager.QueryParams()).
+		Get(o.getURL(messageReactionURI))
+	if err != nil {
+		return nil, err
+	}
+
+	messageReactionUsers := &dto.MessageReactionUsers{}
+	if err := json.Unmarshal(resp.Body(), &messageReactionUsers); err != nil {
+		return nil, err
+	}
+
+	return messageReactionUsers, nil
+}