forked from AgoraIO/Agora-Chat-API-Examples
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update windows-example readme files.
- Loading branch information
1 parent
ec094c1
commit 642d96d
Showing
4 changed files
with
134 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,68 @@ | ||
# Sample projects for the Agora Chat Windows SDK | ||
# API Example Windows | ||
|
||
This repository contains sample projects for the Agora Chat Windows SDK. | ||
_English | [ÖÐÎÄ](README.zh.md)_ | ||
|
||
## Note | ||
## Overview | ||
|
||
This project can ONLY be run after integrating with Windows SDK according to doc [Windows SDK quick start](https://docs-preprod.agora.io/en/agora-chat/agora_chat_get_started_windows?platform=Windows) | ||
This repository contains sample projects using the Agora Chat Windows sdk. | ||
|
||
![img](images/win-running.png) | ||
|
||
## Project structure | ||
|
||
The project uses a single app to combine a variety of functionalities. | ||
|
||
| Function | Location | | ||
| --------------- | ------------------------ | | ||
| Get Started with Agora Chat Windows sdk |https://github.com/AgoraIO/Agora-Chat-API-Examples/blob/main/windows-example/MainWindow.xaml.cs | | ||
|
||
|
||
## How to run the sample project | ||
|
||
### Prerequisites | ||
|
||
*Necessary requirements for the project to run.* | ||
|
||
- *A Windows device running Windows 10 or later* | ||
- *Visual Studio IDE 2019 or later* | ||
- *.Net Framework 4.5.2 or later* | ||
|
||
### Steps to run | ||
|
||
1. *Clone this project to local* | ||
2. *Using visual studio to open project: windows-example\windows-example.sln* | ||
3. *Integrate Agora Chat Windows sdk* | ||
> DownLoad [ Agora Chat Windows SDK](https://downloadsdk.easemob.com/downloads/SDK/WinSDK/agora_chat_sdk.1.0.2.1-beta.nupkg) | ||
> Install the nupkg from local directory(need to check the Include prerelease box). | ||
4. *Add sample code for this project* | ||
|
||
> This project only include a framework which has no implementations. | ||
Need to add sample code. See [Get Started with Agora Chat Windows sdk](https://docs.agora.io/en/null/agora_chat_get_started_windows?platform=Windows) | ||
|
||
5. *Compile, run and test the project* | ||
|
||
You are all set! Feel free to play with this sample project and explore features of the Agora Chat Windows SDK. | ||
|
||
|
||
## Feedback | ||
|
||
If you have any problems or suggestions regarding the sample projects, feel free to file an issue. | ||
|
||
## Reference | ||
|
||
- [Agora Chat Windows SDK Product Overview](https://docs.agora.io/en/agora-chat/agora_chat_overview?platform=Windows) | ||
- [Agora Chat Windows SDK API Reference](https://docs.agora.io/en/agora-chat/api-ref?platform=Windows) | ||
|
||
## Related resources | ||
|
||
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded. | ||
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials | ||
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case | ||
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community) | ||
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io) | ||
|
||
## License | ||
|
||
The sample projects are under the MIT license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# API Example Windows | ||
|
||
_[English](README.md) | 中文_ | ||
|
||
## 简介 | ||
|
||
该仓库包含了使用 Agora Chat Windows sdk 的示例项目。 | ||
|
||
![img](images/win-running.png) | ||
|
||
## 项目结构 | ||
|
||
此项目使用一个单独的 app 实现了多种功能。 | ||
|
||
| Function | Location | | ||
| --------------- | ------------------------ | | ||
| 登录,发送和接收一对一文本消息 |https://github.com/AgoraIO/Agora-Chat-API-Examples/blob/main/windows-example/MainWindow.xaml.cs | | ||
|
||
|
||
## 如何运行示例项目 | ||
|
||
### 前提条件 | ||
|
||
*运行项目的必要条件。* | ||
|
||
- *Windows10或之后的版本* | ||
- *Visual Studio IDE 2019 or 之后的版本* | ||
- *.Net Framework 4.5.2 or 之后的版本* | ||
|
||
### 运行步骤 | ||
|
||
1. *将此项目克隆到本地* | ||
2. *使用 visual studio打开项目: windows-example\windows-example.sln* | ||
3. *集成 Agora Chat Windows sdk* | ||
> 下载 [ Agora Chat Windows SDK](https://downloadsdk.easemob.com/downloads/SDK/WinSDK/agora_chat_sdk.1.0.2.1-beta.nupkg) | ||
> 从本地目录安装nupkg(需要勾选 包括预发行版). | ||
4. *为项目添加示例代码* | ||
|
||
> 此项目只包含一个框架,没有具体实现。 | ||
需要添加示例代码. 参考 [Agora Chat Windows sdk快速开始](https://docs.agora.io/en/null/agora_chat_get_started_windows?platform=Windows) | ||
|
||
5. *编译、运行和测试你的项目* | ||
|
||
一切就绪。你可以自由探索示例项目,体验 SDK 的丰富功能。 | ||
|
||
|
||
## 反馈 | ||
|
||
如果你有任何问题或建议,可以通过 issue 的形式反馈。 | ||
|
||
## 参考文档 | ||
|
||
- [Agora Chat Windows SDK 产品概述](https://docs.agora.io/en/agora-chat/agora_chat_overview?platform=Windows) | ||
- [Agora ChatWindows SDK API 参考](https://docs.agora.io/en/agora-chat/api-ref?platform=Windows) | ||
|
||
## 相关资源 | ||
|
||
- 你可以先参阅[常见问题](https://docs.agora.io/cn/faq) | ||
- 如果你想了解更多官方示例,可以参考[官方 SDK 示例](https://github.com/AgoraIO) | ||
- 如果你想了解声网 SDK 在复杂场景下的应用,可以参考[官方场景案例](https://github.com/AgoraIO-usecase) | ||
- 如果你想了解声网的一些社区开发者维护的项目,可以查看[社区](https://github.com/AgoraIO-Community) | ||
- 若遇到问题需要开发者帮助,你可以到[开发者社区](https://rtcdeveloper.com/)提问 | ||
- 如果需要售后技术支持, 你可以在[Agora Dashboard](https://dashboard.agora.io)提交工单 | ||
|
||
## 代码许可 | ||
|
||
示例项目遵守 MIT 许可证。 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.