Click or drag to resize

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
  ClassDescription
Public classAVIODevice
Audio and video IO device.
Public classCall
A Call represents a media call on Cisco Spark. The application can create an outgoing call by calling phone.dial function.
Public classCallDisconnectedEvent
The call disconnect event.
Public classCallError
Unknown error
Public classCallEvent
Base class for the event of a call.
Public classCallMembership
A data type represents a relationship between *Call* and *Person* at Cisco Spark cloud.
Public classCallMembershipChangedEvent
The call membership changed event.
Public classCallMembershipDeclinedEvent
The person in the membership declined this call.
Public classCallMembershipJoinedEvent
The person in the membership joined this call.
Public classCallMembershipLeftEvent
The person in the membership left this call.
Public classCallMembershipSendingAudioEvent
The person in the membership started sending audio.
Public classCallMembershipSendingShareEvent
The person in the membership started sharing.
Public classCallMembershipSendingVideoEvent
The person in the membership started sending video.
Public classCameraSwitchedEvent
This might be triggered when the selected camera switched.
Public classCapabilitieDTMF
The DTMF capability of this call.
Public classCapabilities
The capabilities of a call.
Public classJWTAuthenticator
A [JSON Web Token](https://jwt.io/introduction) (JWT) based authentication strategy is to be used to authenticate a guest user on Cisco Spark.
Public classLocalCancel
The local party has cancelled the call. This is only applicable when the direction of the call is *outgoing*.
Public classLocalDecline
The local party has declined the call. This is only applicable when the direction of the call is *incoming*.
Public classLocalFile
A data type represents a local file
Public classLocalFileThumbnail
A data type represents a local file thumbnail.
Public classLocalLeft
The local party has left the call.
Public classLocalVideoReadyEvent
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.
Public classLocalVideoViewSizeChangedEvent
Local video rendering view size has changed.
Public classMediaChangedEvent
The media change event.
Public classMediaOption
The media options of a call.
Public classMembership
Membership contents.
Public classMembershipClient
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.
Public classMention
A abstact data type represents mention.
Public classMentionAll
A data type represents mention all in the room.
Public classMentionPerson
A data type represents mention one person in the room.
Public classMessage
The struct of a Message on Cisco Spark.
Public classMessageArrived
The event of a message arrived.
Public classMessageClient
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.
Public classMessageDeleted
The event of a message is deleted.
Public classMessageEvent
A abstract data type represents a message event.
Public classOAuthAuthenticator
An [OAuth](https://oauth.net/2/) based authentication strategy is to be used to authenticate a user on Cisco Spark.
Public classOtherConnected
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*.
Public classOtherDeclined
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*.
Public classPerson
Person contents.
Public classPersonClient
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.
Public classPhone
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.
Public classReceivingAudioEvent
This might be triggered when the local party muted or unmuted the audio.
Public classReceivingShareEvent
This might be triggered when the local party muted or unmuted the video
Public classReceivingVideoEvent
This might be triggered when the local party muted or unmuted the video.
Public classRemoteCancel
The remote party has cancelled the call. This is only applicable when the direction of the call is *incoming*.
Public classRemoteDecline
The remote party has declined the call. This is only applicable when the direction of the call is *outgoing*.
Public classRemoteFile
A data type represents a remote file
Public classRemoteFileThumbnail
A data type represents a remote file thumbnail.
Public classRemoteLeft
The remote party has left the call.
Public classRemoteSendingAudioEvent
This might be triggered when the remote party muted or unmuted the audio.
Public classRemoteSendingShareEvent
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.
Public classRemoteSendingVideoEvent
This might be triggered when the remote party muted or unmuted the video.
Public classRemoteShareViewSizeChangedEvent
Remote share rendering view size has changed.
Public classRemoteVideoReadyEvent
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.
Public classRemoteVideoViewSizeChangedEvent
Remote video rendering view size has changed.
Public classRoom
A data type represents a Room at Cisco Spark cloud.
Public classRoomClient
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
Public classSendingAudioEvent
This might be triggered when the local party muted or unmuted the audio.
Public classSendingShareEvent
This might be triggered when the local party started or stopped share stream.
Public classSendingVideoEvent
This might be triggered when the local party muted or unmuted the video.
Public classShareSource
Share source.
Public classSpark
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.
Public classSparkApiEventArgs
Represents the Spark SDK api event args.
Public classSparkApiEventArgsT
Represents the Spark SDK api event args.
Public classSparkError
A data type represents a error.
Public classSpeakerSwitchedEvent
This might be triggered when the selected speaker switched.
Public classSSOAuthenticator
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)
Public classTeam
A data type represents a Team at Cisco Spark cloud.
Public classTeamClient
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
Public classTeamMembership
A data type represents a relationship between Team and Person at Cisco Spark cloud.
Public classTeamMembershipClient
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.
Public classWebhook
A data type presents a Webhook at Cisco Spark for Developer.
Public classWebhookClient
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
Interfaces
  InterfaceDescription
Public interfaceIAuthenticator
An interface for generic authentication strategies in Cisco Spark. Each authentication strategy is responsible for providing an accessToken used throughout this SDK.
Public interfaceILogger
A protocol for logging in the SDK.
Enumerations
  EnumerationDescription
Public enumerationAVIODeviceType
audio and video IO device type.
Public enumerationCallCallDirection
The enumeration of directions of a call
Public enumerationCallMembershipCallState
The enumeration of the status of the person in the membership.
Public enumerationCallStatus
The status of a Call.
Public enumerationLogLevel
The enumeration of log message level.
Public enumerationPhoneDefaultBandwidth
The enumeration of common bandwidth choices.
Public enumerationRoomSortType
The enumeration of sorting result
Public enumerationRoomType
The enumeration of the types of a room.
Public enumerationShareSourceType
share source types.
Public enumerationSparkErrorCode
The enumeration of error types.