Classes

The following classes are available globally.

  • A value object representing the options used when creating a call.

    This is a value object so instances can be checked for equality.

    See more

    Declaration

    Objective-C

    
    @interface BDKCallOptions : NSObject <NSCopying>

    Swift

    class CallOptions : NSObject, NSCopying
  • A value object holding the configuration values for the Bandyer “broadcast screensharing” tool. You can create this object when you want to enable or disable the “broadcast screensharing” tool in Bandyer calls. When enabling the “broadcast screensharing” tool you are required to provide the app group identifier shared by your app and the your broadcast upload extension. The broadcastExtensionBundleIdentifier is the bundle identifier of your broadcast upload extension, that identifier is needed by the BandyerSDK when it is asked to present the RPSystemBroadcastPickerView on devices running iOS 12 and above. When a value is provided, the BandyerSDK will present the user only your app, among those installed on the user device that provides a broadcast upload extension. If you don’t provide one, however, the user will be presented with a list of all apps installed on her / his device providing a broadcast extension.

    See more

    Declaration

    Objective-C

    
    @interface BDKBroadcastScreensharingToolConfiguration : NSObject <NSCopying>

    Swift

    class BroadcastScreensharingToolConfiguration : NSObject, NSCopying
  • A class encapsulating the configuration options for the bandyer sdk.

    See more

    Declaration

    Objective-C

    
    @interface BDKConfig : NSObject <NSCopying>

    Swift

    class Config : NSObject, NSCopying
  • A value object holding the configuration values for the Bandyer “file share” tool. You can create this object when you want to enable or disable the “file share” tool in Bandyer calls.

    See more

    Declaration

    Objective-C

    
    @interface BDKFileshareToolConfiguration : NSObject <NSCopying>

    Swift

    class FileshareToolConfiguration : NSObject, NSCopying
  • A value object holding the configuration values for the Bandyer “in-app screen share” tool. You can create this object when you want to enable or disable the “in-app screen sharing” tool in Bandyer calls. When enabled, if the screen recorder is available, the user will be able to capture the app screen content and share it with the other participants in the call. However, the screen recorder will record only the app main window’s content and it will be stopped when the app goes in background.

    See more

    Declaration

    Objective-C

    
    @interface BDKInAppScreensharingToolConfiguration : NSObject <NSCopying>

    Swift

    class InAppScreensharingToolConfiguration : NSObject, NSCopying
  • A value object holding the configuration values for the Whiteboard tool. You can create this object when you want to enable or disable the whiteboard tool in Bandyer calls.

    See more

    Declaration

    Objective-C

    
    @interface BDKWhiteboardToolConfiguration : NSObject <NSCopying>

    Swift

    class WhiteboardToolConfiguration : NSObject, NSCopying
  • The environment in which the sdk will run.

    See more

    Declaration

    Objective-C

    
    @interface BDKEnvironment : NSObject <NSCopying>

    Swift

    class Environment : NSObject, NSCopying
  • The Bandyer SDK facade.

    See more

    Declaration

    Objective-C

    @interface BandyerSDK : NSObject

    Swift

    class BandyerSDK : NSObject
  • An opaque object representing a chat notification.

    Declaration

    Objective-C

    
    @interface BDKChatNotification : NSObject

    Swift

    class ChatNotification : NSObject
  • An opaque object representing a file share notification.

    Declaration

    Objective-C

    
    @interface BDKFileShareNotification : NSObject

    Swift

    class FileShareNotification : NSObject
  • Represents the intent of handling a incoming call. When the sdk detects an incoming call has been received, you should create an BDKHandleIncomingCallIntent instance passing it the call object received and hand it to a BDKCallViewController or to a BDKCallWindow.

    See more

    Declaration

    Objective-C

    
    @interface BDKHandleIncomingCallIntent : NSObject <BDKIntent>

    Swift

    class HandleIncomingCallIntent : NSObject, Intent
  • Represents the intent of starting a call from an URL.

    See more

    Declaration

    Objective-C

    
    @interface BDKJoinURLIntent : NSObject <BDKIntent>

    Swift

    class JoinURLIntent : NSObject, Intent
  • Represents the request of making an outgoing call.

    See more

    Declaration

    Objective-C

    
    @interface BDKStartOutgoingCallIntent : NSObject <BDKIntent>

    Swift

    class StartOutgoingCallIntent : NSObject, Intent
  • A view controller showing the user interface for the intent provided. You should present this view controller modally.

    Remark: You must provide an intent before the view controller’s view is loaded.

    See more

    Declaration

    Objective-C

    
    @interface BDKCallViewController : UIViewController

    Swift

    class CallViewController : UIViewController
  • A class holding the customization available for a BDKCallViewController instance.

    See more

    Declaration

    Objective-C

    
    @interface BDKCallViewControllerConfiguration : NSObject <NSCopying>

    Swift

    class CallViewControllerConfiguration : NSObject, NSCopying
  • A class holding user profile information.

    See more

    Declaration

    Objective-C

    
    @interface BDKUserDetails : NSObject <NSCopying>

    Swift

    class UserDetails : NSObject, NSCopying
  • A view controller showing the user interface of the chat between the current user and the user specified in the OpenChatIntent provided. This view controller should be presented modally. You should not embed this view controller in a UINavigationController

    Remark

    You must provide an intent before the view controller’s view is loaded. Any intent provided after the view has loaded will be ignored.
    See more

    Declaration

    Swift

    @objc(BDKChannelViewController)
    public class ChannelViewController : UIViewController
  • A class holding the customization available for a ChannelViewController instance.

    See more

    Declaration

    Swift

    @objc(BDKChannelViewControllerConfiguration)
    public class ChannelViewControllerConfiguration : NSObject
  • Represents the intent of starting a chat.

    See more

    Declaration

    Swift

    @objc(BDKOpenChatIntent)
    public class OpenChatIntent : NSObject, Intent
  • Represents the intent of navigating to the Bandyer downloads screen.

    See more

    Declaration

    Swift

    @objc(BDKOpenDownloadsIntent)
    public class OpenDownloadsIntent : NSObject, Intent
  • A controller managing the “return to call” bar user interface. Once started, this controller will observe for any ongoing call and it will show the “return to call” bar at the top of the screen when at least one call is being performed. It will also hide the presented “return to call” bar when all calls have finished.

    Remark

    In order for this controller to work properly, you must provide a UIViewController instance that will be used to host the “return to call” bar. Failing to do so will result in a fatalError crashing your app.
    See more

    Declaration

    Swift

    @available(*, deprecated, message: "The CallBannerController controller and all its related types have been deprecated and they will be removed in a future release. The SDK now provides a Picture in Picture mode the user can use to get back in call which replaces the old Call Banner")
    @objc(BDKCallBannerController)
    public class CallBannerController : NSObject
  • The domain for a BDKCallPresentationError.

    See more

    Declaration

    Swift

    @objc(BDKCallPresentationErrorDomain)
    public class CallPresentationErrorDomain : NSObject
  • A UIWindow subclass having a BDKCallViewControllerinstance as its rootViewController.

    See more

    Declaration

    Swift

    @objc(BDKCallWindow)
    public class CallWindow : UIWindow
    extension CallWindow: CallViewControllerDelegate
  • A class used to style the Bandyer SDK view controllers. Please see the provided documentation for knowledge about mapping between properties and UI components.

    See more

    Declaration

    Swift

    @objc(BDKTheme)
    public class Theme : NSObject, NSCopying