service/wechat | proxy-use

Index

Enumerations

Type aliases

Variables

Functions

Type aliases

Ca

Ca: (aciton: string, target: string, data: unknown) => unknown

Type declaration

- (aciton: string, target: string, data: unknown): unknown
- window.ca的类型定义
  
  description
  通过脚本获取js挂载到window上
  
  Parameters
  - aciton: string
  - target: string
  - data: unknown
  Returns unknown

Cw

Cw: (...args: unknown[]) => Promise<unknown>

Type declaration

- (...args: unknown[]): Promise<unknown>
- window.cw的类型定义
  
  description
  通过脚本获取js挂载到window上
  
  Parameters
  - Rest ...args: unknown[]
  Returns Promise<unknown>

CwData

CwData: { result: { error?: string } }

cw的返回结果

Type declaration

result: { error?: string }
- Optional error?: string

CwInput

CwInput: { data?: unknown; freeLogin?: 0 | 1; module: string; target: string }

cw的请求参数

Type declaration

Optional data?: unknown
Optional freeLogin?: 0 | 1
module: string
target: string

EventsRecords

EventsRecords<T>: { at: string; detail: ActionView[T] & BaseActionData; id: string }[]

行为事件详情

Type parameters

T: ActionKeys

FormItems

联系人信息字段

LeadResponse

LeadResponse: Partial<{ [ key in FormItems]: string }>

联系人信息字段字典

WechatUserInfo

WechatUserInfo: { headimgurl?: string; language?: string; nickname?: string; openid: string; origin?: string; remark?: string; sex?: Sex; subscribe?: Subscribe; subscribeTime?: string; unionid: string; wechatId: string }

微信用户信息静默授权不会带上用户信息

Type declaration

Optional headimgurl?: string
Optional language?: string
Optional nickname?: string
openid: string
Optional origin?: string
Optional remark?: string
Optional sex?: Sex
Optional subscribe?: Subscribe
Optional subscribeTime?: string
unionid: string
wechatId: string

Variables

LoginState

LoginState: typeof LoginState = ...

WechatState

WechatState: typeof WechatState = ...

Functions

GetWechatUserInfo

GetWechatUserInfo(): Promise<WechatUserInfo & { headimgurl: undefined | string }>

- Defined in service/wechat.ts:74
本地缓存的粉丝信息

export
Returns Promise<WechatUserInfo & { headimgurl: undefined | string }>

cwLogin

cwLogin(refresh?: boolean): Promise<Promise<string>>

- Defined in service/wechat.ts:86
本地缓存的登录信息

export
Parameters
- Optional refresh: boolean
Returns Promise<Promise<string>>

cwLogout

cwLogout(): Promise<void>

- Defined in service/wechat.ts:93
登出

Returns Promise<void>

getEventDetail

getEventDetail<T>(id: string): Promise<EventsRecords<T>>

- Defined in service/wechat.ts:138
根据id查询某个行为事件

Type parameters
- T: keyof ActionView
Parameters
- id: string
Returns Promise<EventsRecords<T>>

getEventRecords

getEventRecords<T>(params: { type: T; uaId?: string } & ListPagination): ListResponse<EventsRecords<T>>

- Defined in service/wechat.ts:130
查询行为事件

Type parameters
- T: keyof ActionView
Parameters
- params: { type: T; uaId?: string } & ListPagination
Returns ListResponse<EventsRecords<T>>

getEventRecordsByKol

getEventRecordsByKol<T>(params: { path?: string; type: T; uaId?: string } & ListPagination): ListResponse<EventsRecords<T> & { headimg: string; nickname: string; openid: string }>

- Defined in service/wechat.ts:146
以originopenId为主体查询行为事件,可按path过滤

Type parameters
- T: keyof ActionView
Parameters
- params: { path?: string; type: T; uaId?: string } & ListPagination
Returns ListResponse<EventsRecords<T> & { headimg: string; nickname: string; openid: string }>

getLeadinfo

getLeadinfo<T>(keys: T): Promise<Partial<{ Department: string; FullAddress: string; FullName: string; Industry: string; Mailbox: string; Organization: string; Phone: string; Position: string; Sex: string }>>

- Defined in service/wechat.ts:170
获取联系人信息

export
Type parameters
- T: FormItems[]
Parameters
- keys: T
Returns Promise<Partial<{ Department: string; FullAddress: string; FullName: string; Industry: string; Mailbox: string; Organization: string; Phone: string; Position: string; Sex: string }>>

promisifyCw

promisifyCw<T>(name: string): Promise<T>

- Defined in service/wechat.ts:106
将cw接口promise化

Type parameters
- T
  
  返回数据结果
Parameters
- name: string
Returns Promise<T>

wechatApi

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

- Defined in service/wechat.ts:119
微信的代理接口

description
系统应用市场的微信模块的暴露接口

export
Parameters
- target: string
  
  请求路由
- Optional data: any
Returns Promise<any>

Index

Enumerations

Type aliases

Variables

Functions

Type aliases

Ca

Type declaration

Parameters

aciton: string

target: string

data: unknown

Returns unknown

Cw

Type declaration

Parameters

Rest ...args: unknown[]

Returns Promise<unknown>

CwData

Type declaration

result: { error?: string }

Optional error?: string

CwInput

Type declaration

Optional data?: unknown

Optional freeLogin?: 0 | 1

module: string

target: string

EventsRecords

Type parameters

T: ActionKeys

FormItems

LeadResponse

WechatUserInfo

Type declaration

Optional headimgurl?: string

Optional language?: string

Optional nickname?: string

openid: string

Optional origin?: string

Optional remark?: string

Optional sex?: Sex

Optional subscribe?: Subscribe

Optional subscribeTime?: string

unionid: string

wechatId: string

Variables

LoginState

WechatState

Functions

GetWechatUserInfo

Returns Promise<WechatUserInfo & { headimgurl: undefined | string }>

cwLogin

Parameters

Optional refresh: boolean

Returns Promise<Promise<string>>

cwLogout

Returns Promise<void>

getEventDetail

Type parameters

T: keyof ActionView

Parameters

id: string

Returns Promise<EventsRecords<T>>

getEventRecords

Type parameters

T: keyof ActionView

Parameters

params: { type: T; uaId?: string } & ListPagination

Returns ListResponse<EventsRecords<T>>

getEventRecordsByKol

Type parameters

T: keyof ActionView

Parameters

params: { path?: string; type: T; uaId?: string } & ListPagination

Returns ListResponse<EventsRecords<T> & { headimg: string; nickname: string; openid: string }>

getLeadinfo

Type parameters

T: FormItems[]

Parameters