BDKWhiteboardToolConfiguration

Objective-C


@interface BDKWhiteboardToolConfiguration : NSObject <NSCopying>

Swift

class WhiteboardToolConfiguration : 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.

  • A boolean flag indicating whether the whiteboard tool is enabled or disabled.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isEnabled) BOOL enabled;

    Swift

    var isEnabled: Bool { get }

  • A boolean flag indicating whether the whiteboard upload tool is enabled or disabled.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isUploadEnabled) BOOL uploadEnabled;

    Swift

    var isUploadEnabled: Bool { get }

  • A factory method creating a configuration instance with all flags to false. You should use this method when you want to disable the whiteboard tool altogether.

    Declaration

    Objective-C

    + (nonnull instancetype)disabled;

    Swift

    class func disabled() -> Self

    Return Value

    a BDKWhiteboardToolConfiguration instance with all flags to false.

  • A factory method creating a configuration instance with “enabled” flag to true and “uploadEnabled” flag to the value provided as first argument.

    Declaration

    Objective-C

    + (nonnull instancetype)enabledWithUploadEnabled:(BOOL)uploadEnabled;

    Swift

    class func enabled(withUploadEnabled uploadEnabled: Bool) -> Self

    Parameters

    uploadEnabled

    a boolean flag indicating whether the whiteboard upload tool must be enabled or disabled.

    Return Value

    a BDKWhiteboardToolConfiguration instance with “enabled” flag to true and “uploadEnabled” to the value provided as argument.