Options
All
  • Public
  • Public/Protected
  • All
Menu

Module UserServiceInterface

Index

Enumerations

Interfaces

Type aliases

Type aliases

Gender

Gender: keyof typeof GenderMap

MarkedUserInfo

MarkedUserInfo: { account: string; createTime: number; isBlack?: boolean; isMuted?: boolean; updateTime: number }

Type declaration

  • account: string

    账号 accid

  • createTime: number
  • Optional isBlack?: boolean

    是否被拉入黑名单

  • Optional isMuted?: boolean

    是否被静音

  • updateTime: number

Relations

Relations: { blackList: MarkedUserInfo[]; muteList: MarkedUserInfo[] }

Type declaration

UpdateAppBackgroundOptions

UpdateAppBackgroundOptions: { badge: number; isBackground: boolean }

推送专用

Type declaration

  • badge: number

    未读数（角标数字），只有ios需要传这个参数。

  • isBackground: boolean

    app 是否正处在后台。 true 为 app 转入后台运行 false 为 app 切回前台运行

UpdatePushTokenOptions

UpdatePushTokenOptions: { pushkit: number; token: string; tokenName: string }

推送专用，更新并上报厂商推送（APNs、小米推送等）的devicetoken

Type declaration

  • pushkit: number

    推送通道。默认 0，表示 apns 通道

  • token: string

    推送 token

  • tokenName: string

    证书名

UserNameCard

UserNameCard: { account: string; avatar: string; birth: string; createTime: number; email: string; ext: string; gender: Gender; nick: string; signature: string; tel: string; updateTime: number }

Type declaration

  • account: string

    accid

  • avatar: string

    头像

  • birth: string

    出生日期

  • createTime: number
  • email: string

    邮箱

  • ext: string

    扩展字段

  • gender: Gender

    性别

  • nick: string

    昵称

  • signature: string

    签名

  • tel: string

    电话

  • updateTime: number

getUsersOptions

getUsersOptions: { accounts: string[] }

Type declaration

  • accounts: string[]

    账号列表

    注意：每次最多 150 个

updateMyInfoOptions

updateMyInfoOptions: { avatar: string; birth: string; email: string; ext: string; gender: Gender; nick: string; signature: string; tel: string }

Type declaration

  • avatar: string

    头像

  • birth: string

    出生日期

  • email: string

    邮箱

  • ext: string

    扩展字段

  • gender: Gender

    性别

  • nick: string

    昵称

  • signature: string

    签名

  • tel: string

    电话

updateRelationsOptions

updateRelationsOptions: { accout: string; isAdd: boolean }

Type declaration

  • accout: string
  • isAdd: boolean

    isAdd 为 true 时, 会将 account 确定这么设置（黑名单，静音） 如果一个用户被加入了黑名单, 那么就不再会收到此用户发送的消息

    isAdd 为 false 时, 会将 account 取消设置 如果一个用户被从黑名单移除, 那么可以收到此用户发送的消息