SparkSDK Namespace |
The Cisco Spark Windows SDK makes it easy to integrate secure and convenient Cisco Spark messaging and calling features in your apps.
Classes| Class | Description | |
|---|---|---|
 | AVIODevice |
Audio and video IO device.
|
| Call |
A Call represents a media call on Cisco Spark.
The application can create an outgoing call by calling phone.dial function.
|
| CallDisconnectedEvent |
The call disconnect event.
|
| CallError |
Unknown error
|
| CallEvent |
Base class for the event of a call.
|
| CallMembership |
A data type represents a relationship between *Call* and *Person* at Cisco Spark cloud.
|
| CallMembershipChangedEvent |
The call membership changed event.
|
| CallMembershipDeclinedEvent |
The person in the membership declined this call.
|
| CallMembershipJoinedEvent |
The person in the membership joined this call.
|
| CallMembershipLeftEvent |
The person in the membership left this call.
|
| CallMembershipSendingAudioEvent |
The person in the membership started sending audio.
|
| CallMembershipSendingShareEvent |
The person in the membership started sharing.
|
| CallMembershipSendingVideoEvent |
The person in the membership started sending video.
|
| CameraSwitchedEvent |
This might be triggered when the selected camera switched.
|
| CapabilitieDTMF |
The DTMF capability of this call.
|
| Capabilities |
The capabilities of a call.
|
| JWTAuthenticator |
A [JSON Web Token](https://jwt.io/introduction) (JWT) based authentication strategy
is to be used to authenticate a guest user on Cisco Spark.
|
| LocalCancel |
The local party has cancelled the call.
This is only applicable when the direction of the call is *outgoing*.
|
| LocalDecline |
The local party has declined the call.
This is only applicable when the direction of the call is *incoming*.
|
| LocalFile |
A data type represents a local file
|
| LocalFileThumbnail |
A data type represents a local file thumbnail.
|
| LocalLeft |
The local party has left the call.
|
| LocalVideoReadyEvent |
This is triggered when ready for show local video.
If you haven't set the local view handle, you can set it by calling SetLocalView(IntPtr) now.
|
| LocalVideoViewSizeChangedEvent |
Local video rendering view size has changed.
|
| MediaChangedEvent |
The media change event.
|
| MediaOption |
The media options of a call.
|
| Membership |
Membership contents.
|
| MembershipClient |
Memberships represent a person's relationship to a room.
Use this API to list members of any room that you're in or create memberships to invite someone to a room.
Memberships can also be updated to make someome a moderator or deleted to remove them from the room.
|
| Mention |
A abstact data type represents mention.
|
| MentionAll |
A data type represents mention all in the room.
|
| MentionPerson |
A data type represents mention one person in the room.
|
| Message |
The struct of a Message on Cisco Spark.
|
| MessageArrived |
The event of a message arrived.
|
| MessageClient |
Messages are how we communicate in a room. In Spark, each message is displayed on its own line along with a timestamp and sender information.
Use this API to list, create, and delete messages. Message can contain plain text, rich text, and a file attachment.
|
| MessageDeleted |
The event of a message is deleted.
|
| MessageEvent |
A abstract data type represents a message event.
|
| OAuthAuthenticator |
An [OAuth](https://oauth.net/2/) based authentication strategy is to be used to authenticate a user on Cisco Spark.
|
| OtherConnected |
One of the other phones of the authenticated user has answered the call.
This is only applicable when the direction of the call is *incoming*.
|
| OtherDeclined |
One of the other phones of the authenticated user has declined the call.
This is only applicable when the direction of the call is *incoming*.
|
| Person |
Person contents.
|
| PersonClient |
Person are registered users of Cisco Spark.
Searching and viewing Person requires an auth token with a scope of spark:people_read.
Viewing the list of all People in your Organization requires an administrator auth token with spark-admin:people_read scope.
Adding, updating, and removing People requires an administrator auth token with the spark-admin:people_write scope.
|
| Phone |
Phone represents a Cisco Spark calling device.
The application can obtain a phone object from Spark object
and use *phone* to call other Cisco Spark users or PSTN when enabled.
The phone must be registered before it can make or receive calls.
|
| ReceivingAudioEvent |
This might be triggered when the local party muted or unmuted the audio.
|
| ReceivingShareEvent |
This might be triggered when the local party muted or unmuted the video
|
| ReceivingVideoEvent |
This might be triggered when the local party muted or unmuted the video.
|
| RemoteCancel |
The remote party has cancelled the call.
This is only applicable when the direction of the call is *incoming*.
|
| RemoteDecline |
The remote party has declined the call.
This is only applicable when the direction of the call is *outgoing*.
|
| RemoteFile |
A data type represents a remote file
|
| RemoteFileThumbnail |
A data type represents a remote file thumbnail.
|
| RemoteLeft |
The remote party has left the call.
|
| RemoteSendingAudioEvent |
This might be triggered when the remote party muted or unmuted the audio.
|
| RemoteSendingShareEvent |
This might be triggered when the remote party started or stopped share stream.
If you haven't set the share view handle, you can set it by calling SetRemoteShareView(IntPtr) now.
|
| RemoteSendingVideoEvent |
This might be triggered when the remote party muted or unmuted the video.
|
| RemoteShareViewSizeChangedEvent |
Remote share rendering view size has changed.
|
| RemoteVideoReadyEvent |
This is triggered when ready for show remote video.
If you haven't set the remote view handle, you can set it by calling SetRemoteView(IntPtr) now.
|
| RemoteVideoViewSizeChangedEvent |
Remote video rendering view size has changed.
|
| Room |
A data type represents a Room at Cisco Spark cloud.
|
| RoomClient |
Class RoomClient contains APIs which are used to manage the rooms themselves.
Rooms are created and deleted with this API. You can also update a room to change its title
|
| SendingAudioEvent |
This might be triggered when the local party muted or unmuted the audio.
|
| SendingShareEvent |
This might be triggered when the local party started or stopped share stream.
|
| SendingVideoEvent |
This might be triggered when the local party muted or unmuted the video.
|
| ShareSource |
Share source.
|
| Spark |
Spark object is the entry point to use this Cisco Spark .Net SDK. A Spark object must be created with one of the following Authenticator.
|
| SparkApiEventArgs |
Represents the Spark SDK api event args.
|
| SparkApiEventArgsT |
Represents the Spark SDK api event args.
|
| SparkError |
A data type represents a error.
|
| SpeakerSwitchedEvent |
This might be triggered when the selected speaker switched.
|
| SSOAuthenticator |
An Single sign-on [SSO](https://help.webex.com/docs/DOC-9143#reference_E9B2CEDE975E4CD311C56D9B0EF2476C)
based authentication strategy used to authenticate a user on Cisco Spark.
See: [Cisco Spark Integration](https://developer.ciscospark.com/authentication.html)
|
| Team |
A data type represents a Team at Cisco Spark cloud.
|
| TeamClient |
Class TeamClient contains APIs which are used to manage the teams themselves.
Teams are created and deleted with this API. You can also update a team to change its title
|
| TeamMembership |
A data type represents a relationship between Team and Person at Cisco Spark cloud.
|
| TeamMembershipClient |
TeamMemberships represent a person's relationship to a team.
Use this API to list members of any team that you're in or create memberships to invite someone to a team.
Team memberships can also be updated to make someone a moderator or deleted to remove them from the team.
|
| Webhook |
A data type presents a Webhook at Cisco Spark for Developer.
|
| WebhookClient |
WebhookClient allow your app to be notified via HTTP when a specific event occurs on Spark. For example, your app can register a webhook to be notified when a new message is posted into a specific room
|
Structures| Structure | Description | |
|---|---|---|
 | CallVideoDimensions |
video render view dimensions.
|
Interfaces| Interface | Description | |
|---|---|---|
 | IAuthenticator |
An interface for generic authentication strategies in Cisco Spark. Each authentication strategy
is responsible for providing an accessToken used throughout this SDK.
|
| ILogger |
A protocol for logging in the SDK.
|
Enumerations| Enumeration | Description | |
|---|---|---|
 | AVIODeviceType |
audio and video IO device type.
|
| CallCallDirection |
The enumeration of directions of a call
|
| CallMembershipCallState |
The enumeration of the status of the person in the membership.
|
| CallStatus |
The status of a Call.
|
| LogLevel |
The enumeration of log message level.
|
| PhoneDefaultBandwidth |
The enumeration of common bandwidth choices.
|
| RoomSortType |
The enumeration of sorting result
|
| RoomType |
The enumeration of the types of a room.
|
| ShareSourceType |
share source types.
|
| SparkErrorCode |
The enumeration of error types.
|