Classes
The following classes are available globally.
-
A JSON Web Token (JWT) based authentication strategy is to be used to authenticate a guest user on Cisco Webex.
Since
1.2.0Declaration
Swift
public class JWTAuthenticator : Authenticator
-
An OAuth based authentication strategy for authenticating a user on Cisco Webex.
Since
1.2.0Declaration
Swift
public class OAuthAuthenticator : Authenticator
-
A custom Access Token based authentication strategy is to be used to authenticate with an application provided access token.
Since
3.2.0Declaration
Swift
public class TokenAuthenticator : Authenticator
-
Declaration
Swift
public class CalendarMeetingClient
-
Declaration
Swift
public class MembershipClient
-
Declaration
Swift
public class LocalFile
-
MessageClient represents a client to the Webex platform. It can send and receive messages.
Use
Webex.messages
to get an instance of MessageClient.Since
1.4.0Declaration
Swift
public class MessageClient
-
Declaration
Swift
public class PersonClient
-
Represents an AuxStream
See moreDeclaration
Swift
public class AuxStream
-
Declaration
Swift
public class Call : WebexBroadcastCallServerProtocol
-
MediaRenderView is an OpenGL backed UIView, used to display video, developer should inherit customised video view from this.
Declaration
Swift
@MainActor public class MediaRenderView : SparkVideoLayer
-
Declaration
Swift
public class MediaStream
-
Declaration
Swift
public class MediaStreamChangeEventInfo
-
Declaration
Swift
public class CallHistoryRecord
-
Declaration
Swift
public class CallSchedule : Equatable, CustomStringConvertible
-
To enable video calls, user needs to activate a free video license (H.264 AVC) from Cisco. This UIViewController helps create a view to accept or decline the license
Declaration
Swift
@MainActor public class H264LicensePrompter : UIViewController
-
Declaration
Swift
public class CameraDeviceManager
-
A data type to represent the WebEx Assistant
Note
If
canControlWXA
is false for a meeting, even though the participant is a host, please verify your organization’s control hub settings and disable the Webex AI Assistant. This will enable the old Webex Assistant to continue using Transcription.Since
3.3.0
Declaration
Swift
public class WXA
-
Declaration
Swift
public class SpaceClient
-
Declaration
Swift
public class TeamClient
-
Declaration
Swift
public class TeamMembershipClient
-
Webex
object is the entry point to use this Cisco Webex iOS SDK. AWebex
object must be created with one of the followingAuthenticator
.OAuthAuthenticator
- this should be used when the SDK is to be authenticated as a registered user to Cisco Webex cloud.
let clientId = "Def123456..." let clientSecret = "fed456..." let scope = "spark:all" // This can be a space separated list of scopes that your access token should posses. It should always contain `spark:all`. Please contact support if you want to add new scopes to your app. let redirectUri = "MyCustomApplication://response" let emailId = "user@example.com" let authenticator = OAuthAuthenticator(clientId: clientId, clientSecret: clientSecret, scope: scope, redirectUri: redirectUri, emailId: emailId) let webex = Webex(authenticator: authenticator) webex = Webex(authenticator: authenticator) webex.initialize { isLoggedIn in if !isLoggedIn { authenticator.authorize(parentViewController: self) { result in if result == .success { print("user is logged in") } } } }
JWTAuthenticator
- This should be used when the SDK is to be authenticated as a guest user to Cisco Webex cloud.
let authenticator = JWTAuthenticator() let webex = Webex(authenticator: authenticator) webex.initialize { isLoggedIn in if !isLoggedIn { authenticator.authorizedWith(jwt: myJwt) { result in if result == .success { print("Guest user is logged in") } } } }
Attention
All APIs on Cisco Webex iOS SDK are expected to run on the application’s main thread, unless specified otherwise.Since
1.2.0Declaration
Swift
@objc public class Webex : NSObject
extension Webex: OmniusServiceBridgeDelegate
-
Declaration
Swift
public class WebhookClient
-
A data type represents an email address with validation and equatable implementation.
Since
1.2.0Declaration
Swift
open class EmailAddress
extension EmailAddress: Equatable
-
Undocumented
See moreDeclaration
Swift
public class Reachability