Karin API Docs / contact

变量: contact

const contact: object

定义于: packages/core/src/event/contact.ts:109

事件来源构建器

类型声明

direct()

direct: (peer, subId, name, subName) => DirectContact = contactDirect

频道私信场景

构建频道私信事件来源

参数

peer

string

频道ID

subId

string

子频道ID

name

string = ''

频道名称 默认为空字符串

subName

子频道名称 默认为空字符串

string | undefined

返回

DirectContact

friend()

friend: (peer, name) => FriendContact = contactFriend

好友场景

构建好友事件来源

参数

peer

string

好友ID

name

string = ''

好友昵称 默认为空字符串

返回

FriendContact

group()

group: (peer, name) => GroupContact = contactGroup

群聊场景

构建群聊事件来源

参数

peer

string

群ID

name

string = ''

群名

返回

GroupContact

groupTemp()

groupTemp: (peer, subPeer, name) => GroupTempContact = contactGroupTemp

群聊临时会话场景

构建群聊临时会话事件来源

参数

peer

string

群ID

subPeer

string

发起临时会话的用户ID

name

string = ''

群名

返回

GroupTempContact

guild()

guild: (peer, subPeer, name, subName) => GuildContact = contactGuild

频道场景

构建频道事件来源

参数

peer

string

频道ID

subPeer

string

子频道ID

name

string = ''

频道名称 默认为空字符串

subName

string = ''

子频道名称 默认为空字符串

返回

GuildContact

Description

用于构建不同场景的事件来源信息