manage

Documentation

Overview

** description(""). ** copyright('open-im,www.open-im.io'). ** author("fg,Gordon@tuoyun.net"). ** time(2021/9/15 15:23).

** description(""). ** copyright('open-im,www.open-im.io'). ** author("fg,Gordon@tuoyun.net"). ** time(2021/9/15 10:28).

Index

• func AccountCheck(c *gin.Context)
• func CheckMsgIsSendSuccess(c *gin.Context)
• func GetAllUsersUid(c *gin.Context)
• func GetUsersOnlineStatus(c *gin.Context)
• func ManagementBatchSendMsg(c *gin.Context)
• func ManagementSendMsg(c *gin.Context)
• func SetOptions(options map[string]bool, value bool)
• type AtElem
• type CustomElem
• type FileElem
• type LocationElem
• type MessageRevoked
• type OANotificationElem
• type PictureBaseInfo
• type PictureElem
• type RevokeElem
• type SoundElem
• type TextElem
• type VideoElem

Functions

func AccountCheck

func AccountCheck(c *gin.Context)

@Summary 检查列表账户注册状态，并且返回结果 @Description 传入UserIDList检查列表账户注册状态，并且返回结果 @Tags 用户相关 @ID AccountCheck @Accept json @Param token header string true "im token" @Param req body api.AccountCheckReq true "请求体" @Produce json @Success 0 {object} api.AccountCheckResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /user/account_check [post]

func CheckMsgIsSendSuccess

func CheckMsgIsSendSuccess(c *gin.Context)

func GetAllUsersUid

func GetAllUsersUid(c *gin.Context)

@Summary 获取所有用户uid列表 @Description 获取所有用户uid列表 @Tags 用户相关 @ID GetAllUsersUid @Accept json @Param token header string true "im token" @Param req body api.GetAllUsersUidReq true "请求体" @Produce json @Success 0 {object} api.GetAllUsersUidResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /user/get_all_users_uid [post]

func GetUsersOnlineStatus

func GetUsersOnlineStatus(c *gin.Context)

func ManagementBatchSendMsg

func ManagementBatchSendMsg(c *gin.Context)

@Summary 管理员批量发送群聊单聊消息 @Description 管理员批量发送群聊单聊消息 消息格式详细见<a href="https://doc.rentsoft.cn/#/server_doc/admin?id=%e6%b6%88%e6%81%af%e7%b1%bb%e5%9e%8b%e6%a0%bc%e5%bc%8f%e6%8f%8f%e8%bf%b0">消息格式</href> @Tags 消息相关 @ID ManagementBatchSendMsg @Accept json @Param token header string true "im token" @Param 管理员批量发送单聊消息 body api.ManagementBatchSendMsgReq{content=TextElem{}} true "该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表" @Param 管理员批量发送OA通知 body api.ManagementSendMsgReq{content=OANotificationElem{}} true "该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表" @Produce json @Success 0 {object} api.ManagementBatchSendMsgReq "serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间" @Failure 500 {object} api.ManagementBatchSendMsgReq "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.ManagementBatchSendMsgReq "errCode为400 一般为参数输入错误, token未带上等" @Router /msg/batch_send_msg [post]

func ManagementSendMsg

func ManagementSendMsg(c *gin.Context)

@Summary 管理员发送/撤回消息 @Description 管理员发送/撤回消息 消息格式详细见<a href="https://doc.rentsoft.cn/#/server_doc/admin?id=%e6%b6%88%e6%81%af%e7%b1%bb%e5%9e%8b%e6%a0%bc%e5%bc%8f%e6%8f%8f%e8%bf%b0">消息格式</href> @Tags 消息相关 @ID ManagementSendMsg @Accept json @Param token header string true "im token" @Param 管理员发送文字消息 body api.ManagementSendMsgReq{content=TextElem{}} true "该请求和消息结构体一样" @Param 管理员发送OA通知消息 body api.ManagementSendMsgReq{content=OANotificationElem{}} true "该请求和消息结构体一样" @Param 管理员撤回单聊消息 body api.ManagementSendMsgReq{content=RevokeElem{}} true "该请求和消息结构体一样" @Produce json @Success 0 {object} api.ManagementSendMsgResp "serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间" @Failure 500 {object} api.ManagementSendMsgResp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.ManagementSendMsgResp "errCode为400 一般为参数输入错误, token未带上等" @Router /msg/manage_send_msg [post]

func SetOptions

func SetOptions(options map[string]bool, value bool)

Types

type AtElem

type AtElem struct {
	Text        string   `mapstructure:"text"`
	AtUserList  []string `mapstructure:"atUserList"`
	AtUsersInfo []struct {
		AtUserID      string `json:"atUserID,omitempty"`
		GroupNickname string `json:"groupNickname,omitempty"`
	} `json:"atUsersInfo,omitempty"`
	IsAtSelf bool `mapstructure:"isAtSelf"`
}

type CustomElem

type CustomElem struct {
	Data        string `mapstructure:"data" validate:"required"`
	Description string `mapstructure:"description"`
	Extension   string `mapstructure:"extension"`
}

type FileElem

type FileElem struct {
	FilePath  string `mapstructure:"filePath"`
	UUID      string `mapstructure:"uuid"`
	SourceURL string `mapstructure:"sourceUrl"`
	FileName  string `mapstructure:"fileName"`
	FileSize  int64  `mapstructure:"fileSize"`
}

type LocationElem

type LocationElem struct {
	Description string  `mapstructure:"description"`
	Longitude   float64 `mapstructure:"longitude"`
	Latitude    float64 `mapstructure:"latitude"`
}

type MessageRevoked

type MessageRevoked struct {
	RevokerID       string `mapstructure:"revokerID" json:"revokerID" validate:"required"`
	RevokerRole     int32  `mapstructure:"revokerRole" json:"revokerRole" validate:"required"`
	ClientMsgID     string `mapstructure:"clientMsgID" json:"clientMsgID" validate:"required"`
	RevokerNickname string `mapstructure:"revokerNickname" json:"revokerNickname"`
	SessionType     int32  `mapstructure:"sessionType" json:"sessionType" validate:"required"`
	Seq             uint32 `mapstructure:"seq" json:"seq" validate:"required"`
}

type OANotificationElem

type OANotificationElem struct {
	NotificationName    string      `mapstructure:"notificationName" json:"notificationName" validate:"required"`
	NotificationFaceURL string      `mapstructure:"notificationFaceURL" json:"notificationFaceURL"`
	NotificationType    int32       `mapstructure:"notificationType" json:"notificationType" validate:"required"`
	Text                string      `mapstructure:"text" json:"text" validate:"required"`
	Url                 string      `mapstructure:"url" json:"url"`
	MixType             int32       `mapstructure:"mixType" json:"mixType"`
	PictureElem         PictureElem `mapstructure:"pictureElem" json:"pictureElem"`
	SoundElem           SoundElem   `mapstructure:"soundElem" json:"soundElem"`
	VideoElem           VideoElem   `mapstructure:"videoElem" json:"videoElem"`
	FileElem            FileElem    `mapstructure:"fileElem" json:"fileElem"`
	Ex                  string      `mapstructure:"ex" json:"ex"`
}

type PictureBaseInfo

type PictureBaseInfo struct {
	UUID   string `mapstructure:"uuid"`
	Type   string `mapstructure:"type" `
	Size   int64  `mapstructure:"size" `
	Width  int32  `mapstructure:"width" `
	Height int32  `mapstructure:"height"`
	Url    string `mapstructure:"url" `
}

type PictureElem

type PictureElem struct {
	SourcePath      string          `mapstructure:"sourcePath"`
	SourcePicture   PictureBaseInfo `mapstructure:"sourcePicture"`
	BigPicture      PictureBaseInfo `mapstructure:"bigPicture" `
	SnapshotPicture PictureBaseInfo `mapstructure:"snapshotPicture"`
}

type RevokeElem

type RevokeElem struct {
	RevokeMsgClientID string `mapstructure:"revokeMsgClientID" validate:"required"`
}

type SoundElem

type SoundElem struct {
	UUID      string `mapstructure:"uuid"`
	SoundPath string `mapstructure:"soundPath"`
	SourceURL string `mapstructure:"sourceUrl"`
	DataSize  int64  `mapstructure:"dataSize"`
	Duration  int64  `mapstructure:"duration"`
}

type TextElem

type TextElem struct {
	Text string `mapstructure:"text" validate:"required"`
}

type VideoElem

type VideoElem struct {
	VideoPath      string `mapstructure:"videoPath"`
	VideoUUID      string `mapstructure:"videoUUID"`
	VideoURL       string `mapstructure:"videoUrl"`
	VideoType      string `mapstructure:"videoType"`
	VideoSize      int64  `mapstructure:"videoSize"`
	Duration       int64  `mapstructure:"duration"`
	SnapshotPath   string `mapstructure:"snapshotPath"`
	SnapshotUUID   string `mapstructure:"snapshotUUID"`
	SnapshotSize   int64  `mapstructure:"snapshotSize"`
	SnapshotURL    string `mapstructure:"snapshotUrl"`
	SnapshotWidth  int32  `mapstructure:"snapshotWidth"`
	SnapshotHeight int32  `mapstructure:"snapshotHeight"`
}