Options
All
  • Public
  • Public/Protected
  • All
Menu

Module service/staff

Index

Enumerations

Type aliases

Functions

Type aliases

StaffInfo

StaffInfo: { department: string; mailbox: string; name: string; phone: string; position: string; staffId: string }

员工信息

Type declaration

  • department: string
  • mailbox: string
  • name: string
  • phone: string
  • position: string
  • staffId: string

StaffValidType

StaffValidType: "Phone" | "Mailbox"

验证方式

Functions

getLoginStaffInfo

  • 查询登录的员工信息 loginInfo 的会去判断 员工的状态，如果被锁定的话，就不返回了

    Returns Promise<StaffInfo>

getStaffInfo

  • 查询openid绑定的员工信息

    deprecated

    使用loginInfo获取带限制的员工信息

    description

    多个员工信息返回第1条

    Returns Promise<StaffInfo>

getStaffValidCode

  • getStaffValidCode(params: { phone: string; type: "Phone" }): Promise<{ code: SendVaildCodeStatus }>
  • getStaffValidCode(params: { mailbox: string; type: "Mailbox" }): Promise<{ code: SendVaildCodeStatus }>

  • 员工手机验证登录

    description

    选择邮箱或者手机验证

    Parameters

    • params: { phone: string; type: "Phone" }
      • phone: string
      • type: "Phone"

    Returns Promise<{ code: SendVaildCodeStatus }>

  • 员工邮箱验证登录

    description

    选择邮箱或者手机验证

    Parameters

    • params: { mailbox: string; type: "Mailbox" }
      • mailbox: string
      • type: "Mailbox"

    Returns Promise<{ code: SendVaildCodeStatus }>

loginWithStaff

  • loginWithStaff(params: { mailbox: string; mailboxValidCode: string }): Promise<StaffLoginStatus>
  • loginWithStaff(params: { phone: string; phoneValidCode: string }): Promise<StaffLoginStatus>

  • 员工邮箱登录

    description

    使用短信或者邮件验证码进行登录; 登录会有一个绑定的过程，如果之前你的手机号和openid 没有绑定的话，就会再登录完成之后进行绑定

    Parameters

    • params: { mailbox: string; mailboxValidCode: string }
      • mailbox: string
      • mailboxValidCode: string

    Returns Promise<StaffLoginStatus>

  • 员工手机登录

    description

    使用短信或者邮件验证码进行登录; 登录会有一个绑定的过程，如果之前你的手机号和openid 没有绑定的话，就会再登录完成之后进行绑定

    Parameters

    • params: { phone: string; phoneValidCode: string }
      • phone: string
      • phoneValidCode: string

    Returns Promise<StaffLoginStatus>

staffApi

  • staffApi(target: string, data?: any): Promise<any>

  • 员工 的代理接口

    description

    系统员工模块的暴露接口

    export

    Parameters

    • target: string

      请求路由

    • Optional data: any

    Returns Promise<any>

Generated using TypeDoc