api

package
v3.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 22, 2024 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	NoCompression      = -1
	DefaultCompression = 0
	BestCompression    = 1
	BestSpeed          = 2
)

Variables

View Source 
var Whitelist = []string{
	"/auth/get_admin_token",
	"/auth/parse_token",
}

Whitelist api not parse token

Functions

func GinParseToken 

func GinParseToken(authRPC *rpcclient.Auth) gin.HandlerFunc

func RequiredIf 

func RequiredIf(fl validator.FieldLevel) bool

RequiredIf validates if the specified field is required based on the session type.

func Start added in v3.6.0 

func Start(ctx context.Context, index int, config *Config) error

Types

type AuthApi 

type AuthApi rpcclient.Auth

func NewAuthApi 

func NewAuthApi(client rpcclient.Auth) AuthApi

func (*AuthApi) ForceLogout 

func (o *AuthApi) ForceLogout(c *gin.Context)

func (*AuthApi) GetAdminToken added in v3.8.1 

func (o *AuthApi) GetAdminToken(c *gin.Context)

func (*AuthApi) GetUserToken added in v3.6.0 

func (o *AuthApi) GetUserToken(c *gin.Context)

func (*AuthApi) ParseToken 

func (o *AuthApi) ParseToken(c *gin.Context)

type Config added in v3.7.0 

type Config struct {
	API       config.API
	Share     config.Share
	Discovery config.Discovery
}

type ConversationApi 

type ConversationApi rpcclient.Conversation

func NewConversationApi 

func NewConversationApi(client rpcclient.Conversation) ConversationApi

func (*ConversationApi) GetAllConversations 

func (o *ConversationApi) GetAllConversations(c *gin.Context)

func (*ConversationApi) GetConversation 

func (o *ConversationApi) GetConversation(c *gin.Context)

func (*ConversationApi) GetConversationOfflinePushUserIDs added in v3.3.2 

func (o *ConversationApi) GetConversationOfflinePushUserIDs(c *gin.Context)

func (*ConversationApi) GetConversations 

func (o *ConversationApi) GetConversations(c *gin.Context)

func (*ConversationApi) GetFullOwnerConversationIDs added in v3.8.0 

func (o *ConversationApi) GetFullOwnerConversationIDs(c *gin.Context)

func (*ConversationApi) GetIncrementalConversation added in v3.8.0 

func (o *ConversationApi) GetIncrementalConversation(c *gin.Context)

func (*ConversationApi) GetNotNotifyConversationIDs added in v3.8.1 

func (o *ConversationApi) GetNotNotifyConversationIDs(c *gin.Context)

func (*ConversationApi) GetOwnerConversation added in v3.8.0 

func (o *ConversationApi) GetOwnerConversation(c *gin.Context)

func (*ConversationApi) GetPinnedConversationIDs added in v3.8.1 

func (o *ConversationApi) GetPinnedConversationIDs(c *gin.Context)

func (*ConversationApi) GetSortedConversationList added in v3.6.0 

func (o *ConversationApi) GetSortedConversationList(c *gin.Context)

func (*ConversationApi) SetConversations 

func (o *ConversationApi) SetConversations(c *gin.Context)

type FriendApi 

type FriendApi rpcclient.Friend

func NewFriendApi 

func NewFriendApi(client rpcclient.Friend) FriendApi

func (*FriendApi) AddBlack 

func (o *FriendApi) AddBlack(c *gin.Context)

func (*FriendApi) ApplyToAddFriend 

func (o *FriendApi) ApplyToAddFriend(c *gin.Context)

func (*FriendApi) DeleteFriend 

func (o *FriendApi) DeleteFriend(c *gin.Context)

func (*FriendApi) GetDesignatedFriends 

func (o *FriendApi) GetDesignatedFriends(c *gin.Context)

func (*FriendApi) GetDesignatedFriendsApply 

func (o *FriendApi) GetDesignatedFriendsApply(c *gin.Context)

func (*FriendApi) GetFriendApplyList 

func (o *FriendApi) GetFriendApplyList(c *gin.Context)

func (*FriendApi) GetFriendIDs 

func (o *FriendApi) GetFriendIDs(c *gin.Context)

func (*FriendApi) GetFriendList 

func (o *FriendApi) GetFriendList(c *gin.Context)

func (*FriendApi) GetFullFriendUserIDs added in v3.8.0 

func (o *FriendApi) GetFullFriendUserIDs(c *gin.Context)

func (*FriendApi) GetIncrementalBlacks added in v3.8.0 

func (o *FriendApi) GetIncrementalBlacks(c *gin.Context)

GetIncrementalBlacks is temporarily unused. Deprecated: This function is currently unused and may be removed in future versions.

func (*FriendApi) GetIncrementalFriends added in v3.8.0 

func (o *FriendApi) GetIncrementalFriends(c *gin.Context)

func (*FriendApi) GetPaginationBlacks 

func (o *FriendApi) GetPaginationBlacks(c *gin.Context)

func (*FriendApi) GetSelfApplyList 

func (o *FriendApi) GetSelfApplyList(c *gin.Context)

func (*FriendApi) GetSpecifiedBlacks added in v3.8.1 

func (o *FriendApi) GetSpecifiedBlacks(c *gin.Context)

func (*FriendApi) GetSpecifiedFriendsInfo 

func (o *FriendApi) GetSpecifiedFriendsInfo(c *gin.Context)

func (*FriendApi) ImportFriends 

func (o *FriendApi) ImportFriends(c *gin.Context)

func (*FriendApi) IsFriend 

func (o *FriendApi) IsFriend(c *gin.Context)

func (*FriendApi) RemoveBlack 

func (o *FriendApi) RemoveBlack(c *gin.Context)

func (*FriendApi) RespondFriendApply 

func (o *FriendApi) RespondFriendApply(c *gin.Context)

func (*FriendApi) SetFriendRemark 

func (o *FriendApi) SetFriendRemark(c *gin.Context)

func (*FriendApi) UpdateFriends added in v3.5.0 

func (o *FriendApi) UpdateFriends(c *gin.Context)

type GroupApi 

type GroupApi rpcclient.Group

func NewGroupApi 

func NewGroupApi(client rpcclient.Group) GroupApi

func (*GroupApi) ApplicationGroupResponse 

func (o *GroupApi) ApplicationGroupResponse(c *gin.Context)

func (*GroupApi) CancelMuteGroup 

func (o *GroupApi) CancelMuteGroup(c *gin.Context)

func (*GroupApi) CancelMuteGroupMember 

func (o *GroupApi) CancelMuteGroupMember(c *gin.Context)

func (*GroupApi) CreateGroup 

func (o *GroupApi) CreateGroup(c *gin.Context)

func (*GroupApi) DismissGroup 

func (o *GroupApi) DismissGroup(c *gin.Context)

func (*GroupApi) GetFullGroupMemberUserIDs added in v3.8.0 

func (o *GroupApi) GetFullGroupMemberUserIDs(c *gin.Context)

func (*GroupApi) GetFullJoinGroupIDs added in v3.8.0 

func (o *GroupApi) GetFullJoinGroupIDs(c *gin.Context)

func (*GroupApi) GetGroupAbstractInfo 

func (o *GroupApi) GetGroupAbstractInfo(c *gin.Context)

func (*GroupApi) GetGroupMemberList 

func (o *GroupApi) GetGroupMemberList(c *gin.Context)

func (*GroupApi) GetGroupMemberUserIDs 

func (o *GroupApi) GetGroupMemberUserIDs(c *gin.Context)

func (*GroupApi) GetGroupMembersInfo 

func (o *GroupApi) GetGroupMembersInfo(c *gin.Context)

func (*GroupApi) GetGroupUsersReqApplicationList 

func (o *GroupApi) GetGroupUsersReqApplicationList(c *gin.Context)

func (*GroupApi) GetGroups 

func (o *GroupApi) GetGroups(c *gin.Context)

func (*GroupApi) GetGroupsInfo 

func (o *GroupApi) GetGroupsInfo(c *gin.Context)

func (*GroupApi) GetIncrementalGroupMember added in v3.8.0 

func (o *GroupApi) GetIncrementalGroupMember(c *gin.Context)

func (*GroupApi) GetIncrementalGroupMemberBatch added in v3.8.0 

func (o *GroupApi) GetIncrementalGroupMemberBatch(c *gin.Context)

func (*GroupApi) GetIncrementalJoinGroup added in v3.8.0 

func (o *GroupApi) GetIncrementalJoinGroup(c *gin.Context)

func (*GroupApi) GetJoinedGroupList 

func (o *GroupApi) GetJoinedGroupList(c *gin.Context)

func (*GroupApi) GetRecvGroupApplicationList 

func (o *GroupApi) GetRecvGroupApplicationList(c *gin.Context)

func (*GroupApi) GetSpecifiedUserGroupRequestInfo added in v3.8.1 

func (o *GroupApi) GetSpecifiedUserGroupRequestInfo(c *gin.Context)

func (*GroupApi) GetUserReqGroupApplicationList 

func (o *GroupApi) GetUserReqGroupApplicationList(c *gin.Context)

func (*GroupApi) GroupCreateCount 

func (o *GroupApi) GroupCreateCount(c *gin.Context)

func (*GroupApi) InviteUserToGroup 

func (o *GroupApi) InviteUserToGroup(c *gin.Context)

func (*GroupApi) JoinGroup 

func (o *GroupApi) JoinGroup(c *gin.Context)

func (*GroupApi) KickGroupMember 

func (o *GroupApi) KickGroupMember(c *gin.Context)

func (*GroupApi) MuteGroup 

func (o *GroupApi) MuteGroup(c *gin.Context)

func (*GroupApi) MuteGroupMember 

func (o *GroupApi) MuteGroupMember(c *gin.Context)

func (*GroupApi) QuitGroup 

func (o *GroupApi) QuitGroup(c *gin.Context)

func (*GroupApi) SetGroupInfo 

func (o *GroupApi) SetGroupInfo(c *gin.Context)

func (*GroupApi) SetGroupInfoEx added in v3.8.1 

func (o *GroupApi) SetGroupInfoEx(c *gin.Context)

func (*GroupApi) SetGroupMemberInfo 

func (o *GroupApi) SetGroupMemberInfo(c *gin.Context)

func (*GroupApi) TransferGroupOwner 

func (o *GroupApi) TransferGroupOwner(c *gin.Context)

type MessageApi 

type MessageApi struct {
	*rpcclient.Message
	// contains filtered or unexported fields
}

func NewMessageApi 

func NewMessageApi(msgRpcClient *rpcclient.Message, userRpcClient *rpcclient.User,
	imAdminUserID []string) MessageApi

func (*MessageApi) BatchSendMsg 

func (m *MessageApi) BatchSendMsg(c *gin.Context)

func (*MessageApi) CheckMsgIsSendSuccess 

func (m *MessageApi) CheckMsgIsSendSuccess(c *gin.Context)

func (*MessageApi) ClearConversationsMsg 

func (m *MessageApi) ClearConversationsMsg(c *gin.Context)

func (*MessageApi) DeleteMsgPhysical 

func (m *MessageApi) DeleteMsgPhysical(c *gin.Context)

func (*MessageApi) DeleteMsgPhysicalBySeq 

func (m *MessageApi) DeleteMsgPhysicalBySeq(c *gin.Context)

func (*MessageApi) DeleteMsgs 

func (m *MessageApi) DeleteMsgs(c *gin.Context)

func (*MessageApi) GetActiveGroup 

func (m *MessageApi) GetActiveGroup(c *gin.Context)

func (*MessageApi) GetActiveUser 

func (m *MessageApi) GetActiveUser(c *gin.Context)

func (*MessageApi) GetConversationsHasReadAndMaxSeq 

func (m *MessageApi) GetConversationsHasReadAndMaxSeq(c *gin.Context)

func (*MessageApi) GetSeq 

func (m *MessageApi) GetSeq(c *gin.Context)

func (*MessageApi) GetServerTime 

func (m *MessageApi) GetServerTime(c *gin.Context)

func (*MessageApi) GetUsersOnlineStatus 

func (m *MessageApi) GetUsersOnlineStatus(c *gin.Context)

func (*MessageApi) MarkConversationAsRead 

func (m *MessageApi) MarkConversationAsRead(c *gin.Context)

func (*MessageApi) MarkMsgsAsRead 

func (m *MessageApi) MarkMsgsAsRead(c *gin.Context)

func (*MessageApi) PullMsgBySeqs 

func (m *MessageApi) PullMsgBySeqs(c *gin.Context)

func (*MessageApi) RevokeMsg 

func (m *MessageApi) RevokeMsg(c *gin.Context)

func (*MessageApi) SearchMsg 

func (m *MessageApi) SearchMsg(c *gin.Context)

func (*MessageApi) SendBusinessNotification 

func (m *MessageApi) SendBusinessNotification(c *gin.Context)

func (*MessageApi) SendMessage 

func (m *MessageApi) SendMessage(c *gin.Context)

SendMessage handles the sending of a message. It's an HTTP handler function to be used with Gin framework.

func (*MessageApi) SetConversationHasReadSeq 

func (m *MessageApi) SetConversationHasReadSeq(c *gin.Context)

func (*MessageApi) SetOptions 

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

func (*MessageApi) UserClearAllMsg 

func (m *MessageApi) UserClearAllMsg(c *gin.Context)

type StatisticsApi 

type StatisticsApi rpcclient.User

func NewStatisticsApi 

func NewStatisticsApi(client rpcclient.User) StatisticsApi

func (*StatisticsApi) UserRegister 

func (s *StatisticsApi) UserRegister(c *gin.Context)

type ThirdApi 

type ThirdApi rpcclient.Third

func NewThirdApi 

func NewThirdApi(client rpcclient.Third) ThirdApi

func (*ThirdApi) AccessURL 

func (o *ThirdApi) AccessURL(c *gin.Context)

func (*ThirdApi) AuthSign 

func (o *ThirdApi) AuthSign(c *gin.Context)

func (*ThirdApi) CompleteFormData added in v3.5.0 

func (o *ThirdApi) CompleteFormData(c *gin.Context)

func (*ThirdApi) CompleteMultipartUpload 

func (o *ThirdApi) CompleteMultipartUpload(c *gin.Context)

func (*ThirdApi) DeleteLogs added in v3.3.2 

func (o *ThirdApi) DeleteLogs(c *gin.Context)

func (*ThirdApi) FcmUpdateToken 

func (o *ThirdApi) FcmUpdateToken(c *gin.Context)

func (*ThirdApi) GetPrometheus added in v3.6.0 

func (o *ThirdApi) GetPrometheus(c *gin.Context)

func (*ThirdApi) InitiateFormData added in v3.5.0 

func (o *ThirdApi) InitiateFormData(c *gin.Context)

func (*ThirdApi) InitiateMultipartUpload 

func (o *ThirdApi) InitiateMultipartUpload(c *gin.Context)

func (*ThirdApi) ObjectRedirect 

func (o *ThirdApi) ObjectRedirect(c *gin.Context)

func (*ThirdApi) PartLimit 

func (o *ThirdApi) PartLimit(c *gin.Context)

func (*ThirdApi) PartSize 

func (o *ThirdApi) PartSize(c *gin.Context)

func (*ThirdApi) SearchLogs added in v3.3.2 

func (o *ThirdApi) SearchLogs(c *gin.Context)

func (*ThirdApi) SetAppBadge 

func (o *ThirdApi) SetAppBadge(c *gin.Context)

func (*ThirdApi) UploadLogs added in v3.3.2 

func (o *ThirdApi) UploadLogs(c *gin.Context)

#################### logs ####################.

type UserApi 

type UserApi rpcclient.User

func NewUserApi 

func NewUserApi(client rpcclient.User) UserApi

func (*UserApi) AccountCheck 

func (u *UserApi) AccountCheck(c *gin.Context)

func (*UserApi) AddNotificationAccount added in v3.5.0 

func (u *UserApi) AddNotificationAccount(c *gin.Context)

func (*UserApi) GetAllUsersID 

func (u *UserApi) GetAllUsersID(c *gin.Context)

func (*UserApi) GetSubscribeUsersStatus 

func (u *UserApi) GetSubscribeUsersStatus(c *gin.Context)

GetSubscribeUsersStatus Get the online status of subscribers.

func (*UserApi) GetUserStatus 

func (u *UserApi) GetUserStatus(c *gin.Context)

GetUserStatus Get the online status of the user.

func (*UserApi) GetUsers 

func (u *UserApi) GetUsers(c *gin.Context)

func (*UserApi) GetUsersOnlineStatus 

func (u *UserApi) GetUsersOnlineStatus(c *gin.Context)

GetUsersOnlineStatus Get user online status.

func (*UserApi) GetUsersOnlineTokenDetail 

func (u *UserApi) GetUsersOnlineTokenDetail(c *gin.Context)

GetUsersOnlineTokenDetail Get user online token details.

func (*UserApi) GetUsersPublicInfo 

func (u *UserApi) GetUsersPublicInfo(c *gin.Context)

func (*UserApi) ProcessUserCommandAdd added in v3.5.0 

func (u *UserApi) ProcessUserCommandAdd(c *gin.Context)

ProcessUserCommandAdd user general function add.

func (*UserApi) ProcessUserCommandDelete added in v3.5.0 

func (u *UserApi) ProcessUserCommandDelete(c *gin.Context)

ProcessUserCommandDelete user general function delete.

func (*UserApi) ProcessUserCommandGet added in v3.5.0 

func (u *UserApi) ProcessUserCommandGet(c *gin.Context)

ProcessUserCommandGet user general function get.

func (*UserApi) ProcessUserCommandGetAll added in v3.6.0 

func (u *UserApi) ProcessUserCommandGetAll(c *gin.Context)

ProcessUserCommandGet user general function get all.

func (*UserApi) ProcessUserCommandUpdate added in v3.5.0 

func (u *UserApi) ProcessUserCommandUpdate(c *gin.Context)

ProcessUserCommandUpdate user general function update.

func (*UserApi) SearchNotificationAccount added in v3.5.0 

func (u *UserApi) SearchNotificationAccount(c *gin.Context)

func (*UserApi) SetGlobalRecvMessageOpt 

func (u *UserApi) SetGlobalRecvMessageOpt(c *gin.Context)

func (*UserApi) SubscriberStatus 

func (u *UserApi) SubscriberStatus(c *gin.Context)

SubscriberStatus Presence status of subscribed users.

func (*UserApi) UpdateNotificationAccountInfo added in v3.5.0 

func (u *UserApi) UpdateNotificationAccountInfo(c *gin.Context)

func (*UserApi) UpdateUserInfo 

func (u *UserApi) UpdateUserInfo(c *gin.Context)

UpdateUserInfo is deprecated. Use UpdateUserInfoEx

func (*UserApi) UpdateUserInfoEx added in v3.5.0 

func (u *UserApi) UpdateUserInfoEx(c *gin.Context)

func (*UserApi) UserRegister 

func (u *UserApi) UserRegister(c *gin.Context)

func (*UserApi) UserRegisterCount 

func (u *UserApi) UserRegisterCount(c *gin.Context)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.