External module: wx操作微信
Index
Interfaces
- IAuthOption
- IEmoticonMediaMessage
- IFileMediaMessage
- IImageMediaMessage
- IInitializeOption
- ILaunchMiniProgramOption
- ILocationMediaMessage
- IMiniProgramMediaMessage
- IMusicMediaMessage
- ITextMediaMessage
- IUserinfo
- IVideoMediaMessage
- IWebpageMediaMessage
Functions
- is_wx_app_installed
- open_mini_program
- open_wx_app
- register_app
- send_emoticon
- send_image
- send_link
- send_location
- send_mini_program
- send_music
- send_text
- send_video
- send_video
Functions
is_wx_app_installed
▸ is_wx_app_installed(): Promise
<boolean
>
Defined in wx/is-wx-app-installed.ts:16
查看手机是否安装了微信
requires: @yyyyu/react-native-wechat
example:
import is_wx_app_installed from '@dfeidao/atom-mobile/wx/is-wx-app-installed';
const res = await is_wx_app_installed();
Returns: Promise
<boolean
>
open_mini_program
▸ open_mini_program(options: ILaunchMiniProgramOption): Promise
<object
>
Defined in wx/open-mini-program.ts:28
打开小程序
requires: @yyyyu/react-native-wechat
example:
import open_mini_program from '@dfeidao/atom-mobile/wx/open-mini-program';
open_mini_program({
username: 'gh_da7fdfa75b27', // 原始 id,微信开放平台注册小程序处获取
path: 'pages/app-teacher-homepage/app-teacher-homepage', // 小程序路由地址
type: 1 // 0是测试版,1是体验版,2是正式版
});
Parameters:
Name | Type |
---|---|
options | ILaunchMiniProgramOption |
Returns: Promise
<object
>
open_wx_app
▸ open_wx_app(): Promise
<void
>
Defined in wx/open-wx-app.ts:16
打开微信
requires: @yyyyu/react-native-wechat
example:
import open_wx_app from '@dfeidao/atom-mobile/wx/open-wx-app';
open_wx_app();
Returns: Promise
<void
>
register_app
▸ register_app(options: IInitializeOption): Promise
<void
>
Defined in wx/register-app.ts:24
注册微信 api
requires: @yyyyu/react-native-wechat
example:
import register_app from '@dfeidao/atom-mobile/wx/register-app';
register_app({
appId: 'wx59848add8e868031', // 微信平台注册应用后得到的 appId
isDebug: true // 可选项,默认false
});
Parameters:
Name | Type |
---|---|
options | IInitializeOption |
Returns: Promise
<void
>
send_emoticon
▸ send_emoticon(options: IEmoticonMediaMessage): Promise
<object
>
Defined in wx/send-emoticon.ts:32
发送表情
requires: @yyyyu/react-native-wechat
example:
import send_emoticon from '@dfeidao/atom-mobile/wx/send-emoticon';
awati send_emoticon({
image: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784',
scene: 0 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IEmoticonMediaMessage |
Returns: Promise
<object
>
send_image
▸ send_image(options: IImageMediaMessage): Promise
<object
>
Defined in wx/send-image.ts:32
发送图片
requires: @yyyyu/react-native-wechat
example:
import send_image from '@dfeidao/atom-mobile/wx/send-image';
await sendImage({
image: "https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784", // 用于发送的图片
scene: 1 // 发送场景 optional('session')
});
Parameters:
Name | Type |
---|---|
options | IImageMediaMessage |
Returns: Promise
<object
>
send_link
▸ send_link(options: IWebpageMediaMessage): Promise
<object
>
Defined in wx/send-link.ts:35
发送链接
requires: @yyyyu/react-native-wechat
example:
import send_link from '@dfeidao/atom-mobile/wx/send-link';
await sendLink({
url: 'https://www.baidu.com/', // 链接地址
messageTitle: '标题', // 标题
messageDesc: '描述', // 描述
messageThumb: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784', // 缩略图
scene: 1 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IWebpageMediaMessage |
Returns: Promise
<object
>
send_location
▸ send_location(options: ILocationMediaMessage): Promise
<object
>
Defined in wx/send-location.ts:34
发送位置
requires: @yyyyu/react-native-wechat
example:
import send_location from '@dfeidao/atom-mobile/wx/send-location';
send_location({
lng: 36.2265501475,
lat: 114.1040039063,
scene: 0
});
Parameters:
Name | Type |
---|---|
options | ILocationMediaMessage |
Returns: Promise
<object
>
send_mini_program
▸ send_mini_program(options: IMiniProgramMediaMessage): Promise
<object
>
Defined in wx/send-mini-program.ts:44
发送小程序
requires: @yyyyu/react-native-wechat
example:
import send_mini_program from '@dfeidao/atom-mobile/wx/send-mini-program';
await sendMiniProgram({
username: 'gh_da7fdfa75b27', // 原始 id,微信开放平台注册小程序处获取
path: 'pages/app-teacher-homepage/app-teacher-homepage', // 小程序路由地址
messageTitle: '标题', // 标题
messageDesc: '描述', // 描述
hdImage: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784', // 缩略图
url: 'https://www.baidu.com/', // 兼容旧版本链接,不支持小程序的微信版本会以此方式打开
messageThumb: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784', // 兼容旧版本缩略图,不支持小程序的微信版本会看到此缩略图
type: 1, // 0是测试版,1是体验版,2是正式版
scene: 0 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IMiniProgramMediaMessage |
Returns: Promise
<object
>
send_music
▸ send_music(options: IMusicMediaMessage): Promise
<object
>
Defined in wx/send-music.ts:41
发送音乐
requires: @yyyyu/react-native-wechat
example:
import send_music from '@dfeidao/atom-mobile/wx/send-music';
await sendMusic({
url: 'https://music.com/music.html', // 音频网页的URL地址
lowBandURL: 'https://music.com/music.html', // 供低带宽环境下使用的音频网页URL地址
dataURL: 'https://music.com/data', // 音频数据的URL地址
lowBandDataURL: 'https://music.com/data', // 供低带宽环境下使用的音频数据URL地址
messageTitle: '标题', // 标题
messageDesc: '描述', // 描述
messageThumb: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784', // 缩略图
scene: 1 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IMusicMediaMessage |
Returns: Promise
<object
>
send_text
▸ send_text(options: ITextMediaMessage): Promise
<object
>
Defined in wx/send-text.ts:33
发送文字
requires: @yyyyu/react-native-wechat
example:
import send_text from '@dfeidao/atom-mobile/wx/send-text';
await sendText({
content: '测试', // 用于发送的文字
scene: 1 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | ITextMediaMessage |
Returns: Promise
<object
>
send_video
▸ send_video(options: IFileMediaMessage): Promise
<object
>
Defined in wx/send-file.ts:34
发送文件
requires: @yyyyu/react-native-wechat
example:
import send_video from '@dfeidao/atom-mobile/wx/send-video';
send_file({
file: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784',
messageTitle:'图片' // 文件名
ext: '',
scene: 0 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IFileMediaMessage |
Returns: Promise
<object
>
send_video
▸ send_video(options: IVideoMediaMessage): Promise
<object
>
Defined in wx/send-video.ts:37
发送视频
requires: @yyyyu/react-native-wechat
example:
import send_video from '@dfeidao/atom-mobile/wx/send-video';
await sendVideo({
url: 'https://video.com/video', // 视频地址
lowBandURL: 'https://video.com/video',
messageTitle: '标题', // 标题
messageDesc: '描述', // 描述
messageThumb: 'https://avatar.gitee.com/uploads/69/1961669_xiapeixu.png!avatar100?1530761784', // 缩略图
scene: 1 // 发送场景 0是聊天,1是朋友圈,2是收藏,3是指定联系人
});
Parameters:
Name | Type |
---|---|
options | IVideoMediaMessage |
Returns: Promise
<object
>