Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webex/spark-windows-sdk
Integrate Webex Teams into your Windows application quickly.
https://github.com/webex/spark-windows-sdk
Last synced: 9 days ago
JSON representation
Integrate Webex Teams into your Windows application quickly.
- Host: GitHub
- URL: https://github.com/webex/spark-windows-sdk
- Owner: webex
- License: other
- Created: 2018-01-10T08:52:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-03T06:57:01.000Z (over 6 years ago)
- Last Synced: 2024-10-03T08:07:34.976Z (about 1 month ago)
- Language: C#
- Homepage: https://webex.github.io/spark-windows-sdk/
- Size: 2.63 MB
- Stars: 2
- Watchers: 14
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-webex - SDK for Windows - Integrate messaging and calling in your Windows apps (by Cisco Webex). (Client SDKs / Advanced APIs)
README
# Cisco Spark Windows SDK
[](https://www.nuget.org/packages/Cisco.Spark.WindowsSDK/)
[](https://ci.appveyor.com/project/ciscospark/spark-windows-sdk/branch/master)
[](https://github.com/ciscospark/spark-windows-sdk/blob/master/LICENSE)
> The Cisco Spark™ Windows SDK
The Cisco Spark Windows SDK makes it easy to integrate secure and convenient Cisco Spark calling and messaging features in your Windows applications.
This SDK is built with **Vistual Studio 2017** and requires:
- .NET Framework 4.5.2 or higher version
- Win8 or Win10
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)
## Install
In your Windows application for example WPF project, here are steps to integrate the Cisco Spark Windows SDK into your project:
1. Right click your project, and select "Manage NuGet Packages..."
2. Search "Cisco.Spark.WindowsSDK" in the Browse tag
3. Install the lastest stable version
## Usage
To use the SDK, you will need Cisco Spark integration credentials. If you do not already have a Cisco Spark account, visit the [Cisco Spark for Developers portal](https://developer.ciscospark.com/) to create your account and [register an integration](https://developer.ciscospark.com/authentication.html#registering-your-integration). Your app will need to authenticate users via an [OAuth](https://oauth.net/) grant flow for existing Cisco Spark users or a [JSON Web Token](https://jwt.io/) for guest users without a Cisco Spark account.
See the [Windows SDK area](https://developer.ciscospark.com/sdk-for-windows.html) of the Cisco Spark for Developers site for more information about this SDK.
### Examples
Here are some examples of how to use the Windows SDK in your application. More details can be found under [Windows SDK Demo app](https://github.com/ciscospark/spark-windows-sdk-example).
1. Create a new *Spark* instance using Spark ID authentication ([OAuth](https://oauth.net/)-based):
``` c#
string clientId = "your client id";
string clientSecret = "your client secret";
string redirectUri = "KitchenSink://response/";
string scope = "spark:all";
var auth = new OAuthAuthenticator(clientId, clientSecret, scope, redirectUri);
// authCode(64 bits) can be extracted from url by loading auth.authorizationUrl with a WebBrowser
var spark = new SPARK(auth);
auth?.Authorize(authCode, result =>
{
if (result.Success)
{
System.Console.WriteLine("authorize success!");
}
else
{
System.Console.WriteLine("authorize failed!");
}
});
```
2. Create a new *Spark* instance using Guest ID authentication ([JWT](https://jwt.io/)-based):
```c#
var auth = new JWTAuthenticator();
var spark = new SPARK(auth);
auth?.AuthorizeWith(jwt, result =>
{
if (result.Success)
{
System.Console.WriteLine("authorize success!");
}
else
{
System.Console.WriteLine("authorize failed!");
}
});
```
3. Register the device to make or receive calls:
``` c#
spark?.Phone.Register(result =>
{
if (result.Success == true)
{
System.Console.WriteLine("spark cloud connected");
}
else
{
System.Console.WriteLine("spark cloud connect failed");
}
});
```
4. Make an outgoing call:
```c#
// dial
// calleeAddress can be email address, person ID, or a room ID
spark?.Phone.Dial(calleeAddress, MediaOption.AudioVideoShare(curCallView.LocalViewHandle, curCallView.RemoteViewHandle, curCallView.RemoteShareViewHandle), result =>
{
if (result.Success)
{
currentCall = result.Data;
RegisterCallEvent();
}
else
{
System.Console.WriteLine($"Error: {result.Error?.errorCode.ToString()} {result.Error?.reason}");
}
});
// register call event handlers
void RegisterCallEvent()
{
currentCall.onRinging += CurrentCall_onRinging;
currentCall.onConnected += CurrentCall_onConnected;
currentCall.onDisconnected += CurrentCall_onDisconnected;
currentCall.onMediaChanged += CurrentCall_onMediaChanged;
currentCall.onCapabilitiesChanged += CurrentCall_onCapabilitiesChanged;
currentCall.onCallMembershipChanged += CurrentCall_onCallMembershipChanged;
}
// when video window such as local/remote/sharing window is resized or hided, call corresponding updateView with the windows handle
currentCall.UpdateLocalView(curCallView.LocalViewHandle);
```
5. Answer incoming call:
```c#
// register incoming call event
spark?.Phone.OnIncoming += Phone_onIncoming;
// get call object
void Phone_onIncoming(SparkSDK.Call obj)
{
currentCall = obj;
}
// register call event handler and answer the call
RegisterCallEvent();
// answer current call
currentCall?.Answer(MediaOption.audioVideo(curCallView.LocalViewHandle, curCallView.RemoteViewHandle), result =>
{
if (!result.Success)
{
System.Console.WriteLine($"Error: {result.Error?.errorCode.ToString()} {result.Error?.reason}");
}
});
```
6. Start a screen share
```c#
// Fetch all shareable desktop sources
this.currentCall.FetchShareSources(ShareSourceType.Desktop, result =>
{
if (result.IsSuccess)
{
List ShareSourceList = result.Data;
}
});
// Fetch all shareable application sources
this.currentCall.FetchShareSources(ShareSourceType.Application, result =>
{
if (result.IsSuccess)
{
List ShareSourceList = result.Data;
}
});
// Start share a selected share source.
this.currentCall.StartShare(sourceId, r =>
{
if (r.IsSuccess)
{
System.Console.WriteLine("Start share success.");
}
else
{
System.Console.WriteLine($"Start share failed! Error: {r.Error?.ErrorCode.ToString()} {r.Error?.Reason}");
}
});
```
7. Receive a screen share
```c#
// set share view handle when invoke dial method.
spark?.Phone.Dial(calleeAddress, MediaOption.AudioVideoShare(curCallView.LocalViewHandle, curCallView.RemoteViewHandle, curCallView.RemoteShareViewHandle), result =>
{});
// or set set share view handle when receive RemoteSendingShareEvent
currentCall.OnMediaChanged += CurrentCall_onMediaChanged;
private void CurrentCall_onMediaChanged(MediaChangedEvent mediaChgEvent)
{
if (mediaChgEvent is RemoteSendingShareEvent)
{
var remoteSendingShareEvent = mediaChgEvent as RemoteSendingShareEvent;
if (remoteSendingShareEvent.IsSending)
{
currentCall.SetRemoteShareView(curCallView.RemoteShareViewHandle);
}
}
}
```
8. Create a new Cisco Spark space, add a user to the space:
```c#
// Create a Cisco Spark room:
SparkSDK.Room room = null;
spark?.Rooms.Create("hello world", null, rsp =>
{
if (rsp.Success){
room = rsp.Data;
System.Console.WriteLine("create space successfully");
}
});
// Add a user to the room
spark?.Memberships.CreateByPersonEmail(room?.Id, "email address", false, rsp =>
{
if (rsp.Success)
{
System.Console.WriteLine("add user successfully");
}
});
// send message to the room
spark?.Messages.PostToRoom(room?.Id, "hello", null, rsp =>
{
if(rsp.Success)
{
System.Console.WriteLine("post message successfully");
}
});
```
9. Post a message
```c#
// Post a message to a person by email or person ID.
spark?.Messages.PostToPerson(toPerson, text, files, r =>
{
if (r.IsSuccess)
{
Message message = r.Data;
System.Console.WriteLine($"{message.PersonEmail} {message.Created}");
System.Console.WriteLine($"{message.Text}");
}
else
{
System.Console.WriteLine($"send the message failed. {r.Error.ErrorCode} {r.Error.Reason}");
}
});
// Post a message to a room by roomId.
spark?.Messages.PostToRoom(roomId, text, mentions, files, r =>
{
if (r.IsSuccess)
{
Message message = r.Data;
System.Console.WriteLine($"{message.PersonEmail} {message.Created}");
System.Console.WriteLine($"{message.Text}");
}
else
{
System.Console.WriteLine($"send the message failed. {r.Error.ErrorCode} {r.Error.Reason}");
}
});
```
10. Mention
```c#
// Mention list
List Mentions = new List();
// Mention All
Mentions.Add(new MentionAll());
spark?.Messages.PostToRoom(roomId, text, Mentions, files, r =>
{
if (r.IsSuccess)
{
Message message = r.Data;
System.Console.WriteLine($"{message.PersonEmail} {message.Created}");
System.Console.WriteLine($"{message.Text}");
}
else
{
System.Console.WriteLine($"send the message failed. {r.Error.ErrorCode} {r.Error.Reason}");
}
});
// Mention one person
Mentions.Add(new MentionPerson(personId));
spark?.Messages.PostToRoom(roomId, text, Mentions, files, r =>
{
if (r.IsSuccess)
{
Message message = r.Data;
System.Console.WriteLine($"{message.PersonEmail} {message.Created}");
System.Console.WriteLine($"{message.Text}");
}
else
{
System.Console.WriteLine($"send the message failed. {r.Error.ErrorCode} {r.Error.Reason}");
}
});
// Receive a Mention: See receive a message.
```
11. Receive a message
```c#
spark?.Messages.OnEvent += OnMessageEvent;
private void OnMessageEvent(MessageEvent e)
{
if (e is MessageArrived)
{
System.Console.WriteLine("received a message.");
var messageArrived = e as MessageArrived;
var msgInfo = messageArrived?.Message;
if (msgInfo != null)
{
// self is mentioned
if (msgInfo.IsSelfMentioned)
{
System.Console.WriteLine($"{msgInfo.PersonEmail} mentioned you.");
}
// message text
System.Console.WriteLine($"{msgInfo.PersonEmail} {msgInfo.Created}");
System.Console.WriteLine($"{msgInfo.Text}");
// received attached files.
if (msgInfo.Files != null && msgInfo.Files.Count > 0)
{
foreach (var file in msgInfo.Files)
{
// download thumbnail if exist.
if (file.RemoteThumbnail != null)
{
spark?.Messages.DownloadThumbnail(file, to, r =>
{
if (r.IsSuccess)
{
// callback download path.
ThumbnailPath = r.Data;
}
});
}
// download file
spark?.Messages.DownloadFile(file, downloadPath, r =>
{
if (r.IsSuccess)
{
System.Console.WriteLine($"downloading {r.Data}%");
}
else
{
System.Console.WriteLine($"download failed {r.Data}");
}
});
}
}
}
}
}
```
## Contribute
Pull requests welcome. To suggest changes to the SDK, please fork this repository and submit a pull request with your changes. Your request will be reviewed by one of the project maintainers.
## License
© 2016-2018 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.
See [LICENSE](https://github.com/ciscospark/spark-windows-sdk/blob/master/LICENSE) for details.