Classes

The following classes are available globally.

  • A JWTAuthStorage implementation based on the iOS device keychain.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class JWTAuthKeychainStorage : JWTAuthStorage
  • A JSON Web Token (JWT) based authentication strategy is to be used to authenticate a guest user on Cisco Webex.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class JWTAuthenticator : Authenticator
  • An OAuth based authentication strategy for authenticating a user on Cisco Webex.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class OAuthAuthenticator : Authenticator
  • An OAuthStorage implementation based on the iOS device keychain.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class OAuthKeychainStorage : OAuthStorage
  • An Single sign-on SSO based authentication strategy used to authenticate a user on Cisco Webex.

    Since

    1.3.1
    See more

    Declaration

    Swift

    public class SSOAuthenticator : OAuthAuthenticator
  • An iOS client wrapper of the Cisco Webex Space Memberships REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class MembershipClient
  • A data type represents a local file.

    Since

    1.4.0
    See more

    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.0
    See more

    Declaration

    Swift

    public class MessageClient
  • An iOS client wrapper of the Cisco Webex People REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class PersonClient
  • A Call represents a media call on Cisco Webex.

    The application can create an outgoing Call by calling Phone.dial(...) function:

        let address = "coworker@example.com"
        let localVideoView = MediaRenderView()
        let remoteVideoView = MediaRenderView()
        let mediaOption = MediaOption.audioVideo(local: localVideoView, remote: remoteVideoView)
        webex.phone.dial(address, option:mediaOption) {
          switch ret {
          case .success(let call):
            // success
            call.onConnected = {
    
            }
            call.onDisconnected = { reason in
    
            }
          case .failure(let error):
            // failure
          }
        }
    

    The application can receive an incoming Call on Phone.onIncoming function:

        webex.phone.onIncoming = { call in
          call.answer(option: mediaOption) { error in
            if let error = error {
              // success
            }
            else {
              // failure
            }
          }
        }
    

    See

    see Phone API about how to create calls.

    See

    CallStatus for the states and transitions of a Call.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class Call
  • A CallSchedule represents the schedule of a scheduled call

    Since

    2.6.0
    See more

    Declaration

    Swift

    public class CallSchedule : Equatable, CustomStringConvertible
  • Undocumented

    See more

    Declaration

    Swift

    public class AuxStream
  • MediaRenderView is an OpenGL backed UIView, used to display video, developer should let customized video view inherit it.

    See more

    Declaration

    Swift

    public class MediaRenderView : UIView
  • Phone represents a Cisco Webex calling device. The application can obtain a phone object from Webex object and use phone to call other Cisco Webex users or PSTN when enabled. The phone must be registered before it can make or receive calls.

        webex.phone.register() { error in
          if let error = error {
            ... // Device was not registered, and no calls can be sent or received
          } else {
            ... // Successfully registered device
          }
        }
    

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class Phone
  • An iOS client wrapper of the Cisco Webex Spaces REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class SpaceClient
  • An iOS client wrapper of the Cisco Webex Teams REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class TeamClient
  • An iOS client wrapper of the Cisco Webex TeamMemberships REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class TeamMembershipClient
  • A data type represents an email address with validation and equatable implementation.

    Since

    1.2.0
    See more

    Declaration

    Swift

    open class EmailAddress
    extension EmailAddress: Equatable
  • Webex object is the entry point to use this Cisco Webex iOS SDK. A Webex object must be created with one of the following Authenticator.

    • 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 = "webex:all"
       let redirectUri = "MyCustomApplication://response"
       let authenticator = OAuthAuthenticator(clientId: clientId, clientSecret: clientSecret, scope: scope, redirectUri: redirectUri)
       let webex = Webex(authenticator: authenticator)
       ...
       if !authenticator.authorized {
         authenticator.authorize(parentViewController: self) { success in
           if !success {
               print("User not authorized")
           }
         }
       }
    
    • 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)
       ...
       if !authenticator.authorized {
         authenticator.authorizedWith(jwt: myJwt)
       }
    

    Attention

    All APIs on Cisco Webex iOS SDK are expected to run on the application’s main thread, unless specified otherwise.

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class Webex
  • An iOS client wrapper of the Cisco Webex Webhooks REST API .

    Since

    1.2.0
    See more

    Declaration

    Swift

    public class WebhookClient