Options
All
  • Public
  • Public/Protected
  • All
Menu

Module service/common

Index

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ActionKeys

ActionKeys: keyof ActionView

所有行为事件的种类

AllActions

AllActions: ActionView[ActionKeys]

所有行为事件

BaseActionData

BaseActionData: { cms?: string; originOpenId?: string; path: string; tagIds?: string; title?: string; uaId: string }

基础的action信息

Type declaration

  • Optional cms?: string

    cmsid: {pId},{mId},{hId},{rId}

  • Optional originOpenId?: string

    推荐人openid

  • path: string
  • Optional tagIds?: string

    tagIds: {tagId1},{tagId2}

  • Optional title?: string
  • uaId: string

PartialAction

PartialAction<T>: ActionView[T] & Partial<BaseActionData>

行为事件传参时的主体

Type Parameters

RequiredAction

RequiredAction: AllActions & BaseActionData

抛出行为事件时的内容主体

Variables

Const CurrentPageParams

CurrentPageParams: { cms?: string; routeName?: string; tagIds?: string; title?: string } = {}

Type declaration

  • Optional cms?: string
  • Optional routeName?: string
  • Optional tagIds?: string
  • Optional title?: string

Functions

actionView

  • 行为事件通用处理函数

    internal
    export

    Parameters

    Returns Promise<void>

answerview

  • 答题结果

    Parameters

    Returns Promise<void>

clickview

  • 按键点击

    Parameters

    Returns Promise<void>

collectview

  • 收藏

    Parameters

    Returns Promise<void>

documentview

  • documentview(action: PartialAction<"documentview">): Promise<void>

  • 浏览文档

    Parameters

    Returns Promise<void>

downloadview

  • downloadview(action: PartialAction<"downloadview">): Promise<void>

  • 下载资料

    Parameters

    Returns Promise<void>

getShareQrcode

  • getShareQrcode(__namedParameters?: { c_source: undefined | string; desc: undefined | string; image: undefined | string; path: undefined | string; title: undefined | string; uaid: undefined | string; v: undefined | number }): Promise<string>

  • 生成base64的二维码字符串，扫码后跳至公众号弹出外链

    description

    可用于推荐关注后快速返回微站页面

    remarks

    c_source 分享人openid path 外链链接，会拼接上当前的utm参数 desc 外链描述 title 外链标题 image 外链图片

    Parameters

    • __namedParameters: { c_source: undefined | string; desc: undefined | string; image: undefined | string; path: undefined | string; title: undefined | string; uaid: undefined | string; v: undefined | number } = {}
      • c_source: undefined | string
      • desc: undefined | string
      • image: undefined | string
      • path: undefined | string
      • title: undefined | string
      • uaid: undefined | string
      • v: undefined | number

    Returns Promise<string>

likeview

  • 点赞

    Parameters

    Returns Promise<void>

mailDocview

  • 发送文档至邮箱

    Parameters

    Returns Promise<void>

pageview

  • 浏览页面

    Parameters

    Returns Promise<void>

preVideoview

  • 试看

    Parameters

    Returns Promise<void>

recommendview

  • recommendview(action: PartialAction<"recommendview">): Promise<void>

  • 推荐

    Parameters

    Returns Promise<void>

scoreview

  • 互动分数

    Parameters

    Returns Promise<void>

searchview

  • 搜索

    Parameters

    Returns Promise<void>

shareview

  • 分享

    Parameters

    Returns Promise<void>

signInview

  • 签到

    Parameters

    Returns Promise<void>

uncollectview

  • uncollectview(action: PartialAction<"uncollectview">): Promise<void>

  • 取消收藏

    Parameters

    Returns Promise<void>

videorecord

  • 观看视频记录时长

    Parameters

    Returns Promise<void>

videoview

  • 观看视频

    Parameters

    Returns Promise<void>

webinarview

  • 观看直播

    Parameters

    Returns Promise<void>

Generated using TypeDoc